purecloud-platform-client-v2 230.0.0 → 231.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 +3 -3
- package/dist/node/purecloud-platform-client-v2.js +970 -124
- package/dist/web-amd/purecloud-platform-client-v2.js +970 -124
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +365 -138
- package/dist/web-cjs/purecloud-platform-client-v2.js +365 -138
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +958 -264
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/PureCloudRegionHosts.js +2 -0
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +160 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +83 -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/BusinessRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +67 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.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/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +28 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +187 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.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/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +107 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +17 -7
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +241 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +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 -32
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -24,6 +24,8 @@ var PureCloudRegionHosts = {
|
|
|
24
24
|
me_central_1: 'mec1.pure.cloud',
|
|
25
25
|
ap_northeast_3: 'apne3.pure.cloud',
|
|
26
26
|
eu_central_2: 'euc2.pure.cloud',
|
|
27
|
+
mx_central_1: 'mxc1.pure.cloud',
|
|
28
|
+
ap_southeast_1: 'apse1.pure.cloud',
|
|
27
29
|
};
|
|
28
30
|
|
|
29
31
|
class AbstractHttpClient {
|
|
@@ -746,7 +748,7 @@ class Configuration {
|
|
|
746
748
|
|
|
747
749
|
/**
|
|
748
750
|
* @module purecloud-platform-client-v2/ApiClient
|
|
749
|
-
* @version
|
|
751
|
+
* @version 231.0.0
|
|
750
752
|
*/
|
|
751
753
|
class ApiClient {
|
|
752
754
|
/**
|
|
@@ -2290,7 +2292,7 @@ class AIStudioApi {
|
|
|
2290
2292
|
/**
|
|
2291
2293
|
* AIStudio service.
|
|
2292
2294
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2293
|
-
* @version
|
|
2295
|
+
* @version 231.0.0
|
|
2294
2296
|
*/
|
|
2295
2297
|
|
|
2296
2298
|
/**
|
|
@@ -2305,6 +2307,31 @@ class AIStudioApi {
|
|
|
2305
2307
|
}
|
|
2306
2308
|
|
|
2307
2309
|
|
|
2310
|
+
/**
|
|
2311
|
+
* Delete a summary setting.
|
|
2312
|
+
*
|
|
2313
|
+
* @param {String} summarySettingId Summary setting id
|
|
2314
|
+
*/
|
|
2315
|
+
deleteConversationsSummariesSetting(summarySettingId) {
|
|
2316
|
+
// verify the required parameter 'summarySettingId' is set
|
|
2317
|
+
if (summarySettingId === undefined || summarySettingId === null || summarySettingId === '') {
|
|
2318
|
+
throw 'Missing the required parameter "summarySettingId" when calling deleteConversationsSummariesSetting';
|
|
2319
|
+
}
|
|
2320
|
+
|
|
2321
|
+
return this.apiClient.callApi(
|
|
2322
|
+
'/api/v2/conversations/summaries/settings/{summarySettingId}',
|
|
2323
|
+
'DELETE',
|
|
2324
|
+
{ 'summarySettingId': summarySettingId },
|
|
2325
|
+
{ },
|
|
2326
|
+
{ },
|
|
2327
|
+
{ },
|
|
2328
|
+
null,
|
|
2329
|
+
['PureCloud OAuth'],
|
|
2330
|
+
['application/json'],
|
|
2331
|
+
['application/json']
|
|
2332
|
+
);
|
|
2333
|
+
}
|
|
2334
|
+
|
|
2308
2335
|
/**
|
|
2309
2336
|
* Start the deletion of a guide.
|
|
2310
2337
|
*
|
|
@@ -2331,6 +2358,60 @@ class AIStudioApi {
|
|
|
2331
2358
|
);
|
|
2332
2359
|
}
|
|
2333
2360
|
|
|
2361
|
+
/**
|
|
2362
|
+
* Receive a summary setting.
|
|
2363
|
+
*
|
|
2364
|
+
* @param {String} summarySettingId Summary setting id
|
|
2365
|
+
*/
|
|
2366
|
+
getConversationsSummariesSetting(summarySettingId) {
|
|
2367
|
+
// verify the required parameter 'summarySettingId' is set
|
|
2368
|
+
if (summarySettingId === undefined || summarySettingId === null || summarySettingId === '') {
|
|
2369
|
+
throw 'Missing the required parameter "summarySettingId" when calling getConversationsSummariesSetting';
|
|
2370
|
+
}
|
|
2371
|
+
|
|
2372
|
+
return this.apiClient.callApi(
|
|
2373
|
+
'/api/v2/conversations/summaries/settings/{summarySettingId}',
|
|
2374
|
+
'GET',
|
|
2375
|
+
{ 'summarySettingId': summarySettingId },
|
|
2376
|
+
{ },
|
|
2377
|
+
{ },
|
|
2378
|
+
{ },
|
|
2379
|
+
null,
|
|
2380
|
+
['PureCloud OAuth'],
|
|
2381
|
+
['application/json'],
|
|
2382
|
+
['application/json']
|
|
2383
|
+
);
|
|
2384
|
+
}
|
|
2385
|
+
|
|
2386
|
+
/**
|
|
2387
|
+
* Get all summary settings.
|
|
2388
|
+
*
|
|
2389
|
+
* @param {Object} opts Optional parameters
|
|
2390
|
+
* @param {String} opts.language Filter by matching language - case insensitive.
|
|
2391
|
+
* @param {String} opts.name Filter by partially matching name - case insensitive.
|
|
2392
|
+
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
2393
|
+
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
2394
|
+
* @param {Number} opts.pageNumber Page number. (default to 1)
|
|
2395
|
+
* @param {Number} opts.pageSize Page size. The maximum page size is 100. (default to 25)
|
|
2396
|
+
*/
|
|
2397
|
+
getConversationsSummariesSettings(opts) {
|
|
2398
|
+
opts = opts || {};
|
|
2399
|
+
|
|
2400
|
+
|
|
2401
|
+
return this.apiClient.callApi(
|
|
2402
|
+
'/api/v2/conversations/summaries/settings',
|
|
2403
|
+
'GET',
|
|
2404
|
+
{ },
|
|
2405
|
+
{ 'language': opts['language'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
2406
|
+
{ },
|
|
2407
|
+
{ },
|
|
2408
|
+
null,
|
|
2409
|
+
['PureCloud OAuth'],
|
|
2410
|
+
['application/json'],
|
|
2411
|
+
['application/json']
|
|
2412
|
+
);
|
|
2413
|
+
}
|
|
2414
|
+
|
|
2334
2415
|
/**
|
|
2335
2416
|
* Get guide.
|
|
2336
2417
|
*
|
|
@@ -2579,6 +2660,56 @@ class AIStudioApi {
|
|
|
2579
2660
|
);
|
|
2580
2661
|
}
|
|
2581
2662
|
|
|
2663
|
+
/**
|
|
2664
|
+
* Trigger summary preview event generation.
|
|
2665
|
+
*
|
|
2666
|
+
* @param {Object} body
|
|
2667
|
+
*/
|
|
2668
|
+
postConversationsSummariesPreview(body) {
|
|
2669
|
+
// verify the required parameter 'body' is set
|
|
2670
|
+
if (body === undefined || body === null) {
|
|
2671
|
+
throw 'Missing the required parameter "body" when calling postConversationsSummariesPreview';
|
|
2672
|
+
}
|
|
2673
|
+
|
|
2674
|
+
return this.apiClient.callApi(
|
|
2675
|
+
'/api/v2/conversations/summaries/preview',
|
|
2676
|
+
'POST',
|
|
2677
|
+
{ },
|
|
2678
|
+
{ },
|
|
2679
|
+
{ },
|
|
2680
|
+
{ },
|
|
2681
|
+
body,
|
|
2682
|
+
['PureCloud OAuth'],
|
|
2683
|
+
['application/json'],
|
|
2684
|
+
['application/json']
|
|
2685
|
+
);
|
|
2686
|
+
}
|
|
2687
|
+
|
|
2688
|
+
/**
|
|
2689
|
+
* Create a summary setting.
|
|
2690
|
+
*
|
|
2691
|
+
* @param {Object} body
|
|
2692
|
+
*/
|
|
2693
|
+
postConversationsSummariesSettings(body) {
|
|
2694
|
+
// verify the required parameter 'body' is set
|
|
2695
|
+
if (body === undefined || body === null) {
|
|
2696
|
+
throw 'Missing the required parameter "body" when calling postConversationsSummariesSettings';
|
|
2697
|
+
}
|
|
2698
|
+
|
|
2699
|
+
return this.apiClient.callApi(
|
|
2700
|
+
'/api/v2/conversations/summaries/settings',
|
|
2701
|
+
'POST',
|
|
2702
|
+
{ },
|
|
2703
|
+
{ },
|
|
2704
|
+
{ },
|
|
2705
|
+
{ },
|
|
2706
|
+
body,
|
|
2707
|
+
['PureCloud OAuth'],
|
|
2708
|
+
['application/json'],
|
|
2709
|
+
['application/json']
|
|
2710
|
+
);
|
|
2711
|
+
}
|
|
2712
|
+
|
|
2582
2713
|
/**
|
|
2583
2714
|
* Start the publishing of a guide version.
|
|
2584
2715
|
*
|
|
@@ -2697,13 +2828,43 @@ class AIStudioApi {
|
|
|
2697
2828
|
);
|
|
2698
2829
|
}
|
|
2699
2830
|
|
|
2831
|
+
/**
|
|
2832
|
+
* Update a summary setting.
|
|
2833
|
+
*
|
|
2834
|
+
* @param {String} summarySettingId Summary setting id
|
|
2835
|
+
* @param {Object} body
|
|
2836
|
+
*/
|
|
2837
|
+
putConversationsSummariesSetting(summarySettingId, body) {
|
|
2838
|
+
// verify the required parameter 'summarySettingId' is set
|
|
2839
|
+
if (summarySettingId === undefined || summarySettingId === null || summarySettingId === '') {
|
|
2840
|
+
throw 'Missing the required parameter "summarySettingId" when calling putConversationsSummariesSetting';
|
|
2841
|
+
}
|
|
2842
|
+
// verify the required parameter 'body' is set
|
|
2843
|
+
if (body === undefined || body === null) {
|
|
2844
|
+
throw 'Missing the required parameter "body" when calling putConversationsSummariesSetting';
|
|
2845
|
+
}
|
|
2846
|
+
|
|
2847
|
+
return this.apiClient.callApi(
|
|
2848
|
+
'/api/v2/conversations/summaries/settings/{summarySettingId}',
|
|
2849
|
+
'PUT',
|
|
2850
|
+
{ 'summarySettingId': summarySettingId },
|
|
2851
|
+
{ },
|
|
2852
|
+
{ },
|
|
2853
|
+
{ },
|
|
2854
|
+
body,
|
|
2855
|
+
['PureCloud OAuth'],
|
|
2856
|
+
['application/json'],
|
|
2857
|
+
['application/json']
|
|
2858
|
+
);
|
|
2859
|
+
}
|
|
2860
|
+
|
|
2700
2861
|
}
|
|
2701
2862
|
|
|
2702
2863
|
class AgentAssistantsApi {
|
|
2703
2864
|
/**
|
|
2704
2865
|
* AgentAssistants service.
|
|
2705
2866
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2706
|
-
* @version
|
|
2867
|
+
* @version 231.0.0
|
|
2707
2868
|
*/
|
|
2708
2869
|
|
|
2709
2870
|
/**
|
|
@@ -3189,7 +3350,7 @@ class AgentCopilotApi {
|
|
|
3189
3350
|
/**
|
|
3190
3351
|
* AgentCopilot service.
|
|
3191
3352
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3192
|
-
* @version
|
|
3353
|
+
* @version 231.0.0
|
|
3193
3354
|
*/
|
|
3194
3355
|
|
|
3195
3356
|
/**
|
|
@@ -3265,7 +3426,7 @@ class AgentUIApi {
|
|
|
3265
3426
|
/**
|
|
3266
3427
|
* AgentUI service.
|
|
3267
3428
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
3268
|
-
* @version
|
|
3429
|
+
* @version 231.0.0
|
|
3269
3430
|
*/
|
|
3270
3431
|
|
|
3271
3432
|
/**
|
|
@@ -3396,7 +3557,7 @@ class AlertingApi {
|
|
|
3396
3557
|
/**
|
|
3397
3558
|
* Alerting service.
|
|
3398
3559
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3399
|
-
* @version
|
|
3560
|
+
* @version 231.0.0
|
|
3400
3561
|
*/
|
|
3401
3562
|
|
|
3402
3563
|
/**
|
|
@@ -3797,7 +3958,7 @@ class AnalyticsApi {
|
|
|
3797
3958
|
/**
|
|
3798
3959
|
* Analytics service.
|
|
3799
3960
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3800
|
-
* @version
|
|
3961
|
+
* @version 231.0.0
|
|
3801
3962
|
*/
|
|
3802
3963
|
|
|
3803
3964
|
/**
|
|
@@ -4729,6 +4890,62 @@ class AnalyticsApi {
|
|
|
4729
4890
|
);
|
|
4730
4891
|
}
|
|
4731
4892
|
|
|
4893
|
+
/**
|
|
4894
|
+
* Get analytics data warehouse file download
|
|
4895
|
+
*
|
|
4896
|
+
* @param {String} downloadId Unique file Id to download
|
|
4897
|
+
* getAnalyticsDataextractionDownload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4898
|
+
*/
|
|
4899
|
+
getAnalyticsDataextractionDownload(downloadId) {
|
|
4900
|
+
// verify the required parameter 'downloadId' is set
|
|
4901
|
+
if (downloadId === undefined || downloadId === null || downloadId === '') {
|
|
4902
|
+
throw 'Missing the required parameter "downloadId" when calling getAnalyticsDataextractionDownload';
|
|
4903
|
+
}
|
|
4904
|
+
|
|
4905
|
+
return this.apiClient.callApi(
|
|
4906
|
+
'/api/v2/analytics/dataextraction/downloads/{downloadId}',
|
|
4907
|
+
'GET',
|
|
4908
|
+
{ 'downloadId': downloadId },
|
|
4909
|
+
{ },
|
|
4910
|
+
{ },
|
|
4911
|
+
{ },
|
|
4912
|
+
null,
|
|
4913
|
+
['PureCloud OAuth'],
|
|
4914
|
+
['application/json'],
|
|
4915
|
+
['application/json']
|
|
4916
|
+
);
|
|
4917
|
+
}
|
|
4918
|
+
|
|
4919
|
+
/**
|
|
4920
|
+
* Get metadata on files available for extraction
|
|
4921
|
+
*
|
|
4922
|
+
* @param {Object} opts Optional parameters
|
|
4923
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
4924
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
4925
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
4926
|
+
* @param {String} opts.dataSchema Data schema like conversations
|
|
4927
|
+
* @param {Date} opts.dateStart Start DateTime filter. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
4928
|
+
* @param {Date} opts.dateEnd End DateTime filter. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
4929
|
+
* getAnalyticsDataextractionDownloadsMetadata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4930
|
+
*/
|
|
4931
|
+
getAnalyticsDataextractionDownloadsMetadata(opts) {
|
|
4932
|
+
opts = opts || {};
|
|
4933
|
+
|
|
4934
|
+
|
|
4935
|
+
return this.apiClient.callApi(
|
|
4936
|
+
'/api/v2/analytics/dataextraction/downloads/metadata',
|
|
4937
|
+
'GET',
|
|
4938
|
+
{ },
|
|
4939
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'dataSchema': opts['dataSchema'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'] },
|
|
4940
|
+
{ },
|
|
4941
|
+
{ },
|
|
4942
|
+
null,
|
|
4943
|
+
['PureCloud OAuth'],
|
|
4944
|
+
['application/json'],
|
|
4945
|
+
['application/json']
|
|
4946
|
+
);
|
|
4947
|
+
}
|
|
4948
|
+
|
|
4732
4949
|
/**
|
|
4733
4950
|
* Get analytics data retention setting
|
|
4734
4951
|
*
|
|
@@ -6021,6 +6238,32 @@ class AnalyticsApi {
|
|
|
6021
6238
|
);
|
|
6022
6239
|
}
|
|
6023
6240
|
|
|
6241
|
+
/**
|
|
6242
|
+
* Get download URLs for analytics data warehouse files
|
|
6243
|
+
*
|
|
6244
|
+
* @param {Object} body request
|
|
6245
|
+
* postAnalyticsDataextractionDownloadsBulk is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6246
|
+
*/
|
|
6247
|
+
postAnalyticsDataextractionDownloadsBulk(body) {
|
|
6248
|
+
// verify the required parameter 'body' is set
|
|
6249
|
+
if (body === undefined || body === null) {
|
|
6250
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsDataextractionDownloadsBulk';
|
|
6251
|
+
}
|
|
6252
|
+
|
|
6253
|
+
return this.apiClient.callApi(
|
|
6254
|
+
'/api/v2/analytics/dataextraction/downloads/bulk',
|
|
6255
|
+
'POST',
|
|
6256
|
+
{ },
|
|
6257
|
+
{ },
|
|
6258
|
+
{ },
|
|
6259
|
+
{ },
|
|
6260
|
+
body,
|
|
6261
|
+
['PureCloud OAuth'],
|
|
6262
|
+
['application/json'],
|
|
6263
|
+
['application/json']
|
|
6264
|
+
);
|
|
6265
|
+
}
|
|
6266
|
+
|
|
6024
6267
|
/**
|
|
6025
6268
|
* Query for evaluation aggregates asynchronously
|
|
6026
6269
|
*
|
|
@@ -6983,7 +7226,7 @@ class ArchitectApi {
|
|
|
6983
7226
|
/**
|
|
6984
7227
|
* Architect service.
|
|
6985
7228
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6986
|
-
* @version
|
|
7229
|
+
* @version 231.0.0
|
|
6987
7230
|
*/
|
|
6988
7231
|
|
|
6989
7232
|
/**
|
|
@@ -11278,7 +11521,7 @@ class AuditApi {
|
|
|
11278
11521
|
/**
|
|
11279
11522
|
* Audit service.
|
|
11280
11523
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
11281
|
-
* @version
|
|
11524
|
+
* @version 231.0.0
|
|
11282
11525
|
*/
|
|
11283
11526
|
|
|
11284
11527
|
/**
|
|
@@ -11479,7 +11722,7 @@ class AuthorizationApi {
|
|
|
11479
11722
|
/**
|
|
11480
11723
|
* Authorization service.
|
|
11481
11724
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
11482
|
-
* @version
|
|
11725
|
+
* @version 231.0.0
|
|
11483
11726
|
*/
|
|
11484
11727
|
|
|
11485
11728
|
/**
|
|
@@ -13194,7 +13437,7 @@ class BillingApi {
|
|
|
13194
13437
|
/**
|
|
13195
13438
|
* Billing service.
|
|
13196
13439
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
13197
|
-
* @version
|
|
13440
|
+
* @version 231.0.0
|
|
13198
13441
|
*/
|
|
13199
13442
|
|
|
13200
13443
|
/**
|
|
@@ -13450,7 +13693,7 @@ class BusinessRulesApi {
|
|
|
13450
13693
|
/**
|
|
13451
13694
|
* BusinessRules service.
|
|
13452
13695
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
13453
|
-
* @version
|
|
13696
|
+
* @version 231.0.0
|
|
13454
13697
|
*/
|
|
13455
13698
|
|
|
13456
13699
|
/**
|
|
@@ -14366,7 +14609,7 @@ class CarrierServicesApi {
|
|
|
14366
14609
|
/**
|
|
14367
14610
|
* CarrierServices service.
|
|
14368
14611
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
14369
|
-
* @version
|
|
14612
|
+
* @version 231.0.0
|
|
14370
14613
|
*/
|
|
14371
14614
|
|
|
14372
14615
|
/**
|
|
@@ -14436,7 +14679,7 @@ class ChatApi {
|
|
|
14436
14679
|
/**
|
|
14437
14680
|
* Chat service.
|
|
14438
14681
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
14439
|
-
* @version
|
|
14682
|
+
* @version 231.0.0
|
|
14440
14683
|
*/
|
|
14441
14684
|
|
|
14442
14685
|
/**
|
|
@@ -15417,7 +15660,7 @@ class CoachingApi {
|
|
|
15417
15660
|
/**
|
|
15418
15661
|
* Coaching service.
|
|
15419
15662
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
15420
|
-
* @version
|
|
15663
|
+
* @version 231.0.0
|
|
15421
15664
|
*/
|
|
15422
15665
|
|
|
15423
15666
|
/**
|
|
@@ -15994,7 +16237,7 @@ class ContentManagementApi {
|
|
|
15994
16237
|
/**
|
|
15995
16238
|
* ContentManagement service.
|
|
15996
16239
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
15997
|
-
* @version
|
|
16240
|
+
* @version 231.0.0
|
|
15998
16241
|
*/
|
|
15999
16242
|
|
|
16000
16243
|
/**
|
|
@@ -17075,7 +17318,7 @@ class ConversationsApi {
|
|
|
17075
17318
|
/**
|
|
17076
17319
|
* Conversations service.
|
|
17077
17320
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
17078
|
-
* @version
|
|
17321
|
+
* @version 231.0.0
|
|
17079
17322
|
*/
|
|
17080
17323
|
|
|
17081
17324
|
/**
|
|
@@ -23027,6 +23270,41 @@ class ConversationsApi {
|
|
|
23027
23270
|
);
|
|
23028
23271
|
}
|
|
23029
23272
|
|
|
23273
|
+
/**
|
|
23274
|
+
* Add participants to a conversation without a user context
|
|
23275
|
+
*
|
|
23276
|
+
* @param {String} conversationId conversationId
|
|
23277
|
+
* @param {String} userId userId
|
|
23278
|
+
* @param {Object} body Conversation
|
|
23279
|
+
*/
|
|
23280
|
+
postConversationsCallParticipantsUserUserId(conversationId, userId, body) {
|
|
23281
|
+
// verify the required parameter 'conversationId' is set
|
|
23282
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
23283
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantsUserUserId';
|
|
23284
|
+
}
|
|
23285
|
+
// verify the required parameter 'userId' is set
|
|
23286
|
+
if (userId === undefined || userId === null || userId === '') {
|
|
23287
|
+
throw 'Missing the required parameter "userId" when calling postConversationsCallParticipantsUserUserId';
|
|
23288
|
+
}
|
|
23289
|
+
// verify the required parameter 'body' is set
|
|
23290
|
+
if (body === undefined || body === null) {
|
|
23291
|
+
throw 'Missing the required parameter "body" when calling postConversationsCallParticipantsUserUserId';
|
|
23292
|
+
}
|
|
23293
|
+
|
|
23294
|
+
return this.apiClient.callApi(
|
|
23295
|
+
'/api/v2/conversations/calls/{conversationId}/participants/user/{userId}',
|
|
23296
|
+
'POST',
|
|
23297
|
+
{ 'conversationId': conversationId,'userId': userId },
|
|
23298
|
+
{ },
|
|
23299
|
+
{ },
|
|
23300
|
+
{ },
|
|
23301
|
+
body,
|
|
23302
|
+
['PureCloud OAuth'],
|
|
23303
|
+
['application/json'],
|
|
23304
|
+
['application/json']
|
|
23305
|
+
);
|
|
23306
|
+
}
|
|
23307
|
+
|
|
23030
23308
|
/**
|
|
23031
23309
|
* Apply wrap-up for this conversation communication
|
|
23032
23310
|
*
|
|
@@ -23201,6 +23479,36 @@ class ConversationsApi {
|
|
|
23201
23479
|
);
|
|
23202
23480
|
}
|
|
23203
23481
|
|
|
23482
|
+
/**
|
|
23483
|
+
* Create a call conversation on behalf of a user
|
|
23484
|
+
*
|
|
23485
|
+
* @param {String} userId userId
|
|
23486
|
+
* @param {Object} body Call request
|
|
23487
|
+
*/
|
|
23488
|
+
postConversationsCallsUserUserId(userId, body) {
|
|
23489
|
+
// verify the required parameter 'userId' is set
|
|
23490
|
+
if (userId === undefined || userId === null || userId === '') {
|
|
23491
|
+
throw 'Missing the required parameter "userId" when calling postConversationsCallsUserUserId';
|
|
23492
|
+
}
|
|
23493
|
+
// verify the required parameter 'body' is set
|
|
23494
|
+
if (body === undefined || body === null) {
|
|
23495
|
+
throw 'Missing the required parameter "body" when calling postConversationsCallsUserUserId';
|
|
23496
|
+
}
|
|
23497
|
+
|
|
23498
|
+
return this.apiClient.callApi(
|
|
23499
|
+
'/api/v2/conversations/calls/user/{userId}',
|
|
23500
|
+
'POST',
|
|
23501
|
+
{ 'userId': userId },
|
|
23502
|
+
{ },
|
|
23503
|
+
{ },
|
|
23504
|
+
{ },
|
|
23505
|
+
body,
|
|
23506
|
+
['PureCloud OAuth'],
|
|
23507
|
+
['application/json'],
|
|
23508
|
+
['application/json']
|
|
23509
|
+
);
|
|
23510
|
+
}
|
|
23511
|
+
|
|
23204
23512
|
/**
|
|
23205
23513
|
* Send a message on behalf of a communication in a chat conversation.
|
|
23206
23514
|
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
@@ -23611,7 +23919,7 @@ class ConversationsApi {
|
|
|
23611
23919
|
|
|
23612
23920
|
/**
|
|
23613
23921
|
* Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation
|
|
23614
|
-
*
|
|
23922
|
+
* This request is not valid when using the Client Credentials OAuth grant.
|
|
23615
23923
|
* @param {String} conversationId conversationId
|
|
23616
23924
|
*/
|
|
23617
23925
|
postConversationsEmailReconnect(conversationId) {
|
|
@@ -25398,7 +25706,7 @@ class DataExtensionsApi {
|
|
|
25398
25706
|
/**
|
|
25399
25707
|
* DataExtensions service.
|
|
25400
25708
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
25401
|
-
* @version
|
|
25709
|
+
* @version 231.0.0
|
|
25402
25710
|
*/
|
|
25403
25711
|
|
|
25404
25712
|
/**
|
|
@@ -25484,7 +25792,7 @@ class DataPrivacyApi {
|
|
|
25484
25792
|
/**
|
|
25485
25793
|
* DataPrivacy service.
|
|
25486
25794
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
25487
|
-
* @version
|
|
25795
|
+
* @version 231.0.0
|
|
25488
25796
|
*/
|
|
25489
25797
|
|
|
25490
25798
|
/**
|
|
@@ -25654,7 +25962,7 @@ class DownloadsApi {
|
|
|
25654
25962
|
/**
|
|
25655
25963
|
* Downloads service.
|
|
25656
25964
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
25657
|
-
* @version
|
|
25965
|
+
* @version 231.0.0
|
|
25658
25966
|
*/
|
|
25659
25967
|
|
|
25660
25968
|
/**
|
|
@@ -25706,7 +26014,7 @@ class EmailsApi {
|
|
|
25706
26014
|
/**
|
|
25707
26015
|
* Emails service.
|
|
25708
26016
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
25709
|
-
* @version
|
|
26017
|
+
* @version 231.0.0
|
|
25710
26018
|
*/
|
|
25711
26019
|
|
|
25712
26020
|
/**
|
|
@@ -25835,7 +26143,7 @@ class EmployeeEngagementApi {
|
|
|
25835
26143
|
/**
|
|
25836
26144
|
* EmployeeEngagement service.
|
|
25837
26145
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
25838
|
-
* @version
|
|
26146
|
+
* @version 231.0.0
|
|
25839
26147
|
*/
|
|
25840
26148
|
|
|
25841
26149
|
/**
|
|
@@ -25986,7 +26294,7 @@ class EventsApi {
|
|
|
25986
26294
|
/**
|
|
25987
26295
|
* Events service.
|
|
25988
26296
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
25989
|
-
* @version
|
|
26297
|
+
* @version 231.0.0
|
|
25990
26298
|
*/
|
|
25991
26299
|
|
|
25992
26300
|
/**
|
|
@@ -26082,7 +26390,7 @@ class ExternalContactsApi {
|
|
|
26082
26390
|
/**
|
|
26083
26391
|
* ExternalContacts service.
|
|
26084
26392
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
26085
|
-
* @version
|
|
26393
|
+
* @version 231.0.0
|
|
26086
26394
|
*/
|
|
26087
26395
|
|
|
26088
26396
|
/**
|
|
@@ -29329,7 +29637,7 @@ class FaxApi {
|
|
|
29329
29637
|
/**
|
|
29330
29638
|
* Fax service.
|
|
29331
29639
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
29332
|
-
* @version
|
|
29640
|
+
* @version 231.0.0
|
|
29333
29641
|
*/
|
|
29334
29642
|
|
|
29335
29643
|
/**
|
|
@@ -29544,7 +29852,7 @@ class FlowsApi {
|
|
|
29544
29852
|
/**
|
|
29545
29853
|
* Flows service.
|
|
29546
29854
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
29547
|
-
* @version
|
|
29855
|
+
* @version 231.0.0
|
|
29548
29856
|
*/
|
|
29549
29857
|
|
|
29550
29858
|
/**
|
|
@@ -29753,7 +30061,7 @@ class GamificationApi {
|
|
|
29753
30061
|
/**
|
|
29754
30062
|
* Gamification service.
|
|
29755
30063
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
29756
|
-
* @version
|
|
30064
|
+
* @version 231.0.0
|
|
29757
30065
|
*/
|
|
29758
30066
|
|
|
29759
30067
|
/**
|
|
@@ -32260,7 +32568,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
32260
32568
|
/**
|
|
32261
32569
|
* GeneralDataProtectionRegulation service.
|
|
32262
32570
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
32263
|
-
* @version
|
|
32571
|
+
* @version 231.0.0
|
|
32264
32572
|
*/
|
|
32265
32573
|
|
|
32266
32574
|
/**
|
|
@@ -32390,7 +32698,7 @@ class GeolocationApi {
|
|
|
32390
32698
|
/**
|
|
32391
32699
|
* Geolocation service.
|
|
32392
32700
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
32393
|
-
* @version
|
|
32701
|
+
* @version 231.0.0
|
|
32394
32702
|
*/
|
|
32395
32703
|
|
|
32396
32704
|
/**
|
|
@@ -32521,7 +32829,7 @@ class GreetingsApi {
|
|
|
32521
32829
|
/**
|
|
32522
32830
|
* Greetings service.
|
|
32523
32831
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
32524
|
-
* @version
|
|
32832
|
+
* @version 231.0.0
|
|
32525
32833
|
*/
|
|
32526
32834
|
|
|
32527
32835
|
/**
|
|
@@ -33063,7 +33371,7 @@ class GroupsApi {
|
|
|
33063
33371
|
/**
|
|
33064
33372
|
* Groups service.
|
|
33065
33373
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
33066
|
-
* @version
|
|
33374
|
+
* @version 231.0.0
|
|
33067
33375
|
*/
|
|
33068
33376
|
|
|
33069
33377
|
/**
|
|
@@ -33582,7 +33890,7 @@ class IdentityProviderApi {
|
|
|
33582
33890
|
/**
|
|
33583
33891
|
* IdentityProvider service.
|
|
33584
33892
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
33585
|
-
* @version
|
|
33893
|
+
* @version 231.0.0
|
|
33586
33894
|
*/
|
|
33587
33895
|
|
|
33588
33896
|
/**
|
|
@@ -34443,7 +34751,7 @@ class InfrastructureAsCodeApi {
|
|
|
34443
34751
|
/**
|
|
34444
34752
|
* InfrastructureAsCode service.
|
|
34445
34753
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
34446
|
-
* @version
|
|
34754
|
+
* @version 231.0.0
|
|
34447
34755
|
*/
|
|
34448
34756
|
|
|
34449
34757
|
/**
|
|
@@ -34610,7 +34918,7 @@ class IntegrationsApi {
|
|
|
34610
34918
|
/**
|
|
34611
34919
|
* Integrations service.
|
|
34612
34920
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
34613
|
-
* @version
|
|
34921
|
+
* @version 231.0.0
|
|
34614
34922
|
*/
|
|
34615
34923
|
|
|
34616
34924
|
/**
|
|
@@ -37255,7 +37563,7 @@ class JourneyApi {
|
|
|
37255
37563
|
/**
|
|
37256
37564
|
* Journey service.
|
|
37257
37565
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
37258
|
-
* @version
|
|
37566
|
+
* @version 231.0.0
|
|
37259
37567
|
*/
|
|
37260
37568
|
|
|
37261
37569
|
/**
|
|
@@ -38543,6 +38851,33 @@ class JourneyApi {
|
|
|
38543
38851
|
);
|
|
38544
38852
|
}
|
|
38545
38853
|
|
|
38854
|
+
/**
|
|
38855
|
+
* Get my jobs
|
|
38856
|
+
*
|
|
38857
|
+
* @param {Object} opts Optional parameters
|
|
38858
|
+
* @param {Number} opts.pageNumber The number of the page to return (default to 1)
|
|
38859
|
+
* @param {Number} opts.pageSize Max number of entities to return (default to 25)
|
|
38860
|
+
* @param {String} opts.interval An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.
|
|
38861
|
+
* @param {String} opts.statuses Job statuses to filter for
|
|
38862
|
+
*/
|
|
38863
|
+
getJourneyViewsJobsMe(opts) {
|
|
38864
|
+
opts = opts || {};
|
|
38865
|
+
|
|
38866
|
+
|
|
38867
|
+
return this.apiClient.callApi(
|
|
38868
|
+
'/api/v2/journey/views/jobs/me',
|
|
38869
|
+
'GET',
|
|
38870
|
+
{ },
|
|
38871
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'interval': opts['interval'],'statuses': opts['statuses'] },
|
|
38872
|
+
{ },
|
|
38873
|
+
{ },
|
|
38874
|
+
null,
|
|
38875
|
+
['PureCloud OAuth'],
|
|
38876
|
+
['application/json'],
|
|
38877
|
+
['application/json']
|
|
38878
|
+
);
|
|
38879
|
+
}
|
|
38880
|
+
|
|
38546
38881
|
/**
|
|
38547
38882
|
* Get the journey schedules for an organization.
|
|
38548
38883
|
*
|
|
@@ -39325,7 +39660,7 @@ class KnowledgeApi {
|
|
|
39325
39660
|
/**
|
|
39326
39661
|
* Knowledge service.
|
|
39327
39662
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
39328
|
-
* @version
|
|
39663
|
+
* @version 231.0.0
|
|
39329
39664
|
*/
|
|
39330
39665
|
|
|
39331
39666
|
/**
|
|
@@ -43227,7 +43562,7 @@ class LanguageUnderstandingApi {
|
|
|
43227
43562
|
/**
|
|
43228
43563
|
* LanguageUnderstanding service.
|
|
43229
43564
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
43230
|
-
* @version
|
|
43565
|
+
* @version 231.0.0
|
|
43231
43566
|
*/
|
|
43232
43567
|
|
|
43233
43568
|
/**
|
|
@@ -43601,6 +43936,72 @@ class LanguageUnderstandingApi {
|
|
|
43601
43936
|
);
|
|
43602
43937
|
}
|
|
43603
43938
|
|
|
43939
|
+
/**
|
|
43940
|
+
* Get list of all ignored phrases of the specified language code
|
|
43941
|
+
*
|
|
43942
|
+
* @param {String} languageCode Language Code
|
|
43943
|
+
* @param {Object} opts Optional parameters
|
|
43944
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 200. (default to 25)
|
|
43945
|
+
* @param {Number} opts.pageNumber The page number for the listing (default to 1)
|
|
43946
|
+
* @param {String} opts.text The phrase text filter applied to the listing
|
|
43947
|
+
* @param {Object} opts.sortOrder The sort order for the listing (default to desc)
|
|
43948
|
+
* @param {Object} opts.sortBy The field to sort by for the listing (default to dateModified)
|
|
43949
|
+
*/
|
|
43950
|
+
getLanguageunderstandingIgnorephrase(languageCode, opts) {
|
|
43951
|
+
opts = opts || {};
|
|
43952
|
+
|
|
43953
|
+
// verify the required parameter 'languageCode' is set
|
|
43954
|
+
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
43955
|
+
throw 'Missing the required parameter "languageCode" when calling getLanguageunderstandingIgnorephrase';
|
|
43956
|
+
}
|
|
43957
|
+
|
|
43958
|
+
return this.apiClient.callApi(
|
|
43959
|
+
'/api/v2/languageunderstanding/ignorephrases/{languageCode}',
|
|
43960
|
+
'GET',
|
|
43961
|
+
{ 'languageCode': languageCode },
|
|
43962
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'text': opts['text'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'] },
|
|
43963
|
+
{ },
|
|
43964
|
+
{ },
|
|
43965
|
+
null,
|
|
43966
|
+
['PureCloud OAuth'],
|
|
43967
|
+
['application/json'],
|
|
43968
|
+
['application/json']
|
|
43969
|
+
);
|
|
43970
|
+
}
|
|
43971
|
+
|
|
43972
|
+
/**
|
|
43973
|
+
* Get list of all ignored topics of the specified language code
|
|
43974
|
+
*
|
|
43975
|
+
* @param {String} languageCode Language Code
|
|
43976
|
+
* @param {Object} opts Optional parameters
|
|
43977
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 200. (default to 25)
|
|
43978
|
+
* @param {Number} opts.pageNumber The page number for the listing (default to 1)
|
|
43979
|
+
* @param {String} opts.text The topic text filter applied to the listing
|
|
43980
|
+
* @param {Object} opts.sortOrder The sort order for the listing (default to desc)
|
|
43981
|
+
* @param {Object} opts.sortBy The field to sort by for the listing (default to dateModified)
|
|
43982
|
+
*/
|
|
43983
|
+
getLanguageunderstandingIgnoretopic(languageCode, opts) {
|
|
43984
|
+
opts = opts || {};
|
|
43985
|
+
|
|
43986
|
+
// verify the required parameter 'languageCode' is set
|
|
43987
|
+
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
43988
|
+
throw 'Missing the required parameter "languageCode" when calling getLanguageunderstandingIgnoretopic';
|
|
43989
|
+
}
|
|
43990
|
+
|
|
43991
|
+
return this.apiClient.callApi(
|
|
43992
|
+
'/api/v2/languageunderstanding/ignoretopics/{languageCode}',
|
|
43993
|
+
'GET',
|
|
43994
|
+
{ 'languageCode': languageCode },
|
|
43995
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'text': opts['text'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'] },
|
|
43996
|
+
{ },
|
|
43997
|
+
{ },
|
|
43998
|
+
null,
|
|
43999
|
+
['PureCloud OAuth'],
|
|
44000
|
+
['application/json'],
|
|
44001
|
+
['application/json']
|
|
44002
|
+
);
|
|
44003
|
+
}
|
|
44004
|
+
|
|
43604
44005
|
/**
|
|
43605
44006
|
* Get information about a miner.
|
|
43606
44007
|
*
|
|
@@ -44135,6 +44536,126 @@ class LanguageUnderstandingApi {
|
|
|
44135
44536
|
);
|
|
44136
44537
|
}
|
|
44137
44538
|
|
|
44539
|
+
/**
|
|
44540
|
+
* Add phrases to the ignored phrases list
|
|
44541
|
+
*
|
|
44542
|
+
* @param {String} languageCode Language Code
|
|
44543
|
+
* @param {Object} body Request body containing phrases to be ignored
|
|
44544
|
+
*/
|
|
44545
|
+
postLanguageunderstandingIgnorephrase(languageCode, body) {
|
|
44546
|
+
// verify the required parameter 'languageCode' is set
|
|
44547
|
+
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
44548
|
+
throw 'Missing the required parameter "languageCode" when calling postLanguageunderstandingIgnorephrase';
|
|
44549
|
+
}
|
|
44550
|
+
// verify the required parameter 'body' is set
|
|
44551
|
+
if (body === undefined || body === null) {
|
|
44552
|
+
throw 'Missing the required parameter "body" when calling postLanguageunderstandingIgnorephrase';
|
|
44553
|
+
}
|
|
44554
|
+
|
|
44555
|
+
return this.apiClient.callApi(
|
|
44556
|
+
'/api/v2/languageunderstanding/ignorephrases/{languageCode}',
|
|
44557
|
+
'POST',
|
|
44558
|
+
{ 'languageCode': languageCode },
|
|
44559
|
+
{ },
|
|
44560
|
+
{ },
|
|
44561
|
+
{ },
|
|
44562
|
+
body,
|
|
44563
|
+
['PureCloud OAuth'],
|
|
44564
|
+
['application/json'],
|
|
44565
|
+
['application/json']
|
|
44566
|
+
);
|
|
44567
|
+
}
|
|
44568
|
+
|
|
44569
|
+
/**
|
|
44570
|
+
* Delete ignored phrases
|
|
44571
|
+
*
|
|
44572
|
+
* @param {String} languageCode Language Code
|
|
44573
|
+
* @param {Object} body Request body containing entities to be removed
|
|
44574
|
+
*/
|
|
44575
|
+
postLanguageunderstandingIgnorephraseRemove(languageCode, body) {
|
|
44576
|
+
// verify the required parameter 'languageCode' is set
|
|
44577
|
+
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
44578
|
+
throw 'Missing the required parameter "languageCode" when calling postLanguageunderstandingIgnorephraseRemove';
|
|
44579
|
+
}
|
|
44580
|
+
// verify the required parameter 'body' is set
|
|
44581
|
+
if (body === undefined || body === null) {
|
|
44582
|
+
throw 'Missing the required parameter "body" when calling postLanguageunderstandingIgnorephraseRemove';
|
|
44583
|
+
}
|
|
44584
|
+
|
|
44585
|
+
return this.apiClient.callApi(
|
|
44586
|
+
'/api/v2/languageunderstanding/ignorephrases/{languageCode}/remove',
|
|
44587
|
+
'POST',
|
|
44588
|
+
{ 'languageCode': languageCode },
|
|
44589
|
+
{ },
|
|
44590
|
+
{ },
|
|
44591
|
+
{ },
|
|
44592
|
+
body,
|
|
44593
|
+
['PureCloud OAuth'],
|
|
44594
|
+
['application/json'],
|
|
44595
|
+
['application/json']
|
|
44596
|
+
);
|
|
44597
|
+
}
|
|
44598
|
+
|
|
44599
|
+
/**
|
|
44600
|
+
* Add topics to the ignored topics list
|
|
44601
|
+
*
|
|
44602
|
+
* @param {String} languageCode Language Code
|
|
44603
|
+
* @param {Object} body Request body containing topics to be ignored
|
|
44604
|
+
*/
|
|
44605
|
+
postLanguageunderstandingIgnoretopic(languageCode, body) {
|
|
44606
|
+
// verify the required parameter 'languageCode' is set
|
|
44607
|
+
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
44608
|
+
throw 'Missing the required parameter "languageCode" when calling postLanguageunderstandingIgnoretopic';
|
|
44609
|
+
}
|
|
44610
|
+
// verify the required parameter 'body' is set
|
|
44611
|
+
if (body === undefined || body === null) {
|
|
44612
|
+
throw 'Missing the required parameter "body" when calling postLanguageunderstandingIgnoretopic';
|
|
44613
|
+
}
|
|
44614
|
+
|
|
44615
|
+
return this.apiClient.callApi(
|
|
44616
|
+
'/api/v2/languageunderstanding/ignoretopics/{languageCode}',
|
|
44617
|
+
'POST',
|
|
44618
|
+
{ 'languageCode': languageCode },
|
|
44619
|
+
{ },
|
|
44620
|
+
{ },
|
|
44621
|
+
{ },
|
|
44622
|
+
body,
|
|
44623
|
+
['PureCloud OAuth'],
|
|
44624
|
+
['application/json'],
|
|
44625
|
+
['application/json']
|
|
44626
|
+
);
|
|
44627
|
+
}
|
|
44628
|
+
|
|
44629
|
+
/**
|
|
44630
|
+
* Delete ignored topics
|
|
44631
|
+
*
|
|
44632
|
+
* @param {String} languageCode Language Code
|
|
44633
|
+
* @param {Object} body Request body containing entities to be removed
|
|
44634
|
+
*/
|
|
44635
|
+
postLanguageunderstandingIgnoretopicRemove(languageCode, body) {
|
|
44636
|
+
// verify the required parameter 'languageCode' is set
|
|
44637
|
+
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
44638
|
+
throw 'Missing the required parameter "languageCode" when calling postLanguageunderstandingIgnoretopicRemove';
|
|
44639
|
+
}
|
|
44640
|
+
// verify the required parameter 'body' is set
|
|
44641
|
+
if (body === undefined || body === null) {
|
|
44642
|
+
throw 'Missing the required parameter "body" when calling postLanguageunderstandingIgnoretopicRemove';
|
|
44643
|
+
}
|
|
44644
|
+
|
|
44645
|
+
return this.apiClient.callApi(
|
|
44646
|
+
'/api/v2/languageunderstanding/ignoretopics/{languageCode}/remove',
|
|
44647
|
+
'POST',
|
|
44648
|
+
{ 'languageCode': languageCode },
|
|
44649
|
+
{ },
|
|
44650
|
+
{ },
|
|
44651
|
+
{ },
|
|
44652
|
+
body,
|
|
44653
|
+
['PureCloud OAuth'],
|
|
44654
|
+
['application/json'],
|
|
44655
|
+
['application/json']
|
|
44656
|
+
);
|
|
44657
|
+
}
|
|
44658
|
+
|
|
44138
44659
|
/**
|
|
44139
44660
|
* Create a new draft resource.
|
|
44140
44661
|
*
|
|
@@ -44260,7 +44781,7 @@ class LanguagesApi {
|
|
|
44260
44781
|
/**
|
|
44261
44782
|
* Languages service.
|
|
44262
44783
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
44263
|
-
* @version
|
|
44784
|
+
* @version 231.0.0
|
|
44264
44785
|
*/
|
|
44265
44786
|
|
|
44266
44787
|
/**
|
|
@@ -44482,7 +45003,7 @@ class LearningApi {
|
|
|
44482
45003
|
/**
|
|
44483
45004
|
* Learning service.
|
|
44484
45005
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
44485
|
-
* @version
|
|
45006
|
+
* @version 231.0.0
|
|
44486
45007
|
*/
|
|
44487
45008
|
|
|
44488
45009
|
/**
|
|
@@ -45511,7 +46032,7 @@ class LicenseApi {
|
|
|
45511
46032
|
/**
|
|
45512
46033
|
* License service.
|
|
45513
46034
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
45514
|
-
* @version
|
|
46035
|
+
* @version 231.0.0
|
|
45515
46036
|
*/
|
|
45516
46037
|
|
|
45517
46038
|
/**
|
|
@@ -45749,7 +46270,7 @@ class LocationsApi {
|
|
|
45749
46270
|
/**
|
|
45750
46271
|
* Locations service.
|
|
45751
46272
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
45752
|
-
* @version
|
|
46273
|
+
* @version 231.0.0
|
|
45753
46274
|
*/
|
|
45754
46275
|
|
|
45755
46276
|
/**
|
|
@@ -45985,7 +46506,7 @@ class LogCaptureApi {
|
|
|
45985
46506
|
/**
|
|
45986
46507
|
* LogCapture service.
|
|
45987
46508
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
45988
|
-
* @version
|
|
46509
|
+
* @version 231.0.0
|
|
45989
46510
|
*/
|
|
45990
46511
|
|
|
45991
46512
|
/**
|
|
@@ -46184,7 +46705,7 @@ class MessagingApi {
|
|
|
46184
46705
|
/**
|
|
46185
46706
|
* Messaging service.
|
|
46186
46707
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
46187
|
-
* @version
|
|
46708
|
+
* @version 231.0.0
|
|
46188
46709
|
*/
|
|
46189
46710
|
|
|
46190
46711
|
/**
|
|
@@ -46543,7 +47064,7 @@ class MobileDevicesApi {
|
|
|
46543
47064
|
/**
|
|
46544
47065
|
* MobileDevices service.
|
|
46545
47066
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
46546
|
-
* @version
|
|
47067
|
+
* @version 231.0.0
|
|
46547
47068
|
*/
|
|
46548
47069
|
|
|
46549
47070
|
/**
|
|
@@ -46694,7 +47215,7 @@ class NotificationsApi {
|
|
|
46694
47215
|
/**
|
|
46695
47216
|
* Notifications service.
|
|
46696
47217
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
46697
|
-
* @version
|
|
47218
|
+
* @version 231.0.0
|
|
46698
47219
|
*/
|
|
46699
47220
|
|
|
46700
47221
|
/**
|
|
@@ -46927,7 +47448,7 @@ class OAuthApi {
|
|
|
46927
47448
|
/**
|
|
46928
47449
|
* OAuth service.
|
|
46929
47450
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
46930
|
-
* @version
|
|
47451
|
+
* @version 231.0.0
|
|
46931
47452
|
*/
|
|
46932
47453
|
|
|
46933
47454
|
/**
|
|
@@ -47293,7 +47814,7 @@ class ObjectsApi {
|
|
|
47293
47814
|
/**
|
|
47294
47815
|
* Objects service.
|
|
47295
47816
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
47296
|
-
* @version
|
|
47817
|
+
* @version 231.0.0
|
|
47297
47818
|
*/
|
|
47298
47819
|
|
|
47299
47820
|
/**
|
|
@@ -47617,7 +48138,7 @@ class OperationalEventsApi {
|
|
|
47617
48138
|
/**
|
|
47618
48139
|
* OperationalEvents service.
|
|
47619
48140
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
47620
|
-
* @version
|
|
48141
|
+
* @version 231.0.0
|
|
47621
48142
|
*/
|
|
47622
48143
|
|
|
47623
48144
|
/**
|
|
@@ -47734,7 +48255,7 @@ class OrganizationApi {
|
|
|
47734
48255
|
/**
|
|
47735
48256
|
* Organization service.
|
|
47736
48257
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
47737
|
-
* @version
|
|
48258
|
+
* @version 231.0.0
|
|
47738
48259
|
*/
|
|
47739
48260
|
|
|
47740
48261
|
/**
|
|
@@ -48209,7 +48730,7 @@ class OrganizationAuthorizationApi {
|
|
|
48209
48730
|
/**
|
|
48210
48731
|
* OrganizationAuthorization service.
|
|
48211
48732
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
48212
|
-
* @version
|
|
48733
|
+
* @version 231.0.0
|
|
48213
48734
|
*/
|
|
48214
48735
|
|
|
48215
48736
|
/**
|
|
@@ -49603,7 +50124,7 @@ class OutboundApi {
|
|
|
49603
50124
|
/**
|
|
49604
50125
|
* Outbound service.
|
|
49605
50126
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
49606
|
-
* @version
|
|
50127
|
+
* @version 231.0.0
|
|
49607
50128
|
*/
|
|
49608
50129
|
|
|
49609
50130
|
/**
|
|
@@ -54325,7 +54846,7 @@ class PresenceApi {
|
|
|
54325
54846
|
/**
|
|
54326
54847
|
* Presence service.
|
|
54327
54848
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
54328
|
-
* @version
|
|
54849
|
+
* @version 231.0.0
|
|
54329
54850
|
*/
|
|
54330
54851
|
|
|
54331
54852
|
/**
|
|
@@ -55069,7 +55590,7 @@ class ProcessAutomationApi {
|
|
|
55069
55590
|
/**
|
|
55070
55591
|
* ProcessAutomation service.
|
|
55071
55592
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
55072
|
-
* @version
|
|
55593
|
+
* @version 231.0.0
|
|
55073
55594
|
*/
|
|
55074
55595
|
|
|
55075
55596
|
/**
|
|
@@ -55308,7 +55829,7 @@ class QualityApi {
|
|
|
55308
55829
|
/**
|
|
55309
55830
|
* Quality service.
|
|
55310
55831
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
55311
|
-
* @version
|
|
55832
|
+
* @version 231.0.0
|
|
55312
55833
|
*/
|
|
55313
55834
|
|
|
55314
55835
|
/**
|
|
@@ -56372,6 +56893,59 @@ class QualityApi {
|
|
|
56372
56893
|
);
|
|
56373
56894
|
}
|
|
56374
56895
|
|
|
56896
|
+
/**
|
|
56897
|
+
* Get the most recent published version of an evaluation form across any division.
|
|
56898
|
+
*
|
|
56899
|
+
* @param {String} evaluationFormId Evaluation Form ID
|
|
56900
|
+
* getQualityPublishedformsEvaluationsDivisionview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56901
|
+
*/
|
|
56902
|
+
getQualityPublishedformsEvaluationsDivisionview(evaluationFormId) {
|
|
56903
|
+
// verify the required parameter 'evaluationFormId' is set
|
|
56904
|
+
if (evaluationFormId === undefined || evaluationFormId === null || evaluationFormId === '') {
|
|
56905
|
+
throw 'Missing the required parameter "evaluationFormId" when calling getQualityPublishedformsEvaluationsDivisionview';
|
|
56906
|
+
}
|
|
56907
|
+
|
|
56908
|
+
return this.apiClient.callApi(
|
|
56909
|
+
'/api/v2/quality/publishedforms/evaluations/divisionviews/{evaluationFormId}',
|
|
56910
|
+
'GET',
|
|
56911
|
+
{ 'evaluationFormId': evaluationFormId },
|
|
56912
|
+
{ },
|
|
56913
|
+
{ },
|
|
56914
|
+
{ },
|
|
56915
|
+
null,
|
|
56916
|
+
['PureCloud OAuth'],
|
|
56917
|
+
['application/json'],
|
|
56918
|
+
['application/json']
|
|
56919
|
+
);
|
|
56920
|
+
}
|
|
56921
|
+
|
|
56922
|
+
/**
|
|
56923
|
+
* Get the published evaluation forms across any division.
|
|
56924
|
+
*
|
|
56925
|
+
* @param {Object} opts Optional parameters
|
|
56926
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
56927
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
56928
|
+
* @param {String} opts.name Name
|
|
56929
|
+
* getQualityPublishedformsEvaluationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56930
|
+
*/
|
|
56931
|
+
getQualityPublishedformsEvaluationsDivisionviews(opts) {
|
|
56932
|
+
opts = opts || {};
|
|
56933
|
+
|
|
56934
|
+
|
|
56935
|
+
return this.apiClient.callApi(
|
|
56936
|
+
'/api/v2/quality/publishedforms/evaluations/divisionviews',
|
|
56937
|
+
'GET',
|
|
56938
|
+
{ },
|
|
56939
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'] },
|
|
56940
|
+
{ },
|
|
56941
|
+
{ },
|
|
56942
|
+
null,
|
|
56943
|
+
['PureCloud OAuth'],
|
|
56944
|
+
['application/json'],
|
|
56945
|
+
['application/json']
|
|
56946
|
+
);
|
|
56947
|
+
}
|
|
56948
|
+
|
|
56375
56949
|
/**
|
|
56376
56950
|
* Get the most recent published version of a survey form.
|
|
56377
56951
|
*
|
|
@@ -56424,6 +56998,59 @@ class QualityApi {
|
|
|
56424
56998
|
);
|
|
56425
56999
|
}
|
|
56426
57000
|
|
|
57001
|
+
/**
|
|
57002
|
+
* Get the most recent published version of an enabled survey form across any division.
|
|
57003
|
+
*
|
|
57004
|
+
* @param {String} surveyFormId Survey Form ID
|
|
57005
|
+
* getQualityPublishedformsSurveysDivisionview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57006
|
+
*/
|
|
57007
|
+
getQualityPublishedformsSurveysDivisionview(surveyFormId) {
|
|
57008
|
+
// verify the required parameter 'surveyFormId' is set
|
|
57009
|
+
if (surveyFormId === undefined || surveyFormId === null || surveyFormId === '') {
|
|
57010
|
+
throw 'Missing the required parameter "surveyFormId" when calling getQualityPublishedformsSurveysDivisionview';
|
|
57011
|
+
}
|
|
57012
|
+
|
|
57013
|
+
return this.apiClient.callApi(
|
|
57014
|
+
'/api/v2/quality/publishedforms/surveys/divisionviews/{surveyFormId}',
|
|
57015
|
+
'GET',
|
|
57016
|
+
{ 'surveyFormId': surveyFormId },
|
|
57017
|
+
{ },
|
|
57018
|
+
{ },
|
|
57019
|
+
{ },
|
|
57020
|
+
null,
|
|
57021
|
+
['PureCloud OAuth'],
|
|
57022
|
+
['application/json'],
|
|
57023
|
+
['application/json']
|
|
57024
|
+
);
|
|
57025
|
+
}
|
|
57026
|
+
|
|
57027
|
+
/**
|
|
57028
|
+
* Get the published and enabled survey forms across any division.
|
|
57029
|
+
*
|
|
57030
|
+
* @param {Object} opts Optional parameters
|
|
57031
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
57032
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
57033
|
+
* @param {String} opts.name Name
|
|
57034
|
+
* getQualityPublishedformsSurveysDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57035
|
+
*/
|
|
57036
|
+
getQualityPublishedformsSurveysDivisionviews(opts) {
|
|
57037
|
+
opts = opts || {};
|
|
57038
|
+
|
|
57039
|
+
|
|
57040
|
+
return this.apiClient.callApi(
|
|
57041
|
+
'/api/v2/quality/publishedforms/surveys/divisionviews',
|
|
57042
|
+
'GET',
|
|
57043
|
+
{ },
|
|
57044
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'] },
|
|
57045
|
+
{ },
|
|
57046
|
+
{ },
|
|
57047
|
+
null,
|
|
57048
|
+
['PureCloud OAuth'],
|
|
57049
|
+
['application/json'],
|
|
57050
|
+
['application/json']
|
|
57051
|
+
);
|
|
57052
|
+
}
|
|
57053
|
+
|
|
56427
57054
|
/**
|
|
56428
57055
|
* Get a survey for a conversation
|
|
56429
57056
|
*
|
|
@@ -57147,7 +57774,7 @@ class RecordingApi {
|
|
|
57147
57774
|
/**
|
|
57148
57775
|
* Recording service.
|
|
57149
57776
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
57150
|
-
* @version
|
|
57777
|
+
* @version 231.0.0
|
|
57151
57778
|
*/
|
|
57152
57779
|
|
|
57153
57780
|
/**
|
|
@@ -58583,7 +59210,7 @@ class RecordingApi {
|
|
|
58583
59210
|
|
|
58584
59211
|
/**
|
|
58585
59212
|
* Execute the recording bulk job.
|
|
58586
|
-
* A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recordings retention.
|
|
59213
|
+
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recordings retention.
|
|
58587
59214
|
* @param {String} jobId jobId
|
|
58588
59215
|
* @param {Object} body query
|
|
58589
59216
|
*/
|
|
@@ -58643,7 +59270,7 @@ class RecordingApi {
|
|
|
58643
59270
|
|
|
58644
59271
|
/**
|
|
58645
59272
|
* Update a media retention policy
|
|
58646
|
-
* Policy does not work retroactively
|
|
59273
|
+
* Policy does not work retroactively. In the conditions.forUsers section, each user object can include the id field containing the users unique identifier. Example: [{"id":"<userId>"}].
|
|
58647
59274
|
* @param {String} policyId Policy ID
|
|
58648
59275
|
* @param {Object} body Policy
|
|
58649
59276
|
*/
|
|
@@ -58752,7 +59379,7 @@ class ResponseManagementApi {
|
|
|
58752
59379
|
/**
|
|
58753
59380
|
* ResponseManagement service.
|
|
58754
59381
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
58755
|
-
* @version
|
|
59382
|
+
* @version 231.0.0
|
|
58756
59383
|
*/
|
|
58757
59384
|
|
|
58758
59385
|
/**
|
|
@@ -59262,7 +59889,7 @@ class RoutingApi {
|
|
|
59262
59889
|
/**
|
|
59263
59890
|
* Routing service.
|
|
59264
59891
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
59265
|
-
* @version
|
|
59892
|
+
* @version 231.0.0
|
|
59266
59893
|
*/
|
|
59267
59894
|
|
|
59268
59895
|
/**
|
|
@@ -60052,8 +60679,12 @@ class RoutingApi {
|
|
|
60052
60679
|
* Get domain
|
|
60053
60680
|
*
|
|
60054
60681
|
* @param {String} domainId domain ID
|
|
60682
|
+
* @param {Object} opts Optional parameters
|
|
60683
|
+
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
60055
60684
|
*/
|
|
60056
|
-
getRoutingEmailDomain(domainId) {
|
|
60685
|
+
getRoutingEmailDomain(domainId, opts) {
|
|
60686
|
+
opts = opts || {};
|
|
60687
|
+
|
|
60057
60688
|
// verify the required parameter 'domainId' is set
|
|
60058
60689
|
if (domainId === undefined || domainId === null || domainId === '') {
|
|
60059
60690
|
throw 'Missing the required parameter "domainId" when calling getRoutingEmailDomain';
|
|
@@ -60063,7 +60694,7 @@ class RoutingApi {
|
|
|
60063
60694
|
'/api/v2/routing/email/domains/{domainId}',
|
|
60064
60695
|
'GET',
|
|
60065
60696
|
{ 'domainId': domainId },
|
|
60066
|
-
{
|
|
60697
|
+
{ 'expand': opts['expand'] },
|
|
60067
60698
|
{ },
|
|
60068
60699
|
{ },
|
|
60069
60700
|
null,
|
|
@@ -60177,6 +60808,7 @@ class RoutingApi {
|
|
|
60177
60808
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
60178
60809
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
60179
60810
|
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
60811
|
+
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
60180
60812
|
*/
|
|
60181
60813
|
getRoutingEmailDomains(opts) {
|
|
60182
60814
|
opts = opts || {};
|
|
@@ -60186,7 +60818,7 @@ class RoutingApi {
|
|
|
60186
60818
|
'/api/v2/routing/email/domains',
|
|
60187
60819
|
'GET',
|
|
60188
60820
|
{ },
|
|
60189
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'],'filter': opts['filter'] },
|
|
60821
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'],'filter': opts['filter'],'expand': opts['expand'] },
|
|
60190
60822
|
{ },
|
|
60191
60823
|
{ },
|
|
60192
60824
|
null,
|
|
@@ -60200,8 +60832,12 @@ class RoutingApi {
|
|
|
60200
60832
|
* Get domain
|
|
60201
60833
|
*
|
|
60202
60834
|
* @param {String} domainId domain ID
|
|
60835
|
+
* @param {Object} opts Optional parameters
|
|
60836
|
+
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
60203
60837
|
*/
|
|
60204
|
-
getRoutingEmailOutboundDomain(domainId) {
|
|
60838
|
+
getRoutingEmailOutboundDomain(domainId, opts) {
|
|
60839
|
+
opts = opts || {};
|
|
60840
|
+
|
|
60205
60841
|
// verify the required parameter 'domainId' is set
|
|
60206
60842
|
if (domainId === undefined || domainId === null || domainId === '') {
|
|
60207
60843
|
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomain';
|
|
@@ -60211,7 +60847,7 @@ class RoutingApi {
|
|
|
60211
60847
|
'/api/v2/routing/email/outbound/domains/{domainId}',
|
|
60212
60848
|
'GET',
|
|
60213
60849
|
{ 'domainId': domainId },
|
|
60214
|
-
{
|
|
60850
|
+
{ 'expand': opts['expand'] },
|
|
60215
60851
|
{ },
|
|
60216
60852
|
{ },
|
|
60217
60853
|
null,
|
|
@@ -60253,6 +60889,7 @@ class RoutingApi {
|
|
|
60253
60889
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
60254
60890
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
60255
60891
|
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
60892
|
+
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
60256
60893
|
*/
|
|
60257
60894
|
getRoutingEmailOutboundDomains(opts) {
|
|
60258
60895
|
opts = opts || {};
|
|
@@ -60262,7 +60899,7 @@ class RoutingApi {
|
|
|
60262
60899
|
'/api/v2/routing/email/outbound/domains',
|
|
60263
60900
|
'GET',
|
|
60264
60901
|
{ },
|
|
60265
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'filter': opts['filter'] },
|
|
60902
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'filter': opts['filter'],'expand': opts['expand'] },
|
|
60266
60903
|
{ },
|
|
60267
60904
|
{ },
|
|
60268
60905
|
null,
|
|
@@ -63578,7 +64215,7 @@ class SCIMApi {
|
|
|
63578
64215
|
/**
|
|
63579
64216
|
* SCIM service.
|
|
63580
64217
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
63581
|
-
* @version
|
|
64218
|
+
* @version 231.0.0
|
|
63582
64219
|
*/
|
|
63583
64220
|
|
|
63584
64221
|
/**
|
|
@@ -64455,7 +65092,7 @@ class ScreenRecordingApi {
|
|
|
64455
65092
|
/**
|
|
64456
65093
|
* ScreenRecording service.
|
|
64457
65094
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
64458
|
-
* @version
|
|
65095
|
+
* @version 231.0.0
|
|
64459
65096
|
*/
|
|
64460
65097
|
|
|
64461
65098
|
/**
|
|
@@ -64500,7 +65137,7 @@ class ScriptsApi {
|
|
|
64500
65137
|
/**
|
|
64501
65138
|
* Scripts service.
|
|
64502
65139
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
64503
|
-
* @version
|
|
65140
|
+
* @version 231.0.0
|
|
64504
65141
|
*/
|
|
64505
65142
|
|
|
64506
65143
|
/**
|
|
@@ -64976,7 +65613,7 @@ class SearchApi {
|
|
|
64976
65613
|
/**
|
|
64977
65614
|
* Search service.
|
|
64978
65615
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
64979
|
-
* @version
|
|
65616
|
+
* @version 231.0.0
|
|
64980
65617
|
*/
|
|
64981
65618
|
|
|
64982
65619
|
/**
|
|
@@ -65694,7 +66331,7 @@ class SettingsApi {
|
|
|
65694
66331
|
/**
|
|
65695
66332
|
* Settings service.
|
|
65696
66333
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
65697
|
-
* @version
|
|
66334
|
+
* @version 231.0.0
|
|
65698
66335
|
*/
|
|
65699
66336
|
|
|
65700
66337
|
/**
|
|
@@ -66042,7 +66679,7 @@ class SocialMediaApi {
|
|
|
66042
66679
|
/**
|
|
66043
66680
|
* SocialMedia service.
|
|
66044
66681
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
66045
|
-
* @version
|
|
66682
|
+
* @version 231.0.0
|
|
66046
66683
|
*/
|
|
66047
66684
|
|
|
66048
66685
|
/**
|
|
@@ -66171,6 +66808,40 @@ class SocialMediaApi {
|
|
|
66171
66808
|
);
|
|
66172
66809
|
}
|
|
66173
66810
|
|
|
66811
|
+
/**
|
|
66812
|
+
* Delete a Instagram data ingestion rule.
|
|
66813
|
+
*
|
|
66814
|
+
* @param {String} topicId topicId
|
|
66815
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
66816
|
+
* @param {Object} opts Optional parameters
|
|
66817
|
+
* @param {Boolean} opts.hardDelete Determines whether a Instagram data ingestion rule should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. (default to false)
|
|
66818
|
+
*/
|
|
66819
|
+
deleteSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId(topicId, instagramIngestionRuleId, opts) {
|
|
66820
|
+
opts = opts || {};
|
|
66821
|
+
|
|
66822
|
+
// verify the required parameter 'topicId' is set
|
|
66823
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
66824
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
66825
|
+
}
|
|
66826
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
66827
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
66828
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
66829
|
+
}
|
|
66830
|
+
|
|
66831
|
+
return this.apiClient.callApi(
|
|
66832
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}',
|
|
66833
|
+
'DELETE',
|
|
66834
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
66835
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
66836
|
+
{ },
|
|
66837
|
+
{ },
|
|
66838
|
+
null,
|
|
66839
|
+
['PureCloud OAuth'],
|
|
66840
|
+
['application/json'],
|
|
66841
|
+
['application/json']
|
|
66842
|
+
);
|
|
66843
|
+
}
|
|
66844
|
+
|
|
66174
66845
|
/**
|
|
66175
66846
|
* Delete a open data ingestion rule.
|
|
66176
66847
|
*
|
|
@@ -66571,6 +67242,115 @@ class SocialMediaApi {
|
|
|
66571
67242
|
);
|
|
66572
67243
|
}
|
|
66573
67244
|
|
|
67245
|
+
/**
|
|
67246
|
+
* Get a single Instagram data ingestion rule.
|
|
67247
|
+
*
|
|
67248
|
+
* @param {String} topicId topicId
|
|
67249
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
67250
|
+
* @param {Object} opts Optional parameters
|
|
67251
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
67252
|
+
*/
|
|
67253
|
+
getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId(topicId, instagramIngestionRuleId, opts) {
|
|
67254
|
+
opts = opts || {};
|
|
67255
|
+
|
|
67256
|
+
// verify the required parameter 'topicId' is set
|
|
67257
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
67258
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
67259
|
+
}
|
|
67260
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
67261
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
67262
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
67263
|
+
}
|
|
67264
|
+
|
|
67265
|
+
return this.apiClient.callApi(
|
|
67266
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}',
|
|
67267
|
+
'GET',
|
|
67268
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
67269
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
67270
|
+
{ },
|
|
67271
|
+
{ },
|
|
67272
|
+
null,
|
|
67273
|
+
['PureCloud OAuth'],
|
|
67274
|
+
['application/json'],
|
|
67275
|
+
['application/json']
|
|
67276
|
+
);
|
|
67277
|
+
}
|
|
67278
|
+
|
|
67279
|
+
/**
|
|
67280
|
+
* Get a single Instagram data ingestion rule version.
|
|
67281
|
+
*
|
|
67282
|
+
* @param {String} topicId topicId
|
|
67283
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
67284
|
+
* @param {String} dataIngestionRuleVersion version
|
|
67285
|
+
* @param {Object} opts Optional parameters
|
|
67286
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
67287
|
+
*/
|
|
67288
|
+
getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion(topicId, instagramIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
67289
|
+
opts = opts || {};
|
|
67290
|
+
|
|
67291
|
+
// verify the required parameter 'topicId' is set
|
|
67292
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
67293
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion';
|
|
67294
|
+
}
|
|
67295
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
67296
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
67297
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion';
|
|
67298
|
+
}
|
|
67299
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
67300
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null || dataIngestionRuleVersion === '') {
|
|
67301
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion';
|
|
67302
|
+
}
|
|
67303
|
+
|
|
67304
|
+
return this.apiClient.callApi(
|
|
67305
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}/versions/{dataIngestionRuleVersion}',
|
|
67306
|
+
'GET',
|
|
67307
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
67308
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
67309
|
+
{ },
|
|
67310
|
+
{ },
|
|
67311
|
+
null,
|
|
67312
|
+
['PureCloud OAuth'],
|
|
67313
|
+
['application/json'],
|
|
67314
|
+
['application/json']
|
|
67315
|
+
);
|
|
67316
|
+
}
|
|
67317
|
+
|
|
67318
|
+
/**
|
|
67319
|
+
* Get the Instagram data ingestion rule versions.
|
|
67320
|
+
*
|
|
67321
|
+
* @param {String} topicId topicId
|
|
67322
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
67323
|
+
* @param {Object} opts Optional parameters
|
|
67324
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
67325
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
67326
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
67327
|
+
*/
|
|
67328
|
+
getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersions(topicId, instagramIngestionRuleId, opts) {
|
|
67329
|
+
opts = opts || {};
|
|
67330
|
+
|
|
67331
|
+
// verify the required parameter 'topicId' is set
|
|
67332
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
67333
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersions';
|
|
67334
|
+
}
|
|
67335
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
67336
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
67337
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersions';
|
|
67338
|
+
}
|
|
67339
|
+
|
|
67340
|
+
return this.apiClient.callApi(
|
|
67341
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}/versions',
|
|
67342
|
+
'GET',
|
|
67343
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
67344
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
67345
|
+
{ },
|
|
67346
|
+
{ },
|
|
67347
|
+
null,
|
|
67348
|
+
['PureCloud OAuth'],
|
|
67349
|
+
['application/json'],
|
|
67350
|
+
['application/json']
|
|
67351
|
+
);
|
|
67352
|
+
}
|
|
67353
|
+
|
|
66574
67354
|
/**
|
|
66575
67355
|
* Get a single open data ingestion rule.
|
|
66576
67356
|
*
|
|
@@ -66879,6 +67659,40 @@ class SocialMediaApi {
|
|
|
66879
67659
|
);
|
|
66880
67660
|
}
|
|
66881
67661
|
|
|
67662
|
+
/**
|
|
67663
|
+
* Update the status of a Instagram data ingestion rule.
|
|
67664
|
+
*
|
|
67665
|
+
* @param {String} topicId topicId
|
|
67666
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
67667
|
+
* @param {Object} opts Optional parameters
|
|
67668
|
+
* @param {Object} opts.body
|
|
67669
|
+
*/
|
|
67670
|
+
patchSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId(topicId, instagramIngestionRuleId, opts) {
|
|
67671
|
+
opts = opts || {};
|
|
67672
|
+
|
|
67673
|
+
// verify the required parameter 'topicId' is set
|
|
67674
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
67675
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
67676
|
+
}
|
|
67677
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
67678
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
67679
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
67680
|
+
}
|
|
67681
|
+
|
|
67682
|
+
return this.apiClient.callApi(
|
|
67683
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}',
|
|
67684
|
+
'PATCH',
|
|
67685
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
67686
|
+
{ },
|
|
67687
|
+
{ },
|
|
67688
|
+
{ },
|
|
67689
|
+
opts['body'],
|
|
67690
|
+
['PureCloud OAuth'],
|
|
67691
|
+
['application/json'],
|
|
67692
|
+
['application/json']
|
|
67693
|
+
);
|
|
67694
|
+
}
|
|
67695
|
+
|
|
66882
67696
|
/**
|
|
66883
67697
|
* Update the status of a open data ingestion rule.
|
|
66884
67698
|
*
|
|
@@ -67079,6 +67893,35 @@ class SocialMediaApi {
|
|
|
67079
67893
|
);
|
|
67080
67894
|
}
|
|
67081
67895
|
|
|
67896
|
+
/**
|
|
67897
|
+
* Create an Instagram data ingestion rule.
|
|
67898
|
+
*
|
|
67899
|
+
* @param {String} topicId topicId
|
|
67900
|
+
* @param {Object} opts Optional parameters
|
|
67901
|
+
* @param {Object} opts.body
|
|
67902
|
+
*/
|
|
67903
|
+
postSocialmediaTopicDataingestionrulesInstagram(topicId, opts) {
|
|
67904
|
+
opts = opts || {};
|
|
67905
|
+
|
|
67906
|
+
// verify the required parameter 'topicId' is set
|
|
67907
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
67908
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesInstagram';
|
|
67909
|
+
}
|
|
67910
|
+
|
|
67911
|
+
return this.apiClient.callApi(
|
|
67912
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram',
|
|
67913
|
+
'POST',
|
|
67914
|
+
{ 'topicId': topicId },
|
|
67915
|
+
{ },
|
|
67916
|
+
{ },
|
|
67917
|
+
{ },
|
|
67918
|
+
opts['body'],
|
|
67919
|
+
['PureCloud OAuth'],
|
|
67920
|
+
['application/json'],
|
|
67921
|
+
['application/json']
|
|
67922
|
+
);
|
|
67923
|
+
}
|
|
67924
|
+
|
|
67082
67925
|
/**
|
|
67083
67926
|
* Create an open data ingestion rule.
|
|
67084
67927
|
*
|
|
@@ -67319,6 +68162,40 @@ class SocialMediaApi {
|
|
|
67319
68162
|
);
|
|
67320
68163
|
}
|
|
67321
68164
|
|
|
68165
|
+
/**
|
|
68166
|
+
* Update the Instagram data ingestion rule.
|
|
68167
|
+
*
|
|
68168
|
+
* @param {String} topicId topicId
|
|
68169
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
68170
|
+
* @param {Object} opts Optional parameters
|
|
68171
|
+
* @param {Object} opts.body
|
|
68172
|
+
*/
|
|
68173
|
+
putSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId(topicId, instagramIngestionRuleId, opts) {
|
|
68174
|
+
opts = opts || {};
|
|
68175
|
+
|
|
68176
|
+
// verify the required parameter 'topicId' is set
|
|
68177
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
68178
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
68179
|
+
}
|
|
68180
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
68181
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
68182
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
68183
|
+
}
|
|
68184
|
+
|
|
68185
|
+
return this.apiClient.callApi(
|
|
68186
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}',
|
|
68187
|
+
'PUT',
|
|
68188
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
68189
|
+
{ },
|
|
68190
|
+
{ },
|
|
68191
|
+
{ },
|
|
68192
|
+
opts['body'],
|
|
68193
|
+
['PureCloud OAuth'],
|
|
68194
|
+
['application/json'],
|
|
68195
|
+
['application/json']
|
|
68196
|
+
);
|
|
68197
|
+
}
|
|
68198
|
+
|
|
67322
68199
|
/**
|
|
67323
68200
|
* Update the open data ingestion rule.
|
|
67324
68201
|
*
|
|
@@ -67393,7 +68270,7 @@ class SpeechTextAnalyticsApi {
|
|
|
67393
68270
|
/**
|
|
67394
68271
|
* SpeechTextAnalytics service.
|
|
67395
68272
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
67396
|
-
* @version
|
|
68273
|
+
* @version 231.0.0
|
|
67397
68274
|
*/
|
|
67398
68275
|
|
|
67399
68276
|
/**
|
|
@@ -69039,7 +69916,7 @@ class StationsApi {
|
|
|
69039
69916
|
/**
|
|
69040
69917
|
* Stations service.
|
|
69041
69918
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
69042
|
-
* @version
|
|
69919
|
+
* @version 231.0.0
|
|
69043
69920
|
*/
|
|
69044
69921
|
|
|
69045
69922
|
/**
|
|
@@ -69141,7 +70018,7 @@ class SuggestApi {
|
|
|
69141
70018
|
/**
|
|
69142
70019
|
* Suggest service.
|
|
69143
70020
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
69144
|
-
* @version
|
|
70021
|
+
* @version 231.0.0
|
|
69145
70022
|
*/
|
|
69146
70023
|
|
|
69147
70024
|
/**
|
|
@@ -69280,7 +70157,7 @@ class TaskManagementApi {
|
|
|
69280
70157
|
/**
|
|
69281
70158
|
* TaskManagement service.
|
|
69282
70159
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
69283
|
-
* @version
|
|
70160
|
+
* @version 231.0.0
|
|
69284
70161
|
*/
|
|
69285
70162
|
|
|
69286
70163
|
/**
|
|
@@ -71442,7 +72319,7 @@ class TeamsApi {
|
|
|
71442
72319
|
/**
|
|
71443
72320
|
* Teams service.
|
|
71444
72321
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
71445
|
-
* @version
|
|
72322
|
+
* @version 231.0.0
|
|
71446
72323
|
*/
|
|
71447
72324
|
|
|
71448
72325
|
/**
|
|
@@ -71747,7 +72624,7 @@ class TelephonyApi {
|
|
|
71747
72624
|
/**
|
|
71748
72625
|
* Telephony service.
|
|
71749
72626
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
71750
|
-
* @version
|
|
72627
|
+
* @version 231.0.0
|
|
71751
72628
|
*/
|
|
71752
72629
|
|
|
71753
72630
|
/**
|
|
@@ -72033,7 +72910,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
72033
72910
|
/**
|
|
72034
72911
|
* TelephonyProvidersEdge service.
|
|
72035
72912
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
72036
|
-
* @version
|
|
72913
|
+
* @version 231.0.0
|
|
72037
72914
|
*/
|
|
72038
72915
|
|
|
72039
72916
|
/**
|
|
@@ -75526,7 +76403,7 @@ class TextbotsApi {
|
|
|
75526
76403
|
/**
|
|
75527
76404
|
* Textbots service.
|
|
75528
76405
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
75529
|
-
* @version
|
|
76406
|
+
* @version 231.0.0
|
|
75530
76407
|
*/
|
|
75531
76408
|
|
|
75532
76409
|
/**
|
|
@@ -75655,7 +76532,7 @@ class TokensApi {
|
|
|
75655
76532
|
/**
|
|
75656
76533
|
* Tokens service.
|
|
75657
76534
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
75658
|
-
* @version
|
|
76535
|
+
* @version 231.0.0
|
|
75659
76536
|
*/
|
|
75660
76537
|
|
|
75661
76538
|
/**
|
|
@@ -75809,7 +76686,7 @@ class UploadsApi {
|
|
|
75809
76686
|
/**
|
|
75810
76687
|
* Uploads service.
|
|
75811
76688
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
75812
|
-
* @version
|
|
76689
|
+
* @version 231.0.0
|
|
75813
76690
|
*/
|
|
75814
76691
|
|
|
75815
76692
|
/**
|
|
@@ -76100,7 +76977,7 @@ class UsageApi {
|
|
|
76100
76977
|
/**
|
|
76101
76978
|
* Usage service.
|
|
76102
76979
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
76103
|
-
* @version
|
|
76980
|
+
* @version 231.0.0
|
|
76104
76981
|
*/
|
|
76105
76982
|
|
|
76106
76983
|
/**
|
|
@@ -76435,7 +77312,7 @@ class UserRecordingsApi {
|
|
|
76435
77312
|
/**
|
|
76436
77313
|
* UserRecordings service.
|
|
76437
77314
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
76438
|
-
* @version
|
|
77315
|
+
* @version 231.0.0
|
|
76439
77316
|
*/
|
|
76440
77317
|
|
|
76441
77318
|
/**
|
|
@@ -76504,37 +77381,6 @@ class UserRecordingsApi {
|
|
|
76504
77381
|
);
|
|
76505
77382
|
}
|
|
76506
77383
|
|
|
76507
|
-
/**
|
|
76508
|
-
* Download a user recording.
|
|
76509
|
-
* API should migrate to use GET api/v2/userrecordings/{recordingId}/transcoding
|
|
76510
|
-
* @param {String} recordingId User Recording ID
|
|
76511
|
-
* @param {Object} opts Optional parameters
|
|
76512
|
-
* @param {Object} opts.formatId The desired media format. (default to WEBM)
|
|
76513
|
-
* @param {Boolean} opts.async When set to true, api will return 202 response until the recording is ready for download
|
|
76514
|
-
* @deprecated
|
|
76515
|
-
*/
|
|
76516
|
-
getUserrecordingMedia(recordingId, opts) {
|
|
76517
|
-
opts = opts || {};
|
|
76518
|
-
|
|
76519
|
-
// verify the required parameter 'recordingId' is set
|
|
76520
|
-
if (recordingId === undefined || recordingId === null || recordingId === '') {
|
|
76521
|
-
throw 'Missing the required parameter "recordingId" when calling getUserrecordingMedia';
|
|
76522
|
-
}
|
|
76523
|
-
|
|
76524
|
-
return this.apiClient.callApi(
|
|
76525
|
-
'/api/v2/userrecordings/{recordingId}/media',
|
|
76526
|
-
'GET',
|
|
76527
|
-
{ 'recordingId': recordingId },
|
|
76528
|
-
{ 'formatId': opts['formatId'],'async': opts['async'] },
|
|
76529
|
-
{ },
|
|
76530
|
-
{ },
|
|
76531
|
-
null,
|
|
76532
|
-
['PureCloud OAuth'],
|
|
76533
|
-
['application/json'],
|
|
76534
|
-
['application/json']
|
|
76535
|
-
);
|
|
76536
|
-
}
|
|
76537
|
-
|
|
76538
77384
|
/**
|
|
76539
77385
|
* Download a user recording.
|
|
76540
77386
|
*
|
|
@@ -76650,7 +77496,7 @@ class UsersApi {
|
|
|
76650
77496
|
/**
|
|
76651
77497
|
* Users service.
|
|
76652
77498
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
76653
|
-
* @version
|
|
77499
|
+
* @version 231.0.0
|
|
76654
77500
|
*/
|
|
76655
77501
|
|
|
76656
77502
|
/**
|
|
@@ -79659,7 +80505,7 @@ class UtilitiesApi {
|
|
|
79659
80505
|
/**
|
|
79660
80506
|
* Utilities service.
|
|
79661
80507
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
79662
|
-
* @version
|
|
80508
|
+
* @version 231.0.0
|
|
79663
80509
|
*/
|
|
79664
80510
|
|
|
79665
80511
|
/**
|
|
@@ -79770,7 +80616,7 @@ class VoicemailApi {
|
|
|
79770
80616
|
/**
|
|
79771
80617
|
* Voicemail service.
|
|
79772
80618
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
79773
|
-
* @version
|
|
80619
|
+
* @version 231.0.0
|
|
79774
80620
|
*/
|
|
79775
80621
|
|
|
79776
80622
|
/**
|
|
@@ -80492,7 +81338,7 @@ class WebChatApi {
|
|
|
80492
81338
|
/**
|
|
80493
81339
|
* WebChat service.
|
|
80494
81340
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
80495
|
-
* @version
|
|
81341
|
+
* @version 231.0.0
|
|
80496
81342
|
*/
|
|
80497
81343
|
|
|
80498
81344
|
/**
|
|
@@ -81052,7 +81898,7 @@ class WebDeploymentsApi {
|
|
|
81052
81898
|
/**
|
|
81053
81899
|
* WebDeployments service.
|
|
81054
81900
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
81055
|
-
* @version
|
|
81901
|
+
* @version 231.0.0
|
|
81056
81902
|
*/
|
|
81057
81903
|
|
|
81058
81904
|
/**
|
|
@@ -81634,7 +82480,7 @@ class WebMessagingApi {
|
|
|
81634
82480
|
/**
|
|
81635
82481
|
* WebMessaging service.
|
|
81636
82482
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
81637
|
-
* @version
|
|
82483
|
+
* @version 231.0.0
|
|
81638
82484
|
*/
|
|
81639
82485
|
|
|
81640
82486
|
/**
|
|
@@ -81780,7 +82626,7 @@ class WidgetsApi {
|
|
|
81780
82626
|
/**
|
|
81781
82627
|
* Widgets service.
|
|
81782
82628
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
81783
|
-
* @version
|
|
82629
|
+
* @version 231.0.0
|
|
81784
82630
|
*/
|
|
81785
82631
|
|
|
81786
82632
|
/**
|
|
@@ -81931,7 +82777,7 @@ class WorkforceManagementApi {
|
|
|
81931
82777
|
/**
|
|
81932
82778
|
* WorkforceManagement service.
|
|
81933
82779
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
81934
|
-
* @version
|
|
82780
|
+
* @version 231.0.0
|
|
81935
82781
|
*/
|
|
81936
82782
|
|
|
81937
82783
|
/**
|
|
@@ -89901,7 +90747,7 @@ class WorkforceManagementApi {
|
|
|
89901
90747
|
* </pre>
|
|
89902
90748
|
* </p>
|
|
89903
90749
|
* @module purecloud-platform-client-v2/index
|
|
89904
|
-
* @version
|
|
90750
|
+
* @version 231.0.0
|
|
89905
90751
|
*/
|
|
89906
90752
|
class platformClient {
|
|
89907
90753
|
constructor() {
|