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
|
@@ -21,6 +21,8 @@ define(['axios', 'qs'], (function (axios, qs) { 'use strict';
|
|
|
21
21
|
me_central_1: 'mec1.pure.cloud',
|
|
22
22
|
ap_northeast_3: 'apne3.pure.cloud',
|
|
23
23
|
eu_central_2: 'euc2.pure.cloud',
|
|
24
|
+
mx_central_1: 'mxc1.pure.cloud',
|
|
25
|
+
ap_southeast_1: 'apse1.pure.cloud',
|
|
24
26
|
};
|
|
25
27
|
|
|
26
28
|
class AbstractHttpClient {
|
|
@@ -743,7 +745,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
743
745
|
|
|
744
746
|
/**
|
|
745
747
|
* @module purecloud-platform-client-v2/ApiClient
|
|
746
|
-
* @version
|
|
748
|
+
* @version 231.0.0
|
|
747
749
|
*/
|
|
748
750
|
class ApiClient {
|
|
749
751
|
/**
|
|
@@ -2287,7 +2289,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2287
2289
|
/**
|
|
2288
2290
|
* AIStudio service.
|
|
2289
2291
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2290
|
-
* @version
|
|
2292
|
+
* @version 231.0.0
|
|
2291
2293
|
*/
|
|
2292
2294
|
|
|
2293
2295
|
/**
|
|
@@ -2302,6 +2304,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2302
2304
|
}
|
|
2303
2305
|
|
|
2304
2306
|
|
|
2307
|
+
/**
|
|
2308
|
+
* Delete a summary setting.
|
|
2309
|
+
*
|
|
2310
|
+
* @param {String} summarySettingId Summary setting id
|
|
2311
|
+
*/
|
|
2312
|
+
deleteConversationsSummariesSetting(summarySettingId) {
|
|
2313
|
+
// verify the required parameter 'summarySettingId' is set
|
|
2314
|
+
if (summarySettingId === undefined || summarySettingId === null || summarySettingId === '') {
|
|
2315
|
+
throw 'Missing the required parameter "summarySettingId" when calling deleteConversationsSummariesSetting';
|
|
2316
|
+
}
|
|
2317
|
+
|
|
2318
|
+
return this.apiClient.callApi(
|
|
2319
|
+
'/api/v2/conversations/summaries/settings/{summarySettingId}',
|
|
2320
|
+
'DELETE',
|
|
2321
|
+
{ 'summarySettingId': summarySettingId },
|
|
2322
|
+
{ },
|
|
2323
|
+
{ },
|
|
2324
|
+
{ },
|
|
2325
|
+
null,
|
|
2326
|
+
['PureCloud OAuth'],
|
|
2327
|
+
['application/json'],
|
|
2328
|
+
['application/json']
|
|
2329
|
+
);
|
|
2330
|
+
}
|
|
2331
|
+
|
|
2305
2332
|
/**
|
|
2306
2333
|
* Start the deletion of a guide.
|
|
2307
2334
|
*
|
|
@@ -2328,6 +2355,60 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2328
2355
|
);
|
|
2329
2356
|
}
|
|
2330
2357
|
|
|
2358
|
+
/**
|
|
2359
|
+
* Receive a summary setting.
|
|
2360
|
+
*
|
|
2361
|
+
* @param {String} summarySettingId Summary setting id
|
|
2362
|
+
*/
|
|
2363
|
+
getConversationsSummariesSetting(summarySettingId) {
|
|
2364
|
+
// verify the required parameter 'summarySettingId' is set
|
|
2365
|
+
if (summarySettingId === undefined || summarySettingId === null || summarySettingId === '') {
|
|
2366
|
+
throw 'Missing the required parameter "summarySettingId" when calling getConversationsSummariesSetting';
|
|
2367
|
+
}
|
|
2368
|
+
|
|
2369
|
+
return this.apiClient.callApi(
|
|
2370
|
+
'/api/v2/conversations/summaries/settings/{summarySettingId}',
|
|
2371
|
+
'GET',
|
|
2372
|
+
{ 'summarySettingId': summarySettingId },
|
|
2373
|
+
{ },
|
|
2374
|
+
{ },
|
|
2375
|
+
{ },
|
|
2376
|
+
null,
|
|
2377
|
+
['PureCloud OAuth'],
|
|
2378
|
+
['application/json'],
|
|
2379
|
+
['application/json']
|
|
2380
|
+
);
|
|
2381
|
+
}
|
|
2382
|
+
|
|
2383
|
+
/**
|
|
2384
|
+
* Get all summary settings.
|
|
2385
|
+
*
|
|
2386
|
+
* @param {Object} opts Optional parameters
|
|
2387
|
+
* @param {String} opts.language Filter by matching language - case insensitive.
|
|
2388
|
+
* @param {String} opts.name Filter by partially matching name - case insensitive.
|
|
2389
|
+
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
2390
|
+
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
2391
|
+
* @param {Number} opts.pageNumber Page number. (default to 1)
|
|
2392
|
+
* @param {Number} opts.pageSize Page size. The maximum page size is 100. (default to 25)
|
|
2393
|
+
*/
|
|
2394
|
+
getConversationsSummariesSettings(opts) {
|
|
2395
|
+
opts = opts || {};
|
|
2396
|
+
|
|
2397
|
+
|
|
2398
|
+
return this.apiClient.callApi(
|
|
2399
|
+
'/api/v2/conversations/summaries/settings',
|
|
2400
|
+
'GET',
|
|
2401
|
+
{ },
|
|
2402
|
+
{ 'language': opts['language'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
2403
|
+
{ },
|
|
2404
|
+
{ },
|
|
2405
|
+
null,
|
|
2406
|
+
['PureCloud OAuth'],
|
|
2407
|
+
['application/json'],
|
|
2408
|
+
['application/json']
|
|
2409
|
+
);
|
|
2410
|
+
}
|
|
2411
|
+
|
|
2331
2412
|
/**
|
|
2332
2413
|
* Get guide.
|
|
2333
2414
|
*
|
|
@@ -2576,6 +2657,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2576
2657
|
);
|
|
2577
2658
|
}
|
|
2578
2659
|
|
|
2660
|
+
/**
|
|
2661
|
+
* Trigger summary preview event generation.
|
|
2662
|
+
*
|
|
2663
|
+
* @param {Object} body
|
|
2664
|
+
*/
|
|
2665
|
+
postConversationsSummariesPreview(body) {
|
|
2666
|
+
// verify the required parameter 'body' is set
|
|
2667
|
+
if (body === undefined || body === null) {
|
|
2668
|
+
throw 'Missing the required parameter "body" when calling postConversationsSummariesPreview';
|
|
2669
|
+
}
|
|
2670
|
+
|
|
2671
|
+
return this.apiClient.callApi(
|
|
2672
|
+
'/api/v2/conversations/summaries/preview',
|
|
2673
|
+
'POST',
|
|
2674
|
+
{ },
|
|
2675
|
+
{ },
|
|
2676
|
+
{ },
|
|
2677
|
+
{ },
|
|
2678
|
+
body,
|
|
2679
|
+
['PureCloud OAuth'],
|
|
2680
|
+
['application/json'],
|
|
2681
|
+
['application/json']
|
|
2682
|
+
);
|
|
2683
|
+
}
|
|
2684
|
+
|
|
2685
|
+
/**
|
|
2686
|
+
* Create a summary setting.
|
|
2687
|
+
*
|
|
2688
|
+
* @param {Object} body
|
|
2689
|
+
*/
|
|
2690
|
+
postConversationsSummariesSettings(body) {
|
|
2691
|
+
// verify the required parameter 'body' is set
|
|
2692
|
+
if (body === undefined || body === null) {
|
|
2693
|
+
throw 'Missing the required parameter "body" when calling postConversationsSummariesSettings';
|
|
2694
|
+
}
|
|
2695
|
+
|
|
2696
|
+
return this.apiClient.callApi(
|
|
2697
|
+
'/api/v2/conversations/summaries/settings',
|
|
2698
|
+
'POST',
|
|
2699
|
+
{ },
|
|
2700
|
+
{ },
|
|
2701
|
+
{ },
|
|
2702
|
+
{ },
|
|
2703
|
+
body,
|
|
2704
|
+
['PureCloud OAuth'],
|
|
2705
|
+
['application/json'],
|
|
2706
|
+
['application/json']
|
|
2707
|
+
);
|
|
2708
|
+
}
|
|
2709
|
+
|
|
2579
2710
|
/**
|
|
2580
2711
|
* Start the publishing of a guide version.
|
|
2581
2712
|
*
|
|
@@ -2694,13 +2825,43 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2694
2825
|
);
|
|
2695
2826
|
}
|
|
2696
2827
|
|
|
2828
|
+
/**
|
|
2829
|
+
* Update a summary setting.
|
|
2830
|
+
*
|
|
2831
|
+
* @param {String} summarySettingId Summary setting id
|
|
2832
|
+
* @param {Object} body
|
|
2833
|
+
*/
|
|
2834
|
+
putConversationsSummariesSetting(summarySettingId, body) {
|
|
2835
|
+
// verify the required parameter 'summarySettingId' is set
|
|
2836
|
+
if (summarySettingId === undefined || summarySettingId === null || summarySettingId === '') {
|
|
2837
|
+
throw 'Missing the required parameter "summarySettingId" when calling putConversationsSummariesSetting';
|
|
2838
|
+
}
|
|
2839
|
+
// verify the required parameter 'body' is set
|
|
2840
|
+
if (body === undefined || body === null) {
|
|
2841
|
+
throw 'Missing the required parameter "body" when calling putConversationsSummariesSetting';
|
|
2842
|
+
}
|
|
2843
|
+
|
|
2844
|
+
return this.apiClient.callApi(
|
|
2845
|
+
'/api/v2/conversations/summaries/settings/{summarySettingId}',
|
|
2846
|
+
'PUT',
|
|
2847
|
+
{ 'summarySettingId': summarySettingId },
|
|
2848
|
+
{ },
|
|
2849
|
+
{ },
|
|
2850
|
+
{ },
|
|
2851
|
+
body,
|
|
2852
|
+
['PureCloud OAuth'],
|
|
2853
|
+
['application/json'],
|
|
2854
|
+
['application/json']
|
|
2855
|
+
);
|
|
2856
|
+
}
|
|
2857
|
+
|
|
2697
2858
|
}
|
|
2698
2859
|
|
|
2699
2860
|
class AgentAssistantsApi {
|
|
2700
2861
|
/**
|
|
2701
2862
|
* AgentAssistants service.
|
|
2702
2863
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2703
|
-
* @version
|
|
2864
|
+
* @version 231.0.0
|
|
2704
2865
|
*/
|
|
2705
2866
|
|
|
2706
2867
|
/**
|
|
@@ -3011,6 +3172,115 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3011
3172
|
);
|
|
3012
3173
|
}
|
|
3013
3174
|
|
|
3175
|
+
/**
|
|
3176
|
+
* Bulk add users to assistant-queue (requires manual assignment mode).
|
|
3177
|
+
*
|
|
3178
|
+
* @param {String} assistantId Assistant ID
|
|
3179
|
+
* @param {String} queueId Queue ID
|
|
3180
|
+
* @param {Object} body
|
|
3181
|
+
*/
|
|
3182
|
+
postAssistantQueueUsersBulkAdd(assistantId, queueId, body) {
|
|
3183
|
+
// verify the required parameter 'assistantId' is set
|
|
3184
|
+
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
3185
|
+
throw 'Missing the required parameter "assistantId" when calling postAssistantQueueUsersBulkAdd';
|
|
3186
|
+
}
|
|
3187
|
+
// verify the required parameter 'queueId' is set
|
|
3188
|
+
if (queueId === undefined || queueId === null || queueId === '') {
|
|
3189
|
+
throw 'Missing the required parameter "queueId" when calling postAssistantQueueUsersBulkAdd';
|
|
3190
|
+
}
|
|
3191
|
+
// verify the required parameter 'body' is set
|
|
3192
|
+
if (body === undefined || body === null) {
|
|
3193
|
+
throw 'Missing the required parameter "body" when calling postAssistantQueueUsersBulkAdd';
|
|
3194
|
+
}
|
|
3195
|
+
|
|
3196
|
+
return this.apiClient.callApi(
|
|
3197
|
+
'/api/v2/assistants/{assistantId}/queues/{queueId}/users/bulk/add',
|
|
3198
|
+
'POST',
|
|
3199
|
+
{ 'assistantId': assistantId,'queueId': queueId },
|
|
3200
|
+
{ },
|
|
3201
|
+
{ },
|
|
3202
|
+
{ },
|
|
3203
|
+
body,
|
|
3204
|
+
['PureCloud OAuth'],
|
|
3205
|
+
['application/json'],
|
|
3206
|
+
['application/json']
|
|
3207
|
+
);
|
|
3208
|
+
}
|
|
3209
|
+
|
|
3210
|
+
/**
|
|
3211
|
+
* Bulk remove users from assistant-queue (requires manual assignment mode).
|
|
3212
|
+
*
|
|
3213
|
+
* @param {String} assistantId Assistant ID
|
|
3214
|
+
* @param {String} queueId Queue ID
|
|
3215
|
+
* @param {Object} body
|
|
3216
|
+
*/
|
|
3217
|
+
postAssistantQueueUsersBulkRemove(assistantId, queueId, body) {
|
|
3218
|
+
// verify the required parameter 'assistantId' is set
|
|
3219
|
+
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
3220
|
+
throw 'Missing the required parameter "assistantId" when calling postAssistantQueueUsersBulkRemove';
|
|
3221
|
+
}
|
|
3222
|
+
// verify the required parameter 'queueId' is set
|
|
3223
|
+
if (queueId === undefined || queueId === null || queueId === '') {
|
|
3224
|
+
throw 'Missing the required parameter "queueId" when calling postAssistantQueueUsersBulkRemove';
|
|
3225
|
+
}
|
|
3226
|
+
// verify the required parameter 'body' is set
|
|
3227
|
+
if (body === undefined || body === null) {
|
|
3228
|
+
throw 'Missing the required parameter "body" when calling postAssistantQueueUsersBulkRemove';
|
|
3229
|
+
}
|
|
3230
|
+
|
|
3231
|
+
return this.apiClient.callApi(
|
|
3232
|
+
'/api/v2/assistants/{assistantId}/queues/{queueId}/users/bulk/remove',
|
|
3233
|
+
'POST',
|
|
3234
|
+
{ 'assistantId': assistantId,'queueId': queueId },
|
|
3235
|
+
{ },
|
|
3236
|
+
{ },
|
|
3237
|
+
{ },
|
|
3238
|
+
body,
|
|
3239
|
+
['PureCloud OAuth'],
|
|
3240
|
+
['application/json'],
|
|
3241
|
+
['application/json']
|
|
3242
|
+
);
|
|
3243
|
+
}
|
|
3244
|
+
|
|
3245
|
+
/**
|
|
3246
|
+
* Query for users in the assistant-queue (requires manual assignment mode).
|
|
3247
|
+
*
|
|
3248
|
+
* @param {String} assistantId Assistant ID
|
|
3249
|
+
* @param {String} queueId Queue ID
|
|
3250
|
+
* @param {Object} body
|
|
3251
|
+
* @param {Object} opts Optional parameters
|
|
3252
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand with.
|
|
3253
|
+
*/
|
|
3254
|
+
postAssistantQueueUsersQuery(assistantId, queueId, body, opts) {
|
|
3255
|
+
opts = opts || {};
|
|
3256
|
+
|
|
3257
|
+
// verify the required parameter 'assistantId' is set
|
|
3258
|
+
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
3259
|
+
throw 'Missing the required parameter "assistantId" when calling postAssistantQueueUsersQuery';
|
|
3260
|
+
}
|
|
3261
|
+
// verify the required parameter 'queueId' is set
|
|
3262
|
+
if (queueId === undefined || queueId === null || queueId === '') {
|
|
3263
|
+
throw 'Missing the required parameter "queueId" when calling postAssistantQueueUsersQuery';
|
|
3264
|
+
}
|
|
3265
|
+
// verify the required parameter 'body' is set
|
|
3266
|
+
if (body === undefined || body === null) {
|
|
3267
|
+
throw 'Missing the required parameter "body" when calling postAssistantQueueUsersQuery';
|
|
3268
|
+
}
|
|
3269
|
+
|
|
3270
|
+
return this.apiClient.callApi(
|
|
3271
|
+
'/api/v2/assistants/{assistantId}/queues/{queueId}/users/query',
|
|
3272
|
+
'POST',
|
|
3273
|
+
{ 'assistantId': assistantId,'queueId': queueId },
|
|
3274
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3275
|
+
{ },
|
|
3276
|
+
{ },
|
|
3277
|
+
body,
|
|
3278
|
+
['PureCloud OAuth'],
|
|
3279
|
+
['application/json'],
|
|
3280
|
+
['application/json']
|
|
3281
|
+
);
|
|
3282
|
+
}
|
|
3283
|
+
|
|
3014
3284
|
/**
|
|
3015
3285
|
* Create an Assistant.
|
|
3016
3286
|
*
|
|
@@ -3077,7 +3347,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3077
3347
|
/**
|
|
3078
3348
|
* AgentCopilot service.
|
|
3079
3349
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3080
|
-
* @version
|
|
3350
|
+
* @version 231.0.0
|
|
3081
3351
|
*/
|
|
3082
3352
|
|
|
3083
3353
|
/**
|
|
@@ -3153,7 +3423,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3153
3423
|
/**
|
|
3154
3424
|
* AgentUI service.
|
|
3155
3425
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
3156
|
-
* @version
|
|
3426
|
+
* @version 231.0.0
|
|
3157
3427
|
*/
|
|
3158
3428
|
|
|
3159
3429
|
/**
|
|
@@ -3284,7 +3554,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3284
3554
|
/**
|
|
3285
3555
|
* Alerting service.
|
|
3286
3556
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3287
|
-
* @version
|
|
3557
|
+
* @version 231.0.0
|
|
3288
3558
|
*/
|
|
3289
3559
|
|
|
3290
3560
|
/**
|
|
@@ -3685,7 +3955,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3685
3955
|
/**
|
|
3686
3956
|
* Analytics service.
|
|
3687
3957
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3688
|
-
* @version
|
|
3958
|
+
* @version 231.0.0
|
|
3689
3959
|
*/
|
|
3690
3960
|
|
|
3691
3961
|
/**
|
|
@@ -4617,6 +4887,62 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4617
4887
|
);
|
|
4618
4888
|
}
|
|
4619
4889
|
|
|
4890
|
+
/**
|
|
4891
|
+
* Get analytics data warehouse file download
|
|
4892
|
+
*
|
|
4893
|
+
* @param {String} downloadId Unique file Id to download
|
|
4894
|
+
* getAnalyticsDataextractionDownload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4895
|
+
*/
|
|
4896
|
+
getAnalyticsDataextractionDownload(downloadId) {
|
|
4897
|
+
// verify the required parameter 'downloadId' is set
|
|
4898
|
+
if (downloadId === undefined || downloadId === null || downloadId === '') {
|
|
4899
|
+
throw 'Missing the required parameter "downloadId" when calling getAnalyticsDataextractionDownload';
|
|
4900
|
+
}
|
|
4901
|
+
|
|
4902
|
+
return this.apiClient.callApi(
|
|
4903
|
+
'/api/v2/analytics/dataextraction/downloads/{downloadId}',
|
|
4904
|
+
'GET',
|
|
4905
|
+
{ 'downloadId': downloadId },
|
|
4906
|
+
{ },
|
|
4907
|
+
{ },
|
|
4908
|
+
{ },
|
|
4909
|
+
null,
|
|
4910
|
+
['PureCloud OAuth'],
|
|
4911
|
+
['application/json'],
|
|
4912
|
+
['application/json']
|
|
4913
|
+
);
|
|
4914
|
+
}
|
|
4915
|
+
|
|
4916
|
+
/**
|
|
4917
|
+
* Get metadata on files available for extraction
|
|
4918
|
+
*
|
|
4919
|
+
* @param {Object} opts Optional parameters
|
|
4920
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
4921
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
4922
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
4923
|
+
* @param {String} opts.dataSchema Data schema like conversations
|
|
4924
|
+
* @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
|
|
4925
|
+
* @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
|
|
4926
|
+
* getAnalyticsDataextractionDownloadsMetadata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4927
|
+
*/
|
|
4928
|
+
getAnalyticsDataextractionDownloadsMetadata(opts) {
|
|
4929
|
+
opts = opts || {};
|
|
4930
|
+
|
|
4931
|
+
|
|
4932
|
+
return this.apiClient.callApi(
|
|
4933
|
+
'/api/v2/analytics/dataextraction/downloads/metadata',
|
|
4934
|
+
'GET',
|
|
4935
|
+
{ },
|
|
4936
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'dataSchema': opts['dataSchema'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'] },
|
|
4937
|
+
{ },
|
|
4938
|
+
{ },
|
|
4939
|
+
null,
|
|
4940
|
+
['PureCloud OAuth'],
|
|
4941
|
+
['application/json'],
|
|
4942
|
+
['application/json']
|
|
4943
|
+
);
|
|
4944
|
+
}
|
|
4945
|
+
|
|
4620
4946
|
/**
|
|
4621
4947
|
* Get analytics data retention setting
|
|
4622
4948
|
*
|
|
@@ -5909,6 +6235,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5909
6235
|
);
|
|
5910
6236
|
}
|
|
5911
6237
|
|
|
6238
|
+
/**
|
|
6239
|
+
* Get download URLs for analytics data warehouse files
|
|
6240
|
+
*
|
|
6241
|
+
* @param {Object} body request
|
|
6242
|
+
* postAnalyticsDataextractionDownloadsBulk is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6243
|
+
*/
|
|
6244
|
+
postAnalyticsDataextractionDownloadsBulk(body) {
|
|
6245
|
+
// verify the required parameter 'body' is set
|
|
6246
|
+
if (body === undefined || body === null) {
|
|
6247
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsDataextractionDownloadsBulk';
|
|
6248
|
+
}
|
|
6249
|
+
|
|
6250
|
+
return this.apiClient.callApi(
|
|
6251
|
+
'/api/v2/analytics/dataextraction/downloads/bulk',
|
|
6252
|
+
'POST',
|
|
6253
|
+
{ },
|
|
6254
|
+
{ },
|
|
6255
|
+
{ },
|
|
6256
|
+
{ },
|
|
6257
|
+
body,
|
|
6258
|
+
['PureCloud OAuth'],
|
|
6259
|
+
['application/json'],
|
|
6260
|
+
['application/json']
|
|
6261
|
+
);
|
|
6262
|
+
}
|
|
6263
|
+
|
|
5912
6264
|
/**
|
|
5913
6265
|
* Query for evaluation aggregates asynchronously
|
|
5914
6266
|
*
|
|
@@ -6871,7 +7223,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6871
7223
|
/**
|
|
6872
7224
|
* Architect service.
|
|
6873
7225
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6874
|
-
* @version
|
|
7226
|
+
* @version 231.0.0
|
|
6875
7227
|
*/
|
|
6876
7228
|
|
|
6877
7229
|
/**
|
|
@@ -11166,7 +11518,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11166
11518
|
/**
|
|
11167
11519
|
* Audit service.
|
|
11168
11520
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
11169
|
-
* @version
|
|
11521
|
+
* @version 231.0.0
|
|
11170
11522
|
*/
|
|
11171
11523
|
|
|
11172
11524
|
/**
|
|
@@ -11367,7 +11719,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11367
11719
|
/**
|
|
11368
11720
|
* Authorization service.
|
|
11369
11721
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
11370
|
-
* @version
|
|
11722
|
+
* @version 231.0.0
|
|
11371
11723
|
*/
|
|
11372
11724
|
|
|
11373
11725
|
/**
|
|
@@ -13082,7 +13434,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13082
13434
|
/**
|
|
13083
13435
|
* Billing service.
|
|
13084
13436
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
13085
|
-
* @version
|
|
13437
|
+
* @version 231.0.0
|
|
13086
13438
|
*/
|
|
13087
13439
|
|
|
13088
13440
|
/**
|
|
@@ -13338,7 +13690,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13338
13690
|
/**
|
|
13339
13691
|
* BusinessRules service.
|
|
13340
13692
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
13341
|
-
* @version
|
|
13693
|
+
* @version 231.0.0
|
|
13342
13694
|
*/
|
|
13343
13695
|
|
|
13344
13696
|
/**
|
|
@@ -14254,7 +14606,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14254
14606
|
/**
|
|
14255
14607
|
* CarrierServices service.
|
|
14256
14608
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
14257
|
-
* @version
|
|
14609
|
+
* @version 231.0.0
|
|
14258
14610
|
*/
|
|
14259
14611
|
|
|
14260
14612
|
/**
|
|
@@ -14324,7 +14676,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14324
14676
|
/**
|
|
14325
14677
|
* Chat service.
|
|
14326
14678
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
14327
|
-
* @version
|
|
14679
|
+
* @version 231.0.0
|
|
14328
14680
|
*/
|
|
14329
14681
|
|
|
14330
14682
|
/**
|
|
@@ -15305,7 +15657,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15305
15657
|
/**
|
|
15306
15658
|
* Coaching service.
|
|
15307
15659
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
15308
|
-
* @version
|
|
15660
|
+
* @version 231.0.0
|
|
15309
15661
|
*/
|
|
15310
15662
|
|
|
15311
15663
|
/**
|
|
@@ -15882,7 +16234,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15882
16234
|
/**
|
|
15883
16235
|
* ContentManagement service.
|
|
15884
16236
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
15885
|
-
* @version
|
|
16237
|
+
* @version 231.0.0
|
|
15886
16238
|
*/
|
|
15887
16239
|
|
|
15888
16240
|
/**
|
|
@@ -16963,7 +17315,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16963
17315
|
/**
|
|
16964
17316
|
* Conversations service.
|
|
16965
17317
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
16966
|
-
* @version
|
|
17318
|
+
* @version 231.0.0
|
|
16967
17319
|
*/
|
|
16968
17320
|
|
|
16969
17321
|
/**
|
|
@@ -17029,6 +17381,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17029
17381
|
);
|
|
17030
17382
|
}
|
|
17031
17383
|
|
|
17384
|
+
/**
|
|
17385
|
+
* Update a conversation by disconnecting all of the participants
|
|
17386
|
+
*
|
|
17387
|
+
* @param {String} conversationId conversation ID
|
|
17388
|
+
*/
|
|
17389
|
+
deleteConversation(conversationId) {
|
|
17390
|
+
// verify the required parameter 'conversationId' is set
|
|
17391
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
17392
|
+
throw 'Missing the required parameter "conversationId" when calling deleteConversation';
|
|
17393
|
+
}
|
|
17394
|
+
|
|
17395
|
+
return this.apiClient.callApi(
|
|
17396
|
+
'/api/v2/conversations/{conversationId}',
|
|
17397
|
+
'DELETE',
|
|
17398
|
+
{ 'conversationId': conversationId },
|
|
17399
|
+
{ },
|
|
17400
|
+
{ },
|
|
17401
|
+
{ },
|
|
17402
|
+
null,
|
|
17403
|
+
['PureCloud OAuth'],
|
|
17404
|
+
['application/json'],
|
|
17405
|
+
['application/json']
|
|
17406
|
+
);
|
|
17407
|
+
}
|
|
17408
|
+
|
|
17032
17409
|
/**
|
|
17033
17410
|
* Delete a code used to add a communication to this participant
|
|
17034
17411
|
*
|
|
@@ -20239,6 +20616,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20239
20616
|
);
|
|
20240
20617
|
}
|
|
20241
20618
|
|
|
20619
|
+
/**
|
|
20620
|
+
* Update a conversation by setting its recording state
|
|
20621
|
+
*
|
|
20622
|
+
* @param {String} conversationId conversation ID
|
|
20623
|
+
* @param {Object} body SetRecordingState
|
|
20624
|
+
*/
|
|
20625
|
+
patchConversationRecordingstate(conversationId, body) {
|
|
20626
|
+
// verify the required parameter 'conversationId' is set
|
|
20627
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
20628
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationRecordingstate';
|
|
20629
|
+
}
|
|
20630
|
+
// verify the required parameter 'body' is set
|
|
20631
|
+
if (body === undefined || body === null) {
|
|
20632
|
+
throw 'Missing the required parameter "body" when calling patchConversationRecordingstate';
|
|
20633
|
+
}
|
|
20634
|
+
|
|
20635
|
+
return this.apiClient.callApi(
|
|
20636
|
+
'/api/v2/conversations/{conversationId}/recordingstate',
|
|
20637
|
+
'PATCH',
|
|
20638
|
+
{ 'conversationId': conversationId },
|
|
20639
|
+
{ },
|
|
20640
|
+
{ },
|
|
20641
|
+
{ },
|
|
20642
|
+
body,
|
|
20643
|
+
['PureCloud OAuth'],
|
|
20644
|
+
['application/json'],
|
|
20645
|
+
['application/json']
|
|
20646
|
+
);
|
|
20647
|
+
}
|
|
20648
|
+
|
|
20242
20649
|
/**
|
|
20243
20650
|
* Update the secure attributes on a conversation.
|
|
20244
20651
|
*
|
|
@@ -20437,6 +20844,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20437
20844
|
);
|
|
20438
20845
|
}
|
|
20439
20846
|
|
|
20847
|
+
/**
|
|
20848
|
+
* Update a conversation by merging in other conversations to create a conference
|
|
20849
|
+
*
|
|
20850
|
+
* @param {String} conversationId conversationId
|
|
20851
|
+
* @param {Object} body UpdateConferenceRequest
|
|
20852
|
+
*/
|
|
20853
|
+
patchConversationsCallConference(conversationId, body) {
|
|
20854
|
+
// verify the required parameter 'conversationId' is set
|
|
20855
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
20856
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationsCallConference';
|
|
20857
|
+
}
|
|
20858
|
+
// verify the required parameter 'body' is set
|
|
20859
|
+
if (body === undefined || body === null) {
|
|
20860
|
+
throw 'Missing the required parameter "body" when calling patchConversationsCallConference';
|
|
20861
|
+
}
|
|
20862
|
+
|
|
20863
|
+
return this.apiClient.callApi(
|
|
20864
|
+
'/api/v2/conversations/calls/{conversationId}/conference',
|
|
20865
|
+
'PATCH',
|
|
20866
|
+
{ 'conversationId': conversationId },
|
|
20867
|
+
{ },
|
|
20868
|
+
{ },
|
|
20869
|
+
{ },
|
|
20870
|
+
body,
|
|
20871
|
+
['PureCloud OAuth'],
|
|
20872
|
+
['application/json'],
|
|
20873
|
+
['application/json']
|
|
20874
|
+
);
|
|
20875
|
+
}
|
|
20876
|
+
|
|
20440
20877
|
/**
|
|
20441
20878
|
* Update conversation participant
|
|
20442
20879
|
*
|
|
@@ -22830,6 +23267,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22830
23267
|
);
|
|
22831
23268
|
}
|
|
22832
23269
|
|
|
23270
|
+
/**
|
|
23271
|
+
* Add participants to a conversation without a user context
|
|
23272
|
+
*
|
|
23273
|
+
* @param {String} conversationId conversationId
|
|
23274
|
+
* @param {String} userId userId
|
|
23275
|
+
* @param {Object} body Conversation
|
|
23276
|
+
*/
|
|
23277
|
+
postConversationsCallParticipantsUserUserId(conversationId, userId, body) {
|
|
23278
|
+
// verify the required parameter 'conversationId' is set
|
|
23279
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
23280
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantsUserUserId';
|
|
23281
|
+
}
|
|
23282
|
+
// verify the required parameter 'userId' is set
|
|
23283
|
+
if (userId === undefined || userId === null || userId === '') {
|
|
23284
|
+
throw 'Missing the required parameter "userId" when calling postConversationsCallParticipantsUserUserId';
|
|
23285
|
+
}
|
|
23286
|
+
// verify the required parameter 'body' is set
|
|
23287
|
+
if (body === undefined || body === null) {
|
|
23288
|
+
throw 'Missing the required parameter "body" when calling postConversationsCallParticipantsUserUserId';
|
|
23289
|
+
}
|
|
23290
|
+
|
|
23291
|
+
return this.apiClient.callApi(
|
|
23292
|
+
'/api/v2/conversations/calls/{conversationId}/participants/user/{userId}',
|
|
23293
|
+
'POST',
|
|
23294
|
+
{ 'conversationId': conversationId,'userId': userId },
|
|
23295
|
+
{ },
|
|
23296
|
+
{ },
|
|
23297
|
+
{ },
|
|
23298
|
+
body,
|
|
23299
|
+
['PureCloud OAuth'],
|
|
23300
|
+
['application/json'],
|
|
23301
|
+
['application/json']
|
|
23302
|
+
);
|
|
23303
|
+
}
|
|
23304
|
+
|
|
22833
23305
|
/**
|
|
22834
23306
|
* Apply wrap-up for this conversation communication
|
|
22835
23307
|
*
|
|
@@ -23004,6 +23476,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23004
23476
|
);
|
|
23005
23477
|
}
|
|
23006
23478
|
|
|
23479
|
+
/**
|
|
23480
|
+
* Create a call conversation on behalf of a user
|
|
23481
|
+
*
|
|
23482
|
+
* @param {String} userId userId
|
|
23483
|
+
* @param {Object} body Call request
|
|
23484
|
+
*/
|
|
23485
|
+
postConversationsCallsUserUserId(userId, body) {
|
|
23486
|
+
// verify the required parameter 'userId' is set
|
|
23487
|
+
if (userId === undefined || userId === null || userId === '') {
|
|
23488
|
+
throw 'Missing the required parameter "userId" when calling postConversationsCallsUserUserId';
|
|
23489
|
+
}
|
|
23490
|
+
// verify the required parameter 'body' is set
|
|
23491
|
+
if (body === undefined || body === null) {
|
|
23492
|
+
throw 'Missing the required parameter "body" when calling postConversationsCallsUserUserId';
|
|
23493
|
+
}
|
|
23494
|
+
|
|
23495
|
+
return this.apiClient.callApi(
|
|
23496
|
+
'/api/v2/conversations/calls/user/{userId}',
|
|
23497
|
+
'POST',
|
|
23498
|
+
{ 'userId': userId },
|
|
23499
|
+
{ },
|
|
23500
|
+
{ },
|
|
23501
|
+
{ },
|
|
23502
|
+
body,
|
|
23503
|
+
['PureCloud OAuth'],
|
|
23504
|
+
['application/json'],
|
|
23505
|
+
['application/json']
|
|
23506
|
+
);
|
|
23507
|
+
}
|
|
23508
|
+
|
|
23007
23509
|
/**
|
|
23008
23510
|
* Send a message on behalf of a communication in a chat conversation.
|
|
23009
23511
|
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
@@ -23414,7 +23916,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23414
23916
|
|
|
23415
23917
|
/**
|
|
23416
23918
|
* Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation
|
|
23417
|
-
*
|
|
23919
|
+
* This request is not valid when using the Client Credentials OAuth grant.
|
|
23418
23920
|
* @param {String} conversationId conversationId
|
|
23419
23921
|
*/
|
|
23420
23922
|
postConversationsEmailReconnect(conversationId) {
|
|
@@ -25201,7 +25703,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25201
25703
|
/**
|
|
25202
25704
|
* DataExtensions service.
|
|
25203
25705
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
25204
|
-
* @version
|
|
25706
|
+
* @version 231.0.0
|
|
25205
25707
|
*/
|
|
25206
25708
|
|
|
25207
25709
|
/**
|
|
@@ -25287,7 +25789,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25287
25789
|
/**
|
|
25288
25790
|
* DataPrivacy service.
|
|
25289
25791
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
25290
|
-
* @version
|
|
25792
|
+
* @version 231.0.0
|
|
25291
25793
|
*/
|
|
25292
25794
|
|
|
25293
25795
|
/**
|
|
@@ -25457,7 +25959,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25457
25959
|
/**
|
|
25458
25960
|
* Downloads service.
|
|
25459
25961
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
25460
|
-
* @version
|
|
25962
|
+
* @version 231.0.0
|
|
25461
25963
|
*/
|
|
25462
25964
|
|
|
25463
25965
|
/**
|
|
@@ -25509,7 +26011,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25509
26011
|
/**
|
|
25510
26012
|
* Emails service.
|
|
25511
26013
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
25512
|
-
* @version
|
|
26014
|
+
* @version 231.0.0
|
|
25513
26015
|
*/
|
|
25514
26016
|
|
|
25515
26017
|
/**
|
|
@@ -25638,7 +26140,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25638
26140
|
/**
|
|
25639
26141
|
* EmployeeEngagement service.
|
|
25640
26142
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
25641
|
-
* @version
|
|
26143
|
+
* @version 231.0.0
|
|
25642
26144
|
*/
|
|
25643
26145
|
|
|
25644
26146
|
/**
|
|
@@ -25789,7 +26291,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25789
26291
|
/**
|
|
25790
26292
|
* Events service.
|
|
25791
26293
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
25792
|
-
* @version
|
|
26294
|
+
* @version 231.0.0
|
|
25793
26295
|
*/
|
|
25794
26296
|
|
|
25795
26297
|
/**
|
|
@@ -25885,7 +26387,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25885
26387
|
/**
|
|
25886
26388
|
* ExternalContacts service.
|
|
25887
26389
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
25888
|
-
* @version
|
|
26390
|
+
* @version 231.0.0
|
|
25889
26391
|
*/
|
|
25890
26392
|
|
|
25891
26393
|
/**
|
|
@@ -29132,7 +29634,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29132
29634
|
/**
|
|
29133
29635
|
* Fax service.
|
|
29134
29636
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
29135
|
-
* @version
|
|
29637
|
+
* @version 231.0.0
|
|
29136
29638
|
*/
|
|
29137
29639
|
|
|
29138
29640
|
/**
|
|
@@ -29347,7 +29849,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29347
29849
|
/**
|
|
29348
29850
|
* Flows service.
|
|
29349
29851
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
29350
|
-
* @version
|
|
29852
|
+
* @version 231.0.0
|
|
29351
29853
|
*/
|
|
29352
29854
|
|
|
29353
29855
|
/**
|
|
@@ -29556,7 +30058,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29556
30058
|
/**
|
|
29557
30059
|
* Gamification service.
|
|
29558
30060
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
29559
|
-
* @version
|
|
30061
|
+
* @version 231.0.0
|
|
29560
30062
|
*/
|
|
29561
30063
|
|
|
29562
30064
|
/**
|
|
@@ -32063,7 +32565,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32063
32565
|
/**
|
|
32064
32566
|
* GeneralDataProtectionRegulation service.
|
|
32065
32567
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
32066
|
-
* @version
|
|
32568
|
+
* @version 231.0.0
|
|
32067
32569
|
*/
|
|
32068
32570
|
|
|
32069
32571
|
/**
|
|
@@ -32193,7 +32695,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32193
32695
|
/**
|
|
32194
32696
|
* Geolocation service.
|
|
32195
32697
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
32196
|
-
* @version
|
|
32698
|
+
* @version 231.0.0
|
|
32197
32699
|
*/
|
|
32198
32700
|
|
|
32199
32701
|
/**
|
|
@@ -32324,7 +32826,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32324
32826
|
/**
|
|
32325
32827
|
* Greetings service.
|
|
32326
32828
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
32327
|
-
* @version
|
|
32829
|
+
* @version 231.0.0
|
|
32328
32830
|
*/
|
|
32329
32831
|
|
|
32330
32832
|
/**
|
|
@@ -32866,7 +33368,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32866
33368
|
/**
|
|
32867
33369
|
* Groups service.
|
|
32868
33370
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
32869
|
-
* @version
|
|
33371
|
+
* @version 231.0.0
|
|
32870
33372
|
*/
|
|
32871
33373
|
|
|
32872
33374
|
/**
|
|
@@ -33385,7 +33887,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33385
33887
|
/**
|
|
33386
33888
|
* IdentityProvider service.
|
|
33387
33889
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
33388
|
-
* @version
|
|
33890
|
+
* @version 231.0.0
|
|
33389
33891
|
*/
|
|
33390
33892
|
|
|
33391
33893
|
/**
|
|
@@ -34246,7 +34748,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34246
34748
|
/**
|
|
34247
34749
|
* InfrastructureAsCode service.
|
|
34248
34750
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
34249
|
-
* @version
|
|
34751
|
+
* @version 231.0.0
|
|
34250
34752
|
*/
|
|
34251
34753
|
|
|
34252
34754
|
/**
|
|
@@ -34413,7 +34915,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34413
34915
|
/**
|
|
34414
34916
|
* Integrations service.
|
|
34415
34917
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
34416
|
-
* @version
|
|
34918
|
+
* @version 231.0.0
|
|
34417
34919
|
*/
|
|
34418
34920
|
|
|
34419
34921
|
/**
|
|
@@ -37058,7 +37560,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37058
37560
|
/**
|
|
37059
37561
|
* Journey service.
|
|
37060
37562
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
37061
|
-
* @version
|
|
37563
|
+
* @version 231.0.0
|
|
37062
37564
|
*/
|
|
37063
37565
|
|
|
37064
37566
|
/**
|
|
@@ -38346,6 +38848,33 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38346
38848
|
);
|
|
38347
38849
|
}
|
|
38348
38850
|
|
|
38851
|
+
/**
|
|
38852
|
+
* Get my jobs
|
|
38853
|
+
*
|
|
38854
|
+
* @param {Object} opts Optional parameters
|
|
38855
|
+
* @param {Number} opts.pageNumber The number of the page to return (default to 1)
|
|
38856
|
+
* @param {Number} opts.pageSize Max number of entities to return (default to 25)
|
|
38857
|
+
* @param {String} opts.interval An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.
|
|
38858
|
+
* @param {String} opts.statuses Job statuses to filter for
|
|
38859
|
+
*/
|
|
38860
|
+
getJourneyViewsJobsMe(opts) {
|
|
38861
|
+
opts = opts || {};
|
|
38862
|
+
|
|
38863
|
+
|
|
38864
|
+
return this.apiClient.callApi(
|
|
38865
|
+
'/api/v2/journey/views/jobs/me',
|
|
38866
|
+
'GET',
|
|
38867
|
+
{ },
|
|
38868
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'interval': opts['interval'],'statuses': opts['statuses'] },
|
|
38869
|
+
{ },
|
|
38870
|
+
{ },
|
|
38871
|
+
null,
|
|
38872
|
+
['PureCloud OAuth'],
|
|
38873
|
+
['application/json'],
|
|
38874
|
+
['application/json']
|
|
38875
|
+
);
|
|
38876
|
+
}
|
|
38877
|
+
|
|
38349
38878
|
/**
|
|
38350
38879
|
* Get the journey schedules for an organization.
|
|
38351
38880
|
*
|
|
@@ -39128,7 +39657,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39128
39657
|
/**
|
|
39129
39658
|
* Knowledge service.
|
|
39130
39659
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
39131
|
-
* @version
|
|
39660
|
+
* @version 231.0.0
|
|
39132
39661
|
*/
|
|
39133
39662
|
|
|
39134
39663
|
/**
|
|
@@ -43030,7 +43559,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43030
43559
|
/**
|
|
43031
43560
|
* LanguageUnderstanding service.
|
|
43032
43561
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
43033
|
-
* @version
|
|
43562
|
+
* @version 231.0.0
|
|
43034
43563
|
*/
|
|
43035
43564
|
|
|
43036
43565
|
/**
|
|
@@ -43404,6 +43933,72 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43404
43933
|
);
|
|
43405
43934
|
}
|
|
43406
43935
|
|
|
43936
|
+
/**
|
|
43937
|
+
* Get list of all ignored phrases of the specified language code
|
|
43938
|
+
*
|
|
43939
|
+
* @param {String} languageCode Language Code
|
|
43940
|
+
* @param {Object} opts Optional parameters
|
|
43941
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 200. (default to 25)
|
|
43942
|
+
* @param {Number} opts.pageNumber The page number for the listing (default to 1)
|
|
43943
|
+
* @param {String} opts.text The phrase text filter applied to the listing
|
|
43944
|
+
* @param {Object} opts.sortOrder The sort order for the listing (default to desc)
|
|
43945
|
+
* @param {Object} opts.sortBy The field to sort by for the listing (default to dateModified)
|
|
43946
|
+
*/
|
|
43947
|
+
getLanguageunderstandingIgnorephrase(languageCode, opts) {
|
|
43948
|
+
opts = opts || {};
|
|
43949
|
+
|
|
43950
|
+
// verify the required parameter 'languageCode' is set
|
|
43951
|
+
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
43952
|
+
throw 'Missing the required parameter "languageCode" when calling getLanguageunderstandingIgnorephrase';
|
|
43953
|
+
}
|
|
43954
|
+
|
|
43955
|
+
return this.apiClient.callApi(
|
|
43956
|
+
'/api/v2/languageunderstanding/ignorephrases/{languageCode}',
|
|
43957
|
+
'GET',
|
|
43958
|
+
{ 'languageCode': languageCode },
|
|
43959
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'text': opts['text'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'] },
|
|
43960
|
+
{ },
|
|
43961
|
+
{ },
|
|
43962
|
+
null,
|
|
43963
|
+
['PureCloud OAuth'],
|
|
43964
|
+
['application/json'],
|
|
43965
|
+
['application/json']
|
|
43966
|
+
);
|
|
43967
|
+
}
|
|
43968
|
+
|
|
43969
|
+
/**
|
|
43970
|
+
* Get list of all ignored topics of the specified language code
|
|
43971
|
+
*
|
|
43972
|
+
* @param {String} languageCode Language Code
|
|
43973
|
+
* @param {Object} opts Optional parameters
|
|
43974
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 200. (default to 25)
|
|
43975
|
+
* @param {Number} opts.pageNumber The page number for the listing (default to 1)
|
|
43976
|
+
* @param {String} opts.text The topic text filter applied to the listing
|
|
43977
|
+
* @param {Object} opts.sortOrder The sort order for the listing (default to desc)
|
|
43978
|
+
* @param {Object} opts.sortBy The field to sort by for the listing (default to dateModified)
|
|
43979
|
+
*/
|
|
43980
|
+
getLanguageunderstandingIgnoretopic(languageCode, opts) {
|
|
43981
|
+
opts = opts || {};
|
|
43982
|
+
|
|
43983
|
+
// verify the required parameter 'languageCode' is set
|
|
43984
|
+
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
43985
|
+
throw 'Missing the required parameter "languageCode" when calling getLanguageunderstandingIgnoretopic';
|
|
43986
|
+
}
|
|
43987
|
+
|
|
43988
|
+
return this.apiClient.callApi(
|
|
43989
|
+
'/api/v2/languageunderstanding/ignoretopics/{languageCode}',
|
|
43990
|
+
'GET',
|
|
43991
|
+
{ 'languageCode': languageCode },
|
|
43992
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'text': opts['text'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'] },
|
|
43993
|
+
{ },
|
|
43994
|
+
{ },
|
|
43995
|
+
null,
|
|
43996
|
+
['PureCloud OAuth'],
|
|
43997
|
+
['application/json'],
|
|
43998
|
+
['application/json']
|
|
43999
|
+
);
|
|
44000
|
+
}
|
|
44001
|
+
|
|
43407
44002
|
/**
|
|
43408
44003
|
* Get information about a miner.
|
|
43409
44004
|
*
|
|
@@ -43938,6 +44533,126 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43938
44533
|
);
|
|
43939
44534
|
}
|
|
43940
44535
|
|
|
44536
|
+
/**
|
|
44537
|
+
* Add phrases to the ignored phrases list
|
|
44538
|
+
*
|
|
44539
|
+
* @param {String} languageCode Language Code
|
|
44540
|
+
* @param {Object} body Request body containing phrases to be ignored
|
|
44541
|
+
*/
|
|
44542
|
+
postLanguageunderstandingIgnorephrase(languageCode, body) {
|
|
44543
|
+
// verify the required parameter 'languageCode' is set
|
|
44544
|
+
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
44545
|
+
throw 'Missing the required parameter "languageCode" when calling postLanguageunderstandingIgnorephrase';
|
|
44546
|
+
}
|
|
44547
|
+
// verify the required parameter 'body' is set
|
|
44548
|
+
if (body === undefined || body === null) {
|
|
44549
|
+
throw 'Missing the required parameter "body" when calling postLanguageunderstandingIgnorephrase';
|
|
44550
|
+
}
|
|
44551
|
+
|
|
44552
|
+
return this.apiClient.callApi(
|
|
44553
|
+
'/api/v2/languageunderstanding/ignorephrases/{languageCode}',
|
|
44554
|
+
'POST',
|
|
44555
|
+
{ 'languageCode': languageCode },
|
|
44556
|
+
{ },
|
|
44557
|
+
{ },
|
|
44558
|
+
{ },
|
|
44559
|
+
body,
|
|
44560
|
+
['PureCloud OAuth'],
|
|
44561
|
+
['application/json'],
|
|
44562
|
+
['application/json']
|
|
44563
|
+
);
|
|
44564
|
+
}
|
|
44565
|
+
|
|
44566
|
+
/**
|
|
44567
|
+
* Delete ignored phrases
|
|
44568
|
+
*
|
|
44569
|
+
* @param {String} languageCode Language Code
|
|
44570
|
+
* @param {Object} body Request body containing entities to be removed
|
|
44571
|
+
*/
|
|
44572
|
+
postLanguageunderstandingIgnorephraseRemove(languageCode, body) {
|
|
44573
|
+
// verify the required parameter 'languageCode' is set
|
|
44574
|
+
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
44575
|
+
throw 'Missing the required parameter "languageCode" when calling postLanguageunderstandingIgnorephraseRemove';
|
|
44576
|
+
}
|
|
44577
|
+
// verify the required parameter 'body' is set
|
|
44578
|
+
if (body === undefined || body === null) {
|
|
44579
|
+
throw 'Missing the required parameter "body" when calling postLanguageunderstandingIgnorephraseRemove';
|
|
44580
|
+
}
|
|
44581
|
+
|
|
44582
|
+
return this.apiClient.callApi(
|
|
44583
|
+
'/api/v2/languageunderstanding/ignorephrases/{languageCode}/remove',
|
|
44584
|
+
'POST',
|
|
44585
|
+
{ 'languageCode': languageCode },
|
|
44586
|
+
{ },
|
|
44587
|
+
{ },
|
|
44588
|
+
{ },
|
|
44589
|
+
body,
|
|
44590
|
+
['PureCloud OAuth'],
|
|
44591
|
+
['application/json'],
|
|
44592
|
+
['application/json']
|
|
44593
|
+
);
|
|
44594
|
+
}
|
|
44595
|
+
|
|
44596
|
+
/**
|
|
44597
|
+
* Add topics to the ignored topics list
|
|
44598
|
+
*
|
|
44599
|
+
* @param {String} languageCode Language Code
|
|
44600
|
+
* @param {Object} body Request body containing topics to be ignored
|
|
44601
|
+
*/
|
|
44602
|
+
postLanguageunderstandingIgnoretopic(languageCode, body) {
|
|
44603
|
+
// verify the required parameter 'languageCode' is set
|
|
44604
|
+
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
44605
|
+
throw 'Missing the required parameter "languageCode" when calling postLanguageunderstandingIgnoretopic';
|
|
44606
|
+
}
|
|
44607
|
+
// verify the required parameter 'body' is set
|
|
44608
|
+
if (body === undefined || body === null) {
|
|
44609
|
+
throw 'Missing the required parameter "body" when calling postLanguageunderstandingIgnoretopic';
|
|
44610
|
+
}
|
|
44611
|
+
|
|
44612
|
+
return this.apiClient.callApi(
|
|
44613
|
+
'/api/v2/languageunderstanding/ignoretopics/{languageCode}',
|
|
44614
|
+
'POST',
|
|
44615
|
+
{ 'languageCode': languageCode },
|
|
44616
|
+
{ },
|
|
44617
|
+
{ },
|
|
44618
|
+
{ },
|
|
44619
|
+
body,
|
|
44620
|
+
['PureCloud OAuth'],
|
|
44621
|
+
['application/json'],
|
|
44622
|
+
['application/json']
|
|
44623
|
+
);
|
|
44624
|
+
}
|
|
44625
|
+
|
|
44626
|
+
/**
|
|
44627
|
+
* Delete ignored topics
|
|
44628
|
+
*
|
|
44629
|
+
* @param {String} languageCode Language Code
|
|
44630
|
+
* @param {Object} body Request body containing entities to be removed
|
|
44631
|
+
*/
|
|
44632
|
+
postLanguageunderstandingIgnoretopicRemove(languageCode, body) {
|
|
44633
|
+
// verify the required parameter 'languageCode' is set
|
|
44634
|
+
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
44635
|
+
throw 'Missing the required parameter "languageCode" when calling postLanguageunderstandingIgnoretopicRemove';
|
|
44636
|
+
}
|
|
44637
|
+
// verify the required parameter 'body' is set
|
|
44638
|
+
if (body === undefined || body === null) {
|
|
44639
|
+
throw 'Missing the required parameter "body" when calling postLanguageunderstandingIgnoretopicRemove';
|
|
44640
|
+
}
|
|
44641
|
+
|
|
44642
|
+
return this.apiClient.callApi(
|
|
44643
|
+
'/api/v2/languageunderstanding/ignoretopics/{languageCode}/remove',
|
|
44644
|
+
'POST',
|
|
44645
|
+
{ 'languageCode': languageCode },
|
|
44646
|
+
{ },
|
|
44647
|
+
{ },
|
|
44648
|
+
{ },
|
|
44649
|
+
body,
|
|
44650
|
+
['PureCloud OAuth'],
|
|
44651
|
+
['application/json'],
|
|
44652
|
+
['application/json']
|
|
44653
|
+
);
|
|
44654
|
+
}
|
|
44655
|
+
|
|
43941
44656
|
/**
|
|
43942
44657
|
* Create a new draft resource.
|
|
43943
44658
|
*
|
|
@@ -44063,7 +44778,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44063
44778
|
/**
|
|
44064
44779
|
* Languages service.
|
|
44065
44780
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
44066
|
-
* @version
|
|
44781
|
+
* @version 231.0.0
|
|
44067
44782
|
*/
|
|
44068
44783
|
|
|
44069
44784
|
/**
|
|
@@ -44285,7 +45000,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44285
45000
|
/**
|
|
44286
45001
|
* Learning service.
|
|
44287
45002
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
44288
|
-
* @version
|
|
45003
|
+
* @version 231.0.0
|
|
44289
45004
|
*/
|
|
44290
45005
|
|
|
44291
45006
|
/**
|
|
@@ -45314,7 +46029,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45314
46029
|
/**
|
|
45315
46030
|
* License service.
|
|
45316
46031
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
45317
|
-
* @version
|
|
46032
|
+
* @version 231.0.0
|
|
45318
46033
|
*/
|
|
45319
46034
|
|
|
45320
46035
|
/**
|
|
@@ -45552,7 +46267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45552
46267
|
/**
|
|
45553
46268
|
* Locations service.
|
|
45554
46269
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
45555
|
-
* @version
|
|
46270
|
+
* @version 231.0.0
|
|
45556
46271
|
*/
|
|
45557
46272
|
|
|
45558
46273
|
/**
|
|
@@ -45788,7 +46503,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45788
46503
|
/**
|
|
45789
46504
|
* LogCapture service.
|
|
45790
46505
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
45791
|
-
* @version
|
|
46506
|
+
* @version 231.0.0
|
|
45792
46507
|
*/
|
|
45793
46508
|
|
|
45794
46509
|
/**
|
|
@@ -45987,7 +46702,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45987
46702
|
/**
|
|
45988
46703
|
* Messaging service.
|
|
45989
46704
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
45990
|
-
* @version
|
|
46705
|
+
* @version 231.0.0
|
|
45991
46706
|
*/
|
|
45992
46707
|
|
|
45993
46708
|
/**
|
|
@@ -46346,7 +47061,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46346
47061
|
/**
|
|
46347
47062
|
* MobileDevices service.
|
|
46348
47063
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
46349
|
-
* @version
|
|
47064
|
+
* @version 231.0.0
|
|
46350
47065
|
*/
|
|
46351
47066
|
|
|
46352
47067
|
/**
|
|
@@ -46497,7 +47212,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46497
47212
|
/**
|
|
46498
47213
|
* Notifications service.
|
|
46499
47214
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
46500
|
-
* @version
|
|
47215
|
+
* @version 231.0.0
|
|
46501
47216
|
*/
|
|
46502
47217
|
|
|
46503
47218
|
/**
|
|
@@ -46730,7 +47445,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46730
47445
|
/**
|
|
46731
47446
|
* OAuth service.
|
|
46732
47447
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
46733
|
-
* @version
|
|
47448
|
+
* @version 231.0.0
|
|
46734
47449
|
*/
|
|
46735
47450
|
|
|
46736
47451
|
/**
|
|
@@ -47096,7 +47811,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47096
47811
|
/**
|
|
47097
47812
|
* Objects service.
|
|
47098
47813
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
47099
|
-
* @version
|
|
47814
|
+
* @version 231.0.0
|
|
47100
47815
|
*/
|
|
47101
47816
|
|
|
47102
47817
|
/**
|
|
@@ -47420,7 +48135,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47420
48135
|
/**
|
|
47421
48136
|
* OperationalEvents service.
|
|
47422
48137
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
47423
|
-
* @version
|
|
48138
|
+
* @version 231.0.0
|
|
47424
48139
|
*/
|
|
47425
48140
|
|
|
47426
48141
|
/**
|
|
@@ -47537,7 +48252,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47537
48252
|
/**
|
|
47538
48253
|
* Organization service.
|
|
47539
48254
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
47540
|
-
* @version
|
|
48255
|
+
* @version 231.0.0
|
|
47541
48256
|
*/
|
|
47542
48257
|
|
|
47543
48258
|
/**
|
|
@@ -48012,7 +48727,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48012
48727
|
/**
|
|
48013
48728
|
* OrganizationAuthorization service.
|
|
48014
48729
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
48015
|
-
* @version
|
|
48730
|
+
* @version 231.0.0
|
|
48016
48731
|
*/
|
|
48017
48732
|
|
|
48018
48733
|
/**
|
|
@@ -49406,7 +50121,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49406
50121
|
/**
|
|
49407
50122
|
* Outbound service.
|
|
49408
50123
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
49409
|
-
* @version
|
|
50124
|
+
* @version 231.0.0
|
|
49410
50125
|
*/
|
|
49411
50126
|
|
|
49412
50127
|
/**
|
|
@@ -54128,7 +54843,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54128
54843
|
/**
|
|
54129
54844
|
* Presence service.
|
|
54130
54845
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
54131
|
-
* @version
|
|
54846
|
+
* @version 231.0.0
|
|
54132
54847
|
*/
|
|
54133
54848
|
|
|
54134
54849
|
/**
|
|
@@ -54872,7 +55587,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54872
55587
|
/**
|
|
54873
55588
|
* ProcessAutomation service.
|
|
54874
55589
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
54875
|
-
* @version
|
|
55590
|
+
* @version 231.0.0
|
|
54876
55591
|
*/
|
|
54877
55592
|
|
|
54878
55593
|
/**
|
|
@@ -55111,7 +55826,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55111
55826
|
/**
|
|
55112
55827
|
* Quality service.
|
|
55113
55828
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
55114
|
-
* @version
|
|
55829
|
+
* @version 231.0.0
|
|
55115
55830
|
*/
|
|
55116
55831
|
|
|
55117
55832
|
/**
|
|
@@ -56175,6 +56890,59 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56175
56890
|
);
|
|
56176
56891
|
}
|
|
56177
56892
|
|
|
56893
|
+
/**
|
|
56894
|
+
* Get the most recent published version of an evaluation form across any division.
|
|
56895
|
+
*
|
|
56896
|
+
* @param {String} evaluationFormId Evaluation Form ID
|
|
56897
|
+
* getQualityPublishedformsEvaluationsDivisionview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56898
|
+
*/
|
|
56899
|
+
getQualityPublishedformsEvaluationsDivisionview(evaluationFormId) {
|
|
56900
|
+
// verify the required parameter 'evaluationFormId' is set
|
|
56901
|
+
if (evaluationFormId === undefined || evaluationFormId === null || evaluationFormId === '') {
|
|
56902
|
+
throw 'Missing the required parameter "evaluationFormId" when calling getQualityPublishedformsEvaluationsDivisionview';
|
|
56903
|
+
}
|
|
56904
|
+
|
|
56905
|
+
return this.apiClient.callApi(
|
|
56906
|
+
'/api/v2/quality/publishedforms/evaluations/divisionviews/{evaluationFormId}',
|
|
56907
|
+
'GET',
|
|
56908
|
+
{ 'evaluationFormId': evaluationFormId },
|
|
56909
|
+
{ },
|
|
56910
|
+
{ },
|
|
56911
|
+
{ },
|
|
56912
|
+
null,
|
|
56913
|
+
['PureCloud OAuth'],
|
|
56914
|
+
['application/json'],
|
|
56915
|
+
['application/json']
|
|
56916
|
+
);
|
|
56917
|
+
}
|
|
56918
|
+
|
|
56919
|
+
/**
|
|
56920
|
+
* Get the published evaluation forms across any division.
|
|
56921
|
+
*
|
|
56922
|
+
* @param {Object} opts Optional parameters
|
|
56923
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
56924
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
56925
|
+
* @param {String} opts.name Name
|
|
56926
|
+
* getQualityPublishedformsEvaluationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56927
|
+
*/
|
|
56928
|
+
getQualityPublishedformsEvaluationsDivisionviews(opts) {
|
|
56929
|
+
opts = opts || {};
|
|
56930
|
+
|
|
56931
|
+
|
|
56932
|
+
return this.apiClient.callApi(
|
|
56933
|
+
'/api/v2/quality/publishedforms/evaluations/divisionviews',
|
|
56934
|
+
'GET',
|
|
56935
|
+
{ },
|
|
56936
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'] },
|
|
56937
|
+
{ },
|
|
56938
|
+
{ },
|
|
56939
|
+
null,
|
|
56940
|
+
['PureCloud OAuth'],
|
|
56941
|
+
['application/json'],
|
|
56942
|
+
['application/json']
|
|
56943
|
+
);
|
|
56944
|
+
}
|
|
56945
|
+
|
|
56178
56946
|
/**
|
|
56179
56947
|
* Get the most recent published version of a survey form.
|
|
56180
56948
|
*
|
|
@@ -56227,6 +56995,59 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56227
56995
|
);
|
|
56228
56996
|
}
|
|
56229
56997
|
|
|
56998
|
+
/**
|
|
56999
|
+
* Get the most recent published version of an enabled survey form across any division.
|
|
57000
|
+
*
|
|
57001
|
+
* @param {String} surveyFormId Survey Form ID
|
|
57002
|
+
* getQualityPublishedformsSurveysDivisionview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57003
|
+
*/
|
|
57004
|
+
getQualityPublishedformsSurveysDivisionview(surveyFormId) {
|
|
57005
|
+
// verify the required parameter 'surveyFormId' is set
|
|
57006
|
+
if (surveyFormId === undefined || surveyFormId === null || surveyFormId === '') {
|
|
57007
|
+
throw 'Missing the required parameter "surveyFormId" when calling getQualityPublishedformsSurveysDivisionview';
|
|
57008
|
+
}
|
|
57009
|
+
|
|
57010
|
+
return this.apiClient.callApi(
|
|
57011
|
+
'/api/v2/quality/publishedforms/surveys/divisionviews/{surveyFormId}',
|
|
57012
|
+
'GET',
|
|
57013
|
+
{ 'surveyFormId': surveyFormId },
|
|
57014
|
+
{ },
|
|
57015
|
+
{ },
|
|
57016
|
+
{ },
|
|
57017
|
+
null,
|
|
57018
|
+
['PureCloud OAuth'],
|
|
57019
|
+
['application/json'],
|
|
57020
|
+
['application/json']
|
|
57021
|
+
);
|
|
57022
|
+
}
|
|
57023
|
+
|
|
57024
|
+
/**
|
|
57025
|
+
* Get the published and enabled survey forms across any division.
|
|
57026
|
+
*
|
|
57027
|
+
* @param {Object} opts Optional parameters
|
|
57028
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
57029
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
57030
|
+
* @param {String} opts.name Name
|
|
57031
|
+
* getQualityPublishedformsSurveysDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57032
|
+
*/
|
|
57033
|
+
getQualityPublishedformsSurveysDivisionviews(opts) {
|
|
57034
|
+
opts = opts || {};
|
|
57035
|
+
|
|
57036
|
+
|
|
57037
|
+
return this.apiClient.callApi(
|
|
57038
|
+
'/api/v2/quality/publishedforms/surveys/divisionviews',
|
|
57039
|
+
'GET',
|
|
57040
|
+
{ },
|
|
57041
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'] },
|
|
57042
|
+
{ },
|
|
57043
|
+
{ },
|
|
57044
|
+
null,
|
|
57045
|
+
['PureCloud OAuth'],
|
|
57046
|
+
['application/json'],
|
|
57047
|
+
['application/json']
|
|
57048
|
+
);
|
|
57049
|
+
}
|
|
57050
|
+
|
|
56230
57051
|
/**
|
|
56231
57052
|
* Get a survey for a conversation
|
|
56232
57053
|
*
|
|
@@ -56950,7 +57771,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56950
57771
|
/**
|
|
56951
57772
|
* Recording service.
|
|
56952
57773
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
56953
|
-
* @version
|
|
57774
|
+
* @version 231.0.0
|
|
56954
57775
|
*/
|
|
56955
57776
|
|
|
56956
57777
|
/**
|
|
@@ -58003,7 +58824,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58003
58824
|
|
|
58004
58825
|
/**
|
|
58005
58826
|
* Create a recording bulk job.
|
|
58006
|
-
* 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.
|
|
58827
|
+
* 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.
|
|
58007
58828
|
* @param {Object} body query
|
|
58008
58829
|
*/
|
|
58009
58830
|
postRecordingJobs(body) {
|
|
@@ -58386,7 +59207,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58386
59207
|
|
|
58387
59208
|
/**
|
|
58388
59209
|
* Execute the recording bulk job.
|
|
58389
|
-
* 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.
|
|
59210
|
+
* 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.
|
|
58390
59211
|
* @param {String} jobId jobId
|
|
58391
59212
|
* @param {Object} body query
|
|
58392
59213
|
*/
|
|
@@ -58446,7 +59267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58446
59267
|
|
|
58447
59268
|
/**
|
|
58448
59269
|
* Update a media retention policy
|
|
58449
|
-
* Policy does not work retroactively
|
|
59270
|
+
* 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>"}].
|
|
58450
59271
|
* @param {String} policyId Policy ID
|
|
58451
59272
|
* @param {Object} body Policy
|
|
58452
59273
|
*/
|
|
@@ -58555,7 +59376,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58555
59376
|
/**
|
|
58556
59377
|
* ResponseManagement service.
|
|
58557
59378
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
58558
|
-
* @version
|
|
59379
|
+
* @version 231.0.0
|
|
58559
59380
|
*/
|
|
58560
59381
|
|
|
58561
59382
|
/**
|
|
@@ -59065,7 +59886,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59065
59886
|
/**
|
|
59066
59887
|
* Routing service.
|
|
59067
59888
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
59068
|
-
* @version
|
|
59889
|
+
* @version 231.0.0
|
|
59069
59890
|
*/
|
|
59070
59891
|
|
|
59071
59892
|
/**
|
|
@@ -59855,8 +60676,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59855
60676
|
* Get domain
|
|
59856
60677
|
*
|
|
59857
60678
|
* @param {String} domainId domain ID
|
|
60679
|
+
* @param {Object} opts Optional parameters
|
|
60680
|
+
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
59858
60681
|
*/
|
|
59859
|
-
getRoutingEmailDomain(domainId) {
|
|
60682
|
+
getRoutingEmailDomain(domainId, opts) {
|
|
60683
|
+
opts = opts || {};
|
|
60684
|
+
|
|
59860
60685
|
// verify the required parameter 'domainId' is set
|
|
59861
60686
|
if (domainId === undefined || domainId === null || domainId === '') {
|
|
59862
60687
|
throw 'Missing the required parameter "domainId" when calling getRoutingEmailDomain';
|
|
@@ -59866,7 +60691,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59866
60691
|
'/api/v2/routing/email/domains/{domainId}',
|
|
59867
60692
|
'GET',
|
|
59868
60693
|
{ 'domainId': domainId },
|
|
59869
|
-
{
|
|
60694
|
+
{ 'expand': opts['expand'] },
|
|
59870
60695
|
{ },
|
|
59871
60696
|
{ },
|
|
59872
60697
|
null,
|
|
@@ -59980,6 +60805,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59980
60805
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
59981
60806
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
59982
60807
|
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
60808
|
+
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
59983
60809
|
*/
|
|
59984
60810
|
getRoutingEmailDomains(opts) {
|
|
59985
60811
|
opts = opts || {};
|
|
@@ -59989,7 +60815,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59989
60815
|
'/api/v2/routing/email/domains',
|
|
59990
60816
|
'GET',
|
|
59991
60817
|
{ },
|
|
59992
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'],'filter': opts['filter'] },
|
|
60818
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'],'filter': opts['filter'],'expand': opts['expand'] },
|
|
59993
60819
|
{ },
|
|
59994
60820
|
{ },
|
|
59995
60821
|
null,
|
|
@@ -60003,8 +60829,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60003
60829
|
* Get domain
|
|
60004
60830
|
*
|
|
60005
60831
|
* @param {String} domainId domain ID
|
|
60832
|
+
* @param {Object} opts Optional parameters
|
|
60833
|
+
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
60006
60834
|
*/
|
|
60007
|
-
getRoutingEmailOutboundDomain(domainId) {
|
|
60835
|
+
getRoutingEmailOutboundDomain(domainId, opts) {
|
|
60836
|
+
opts = opts || {};
|
|
60837
|
+
|
|
60008
60838
|
// verify the required parameter 'domainId' is set
|
|
60009
60839
|
if (domainId === undefined || domainId === null || domainId === '') {
|
|
60010
60840
|
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomain';
|
|
@@ -60014,7 +60844,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60014
60844
|
'/api/v2/routing/email/outbound/domains/{domainId}',
|
|
60015
60845
|
'GET',
|
|
60016
60846
|
{ 'domainId': domainId },
|
|
60017
|
-
{
|
|
60847
|
+
{ 'expand': opts['expand'] },
|
|
60018
60848
|
{ },
|
|
60019
60849
|
{ },
|
|
60020
60850
|
null,
|
|
@@ -60049,31 +60879,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60049
60879
|
);
|
|
60050
60880
|
}
|
|
60051
60881
|
|
|
60052
|
-
/**
|
|
60053
|
-
* Search a domain across organizations
|
|
60054
|
-
*
|
|
60055
|
-
* @param {String} domainId domain ID
|
|
60056
|
-
*/
|
|
60057
|
-
getRoutingEmailOutboundDomainSearch(domainId) {
|
|
60058
|
-
// verify the required parameter 'domainId' is set
|
|
60059
|
-
if (domainId === undefined || domainId === null || domainId === '') {
|
|
60060
|
-
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomainSearch';
|
|
60061
|
-
}
|
|
60062
|
-
|
|
60063
|
-
return this.apiClient.callApi(
|
|
60064
|
-
'/api/v2/routing/email/outbound/domains/{domainId}/search',
|
|
60065
|
-
'GET',
|
|
60066
|
-
{ 'domainId': domainId },
|
|
60067
|
-
{ },
|
|
60068
|
-
{ },
|
|
60069
|
-
{ },
|
|
60070
|
-
null,
|
|
60071
|
-
['PureCloud OAuth'],
|
|
60072
|
-
['application/json'],
|
|
60073
|
-
['application/json']
|
|
60074
|
-
);
|
|
60075
|
-
}
|
|
60076
|
-
|
|
60077
60882
|
/**
|
|
60078
60883
|
* Get outbound domains
|
|
60079
60884
|
*
|
|
@@ -60081,6 +60886,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60081
60886
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
60082
60887
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
60083
60888
|
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
60889
|
+
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
60084
60890
|
*/
|
|
60085
60891
|
getRoutingEmailOutboundDomains(opts) {
|
|
60086
60892
|
opts = opts || {};
|
|
@@ -60090,7 +60896,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60090
60896
|
'/api/v2/routing/email/outbound/domains',
|
|
60091
60897
|
'GET',
|
|
60092
60898
|
{ },
|
|
60093
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'filter': opts['filter'] },
|
|
60899
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'filter': opts['filter'],'expand': opts['expand'] },
|
|
60094
60900
|
{ },
|
|
60095
60901
|
{ },
|
|
60096
60902
|
null,
|
|
@@ -62308,8 +63114,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62308
63114
|
}
|
|
62309
63115
|
|
|
62310
63116
|
/**
|
|
62311
|
-
* Tests the custom SMTP server integration connection set on this domain
|
|
62312
|
-
* 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.
|
|
63117
|
+
* Tests the custom SMTP server integration connection set on this ACD domain
|
|
63118
|
+
* 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.
|
|
62313
63119
|
* @param {String} domainId domain ID
|
|
62314
63120
|
* @param {Object} opts Optional parameters
|
|
62315
63121
|
* @param {Object} opts.body TestMessage
|
|
@@ -63406,7 +64212,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63406
64212
|
/**
|
|
63407
64213
|
* SCIM service.
|
|
63408
64214
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
63409
|
-
* @version
|
|
64215
|
+
* @version 231.0.0
|
|
63410
64216
|
*/
|
|
63411
64217
|
|
|
63412
64218
|
/**
|
|
@@ -64283,7 +65089,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64283
65089
|
/**
|
|
64284
65090
|
* ScreenRecording service.
|
|
64285
65091
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
64286
|
-
* @version
|
|
65092
|
+
* @version 231.0.0
|
|
64287
65093
|
*/
|
|
64288
65094
|
|
|
64289
65095
|
/**
|
|
@@ -64328,7 +65134,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64328
65134
|
/**
|
|
64329
65135
|
* Scripts service.
|
|
64330
65136
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
64331
|
-
* @version
|
|
65137
|
+
* @version 231.0.0
|
|
64332
65138
|
*/
|
|
64333
65139
|
|
|
64334
65140
|
/**
|
|
@@ -64804,7 +65610,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64804
65610
|
/**
|
|
64805
65611
|
* Search service.
|
|
64806
65612
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
64807
|
-
* @version
|
|
65613
|
+
* @version 231.0.0
|
|
64808
65614
|
*/
|
|
64809
65615
|
|
|
64810
65616
|
/**
|
|
@@ -65522,7 +66328,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65522
66328
|
/**
|
|
65523
66329
|
* Settings service.
|
|
65524
66330
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
65525
|
-
* @version
|
|
66331
|
+
* @version 231.0.0
|
|
65526
66332
|
*/
|
|
65527
66333
|
|
|
65528
66334
|
/**
|
|
@@ -65870,7 +66676,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65870
66676
|
/**
|
|
65871
66677
|
* SocialMedia service.
|
|
65872
66678
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
65873
|
-
* @version
|
|
66679
|
+
* @version 231.0.0
|
|
65874
66680
|
*/
|
|
65875
66681
|
|
|
65876
66682
|
/**
|
|
@@ -65999,6 +66805,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65999
66805
|
);
|
|
66000
66806
|
}
|
|
66001
66807
|
|
|
66808
|
+
/**
|
|
66809
|
+
* Delete a Instagram data ingestion rule.
|
|
66810
|
+
*
|
|
66811
|
+
* @param {String} topicId topicId
|
|
66812
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
66813
|
+
* @param {Object} opts Optional parameters
|
|
66814
|
+
* @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)
|
|
66815
|
+
*/
|
|
66816
|
+
deleteSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId(topicId, instagramIngestionRuleId, opts) {
|
|
66817
|
+
opts = opts || {};
|
|
66818
|
+
|
|
66819
|
+
// verify the required parameter 'topicId' is set
|
|
66820
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
66821
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
66822
|
+
}
|
|
66823
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
66824
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
66825
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
66826
|
+
}
|
|
66827
|
+
|
|
66828
|
+
return this.apiClient.callApi(
|
|
66829
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}',
|
|
66830
|
+
'DELETE',
|
|
66831
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
66832
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
66833
|
+
{ },
|
|
66834
|
+
{ },
|
|
66835
|
+
null,
|
|
66836
|
+
['PureCloud OAuth'],
|
|
66837
|
+
['application/json'],
|
|
66838
|
+
['application/json']
|
|
66839
|
+
);
|
|
66840
|
+
}
|
|
66841
|
+
|
|
66002
66842
|
/**
|
|
66003
66843
|
* Delete a open data ingestion rule.
|
|
66004
66844
|
*
|
|
@@ -66399,6 +67239,115 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66399
67239
|
);
|
|
66400
67240
|
}
|
|
66401
67241
|
|
|
67242
|
+
/**
|
|
67243
|
+
* Get a single Instagram data ingestion rule.
|
|
67244
|
+
*
|
|
67245
|
+
* @param {String} topicId topicId
|
|
67246
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
67247
|
+
* @param {Object} opts Optional parameters
|
|
67248
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
67249
|
+
*/
|
|
67250
|
+
getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId(topicId, instagramIngestionRuleId, opts) {
|
|
67251
|
+
opts = opts || {};
|
|
67252
|
+
|
|
67253
|
+
// verify the required parameter 'topicId' is set
|
|
67254
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
67255
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
67256
|
+
}
|
|
67257
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
67258
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
67259
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
67260
|
+
}
|
|
67261
|
+
|
|
67262
|
+
return this.apiClient.callApi(
|
|
67263
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}',
|
|
67264
|
+
'GET',
|
|
67265
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
67266
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
67267
|
+
{ },
|
|
67268
|
+
{ },
|
|
67269
|
+
null,
|
|
67270
|
+
['PureCloud OAuth'],
|
|
67271
|
+
['application/json'],
|
|
67272
|
+
['application/json']
|
|
67273
|
+
);
|
|
67274
|
+
}
|
|
67275
|
+
|
|
67276
|
+
/**
|
|
67277
|
+
* Get a single Instagram data ingestion rule version.
|
|
67278
|
+
*
|
|
67279
|
+
* @param {String} topicId topicId
|
|
67280
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
67281
|
+
* @param {String} dataIngestionRuleVersion version
|
|
67282
|
+
* @param {Object} opts Optional parameters
|
|
67283
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
67284
|
+
*/
|
|
67285
|
+
getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion(topicId, instagramIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
67286
|
+
opts = opts || {};
|
|
67287
|
+
|
|
67288
|
+
// verify the required parameter 'topicId' is set
|
|
67289
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
67290
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion';
|
|
67291
|
+
}
|
|
67292
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
67293
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
67294
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion';
|
|
67295
|
+
}
|
|
67296
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
67297
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null || dataIngestionRuleVersion === '') {
|
|
67298
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion';
|
|
67299
|
+
}
|
|
67300
|
+
|
|
67301
|
+
return this.apiClient.callApi(
|
|
67302
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}/versions/{dataIngestionRuleVersion}',
|
|
67303
|
+
'GET',
|
|
67304
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
67305
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
67306
|
+
{ },
|
|
67307
|
+
{ },
|
|
67308
|
+
null,
|
|
67309
|
+
['PureCloud OAuth'],
|
|
67310
|
+
['application/json'],
|
|
67311
|
+
['application/json']
|
|
67312
|
+
);
|
|
67313
|
+
}
|
|
67314
|
+
|
|
67315
|
+
/**
|
|
67316
|
+
* Get the Instagram data ingestion rule versions.
|
|
67317
|
+
*
|
|
67318
|
+
* @param {String} topicId topicId
|
|
67319
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
67320
|
+
* @param {Object} opts Optional parameters
|
|
67321
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
67322
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
67323
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
67324
|
+
*/
|
|
67325
|
+
getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersions(topicId, instagramIngestionRuleId, opts) {
|
|
67326
|
+
opts = opts || {};
|
|
67327
|
+
|
|
67328
|
+
// verify the required parameter 'topicId' is set
|
|
67329
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
67330
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersions';
|
|
67331
|
+
}
|
|
67332
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
67333
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
67334
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersions';
|
|
67335
|
+
}
|
|
67336
|
+
|
|
67337
|
+
return this.apiClient.callApi(
|
|
67338
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}/versions',
|
|
67339
|
+
'GET',
|
|
67340
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
67341
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
67342
|
+
{ },
|
|
67343
|
+
{ },
|
|
67344
|
+
null,
|
|
67345
|
+
['PureCloud OAuth'],
|
|
67346
|
+
['application/json'],
|
|
67347
|
+
['application/json']
|
|
67348
|
+
);
|
|
67349
|
+
}
|
|
67350
|
+
|
|
66402
67351
|
/**
|
|
66403
67352
|
* Get a single open data ingestion rule.
|
|
66404
67353
|
*
|
|
@@ -66707,6 +67656,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66707
67656
|
);
|
|
66708
67657
|
}
|
|
66709
67658
|
|
|
67659
|
+
/**
|
|
67660
|
+
* Update the status of a Instagram data ingestion rule.
|
|
67661
|
+
*
|
|
67662
|
+
* @param {String} topicId topicId
|
|
67663
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
67664
|
+
* @param {Object} opts Optional parameters
|
|
67665
|
+
* @param {Object} opts.body
|
|
67666
|
+
*/
|
|
67667
|
+
patchSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId(topicId, instagramIngestionRuleId, opts) {
|
|
67668
|
+
opts = opts || {};
|
|
67669
|
+
|
|
67670
|
+
// verify the required parameter 'topicId' is set
|
|
67671
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
67672
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
67673
|
+
}
|
|
67674
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
67675
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
67676
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
67677
|
+
}
|
|
67678
|
+
|
|
67679
|
+
return this.apiClient.callApi(
|
|
67680
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}',
|
|
67681
|
+
'PATCH',
|
|
67682
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
67683
|
+
{ },
|
|
67684
|
+
{ },
|
|
67685
|
+
{ },
|
|
67686
|
+
opts['body'],
|
|
67687
|
+
['PureCloud OAuth'],
|
|
67688
|
+
['application/json'],
|
|
67689
|
+
['application/json']
|
|
67690
|
+
);
|
|
67691
|
+
}
|
|
67692
|
+
|
|
66710
67693
|
/**
|
|
66711
67694
|
* Update the status of a open data ingestion rule.
|
|
66712
67695
|
*
|
|
@@ -66907,6 +67890,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66907
67890
|
);
|
|
66908
67891
|
}
|
|
66909
67892
|
|
|
67893
|
+
/**
|
|
67894
|
+
* Create an Instagram data ingestion rule.
|
|
67895
|
+
*
|
|
67896
|
+
* @param {String} topicId topicId
|
|
67897
|
+
* @param {Object} opts Optional parameters
|
|
67898
|
+
* @param {Object} opts.body
|
|
67899
|
+
*/
|
|
67900
|
+
postSocialmediaTopicDataingestionrulesInstagram(topicId, opts) {
|
|
67901
|
+
opts = opts || {};
|
|
67902
|
+
|
|
67903
|
+
// verify the required parameter 'topicId' is set
|
|
67904
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
67905
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesInstagram';
|
|
67906
|
+
}
|
|
67907
|
+
|
|
67908
|
+
return this.apiClient.callApi(
|
|
67909
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram',
|
|
67910
|
+
'POST',
|
|
67911
|
+
{ 'topicId': topicId },
|
|
67912
|
+
{ },
|
|
67913
|
+
{ },
|
|
67914
|
+
{ },
|
|
67915
|
+
opts['body'],
|
|
67916
|
+
['PureCloud OAuth'],
|
|
67917
|
+
['application/json'],
|
|
67918
|
+
['application/json']
|
|
67919
|
+
);
|
|
67920
|
+
}
|
|
67921
|
+
|
|
66910
67922
|
/**
|
|
66911
67923
|
* Create an open data ingestion rule.
|
|
66912
67924
|
*
|
|
@@ -67147,6 +68159,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67147
68159
|
);
|
|
67148
68160
|
}
|
|
67149
68161
|
|
|
68162
|
+
/**
|
|
68163
|
+
* Update the Instagram data ingestion rule.
|
|
68164
|
+
*
|
|
68165
|
+
* @param {String} topicId topicId
|
|
68166
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
68167
|
+
* @param {Object} opts Optional parameters
|
|
68168
|
+
* @param {Object} opts.body
|
|
68169
|
+
*/
|
|
68170
|
+
putSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId(topicId, instagramIngestionRuleId, opts) {
|
|
68171
|
+
opts = opts || {};
|
|
68172
|
+
|
|
68173
|
+
// verify the required parameter 'topicId' is set
|
|
68174
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
68175
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
68176
|
+
}
|
|
68177
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
68178
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
68179
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
68180
|
+
}
|
|
68181
|
+
|
|
68182
|
+
return this.apiClient.callApi(
|
|
68183
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}',
|
|
68184
|
+
'PUT',
|
|
68185
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
68186
|
+
{ },
|
|
68187
|
+
{ },
|
|
68188
|
+
{ },
|
|
68189
|
+
opts['body'],
|
|
68190
|
+
['PureCloud OAuth'],
|
|
68191
|
+
['application/json'],
|
|
68192
|
+
['application/json']
|
|
68193
|
+
);
|
|
68194
|
+
}
|
|
68195
|
+
|
|
67150
68196
|
/**
|
|
67151
68197
|
* Update the open data ingestion rule.
|
|
67152
68198
|
*
|
|
@@ -67221,7 +68267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67221
68267
|
/**
|
|
67222
68268
|
* SpeechTextAnalytics service.
|
|
67223
68269
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
67224
|
-
* @version
|
|
68270
|
+
* @version 231.0.0
|
|
67225
68271
|
*/
|
|
67226
68272
|
|
|
67227
68273
|
/**
|
|
@@ -68867,7 +69913,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68867
69913
|
/**
|
|
68868
69914
|
* Stations service.
|
|
68869
69915
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
68870
|
-
* @version
|
|
69916
|
+
* @version 231.0.0
|
|
68871
69917
|
*/
|
|
68872
69918
|
|
|
68873
69919
|
/**
|
|
@@ -68969,7 +70015,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68969
70015
|
/**
|
|
68970
70016
|
* Suggest service.
|
|
68971
70017
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
68972
|
-
* @version
|
|
70018
|
+
* @version 231.0.0
|
|
68973
70019
|
*/
|
|
68974
70020
|
|
|
68975
70021
|
/**
|
|
@@ -69108,7 +70154,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69108
70154
|
/**
|
|
69109
70155
|
* TaskManagement service.
|
|
69110
70156
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
69111
|
-
* @version
|
|
70157
|
+
* @version 231.0.0
|
|
69112
70158
|
*/
|
|
69113
70159
|
|
|
69114
70160
|
/**
|
|
@@ -71270,7 +72316,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71270
72316
|
/**
|
|
71271
72317
|
* Teams service.
|
|
71272
72318
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
71273
|
-
* @version
|
|
72319
|
+
* @version 231.0.0
|
|
71274
72320
|
*/
|
|
71275
72321
|
|
|
71276
72322
|
/**
|
|
@@ -71575,7 +72621,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71575
72621
|
/**
|
|
71576
72622
|
* Telephony service.
|
|
71577
72623
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
71578
|
-
* @version
|
|
72624
|
+
* @version 231.0.0
|
|
71579
72625
|
*/
|
|
71580
72626
|
|
|
71581
72627
|
/**
|
|
@@ -71861,7 +72907,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71861
72907
|
/**
|
|
71862
72908
|
* TelephonyProvidersEdge service.
|
|
71863
72909
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
71864
|
-
* @version
|
|
72910
|
+
* @version 231.0.0
|
|
71865
72911
|
*/
|
|
71866
72912
|
|
|
71867
72913
|
/**
|
|
@@ -75354,7 +76400,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75354
76400
|
/**
|
|
75355
76401
|
* Textbots service.
|
|
75356
76402
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
75357
|
-
* @version
|
|
76403
|
+
* @version 231.0.0
|
|
75358
76404
|
*/
|
|
75359
76405
|
|
|
75360
76406
|
/**
|
|
@@ -75483,7 +76529,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75483
76529
|
/**
|
|
75484
76530
|
* Tokens service.
|
|
75485
76531
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
75486
|
-
* @version
|
|
76532
|
+
* @version 231.0.0
|
|
75487
76533
|
*/
|
|
75488
76534
|
|
|
75489
76535
|
/**
|
|
@@ -75637,7 +76683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75637
76683
|
/**
|
|
75638
76684
|
* Uploads service.
|
|
75639
76685
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
75640
|
-
* @version
|
|
76686
|
+
* @version 231.0.0
|
|
75641
76687
|
*/
|
|
75642
76688
|
|
|
75643
76689
|
/**
|
|
@@ -75928,7 +76974,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75928
76974
|
/**
|
|
75929
76975
|
* Usage service.
|
|
75930
76976
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
75931
|
-
* @version
|
|
76977
|
+
* @version 231.0.0
|
|
75932
76978
|
*/
|
|
75933
76979
|
|
|
75934
76980
|
/**
|
|
@@ -76263,7 +77309,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76263
77309
|
/**
|
|
76264
77310
|
* UserRecordings service.
|
|
76265
77311
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
76266
|
-
* @version
|
|
77312
|
+
* @version 231.0.0
|
|
76267
77313
|
*/
|
|
76268
77314
|
|
|
76269
77315
|
/**
|
|
@@ -76332,37 +77378,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76332
77378
|
);
|
|
76333
77379
|
}
|
|
76334
77380
|
|
|
76335
|
-
/**
|
|
76336
|
-
* Download a user recording.
|
|
76337
|
-
* API should migrate to use GET api/v2/userrecordings/{recordingId}/transcoding
|
|
76338
|
-
* @param {String} recordingId User Recording ID
|
|
76339
|
-
* @param {Object} opts Optional parameters
|
|
76340
|
-
* @param {Object} opts.formatId The desired media format. (default to WEBM)
|
|
76341
|
-
* @param {Boolean} opts.async When set to true, api will return 202 response until the recording is ready for download
|
|
76342
|
-
* @deprecated
|
|
76343
|
-
*/
|
|
76344
|
-
getUserrecordingMedia(recordingId, opts) {
|
|
76345
|
-
opts = opts || {};
|
|
76346
|
-
|
|
76347
|
-
// verify the required parameter 'recordingId' is set
|
|
76348
|
-
if (recordingId === undefined || recordingId === null || recordingId === '') {
|
|
76349
|
-
throw 'Missing the required parameter "recordingId" when calling getUserrecordingMedia';
|
|
76350
|
-
}
|
|
76351
|
-
|
|
76352
|
-
return this.apiClient.callApi(
|
|
76353
|
-
'/api/v2/userrecordings/{recordingId}/media',
|
|
76354
|
-
'GET',
|
|
76355
|
-
{ 'recordingId': recordingId },
|
|
76356
|
-
{ 'formatId': opts['formatId'],'async': opts['async'] },
|
|
76357
|
-
{ },
|
|
76358
|
-
{ },
|
|
76359
|
-
null,
|
|
76360
|
-
['PureCloud OAuth'],
|
|
76361
|
-
['application/json'],
|
|
76362
|
-
['application/json']
|
|
76363
|
-
);
|
|
76364
|
-
}
|
|
76365
|
-
|
|
76366
77381
|
/**
|
|
76367
77382
|
* Download a user recording.
|
|
76368
77383
|
*
|
|
@@ -76478,7 +77493,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76478
77493
|
/**
|
|
76479
77494
|
* Users service.
|
|
76480
77495
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
76481
|
-
* @version
|
|
77496
|
+
* @version 231.0.0
|
|
76482
77497
|
*/
|
|
76483
77498
|
|
|
76484
77499
|
/**
|
|
@@ -79487,7 +80502,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79487
80502
|
/**
|
|
79488
80503
|
* Utilities service.
|
|
79489
80504
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
79490
|
-
* @version
|
|
80505
|
+
* @version 231.0.0
|
|
79491
80506
|
*/
|
|
79492
80507
|
|
|
79493
80508
|
/**
|
|
@@ -79598,7 +80613,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79598
80613
|
/**
|
|
79599
80614
|
* Voicemail service.
|
|
79600
80615
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
79601
|
-
* @version
|
|
80616
|
+
* @version 231.0.0
|
|
79602
80617
|
*/
|
|
79603
80618
|
|
|
79604
80619
|
/**
|
|
@@ -80320,7 +81335,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80320
81335
|
/**
|
|
80321
81336
|
* WebChat service.
|
|
80322
81337
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
80323
|
-
* @version
|
|
81338
|
+
* @version 231.0.0
|
|
80324
81339
|
*/
|
|
80325
81340
|
|
|
80326
81341
|
/**
|
|
@@ -80880,7 +81895,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80880
81895
|
/**
|
|
80881
81896
|
* WebDeployments service.
|
|
80882
81897
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
80883
|
-
* @version
|
|
81898
|
+
* @version 231.0.0
|
|
80884
81899
|
*/
|
|
80885
81900
|
|
|
80886
81901
|
/**
|
|
@@ -81462,7 +82477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81462
82477
|
/**
|
|
81463
82478
|
* WebMessaging service.
|
|
81464
82479
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
81465
|
-
* @version
|
|
82480
|
+
* @version 231.0.0
|
|
81466
82481
|
*/
|
|
81467
82482
|
|
|
81468
82483
|
/**
|
|
@@ -81477,6 +82492,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81477
82492
|
}
|
|
81478
82493
|
|
|
81479
82494
|
|
|
82495
|
+
/**
|
|
82496
|
+
* Delete device information
|
|
82497
|
+
*
|
|
82498
|
+
* @param {String} deploymentId WebMessaging deployment id
|
|
82499
|
+
* @param {String} tokenId Device token id or cookie id
|
|
82500
|
+
*/
|
|
82501
|
+
deleteWebmessagingDeploymentPushdevice(deploymentId, tokenId) {
|
|
82502
|
+
// verify the required parameter 'deploymentId' is set
|
|
82503
|
+
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
82504
|
+
throw 'Missing the required parameter "deploymentId" when calling deleteWebmessagingDeploymentPushdevice';
|
|
82505
|
+
}
|
|
82506
|
+
// verify the required parameter 'tokenId' is set
|
|
82507
|
+
if (tokenId === undefined || tokenId === null || tokenId === '') {
|
|
82508
|
+
throw 'Missing the required parameter "tokenId" when calling deleteWebmessagingDeploymentPushdevice';
|
|
82509
|
+
}
|
|
82510
|
+
|
|
82511
|
+
return this.apiClient.callApi(
|
|
82512
|
+
'/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}',
|
|
82513
|
+
'DELETE',
|
|
82514
|
+
{ 'deploymentId': deploymentId,'tokenId': tokenId },
|
|
82515
|
+
{ },
|
|
82516
|
+
{ },
|
|
82517
|
+
{ },
|
|
82518
|
+
null,
|
|
82519
|
+
['PureCloud OAuth'],
|
|
82520
|
+
['application/json'],
|
|
82521
|
+
['application/json']
|
|
82522
|
+
);
|
|
82523
|
+
}
|
|
82524
|
+
|
|
81480
82525
|
/**
|
|
81481
82526
|
* Get the messages for a web messaging session.
|
|
81482
82527
|
*
|
|
@@ -81502,13 +82547,83 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81502
82547
|
);
|
|
81503
82548
|
}
|
|
81504
82549
|
|
|
82550
|
+
/**
|
|
82551
|
+
* Edit device information
|
|
82552
|
+
*
|
|
82553
|
+
* @param {String} deploymentId WebMessaging deployment id
|
|
82554
|
+
* @param {String} tokenId Device token id or cookie id
|
|
82555
|
+
* @param {Object} body Request body
|
|
82556
|
+
*/
|
|
82557
|
+
patchWebmessagingDeploymentPushdevice(deploymentId, tokenId, body) {
|
|
82558
|
+
// verify the required parameter 'deploymentId' is set
|
|
82559
|
+
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
82560
|
+
throw 'Missing the required parameter "deploymentId" when calling patchWebmessagingDeploymentPushdevice';
|
|
82561
|
+
}
|
|
82562
|
+
// verify the required parameter 'tokenId' is set
|
|
82563
|
+
if (tokenId === undefined || tokenId === null || tokenId === '') {
|
|
82564
|
+
throw 'Missing the required parameter "tokenId" when calling patchWebmessagingDeploymentPushdevice';
|
|
82565
|
+
}
|
|
82566
|
+
// verify the required parameter 'body' is set
|
|
82567
|
+
if (body === undefined || body === null) {
|
|
82568
|
+
throw 'Missing the required parameter "body" when calling patchWebmessagingDeploymentPushdevice';
|
|
82569
|
+
}
|
|
82570
|
+
|
|
82571
|
+
return this.apiClient.callApi(
|
|
82572
|
+
'/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}',
|
|
82573
|
+
'PATCH',
|
|
82574
|
+
{ 'deploymentId': deploymentId,'tokenId': tokenId },
|
|
82575
|
+
{ },
|
|
82576
|
+
{ },
|
|
82577
|
+
{ },
|
|
82578
|
+
body,
|
|
82579
|
+
['PureCloud OAuth'],
|
|
82580
|
+
['application/json'],
|
|
82581
|
+
['application/json']
|
|
82582
|
+
);
|
|
82583
|
+
}
|
|
82584
|
+
|
|
82585
|
+
/**
|
|
82586
|
+
* Add a new device information
|
|
82587
|
+
*
|
|
82588
|
+
* @param {String} deploymentId WebMessaging deployment id
|
|
82589
|
+
* @param {String} tokenId Device token id or cookie id
|
|
82590
|
+
* @param {Object} body Request body
|
|
82591
|
+
*/
|
|
82592
|
+
postWebmessagingDeploymentPushdevice(deploymentId, tokenId, body) {
|
|
82593
|
+
// verify the required parameter 'deploymentId' is set
|
|
82594
|
+
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
82595
|
+
throw 'Missing the required parameter "deploymentId" when calling postWebmessagingDeploymentPushdevice';
|
|
82596
|
+
}
|
|
82597
|
+
// verify the required parameter 'tokenId' is set
|
|
82598
|
+
if (tokenId === undefined || tokenId === null || tokenId === '') {
|
|
82599
|
+
throw 'Missing the required parameter "tokenId" when calling postWebmessagingDeploymentPushdevice';
|
|
82600
|
+
}
|
|
82601
|
+
// verify the required parameter 'body' is set
|
|
82602
|
+
if (body === undefined || body === null) {
|
|
82603
|
+
throw 'Missing the required parameter "body" when calling postWebmessagingDeploymentPushdevice';
|
|
82604
|
+
}
|
|
82605
|
+
|
|
82606
|
+
return this.apiClient.callApi(
|
|
82607
|
+
'/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}',
|
|
82608
|
+
'POST',
|
|
82609
|
+
{ 'deploymentId': deploymentId,'tokenId': tokenId },
|
|
82610
|
+
{ },
|
|
82611
|
+
{ },
|
|
82612
|
+
{ },
|
|
82613
|
+
body,
|
|
82614
|
+
['PureCloud OAuth'],
|
|
82615
|
+
['application/json'],
|
|
82616
|
+
['application/json']
|
|
82617
|
+
);
|
|
82618
|
+
}
|
|
82619
|
+
|
|
81505
82620
|
}
|
|
81506
82621
|
|
|
81507
82622
|
class WidgetsApi {
|
|
81508
82623
|
/**
|
|
81509
82624
|
* Widgets service.
|
|
81510
82625
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
81511
|
-
* @version
|
|
82626
|
+
* @version 231.0.0
|
|
81512
82627
|
*/
|
|
81513
82628
|
|
|
81514
82629
|
/**
|
|
@@ -81659,7 +82774,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81659
82774
|
/**
|
|
81660
82775
|
* WorkforceManagement service.
|
|
81661
82776
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
81662
|
-
* @version
|
|
82777
|
+
* @version 231.0.0
|
|
81663
82778
|
*/
|
|
81664
82779
|
|
|
81665
82780
|
/**
|
|
@@ -89629,7 +90744,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
89629
90744
|
* </pre>
|
|
89630
90745
|
* </p>
|
|
89631
90746
|
* @module purecloud-platform-client-v2/index
|
|
89632
|
-
* @version
|
|
90747
|
+
* @version 231.0.0
|
|
89633
90748
|
*/
|
|
89634
90749
|
class platformClient {
|
|
89635
90750
|
constructor() {
|