purecloud-platform-client-v2 229.2.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 +1267 -152
- package/dist/web-amd/purecloud-platform-client-v2.js +1267 -152
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +442 -147
- package/dist/web-cjs/purecloud-platform-client-v2.js +442 -147
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1382 -550
- 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 +110 -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 +152 -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 +4 -4
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +19 -34
- 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 +101 -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
|
/**
|
|
@@ -3014,6 +3175,115 @@ class AgentAssistantsApi {
|
|
|
3014
3175
|
);
|
|
3015
3176
|
}
|
|
3016
3177
|
|
|
3178
|
+
/**
|
|
3179
|
+
* Bulk add users to assistant-queue (requires manual assignment mode).
|
|
3180
|
+
*
|
|
3181
|
+
* @param {String} assistantId Assistant ID
|
|
3182
|
+
* @param {String} queueId Queue ID
|
|
3183
|
+
* @param {Object} body
|
|
3184
|
+
*/
|
|
3185
|
+
postAssistantQueueUsersBulkAdd(assistantId, queueId, body) {
|
|
3186
|
+
// verify the required parameter 'assistantId' is set
|
|
3187
|
+
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
3188
|
+
throw 'Missing the required parameter "assistantId" when calling postAssistantQueueUsersBulkAdd';
|
|
3189
|
+
}
|
|
3190
|
+
// verify the required parameter 'queueId' is set
|
|
3191
|
+
if (queueId === undefined || queueId === null || queueId === '') {
|
|
3192
|
+
throw 'Missing the required parameter "queueId" when calling postAssistantQueueUsersBulkAdd';
|
|
3193
|
+
}
|
|
3194
|
+
// verify the required parameter 'body' is set
|
|
3195
|
+
if (body === undefined || body === null) {
|
|
3196
|
+
throw 'Missing the required parameter "body" when calling postAssistantQueueUsersBulkAdd';
|
|
3197
|
+
}
|
|
3198
|
+
|
|
3199
|
+
return this.apiClient.callApi(
|
|
3200
|
+
'/api/v2/assistants/{assistantId}/queues/{queueId}/users/bulk/add',
|
|
3201
|
+
'POST',
|
|
3202
|
+
{ 'assistantId': assistantId,'queueId': queueId },
|
|
3203
|
+
{ },
|
|
3204
|
+
{ },
|
|
3205
|
+
{ },
|
|
3206
|
+
body,
|
|
3207
|
+
['PureCloud OAuth'],
|
|
3208
|
+
['application/json'],
|
|
3209
|
+
['application/json']
|
|
3210
|
+
);
|
|
3211
|
+
}
|
|
3212
|
+
|
|
3213
|
+
/**
|
|
3214
|
+
* Bulk remove users from assistant-queue (requires manual assignment mode).
|
|
3215
|
+
*
|
|
3216
|
+
* @param {String} assistantId Assistant ID
|
|
3217
|
+
* @param {String} queueId Queue ID
|
|
3218
|
+
* @param {Object} body
|
|
3219
|
+
*/
|
|
3220
|
+
postAssistantQueueUsersBulkRemove(assistantId, queueId, body) {
|
|
3221
|
+
// verify the required parameter 'assistantId' is set
|
|
3222
|
+
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
3223
|
+
throw 'Missing the required parameter "assistantId" when calling postAssistantQueueUsersBulkRemove';
|
|
3224
|
+
}
|
|
3225
|
+
// verify the required parameter 'queueId' is set
|
|
3226
|
+
if (queueId === undefined || queueId === null || queueId === '') {
|
|
3227
|
+
throw 'Missing the required parameter "queueId" when calling postAssistantQueueUsersBulkRemove';
|
|
3228
|
+
}
|
|
3229
|
+
// verify the required parameter 'body' is set
|
|
3230
|
+
if (body === undefined || body === null) {
|
|
3231
|
+
throw 'Missing the required parameter "body" when calling postAssistantQueueUsersBulkRemove';
|
|
3232
|
+
}
|
|
3233
|
+
|
|
3234
|
+
return this.apiClient.callApi(
|
|
3235
|
+
'/api/v2/assistants/{assistantId}/queues/{queueId}/users/bulk/remove',
|
|
3236
|
+
'POST',
|
|
3237
|
+
{ 'assistantId': assistantId,'queueId': queueId },
|
|
3238
|
+
{ },
|
|
3239
|
+
{ },
|
|
3240
|
+
{ },
|
|
3241
|
+
body,
|
|
3242
|
+
['PureCloud OAuth'],
|
|
3243
|
+
['application/json'],
|
|
3244
|
+
['application/json']
|
|
3245
|
+
);
|
|
3246
|
+
}
|
|
3247
|
+
|
|
3248
|
+
/**
|
|
3249
|
+
* Query for users in the assistant-queue (requires manual assignment mode).
|
|
3250
|
+
*
|
|
3251
|
+
* @param {String} assistantId Assistant ID
|
|
3252
|
+
* @param {String} queueId Queue ID
|
|
3253
|
+
* @param {Object} body
|
|
3254
|
+
* @param {Object} opts Optional parameters
|
|
3255
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand with.
|
|
3256
|
+
*/
|
|
3257
|
+
postAssistantQueueUsersQuery(assistantId, queueId, body, opts) {
|
|
3258
|
+
opts = opts || {};
|
|
3259
|
+
|
|
3260
|
+
// verify the required parameter 'assistantId' is set
|
|
3261
|
+
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
3262
|
+
throw 'Missing the required parameter "assistantId" when calling postAssistantQueueUsersQuery';
|
|
3263
|
+
}
|
|
3264
|
+
// verify the required parameter 'queueId' is set
|
|
3265
|
+
if (queueId === undefined || queueId === null || queueId === '') {
|
|
3266
|
+
throw 'Missing the required parameter "queueId" when calling postAssistantQueueUsersQuery';
|
|
3267
|
+
}
|
|
3268
|
+
// verify the required parameter 'body' is set
|
|
3269
|
+
if (body === undefined || body === null) {
|
|
3270
|
+
throw 'Missing the required parameter "body" when calling postAssistantQueueUsersQuery';
|
|
3271
|
+
}
|
|
3272
|
+
|
|
3273
|
+
return this.apiClient.callApi(
|
|
3274
|
+
'/api/v2/assistants/{assistantId}/queues/{queueId}/users/query',
|
|
3275
|
+
'POST',
|
|
3276
|
+
{ 'assistantId': assistantId,'queueId': queueId },
|
|
3277
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3278
|
+
{ },
|
|
3279
|
+
{ },
|
|
3280
|
+
body,
|
|
3281
|
+
['PureCloud OAuth'],
|
|
3282
|
+
['application/json'],
|
|
3283
|
+
['application/json']
|
|
3284
|
+
);
|
|
3285
|
+
}
|
|
3286
|
+
|
|
3017
3287
|
/**
|
|
3018
3288
|
* Create an Assistant.
|
|
3019
3289
|
*
|
|
@@ -3080,7 +3350,7 @@ class AgentCopilotApi {
|
|
|
3080
3350
|
/**
|
|
3081
3351
|
* AgentCopilot service.
|
|
3082
3352
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3083
|
-
* @version
|
|
3353
|
+
* @version 231.0.0
|
|
3084
3354
|
*/
|
|
3085
3355
|
|
|
3086
3356
|
/**
|
|
@@ -3156,7 +3426,7 @@ class AgentUIApi {
|
|
|
3156
3426
|
/**
|
|
3157
3427
|
* AgentUI service.
|
|
3158
3428
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
3159
|
-
* @version
|
|
3429
|
+
* @version 231.0.0
|
|
3160
3430
|
*/
|
|
3161
3431
|
|
|
3162
3432
|
/**
|
|
@@ -3287,7 +3557,7 @@ class AlertingApi {
|
|
|
3287
3557
|
/**
|
|
3288
3558
|
* Alerting service.
|
|
3289
3559
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3290
|
-
* @version
|
|
3560
|
+
* @version 231.0.0
|
|
3291
3561
|
*/
|
|
3292
3562
|
|
|
3293
3563
|
/**
|
|
@@ -3688,7 +3958,7 @@ class AnalyticsApi {
|
|
|
3688
3958
|
/**
|
|
3689
3959
|
* Analytics service.
|
|
3690
3960
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3691
|
-
* @version
|
|
3961
|
+
* @version 231.0.0
|
|
3692
3962
|
*/
|
|
3693
3963
|
|
|
3694
3964
|
/**
|
|
@@ -4620,6 +4890,62 @@ class AnalyticsApi {
|
|
|
4620
4890
|
);
|
|
4621
4891
|
}
|
|
4622
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
|
+
|
|
4623
4949
|
/**
|
|
4624
4950
|
* Get analytics data retention setting
|
|
4625
4951
|
*
|
|
@@ -5912,6 +6238,32 @@ class AnalyticsApi {
|
|
|
5912
6238
|
);
|
|
5913
6239
|
}
|
|
5914
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
|
+
|
|
5915
6267
|
/**
|
|
5916
6268
|
* Query for evaluation aggregates asynchronously
|
|
5917
6269
|
*
|
|
@@ -6874,7 +7226,7 @@ class ArchitectApi {
|
|
|
6874
7226
|
/**
|
|
6875
7227
|
* Architect service.
|
|
6876
7228
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6877
|
-
* @version
|
|
7229
|
+
* @version 231.0.0
|
|
6878
7230
|
*/
|
|
6879
7231
|
|
|
6880
7232
|
/**
|
|
@@ -11169,7 +11521,7 @@ class AuditApi {
|
|
|
11169
11521
|
/**
|
|
11170
11522
|
* Audit service.
|
|
11171
11523
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
11172
|
-
* @version
|
|
11524
|
+
* @version 231.0.0
|
|
11173
11525
|
*/
|
|
11174
11526
|
|
|
11175
11527
|
/**
|
|
@@ -11370,7 +11722,7 @@ class AuthorizationApi {
|
|
|
11370
11722
|
/**
|
|
11371
11723
|
* Authorization service.
|
|
11372
11724
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
11373
|
-
* @version
|
|
11725
|
+
* @version 231.0.0
|
|
11374
11726
|
*/
|
|
11375
11727
|
|
|
11376
11728
|
/**
|
|
@@ -13085,7 +13437,7 @@ class BillingApi {
|
|
|
13085
13437
|
/**
|
|
13086
13438
|
* Billing service.
|
|
13087
13439
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
13088
|
-
* @version
|
|
13440
|
+
* @version 231.0.0
|
|
13089
13441
|
*/
|
|
13090
13442
|
|
|
13091
13443
|
/**
|
|
@@ -13341,7 +13693,7 @@ class BusinessRulesApi {
|
|
|
13341
13693
|
/**
|
|
13342
13694
|
* BusinessRules service.
|
|
13343
13695
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
13344
|
-
* @version
|
|
13696
|
+
* @version 231.0.0
|
|
13345
13697
|
*/
|
|
13346
13698
|
|
|
13347
13699
|
/**
|
|
@@ -14257,7 +14609,7 @@ class CarrierServicesApi {
|
|
|
14257
14609
|
/**
|
|
14258
14610
|
* CarrierServices service.
|
|
14259
14611
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
14260
|
-
* @version
|
|
14612
|
+
* @version 231.0.0
|
|
14261
14613
|
*/
|
|
14262
14614
|
|
|
14263
14615
|
/**
|
|
@@ -14327,7 +14679,7 @@ class ChatApi {
|
|
|
14327
14679
|
/**
|
|
14328
14680
|
* Chat service.
|
|
14329
14681
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
14330
|
-
* @version
|
|
14682
|
+
* @version 231.0.0
|
|
14331
14683
|
*/
|
|
14332
14684
|
|
|
14333
14685
|
/**
|
|
@@ -15308,7 +15660,7 @@ class CoachingApi {
|
|
|
15308
15660
|
/**
|
|
15309
15661
|
* Coaching service.
|
|
15310
15662
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
15311
|
-
* @version
|
|
15663
|
+
* @version 231.0.0
|
|
15312
15664
|
*/
|
|
15313
15665
|
|
|
15314
15666
|
/**
|
|
@@ -15885,7 +16237,7 @@ class ContentManagementApi {
|
|
|
15885
16237
|
/**
|
|
15886
16238
|
* ContentManagement service.
|
|
15887
16239
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
15888
|
-
* @version
|
|
16240
|
+
* @version 231.0.0
|
|
15889
16241
|
*/
|
|
15890
16242
|
|
|
15891
16243
|
/**
|
|
@@ -16966,7 +17318,7 @@ class ConversationsApi {
|
|
|
16966
17318
|
/**
|
|
16967
17319
|
* Conversations service.
|
|
16968
17320
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
16969
|
-
* @version
|
|
17321
|
+
* @version 231.0.0
|
|
16970
17322
|
*/
|
|
16971
17323
|
|
|
16972
17324
|
/**
|
|
@@ -17032,6 +17384,31 @@ class ConversationsApi {
|
|
|
17032
17384
|
);
|
|
17033
17385
|
}
|
|
17034
17386
|
|
|
17387
|
+
/**
|
|
17388
|
+
* Update a conversation by disconnecting all of the participants
|
|
17389
|
+
*
|
|
17390
|
+
* @param {String} conversationId conversation ID
|
|
17391
|
+
*/
|
|
17392
|
+
deleteConversation(conversationId) {
|
|
17393
|
+
// verify the required parameter 'conversationId' is set
|
|
17394
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
17395
|
+
throw 'Missing the required parameter "conversationId" when calling deleteConversation';
|
|
17396
|
+
}
|
|
17397
|
+
|
|
17398
|
+
return this.apiClient.callApi(
|
|
17399
|
+
'/api/v2/conversations/{conversationId}',
|
|
17400
|
+
'DELETE',
|
|
17401
|
+
{ 'conversationId': conversationId },
|
|
17402
|
+
{ },
|
|
17403
|
+
{ },
|
|
17404
|
+
{ },
|
|
17405
|
+
null,
|
|
17406
|
+
['PureCloud OAuth'],
|
|
17407
|
+
['application/json'],
|
|
17408
|
+
['application/json']
|
|
17409
|
+
);
|
|
17410
|
+
}
|
|
17411
|
+
|
|
17035
17412
|
/**
|
|
17036
17413
|
* Delete a code used to add a communication to this participant
|
|
17037
17414
|
*
|
|
@@ -20242,6 +20619,36 @@ class ConversationsApi {
|
|
|
20242
20619
|
);
|
|
20243
20620
|
}
|
|
20244
20621
|
|
|
20622
|
+
/**
|
|
20623
|
+
* Update a conversation by setting its recording state
|
|
20624
|
+
*
|
|
20625
|
+
* @param {String} conversationId conversation ID
|
|
20626
|
+
* @param {Object} body SetRecordingState
|
|
20627
|
+
*/
|
|
20628
|
+
patchConversationRecordingstate(conversationId, body) {
|
|
20629
|
+
// verify the required parameter 'conversationId' is set
|
|
20630
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
20631
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationRecordingstate';
|
|
20632
|
+
}
|
|
20633
|
+
// verify the required parameter 'body' is set
|
|
20634
|
+
if (body === undefined || body === null) {
|
|
20635
|
+
throw 'Missing the required parameter "body" when calling patchConversationRecordingstate';
|
|
20636
|
+
}
|
|
20637
|
+
|
|
20638
|
+
return this.apiClient.callApi(
|
|
20639
|
+
'/api/v2/conversations/{conversationId}/recordingstate',
|
|
20640
|
+
'PATCH',
|
|
20641
|
+
{ 'conversationId': conversationId },
|
|
20642
|
+
{ },
|
|
20643
|
+
{ },
|
|
20644
|
+
{ },
|
|
20645
|
+
body,
|
|
20646
|
+
['PureCloud OAuth'],
|
|
20647
|
+
['application/json'],
|
|
20648
|
+
['application/json']
|
|
20649
|
+
);
|
|
20650
|
+
}
|
|
20651
|
+
|
|
20245
20652
|
/**
|
|
20246
20653
|
* Update the secure attributes on a conversation.
|
|
20247
20654
|
*
|
|
@@ -20440,6 +20847,36 @@ class ConversationsApi {
|
|
|
20440
20847
|
);
|
|
20441
20848
|
}
|
|
20442
20849
|
|
|
20850
|
+
/**
|
|
20851
|
+
* Update a conversation by merging in other conversations to create a conference
|
|
20852
|
+
*
|
|
20853
|
+
* @param {String} conversationId conversationId
|
|
20854
|
+
* @param {Object} body UpdateConferenceRequest
|
|
20855
|
+
*/
|
|
20856
|
+
patchConversationsCallConference(conversationId, body) {
|
|
20857
|
+
// verify the required parameter 'conversationId' is set
|
|
20858
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
20859
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationsCallConference';
|
|
20860
|
+
}
|
|
20861
|
+
// verify the required parameter 'body' is set
|
|
20862
|
+
if (body === undefined || body === null) {
|
|
20863
|
+
throw 'Missing the required parameter "body" when calling patchConversationsCallConference';
|
|
20864
|
+
}
|
|
20865
|
+
|
|
20866
|
+
return this.apiClient.callApi(
|
|
20867
|
+
'/api/v2/conversations/calls/{conversationId}/conference',
|
|
20868
|
+
'PATCH',
|
|
20869
|
+
{ 'conversationId': conversationId },
|
|
20870
|
+
{ },
|
|
20871
|
+
{ },
|
|
20872
|
+
{ },
|
|
20873
|
+
body,
|
|
20874
|
+
['PureCloud OAuth'],
|
|
20875
|
+
['application/json'],
|
|
20876
|
+
['application/json']
|
|
20877
|
+
);
|
|
20878
|
+
}
|
|
20879
|
+
|
|
20443
20880
|
/**
|
|
20444
20881
|
* Update conversation participant
|
|
20445
20882
|
*
|
|
@@ -22833,6 +23270,41 @@ class ConversationsApi {
|
|
|
22833
23270
|
);
|
|
22834
23271
|
}
|
|
22835
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
|
+
|
|
22836
23308
|
/**
|
|
22837
23309
|
* Apply wrap-up for this conversation communication
|
|
22838
23310
|
*
|
|
@@ -23007,6 +23479,36 @@ class ConversationsApi {
|
|
|
23007
23479
|
);
|
|
23008
23480
|
}
|
|
23009
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
|
+
|
|
23010
23512
|
/**
|
|
23011
23513
|
* Send a message on behalf of a communication in a chat conversation.
|
|
23012
23514
|
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
@@ -23417,7 +23919,7 @@ class ConversationsApi {
|
|
|
23417
23919
|
|
|
23418
23920
|
/**
|
|
23419
23921
|
* Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation
|
|
23420
|
-
*
|
|
23922
|
+
* This request is not valid when using the Client Credentials OAuth grant.
|
|
23421
23923
|
* @param {String} conversationId conversationId
|
|
23422
23924
|
*/
|
|
23423
23925
|
postConversationsEmailReconnect(conversationId) {
|
|
@@ -25204,7 +25706,7 @@ class DataExtensionsApi {
|
|
|
25204
25706
|
/**
|
|
25205
25707
|
* DataExtensions service.
|
|
25206
25708
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
25207
|
-
* @version
|
|
25709
|
+
* @version 231.0.0
|
|
25208
25710
|
*/
|
|
25209
25711
|
|
|
25210
25712
|
/**
|
|
@@ -25290,7 +25792,7 @@ class DataPrivacyApi {
|
|
|
25290
25792
|
/**
|
|
25291
25793
|
* DataPrivacy service.
|
|
25292
25794
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
25293
|
-
* @version
|
|
25795
|
+
* @version 231.0.0
|
|
25294
25796
|
*/
|
|
25295
25797
|
|
|
25296
25798
|
/**
|
|
@@ -25460,7 +25962,7 @@ class DownloadsApi {
|
|
|
25460
25962
|
/**
|
|
25461
25963
|
* Downloads service.
|
|
25462
25964
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
25463
|
-
* @version
|
|
25965
|
+
* @version 231.0.0
|
|
25464
25966
|
*/
|
|
25465
25967
|
|
|
25466
25968
|
/**
|
|
@@ -25512,7 +26014,7 @@ class EmailsApi {
|
|
|
25512
26014
|
/**
|
|
25513
26015
|
* Emails service.
|
|
25514
26016
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
25515
|
-
* @version
|
|
26017
|
+
* @version 231.0.0
|
|
25516
26018
|
*/
|
|
25517
26019
|
|
|
25518
26020
|
/**
|
|
@@ -25641,7 +26143,7 @@ class EmployeeEngagementApi {
|
|
|
25641
26143
|
/**
|
|
25642
26144
|
* EmployeeEngagement service.
|
|
25643
26145
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
25644
|
-
* @version
|
|
26146
|
+
* @version 231.0.0
|
|
25645
26147
|
*/
|
|
25646
26148
|
|
|
25647
26149
|
/**
|
|
@@ -25792,7 +26294,7 @@ class EventsApi {
|
|
|
25792
26294
|
/**
|
|
25793
26295
|
* Events service.
|
|
25794
26296
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
25795
|
-
* @version
|
|
26297
|
+
* @version 231.0.0
|
|
25796
26298
|
*/
|
|
25797
26299
|
|
|
25798
26300
|
/**
|
|
@@ -25888,7 +26390,7 @@ class ExternalContactsApi {
|
|
|
25888
26390
|
/**
|
|
25889
26391
|
* ExternalContacts service.
|
|
25890
26392
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
25891
|
-
* @version
|
|
26393
|
+
* @version 231.0.0
|
|
25892
26394
|
*/
|
|
25893
26395
|
|
|
25894
26396
|
/**
|
|
@@ -29135,7 +29637,7 @@ class FaxApi {
|
|
|
29135
29637
|
/**
|
|
29136
29638
|
* Fax service.
|
|
29137
29639
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
29138
|
-
* @version
|
|
29640
|
+
* @version 231.0.0
|
|
29139
29641
|
*/
|
|
29140
29642
|
|
|
29141
29643
|
/**
|
|
@@ -29350,7 +29852,7 @@ class FlowsApi {
|
|
|
29350
29852
|
/**
|
|
29351
29853
|
* Flows service.
|
|
29352
29854
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
29353
|
-
* @version
|
|
29855
|
+
* @version 231.0.0
|
|
29354
29856
|
*/
|
|
29355
29857
|
|
|
29356
29858
|
/**
|
|
@@ -29559,7 +30061,7 @@ class GamificationApi {
|
|
|
29559
30061
|
/**
|
|
29560
30062
|
* Gamification service.
|
|
29561
30063
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
29562
|
-
* @version
|
|
30064
|
+
* @version 231.0.0
|
|
29563
30065
|
*/
|
|
29564
30066
|
|
|
29565
30067
|
/**
|
|
@@ -32066,7 +32568,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
32066
32568
|
/**
|
|
32067
32569
|
* GeneralDataProtectionRegulation service.
|
|
32068
32570
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
32069
|
-
* @version
|
|
32571
|
+
* @version 231.0.0
|
|
32070
32572
|
*/
|
|
32071
32573
|
|
|
32072
32574
|
/**
|
|
@@ -32196,7 +32698,7 @@ class GeolocationApi {
|
|
|
32196
32698
|
/**
|
|
32197
32699
|
* Geolocation service.
|
|
32198
32700
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
32199
|
-
* @version
|
|
32701
|
+
* @version 231.0.0
|
|
32200
32702
|
*/
|
|
32201
32703
|
|
|
32202
32704
|
/**
|
|
@@ -32327,7 +32829,7 @@ class GreetingsApi {
|
|
|
32327
32829
|
/**
|
|
32328
32830
|
* Greetings service.
|
|
32329
32831
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
32330
|
-
* @version
|
|
32832
|
+
* @version 231.0.0
|
|
32331
32833
|
*/
|
|
32332
32834
|
|
|
32333
32835
|
/**
|
|
@@ -32869,7 +33371,7 @@ class GroupsApi {
|
|
|
32869
33371
|
/**
|
|
32870
33372
|
* Groups service.
|
|
32871
33373
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
32872
|
-
* @version
|
|
33374
|
+
* @version 231.0.0
|
|
32873
33375
|
*/
|
|
32874
33376
|
|
|
32875
33377
|
/**
|
|
@@ -33388,7 +33890,7 @@ class IdentityProviderApi {
|
|
|
33388
33890
|
/**
|
|
33389
33891
|
* IdentityProvider service.
|
|
33390
33892
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
33391
|
-
* @version
|
|
33893
|
+
* @version 231.0.0
|
|
33392
33894
|
*/
|
|
33393
33895
|
|
|
33394
33896
|
/**
|
|
@@ -34249,7 +34751,7 @@ class InfrastructureAsCodeApi {
|
|
|
34249
34751
|
/**
|
|
34250
34752
|
* InfrastructureAsCode service.
|
|
34251
34753
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
34252
|
-
* @version
|
|
34754
|
+
* @version 231.0.0
|
|
34253
34755
|
*/
|
|
34254
34756
|
|
|
34255
34757
|
/**
|
|
@@ -34416,7 +34918,7 @@ class IntegrationsApi {
|
|
|
34416
34918
|
/**
|
|
34417
34919
|
* Integrations service.
|
|
34418
34920
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
34419
|
-
* @version
|
|
34921
|
+
* @version 231.0.0
|
|
34420
34922
|
*/
|
|
34421
34923
|
|
|
34422
34924
|
/**
|
|
@@ -37061,7 +37563,7 @@ class JourneyApi {
|
|
|
37061
37563
|
/**
|
|
37062
37564
|
* Journey service.
|
|
37063
37565
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
37064
|
-
* @version
|
|
37566
|
+
* @version 231.0.0
|
|
37065
37567
|
*/
|
|
37066
37568
|
|
|
37067
37569
|
/**
|
|
@@ -38349,6 +38851,33 @@ class JourneyApi {
|
|
|
38349
38851
|
);
|
|
38350
38852
|
}
|
|
38351
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
|
+
|
|
38352
38881
|
/**
|
|
38353
38882
|
* Get the journey schedules for an organization.
|
|
38354
38883
|
*
|
|
@@ -39131,7 +39660,7 @@ class KnowledgeApi {
|
|
|
39131
39660
|
/**
|
|
39132
39661
|
* Knowledge service.
|
|
39133
39662
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
39134
|
-
* @version
|
|
39663
|
+
* @version 231.0.0
|
|
39135
39664
|
*/
|
|
39136
39665
|
|
|
39137
39666
|
/**
|
|
@@ -43033,7 +43562,7 @@ class LanguageUnderstandingApi {
|
|
|
43033
43562
|
/**
|
|
43034
43563
|
* LanguageUnderstanding service.
|
|
43035
43564
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
43036
|
-
* @version
|
|
43565
|
+
* @version 231.0.0
|
|
43037
43566
|
*/
|
|
43038
43567
|
|
|
43039
43568
|
/**
|
|
@@ -43407,6 +43936,72 @@ class LanguageUnderstandingApi {
|
|
|
43407
43936
|
);
|
|
43408
43937
|
}
|
|
43409
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
|
+
|
|
43410
44005
|
/**
|
|
43411
44006
|
* Get information about a miner.
|
|
43412
44007
|
*
|
|
@@ -43941,6 +44536,126 @@ class LanguageUnderstandingApi {
|
|
|
43941
44536
|
);
|
|
43942
44537
|
}
|
|
43943
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
|
+
|
|
43944
44659
|
/**
|
|
43945
44660
|
* Create a new draft resource.
|
|
43946
44661
|
*
|
|
@@ -44066,7 +44781,7 @@ class LanguagesApi {
|
|
|
44066
44781
|
/**
|
|
44067
44782
|
* Languages service.
|
|
44068
44783
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
44069
|
-
* @version
|
|
44784
|
+
* @version 231.0.0
|
|
44070
44785
|
*/
|
|
44071
44786
|
|
|
44072
44787
|
/**
|
|
@@ -44288,7 +45003,7 @@ class LearningApi {
|
|
|
44288
45003
|
/**
|
|
44289
45004
|
* Learning service.
|
|
44290
45005
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
44291
|
-
* @version
|
|
45006
|
+
* @version 231.0.0
|
|
44292
45007
|
*/
|
|
44293
45008
|
|
|
44294
45009
|
/**
|
|
@@ -45317,7 +46032,7 @@ class LicenseApi {
|
|
|
45317
46032
|
/**
|
|
45318
46033
|
* License service.
|
|
45319
46034
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
45320
|
-
* @version
|
|
46035
|
+
* @version 231.0.0
|
|
45321
46036
|
*/
|
|
45322
46037
|
|
|
45323
46038
|
/**
|
|
@@ -45555,7 +46270,7 @@ class LocationsApi {
|
|
|
45555
46270
|
/**
|
|
45556
46271
|
* Locations service.
|
|
45557
46272
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
45558
|
-
* @version
|
|
46273
|
+
* @version 231.0.0
|
|
45559
46274
|
*/
|
|
45560
46275
|
|
|
45561
46276
|
/**
|
|
@@ -45791,7 +46506,7 @@ class LogCaptureApi {
|
|
|
45791
46506
|
/**
|
|
45792
46507
|
* LogCapture service.
|
|
45793
46508
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
45794
|
-
* @version
|
|
46509
|
+
* @version 231.0.0
|
|
45795
46510
|
*/
|
|
45796
46511
|
|
|
45797
46512
|
/**
|
|
@@ -45990,7 +46705,7 @@ class MessagingApi {
|
|
|
45990
46705
|
/**
|
|
45991
46706
|
* Messaging service.
|
|
45992
46707
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
45993
|
-
* @version
|
|
46708
|
+
* @version 231.0.0
|
|
45994
46709
|
*/
|
|
45995
46710
|
|
|
45996
46711
|
/**
|
|
@@ -46349,7 +47064,7 @@ class MobileDevicesApi {
|
|
|
46349
47064
|
/**
|
|
46350
47065
|
* MobileDevices service.
|
|
46351
47066
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
46352
|
-
* @version
|
|
47067
|
+
* @version 231.0.0
|
|
46353
47068
|
*/
|
|
46354
47069
|
|
|
46355
47070
|
/**
|
|
@@ -46500,7 +47215,7 @@ class NotificationsApi {
|
|
|
46500
47215
|
/**
|
|
46501
47216
|
* Notifications service.
|
|
46502
47217
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
46503
|
-
* @version
|
|
47218
|
+
* @version 231.0.0
|
|
46504
47219
|
*/
|
|
46505
47220
|
|
|
46506
47221
|
/**
|
|
@@ -46733,7 +47448,7 @@ class OAuthApi {
|
|
|
46733
47448
|
/**
|
|
46734
47449
|
* OAuth service.
|
|
46735
47450
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
46736
|
-
* @version
|
|
47451
|
+
* @version 231.0.0
|
|
46737
47452
|
*/
|
|
46738
47453
|
|
|
46739
47454
|
/**
|
|
@@ -47099,7 +47814,7 @@ class ObjectsApi {
|
|
|
47099
47814
|
/**
|
|
47100
47815
|
* Objects service.
|
|
47101
47816
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
47102
|
-
* @version
|
|
47817
|
+
* @version 231.0.0
|
|
47103
47818
|
*/
|
|
47104
47819
|
|
|
47105
47820
|
/**
|
|
@@ -47423,7 +48138,7 @@ class OperationalEventsApi {
|
|
|
47423
48138
|
/**
|
|
47424
48139
|
* OperationalEvents service.
|
|
47425
48140
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
47426
|
-
* @version
|
|
48141
|
+
* @version 231.0.0
|
|
47427
48142
|
*/
|
|
47428
48143
|
|
|
47429
48144
|
/**
|
|
@@ -47540,7 +48255,7 @@ class OrganizationApi {
|
|
|
47540
48255
|
/**
|
|
47541
48256
|
* Organization service.
|
|
47542
48257
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
47543
|
-
* @version
|
|
48258
|
+
* @version 231.0.0
|
|
47544
48259
|
*/
|
|
47545
48260
|
|
|
47546
48261
|
/**
|
|
@@ -48015,7 +48730,7 @@ class OrganizationAuthorizationApi {
|
|
|
48015
48730
|
/**
|
|
48016
48731
|
* OrganizationAuthorization service.
|
|
48017
48732
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
48018
|
-
* @version
|
|
48733
|
+
* @version 231.0.0
|
|
48019
48734
|
*/
|
|
48020
48735
|
|
|
48021
48736
|
/**
|
|
@@ -49409,7 +50124,7 @@ class OutboundApi {
|
|
|
49409
50124
|
/**
|
|
49410
50125
|
* Outbound service.
|
|
49411
50126
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
49412
|
-
* @version
|
|
50127
|
+
* @version 231.0.0
|
|
49413
50128
|
*/
|
|
49414
50129
|
|
|
49415
50130
|
/**
|
|
@@ -54131,7 +54846,7 @@ class PresenceApi {
|
|
|
54131
54846
|
/**
|
|
54132
54847
|
* Presence service.
|
|
54133
54848
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
54134
|
-
* @version
|
|
54849
|
+
* @version 231.0.0
|
|
54135
54850
|
*/
|
|
54136
54851
|
|
|
54137
54852
|
/**
|
|
@@ -54875,7 +55590,7 @@ class ProcessAutomationApi {
|
|
|
54875
55590
|
/**
|
|
54876
55591
|
* ProcessAutomation service.
|
|
54877
55592
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
54878
|
-
* @version
|
|
55593
|
+
* @version 231.0.0
|
|
54879
55594
|
*/
|
|
54880
55595
|
|
|
54881
55596
|
/**
|
|
@@ -55114,7 +55829,7 @@ class QualityApi {
|
|
|
55114
55829
|
/**
|
|
55115
55830
|
* Quality service.
|
|
55116
55831
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
55117
|
-
* @version
|
|
55832
|
+
* @version 231.0.0
|
|
55118
55833
|
*/
|
|
55119
55834
|
|
|
55120
55835
|
/**
|
|
@@ -56178,6 +56893,59 @@ class QualityApi {
|
|
|
56178
56893
|
);
|
|
56179
56894
|
}
|
|
56180
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
|
+
|
|
56181
56949
|
/**
|
|
56182
56950
|
* Get the most recent published version of a survey form.
|
|
56183
56951
|
*
|
|
@@ -56230,6 +56998,59 @@ class QualityApi {
|
|
|
56230
56998
|
);
|
|
56231
56999
|
}
|
|
56232
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
|
+
|
|
56233
57054
|
/**
|
|
56234
57055
|
* Get a survey for a conversation
|
|
56235
57056
|
*
|
|
@@ -56953,7 +57774,7 @@ class RecordingApi {
|
|
|
56953
57774
|
/**
|
|
56954
57775
|
* Recording service.
|
|
56955
57776
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
56956
|
-
* @version
|
|
57777
|
+
* @version 231.0.0
|
|
56957
57778
|
*/
|
|
56958
57779
|
|
|
56959
57780
|
/**
|
|
@@ -58006,7 +58827,7 @@ class RecordingApi {
|
|
|
58006
58827
|
|
|
58007
58828
|
/**
|
|
58008
58829
|
* Create a recording bulk job.
|
|
58009
|
-
* 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.
|
|
58830
|
+
* 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. It is recommended to query over smaller time periods so your request does not time out.
|
|
58010
58831
|
* @param {Object} body query
|
|
58011
58832
|
*/
|
|
58012
58833
|
postRecordingJobs(body) {
|
|
@@ -58389,7 +59210,7 @@ class RecordingApi {
|
|
|
58389
59210
|
|
|
58390
59211
|
/**
|
|
58391
59212
|
* Execute the recording bulk job.
|
|
58392
|
-
* 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.
|
|
58393
59214
|
* @param {String} jobId jobId
|
|
58394
59215
|
* @param {Object} body query
|
|
58395
59216
|
*/
|
|
@@ -58449,7 +59270,7 @@ class RecordingApi {
|
|
|
58449
59270
|
|
|
58450
59271
|
/**
|
|
58451
59272
|
* Update a media retention policy
|
|
58452
|
-
* 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>"}].
|
|
58453
59274
|
* @param {String} policyId Policy ID
|
|
58454
59275
|
* @param {Object} body Policy
|
|
58455
59276
|
*/
|
|
@@ -58558,7 +59379,7 @@ class ResponseManagementApi {
|
|
|
58558
59379
|
/**
|
|
58559
59380
|
* ResponseManagement service.
|
|
58560
59381
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
58561
|
-
* @version
|
|
59382
|
+
* @version 231.0.0
|
|
58562
59383
|
*/
|
|
58563
59384
|
|
|
58564
59385
|
/**
|
|
@@ -59068,7 +59889,7 @@ class RoutingApi {
|
|
|
59068
59889
|
/**
|
|
59069
59890
|
* Routing service.
|
|
59070
59891
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
59071
|
-
* @version
|
|
59892
|
+
* @version 231.0.0
|
|
59072
59893
|
*/
|
|
59073
59894
|
|
|
59074
59895
|
/**
|
|
@@ -59858,8 +60679,12 @@ class RoutingApi {
|
|
|
59858
60679
|
* Get domain
|
|
59859
60680
|
*
|
|
59860
60681
|
* @param {String} domainId domain ID
|
|
60682
|
+
* @param {Object} opts Optional parameters
|
|
60683
|
+
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
59861
60684
|
*/
|
|
59862
|
-
getRoutingEmailDomain(domainId) {
|
|
60685
|
+
getRoutingEmailDomain(domainId, opts) {
|
|
60686
|
+
opts = opts || {};
|
|
60687
|
+
|
|
59863
60688
|
// verify the required parameter 'domainId' is set
|
|
59864
60689
|
if (domainId === undefined || domainId === null || domainId === '') {
|
|
59865
60690
|
throw 'Missing the required parameter "domainId" when calling getRoutingEmailDomain';
|
|
@@ -59869,7 +60694,7 @@ class RoutingApi {
|
|
|
59869
60694
|
'/api/v2/routing/email/domains/{domainId}',
|
|
59870
60695
|
'GET',
|
|
59871
60696
|
{ 'domainId': domainId },
|
|
59872
|
-
{
|
|
60697
|
+
{ 'expand': opts['expand'] },
|
|
59873
60698
|
{ },
|
|
59874
60699
|
{ },
|
|
59875
60700
|
null,
|
|
@@ -59983,6 +60808,7 @@ class RoutingApi {
|
|
|
59983
60808
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
59984
60809
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
59985
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
|
|
59986
60812
|
*/
|
|
59987
60813
|
getRoutingEmailDomains(opts) {
|
|
59988
60814
|
opts = opts || {};
|
|
@@ -59992,7 +60818,7 @@ class RoutingApi {
|
|
|
59992
60818
|
'/api/v2/routing/email/domains',
|
|
59993
60819
|
'GET',
|
|
59994
60820
|
{ },
|
|
59995
|
-
{ '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'] },
|
|
59996
60822
|
{ },
|
|
59997
60823
|
{ },
|
|
59998
60824
|
null,
|
|
@@ -60006,8 +60832,12 @@ class RoutingApi {
|
|
|
60006
60832
|
* Get domain
|
|
60007
60833
|
*
|
|
60008
60834
|
* @param {String} domainId domain ID
|
|
60835
|
+
* @param {Object} opts Optional parameters
|
|
60836
|
+
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
60009
60837
|
*/
|
|
60010
|
-
getRoutingEmailOutboundDomain(domainId) {
|
|
60838
|
+
getRoutingEmailOutboundDomain(domainId, opts) {
|
|
60839
|
+
opts = opts || {};
|
|
60840
|
+
|
|
60011
60841
|
// verify the required parameter 'domainId' is set
|
|
60012
60842
|
if (domainId === undefined || domainId === null || domainId === '') {
|
|
60013
60843
|
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomain';
|
|
@@ -60017,7 +60847,7 @@ class RoutingApi {
|
|
|
60017
60847
|
'/api/v2/routing/email/outbound/domains/{domainId}',
|
|
60018
60848
|
'GET',
|
|
60019
60849
|
{ 'domainId': domainId },
|
|
60020
|
-
{
|
|
60850
|
+
{ 'expand': opts['expand'] },
|
|
60021
60851
|
{ },
|
|
60022
60852
|
{ },
|
|
60023
60853
|
null,
|
|
@@ -60052,31 +60882,6 @@ class RoutingApi {
|
|
|
60052
60882
|
);
|
|
60053
60883
|
}
|
|
60054
60884
|
|
|
60055
|
-
/**
|
|
60056
|
-
* Search a domain across organizations
|
|
60057
|
-
*
|
|
60058
|
-
* @param {String} domainId domain ID
|
|
60059
|
-
*/
|
|
60060
|
-
getRoutingEmailOutboundDomainSearch(domainId) {
|
|
60061
|
-
// verify the required parameter 'domainId' is set
|
|
60062
|
-
if (domainId === undefined || domainId === null || domainId === '') {
|
|
60063
|
-
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomainSearch';
|
|
60064
|
-
}
|
|
60065
|
-
|
|
60066
|
-
return this.apiClient.callApi(
|
|
60067
|
-
'/api/v2/routing/email/outbound/domains/{domainId}/search',
|
|
60068
|
-
'GET',
|
|
60069
|
-
{ 'domainId': domainId },
|
|
60070
|
-
{ },
|
|
60071
|
-
{ },
|
|
60072
|
-
{ },
|
|
60073
|
-
null,
|
|
60074
|
-
['PureCloud OAuth'],
|
|
60075
|
-
['application/json'],
|
|
60076
|
-
['application/json']
|
|
60077
|
-
);
|
|
60078
|
-
}
|
|
60079
|
-
|
|
60080
60885
|
/**
|
|
60081
60886
|
* Get outbound domains
|
|
60082
60887
|
*
|
|
@@ -60084,6 +60889,7 @@ class RoutingApi {
|
|
|
60084
60889
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
60085
60890
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
60086
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
|
|
60087
60893
|
*/
|
|
60088
60894
|
getRoutingEmailOutboundDomains(opts) {
|
|
60089
60895
|
opts = opts || {};
|
|
@@ -60093,7 +60899,7 @@ class RoutingApi {
|
|
|
60093
60899
|
'/api/v2/routing/email/outbound/domains',
|
|
60094
60900
|
'GET',
|
|
60095
60901
|
{ },
|
|
60096
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'filter': opts['filter'] },
|
|
60902
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'filter': opts['filter'],'expand': opts['expand'] },
|
|
60097
60903
|
{ },
|
|
60098
60904
|
{ },
|
|
60099
60905
|
null,
|
|
@@ -62311,8 +63117,8 @@ class RoutingApi {
|
|
|
62311
63117
|
}
|
|
62312
63118
|
|
|
62313
63119
|
/**
|
|
62314
|
-
* Tests the custom SMTP server integration connection set on this domain
|
|
62315
|
-
* The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server. If the body is specified, there will be an attempt to send an email message to the server.
|
|
63120
|
+
* Tests the custom SMTP server integration connection set on this ACD domain
|
|
63121
|
+
* The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server used by the ACD domain. If the body is specified, there will be an attempt to send an email message to the server.
|
|
62316
63122
|
* @param {String} domainId domain ID
|
|
62317
63123
|
* @param {Object} opts Optional parameters
|
|
62318
63124
|
* @param {Object} opts.body TestMessage
|
|
@@ -63409,7 +64215,7 @@ class SCIMApi {
|
|
|
63409
64215
|
/**
|
|
63410
64216
|
* SCIM service.
|
|
63411
64217
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
63412
|
-
* @version
|
|
64218
|
+
* @version 231.0.0
|
|
63413
64219
|
*/
|
|
63414
64220
|
|
|
63415
64221
|
/**
|
|
@@ -64286,7 +65092,7 @@ class ScreenRecordingApi {
|
|
|
64286
65092
|
/**
|
|
64287
65093
|
* ScreenRecording service.
|
|
64288
65094
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
64289
|
-
* @version
|
|
65095
|
+
* @version 231.0.0
|
|
64290
65096
|
*/
|
|
64291
65097
|
|
|
64292
65098
|
/**
|
|
@@ -64331,7 +65137,7 @@ class ScriptsApi {
|
|
|
64331
65137
|
/**
|
|
64332
65138
|
* Scripts service.
|
|
64333
65139
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
64334
|
-
* @version
|
|
65140
|
+
* @version 231.0.0
|
|
64335
65141
|
*/
|
|
64336
65142
|
|
|
64337
65143
|
/**
|
|
@@ -64807,7 +65613,7 @@ class SearchApi {
|
|
|
64807
65613
|
/**
|
|
64808
65614
|
* Search service.
|
|
64809
65615
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
64810
|
-
* @version
|
|
65616
|
+
* @version 231.0.0
|
|
64811
65617
|
*/
|
|
64812
65618
|
|
|
64813
65619
|
/**
|
|
@@ -65525,7 +66331,7 @@ class SettingsApi {
|
|
|
65525
66331
|
/**
|
|
65526
66332
|
* Settings service.
|
|
65527
66333
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
65528
|
-
* @version
|
|
66334
|
+
* @version 231.0.0
|
|
65529
66335
|
*/
|
|
65530
66336
|
|
|
65531
66337
|
/**
|
|
@@ -65873,7 +66679,7 @@ class SocialMediaApi {
|
|
|
65873
66679
|
/**
|
|
65874
66680
|
* SocialMedia service.
|
|
65875
66681
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
65876
|
-
* @version
|
|
66682
|
+
* @version 231.0.0
|
|
65877
66683
|
*/
|
|
65878
66684
|
|
|
65879
66685
|
/**
|
|
@@ -66002,6 +66808,40 @@ class SocialMediaApi {
|
|
|
66002
66808
|
);
|
|
66003
66809
|
}
|
|
66004
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
|
+
|
|
66005
66845
|
/**
|
|
66006
66846
|
* Delete a open data ingestion rule.
|
|
66007
66847
|
*
|
|
@@ -66402,6 +67242,115 @@ class SocialMediaApi {
|
|
|
66402
67242
|
);
|
|
66403
67243
|
}
|
|
66404
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
|
+
|
|
66405
67354
|
/**
|
|
66406
67355
|
* Get a single open data ingestion rule.
|
|
66407
67356
|
*
|
|
@@ -66710,6 +67659,40 @@ class SocialMediaApi {
|
|
|
66710
67659
|
);
|
|
66711
67660
|
}
|
|
66712
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
|
+
|
|
66713
67696
|
/**
|
|
66714
67697
|
* Update the status of a open data ingestion rule.
|
|
66715
67698
|
*
|
|
@@ -66910,6 +67893,35 @@ class SocialMediaApi {
|
|
|
66910
67893
|
);
|
|
66911
67894
|
}
|
|
66912
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
|
+
|
|
66913
67925
|
/**
|
|
66914
67926
|
* Create an open data ingestion rule.
|
|
66915
67927
|
*
|
|
@@ -67150,6 +68162,40 @@ class SocialMediaApi {
|
|
|
67150
68162
|
);
|
|
67151
68163
|
}
|
|
67152
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
|
+
|
|
67153
68199
|
/**
|
|
67154
68200
|
* Update the open data ingestion rule.
|
|
67155
68201
|
*
|
|
@@ -67224,7 +68270,7 @@ class SpeechTextAnalyticsApi {
|
|
|
67224
68270
|
/**
|
|
67225
68271
|
* SpeechTextAnalytics service.
|
|
67226
68272
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
67227
|
-
* @version
|
|
68273
|
+
* @version 231.0.0
|
|
67228
68274
|
*/
|
|
67229
68275
|
|
|
67230
68276
|
/**
|
|
@@ -68870,7 +69916,7 @@ class StationsApi {
|
|
|
68870
69916
|
/**
|
|
68871
69917
|
* Stations service.
|
|
68872
69918
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
68873
|
-
* @version
|
|
69919
|
+
* @version 231.0.0
|
|
68874
69920
|
*/
|
|
68875
69921
|
|
|
68876
69922
|
/**
|
|
@@ -68972,7 +70018,7 @@ class SuggestApi {
|
|
|
68972
70018
|
/**
|
|
68973
70019
|
* Suggest service.
|
|
68974
70020
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
68975
|
-
* @version
|
|
70021
|
+
* @version 231.0.0
|
|
68976
70022
|
*/
|
|
68977
70023
|
|
|
68978
70024
|
/**
|
|
@@ -69111,7 +70157,7 @@ class TaskManagementApi {
|
|
|
69111
70157
|
/**
|
|
69112
70158
|
* TaskManagement service.
|
|
69113
70159
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
69114
|
-
* @version
|
|
70160
|
+
* @version 231.0.0
|
|
69115
70161
|
*/
|
|
69116
70162
|
|
|
69117
70163
|
/**
|
|
@@ -71273,7 +72319,7 @@ class TeamsApi {
|
|
|
71273
72319
|
/**
|
|
71274
72320
|
* Teams service.
|
|
71275
72321
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
71276
|
-
* @version
|
|
72322
|
+
* @version 231.0.0
|
|
71277
72323
|
*/
|
|
71278
72324
|
|
|
71279
72325
|
/**
|
|
@@ -71578,7 +72624,7 @@ class TelephonyApi {
|
|
|
71578
72624
|
/**
|
|
71579
72625
|
* Telephony service.
|
|
71580
72626
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
71581
|
-
* @version
|
|
72627
|
+
* @version 231.0.0
|
|
71582
72628
|
*/
|
|
71583
72629
|
|
|
71584
72630
|
/**
|
|
@@ -71864,7 +72910,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
71864
72910
|
/**
|
|
71865
72911
|
* TelephonyProvidersEdge service.
|
|
71866
72912
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
71867
|
-
* @version
|
|
72913
|
+
* @version 231.0.0
|
|
71868
72914
|
*/
|
|
71869
72915
|
|
|
71870
72916
|
/**
|
|
@@ -75357,7 +76403,7 @@ class TextbotsApi {
|
|
|
75357
76403
|
/**
|
|
75358
76404
|
* Textbots service.
|
|
75359
76405
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
75360
|
-
* @version
|
|
76406
|
+
* @version 231.0.0
|
|
75361
76407
|
*/
|
|
75362
76408
|
|
|
75363
76409
|
/**
|
|
@@ -75486,7 +76532,7 @@ class TokensApi {
|
|
|
75486
76532
|
/**
|
|
75487
76533
|
* Tokens service.
|
|
75488
76534
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
75489
|
-
* @version
|
|
76535
|
+
* @version 231.0.0
|
|
75490
76536
|
*/
|
|
75491
76537
|
|
|
75492
76538
|
/**
|
|
@@ -75640,7 +76686,7 @@ class UploadsApi {
|
|
|
75640
76686
|
/**
|
|
75641
76687
|
* Uploads service.
|
|
75642
76688
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
75643
|
-
* @version
|
|
76689
|
+
* @version 231.0.0
|
|
75644
76690
|
*/
|
|
75645
76691
|
|
|
75646
76692
|
/**
|
|
@@ -75931,7 +76977,7 @@ class UsageApi {
|
|
|
75931
76977
|
/**
|
|
75932
76978
|
* Usage service.
|
|
75933
76979
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
75934
|
-
* @version
|
|
76980
|
+
* @version 231.0.0
|
|
75935
76981
|
*/
|
|
75936
76982
|
|
|
75937
76983
|
/**
|
|
@@ -76266,7 +77312,7 @@ class UserRecordingsApi {
|
|
|
76266
77312
|
/**
|
|
76267
77313
|
* UserRecordings service.
|
|
76268
77314
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
76269
|
-
* @version
|
|
77315
|
+
* @version 231.0.0
|
|
76270
77316
|
*/
|
|
76271
77317
|
|
|
76272
77318
|
/**
|
|
@@ -76335,37 +77381,6 @@ class UserRecordingsApi {
|
|
|
76335
77381
|
);
|
|
76336
77382
|
}
|
|
76337
77383
|
|
|
76338
|
-
/**
|
|
76339
|
-
* Download a user recording.
|
|
76340
|
-
* API should migrate to use GET api/v2/userrecordings/{recordingId}/transcoding
|
|
76341
|
-
* @param {String} recordingId User Recording ID
|
|
76342
|
-
* @param {Object} opts Optional parameters
|
|
76343
|
-
* @param {Object} opts.formatId The desired media format. (default to WEBM)
|
|
76344
|
-
* @param {Boolean} opts.async When set to true, api will return 202 response until the recording is ready for download
|
|
76345
|
-
* @deprecated
|
|
76346
|
-
*/
|
|
76347
|
-
getUserrecordingMedia(recordingId, opts) {
|
|
76348
|
-
opts = opts || {};
|
|
76349
|
-
|
|
76350
|
-
// verify the required parameter 'recordingId' is set
|
|
76351
|
-
if (recordingId === undefined || recordingId === null || recordingId === '') {
|
|
76352
|
-
throw 'Missing the required parameter "recordingId" when calling getUserrecordingMedia';
|
|
76353
|
-
}
|
|
76354
|
-
|
|
76355
|
-
return this.apiClient.callApi(
|
|
76356
|
-
'/api/v2/userrecordings/{recordingId}/media',
|
|
76357
|
-
'GET',
|
|
76358
|
-
{ 'recordingId': recordingId },
|
|
76359
|
-
{ 'formatId': opts['formatId'],'async': opts['async'] },
|
|
76360
|
-
{ },
|
|
76361
|
-
{ },
|
|
76362
|
-
null,
|
|
76363
|
-
['PureCloud OAuth'],
|
|
76364
|
-
['application/json'],
|
|
76365
|
-
['application/json']
|
|
76366
|
-
);
|
|
76367
|
-
}
|
|
76368
|
-
|
|
76369
77384
|
/**
|
|
76370
77385
|
* Download a user recording.
|
|
76371
77386
|
*
|
|
@@ -76481,7 +77496,7 @@ class UsersApi {
|
|
|
76481
77496
|
/**
|
|
76482
77497
|
* Users service.
|
|
76483
77498
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
76484
|
-
* @version
|
|
77499
|
+
* @version 231.0.0
|
|
76485
77500
|
*/
|
|
76486
77501
|
|
|
76487
77502
|
/**
|
|
@@ -79490,7 +80505,7 @@ class UtilitiesApi {
|
|
|
79490
80505
|
/**
|
|
79491
80506
|
* Utilities service.
|
|
79492
80507
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
79493
|
-
* @version
|
|
80508
|
+
* @version 231.0.0
|
|
79494
80509
|
*/
|
|
79495
80510
|
|
|
79496
80511
|
/**
|
|
@@ -79601,7 +80616,7 @@ class VoicemailApi {
|
|
|
79601
80616
|
/**
|
|
79602
80617
|
* Voicemail service.
|
|
79603
80618
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
79604
|
-
* @version
|
|
80619
|
+
* @version 231.0.0
|
|
79605
80620
|
*/
|
|
79606
80621
|
|
|
79607
80622
|
/**
|
|
@@ -80323,7 +81338,7 @@ class WebChatApi {
|
|
|
80323
81338
|
/**
|
|
80324
81339
|
* WebChat service.
|
|
80325
81340
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
80326
|
-
* @version
|
|
81341
|
+
* @version 231.0.0
|
|
80327
81342
|
*/
|
|
80328
81343
|
|
|
80329
81344
|
/**
|
|
@@ -80883,7 +81898,7 @@ class WebDeploymentsApi {
|
|
|
80883
81898
|
/**
|
|
80884
81899
|
* WebDeployments service.
|
|
80885
81900
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
80886
|
-
* @version
|
|
81901
|
+
* @version 231.0.0
|
|
80887
81902
|
*/
|
|
80888
81903
|
|
|
80889
81904
|
/**
|
|
@@ -81465,7 +82480,7 @@ class WebMessagingApi {
|
|
|
81465
82480
|
/**
|
|
81466
82481
|
* WebMessaging service.
|
|
81467
82482
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
81468
|
-
* @version
|
|
82483
|
+
* @version 231.0.0
|
|
81469
82484
|
*/
|
|
81470
82485
|
|
|
81471
82486
|
/**
|
|
@@ -81480,6 +82495,36 @@ class WebMessagingApi {
|
|
|
81480
82495
|
}
|
|
81481
82496
|
|
|
81482
82497
|
|
|
82498
|
+
/**
|
|
82499
|
+
* Delete device information
|
|
82500
|
+
*
|
|
82501
|
+
* @param {String} deploymentId WebMessaging deployment id
|
|
82502
|
+
* @param {String} tokenId Device token id or cookie id
|
|
82503
|
+
*/
|
|
82504
|
+
deleteWebmessagingDeploymentPushdevice(deploymentId, tokenId) {
|
|
82505
|
+
// verify the required parameter 'deploymentId' is set
|
|
82506
|
+
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
82507
|
+
throw 'Missing the required parameter "deploymentId" when calling deleteWebmessagingDeploymentPushdevice';
|
|
82508
|
+
}
|
|
82509
|
+
// verify the required parameter 'tokenId' is set
|
|
82510
|
+
if (tokenId === undefined || tokenId === null || tokenId === '') {
|
|
82511
|
+
throw 'Missing the required parameter "tokenId" when calling deleteWebmessagingDeploymentPushdevice';
|
|
82512
|
+
}
|
|
82513
|
+
|
|
82514
|
+
return this.apiClient.callApi(
|
|
82515
|
+
'/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}',
|
|
82516
|
+
'DELETE',
|
|
82517
|
+
{ 'deploymentId': deploymentId,'tokenId': tokenId },
|
|
82518
|
+
{ },
|
|
82519
|
+
{ },
|
|
82520
|
+
{ },
|
|
82521
|
+
null,
|
|
82522
|
+
['PureCloud OAuth'],
|
|
82523
|
+
['application/json'],
|
|
82524
|
+
['application/json']
|
|
82525
|
+
);
|
|
82526
|
+
}
|
|
82527
|
+
|
|
81483
82528
|
/**
|
|
81484
82529
|
* Get the messages for a web messaging session.
|
|
81485
82530
|
*
|
|
@@ -81505,13 +82550,83 @@ class WebMessagingApi {
|
|
|
81505
82550
|
);
|
|
81506
82551
|
}
|
|
81507
82552
|
|
|
82553
|
+
/**
|
|
82554
|
+
* Edit device information
|
|
82555
|
+
*
|
|
82556
|
+
* @param {String} deploymentId WebMessaging deployment id
|
|
82557
|
+
* @param {String} tokenId Device token id or cookie id
|
|
82558
|
+
* @param {Object} body Request body
|
|
82559
|
+
*/
|
|
82560
|
+
patchWebmessagingDeploymentPushdevice(deploymentId, tokenId, body) {
|
|
82561
|
+
// verify the required parameter 'deploymentId' is set
|
|
82562
|
+
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
82563
|
+
throw 'Missing the required parameter "deploymentId" when calling patchWebmessagingDeploymentPushdevice';
|
|
82564
|
+
}
|
|
82565
|
+
// verify the required parameter 'tokenId' is set
|
|
82566
|
+
if (tokenId === undefined || tokenId === null || tokenId === '') {
|
|
82567
|
+
throw 'Missing the required parameter "tokenId" when calling patchWebmessagingDeploymentPushdevice';
|
|
82568
|
+
}
|
|
82569
|
+
// verify the required parameter 'body' is set
|
|
82570
|
+
if (body === undefined || body === null) {
|
|
82571
|
+
throw 'Missing the required parameter "body" when calling patchWebmessagingDeploymentPushdevice';
|
|
82572
|
+
}
|
|
82573
|
+
|
|
82574
|
+
return this.apiClient.callApi(
|
|
82575
|
+
'/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}',
|
|
82576
|
+
'PATCH',
|
|
82577
|
+
{ 'deploymentId': deploymentId,'tokenId': tokenId },
|
|
82578
|
+
{ },
|
|
82579
|
+
{ },
|
|
82580
|
+
{ },
|
|
82581
|
+
body,
|
|
82582
|
+
['PureCloud OAuth'],
|
|
82583
|
+
['application/json'],
|
|
82584
|
+
['application/json']
|
|
82585
|
+
);
|
|
82586
|
+
}
|
|
82587
|
+
|
|
82588
|
+
/**
|
|
82589
|
+
* Add a new device information
|
|
82590
|
+
*
|
|
82591
|
+
* @param {String} deploymentId WebMessaging deployment id
|
|
82592
|
+
* @param {String} tokenId Device token id or cookie id
|
|
82593
|
+
* @param {Object} body Request body
|
|
82594
|
+
*/
|
|
82595
|
+
postWebmessagingDeploymentPushdevice(deploymentId, tokenId, body) {
|
|
82596
|
+
// verify the required parameter 'deploymentId' is set
|
|
82597
|
+
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
82598
|
+
throw 'Missing the required parameter "deploymentId" when calling postWebmessagingDeploymentPushdevice';
|
|
82599
|
+
}
|
|
82600
|
+
// verify the required parameter 'tokenId' is set
|
|
82601
|
+
if (tokenId === undefined || tokenId === null || tokenId === '') {
|
|
82602
|
+
throw 'Missing the required parameter "tokenId" when calling postWebmessagingDeploymentPushdevice';
|
|
82603
|
+
}
|
|
82604
|
+
// verify the required parameter 'body' is set
|
|
82605
|
+
if (body === undefined || body === null) {
|
|
82606
|
+
throw 'Missing the required parameter "body" when calling postWebmessagingDeploymentPushdevice';
|
|
82607
|
+
}
|
|
82608
|
+
|
|
82609
|
+
return this.apiClient.callApi(
|
|
82610
|
+
'/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}',
|
|
82611
|
+
'POST',
|
|
82612
|
+
{ 'deploymentId': deploymentId,'tokenId': tokenId },
|
|
82613
|
+
{ },
|
|
82614
|
+
{ },
|
|
82615
|
+
{ },
|
|
82616
|
+
body,
|
|
82617
|
+
['PureCloud OAuth'],
|
|
82618
|
+
['application/json'],
|
|
82619
|
+
['application/json']
|
|
82620
|
+
);
|
|
82621
|
+
}
|
|
82622
|
+
|
|
81508
82623
|
}
|
|
81509
82624
|
|
|
81510
82625
|
class WidgetsApi {
|
|
81511
82626
|
/**
|
|
81512
82627
|
* Widgets service.
|
|
81513
82628
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
81514
|
-
* @version
|
|
82629
|
+
* @version 231.0.0
|
|
81515
82630
|
*/
|
|
81516
82631
|
|
|
81517
82632
|
/**
|
|
@@ -81662,7 +82777,7 @@ class WorkforceManagementApi {
|
|
|
81662
82777
|
/**
|
|
81663
82778
|
* WorkforceManagement service.
|
|
81664
82779
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
81665
|
-
* @version
|
|
82780
|
+
* @version 231.0.0
|
|
81666
82781
|
*/
|
|
81667
82782
|
|
|
81668
82783
|
/**
|
|
@@ -89632,7 +90747,7 @@ class WorkforceManagementApi {
|
|
|
89632
90747
|
* </pre>
|
|
89633
90748
|
* </p>
|
|
89634
90749
|
* @module purecloud-platform-client-v2/index
|
|
89635
|
-
* @version
|
|
90750
|
+
* @version 231.0.0
|
|
89636
90751
|
*/
|
|
89637
90752
|
class platformClient {
|
|
89638
90753
|
constructor() {
|