purecloud-platform-client-v2 230.0.0 → 232.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 +22 -3
- package/dist/node/purecloud-platform-client-v2.js +1247 -141
- package/dist/web-amd/purecloud-platform-client-v2.js +1247 -141
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +449 -156
- package/dist/web-cjs/purecloud-platform-client-v2.js +571 -223
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1704 -518
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +31 -6
- package/src/purecloud-platform-client-v2/PureCloudRegionHosts.js +2 -0
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +160 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +25 -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 +238 -4
- 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 +5 -2
- 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 +7 -3
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +108 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +22 -10
- 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 +7 -4
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +31 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -24,6 +24,8 @@ var PureCloudRegionHosts = {
|
|
|
24
24
|
me_central_1: 'mec1.pure.cloud',
|
|
25
25
|
ap_northeast_3: 'apne3.pure.cloud',
|
|
26
26
|
eu_central_2: 'euc2.pure.cloud',
|
|
27
|
+
mx_central_1: 'mxc1.pure.cloud',
|
|
28
|
+
ap_southeast_1: 'apse1.pure.cloud',
|
|
27
29
|
};
|
|
28
30
|
|
|
29
31
|
class AbstractHttpClient {
|
|
@@ -746,7 +748,7 @@ class Configuration {
|
|
|
746
748
|
|
|
747
749
|
/**
|
|
748
750
|
* @module purecloud-platform-client-v2/ApiClient
|
|
749
|
-
* @version
|
|
751
|
+
* @version 232.0.0
|
|
750
752
|
*/
|
|
751
753
|
class ApiClient {
|
|
752
754
|
/**
|
|
@@ -812,6 +814,8 @@ class ApiClient {
|
|
|
812
814
|
MULTI: 'multi'
|
|
813
815
|
};
|
|
814
816
|
|
|
817
|
+
this.useLegacyParameterFilter = true;
|
|
818
|
+
|
|
815
819
|
/**
|
|
816
820
|
* @description Value is `true` if local storage exists. Otherwise, false.
|
|
817
821
|
*/
|
|
@@ -1930,12 +1934,35 @@ class ApiClient {
|
|
|
1930
1934
|
return Object.keys(query).reduce((url, key) => !query[key] ? url : `${url}&${key}=${query[key]}`, `${loginBasePath}/${path}?`);
|
|
1931
1935
|
}
|
|
1932
1936
|
|
|
1937
|
+
/**
|
|
1938
|
+
* @description If set to `true`, the ApiClient will continue to use its legacy approach for filtering method parameters (mapped to an API Endpoint's query parameter). This is option is meant to facilitate transition from legacy to current and accurate parameters filtering.
|
|
1939
|
+
* @param {boolean} useLegacyParameterFilter - `false` to use modern/accurate approach (default value), `true` to use legacy approach (i.e. parameters of boolean type and equal to false are ignored/filtered, parameters of type integer/number and equal to 0 are ignored/filtered)
|
|
1940
|
+
*/
|
|
1941
|
+
setUseLegacyParameterFilter(useLegacyParameterFilter) {
|
|
1942
|
+
this.useLegacyParameterFilter = useLegacyParameterFilter;
|
|
1943
|
+
}
|
|
1944
|
+
|
|
1945
|
+
getUseLegacyParameterFilter() {
|
|
1946
|
+
return this.useLegacyParameterFilter;
|
|
1947
|
+
}
|
|
1948
|
+
|
|
1933
1949
|
/**
|
|
1934
1950
|
* Returns a string representation for an actual parameter.
|
|
1935
1951
|
* @param param The actual parameter.
|
|
1936
1952
|
* @returns {String} The string representation of <code>param</code>.
|
|
1937
1953
|
*/
|
|
1938
1954
|
paramToString(param) {
|
|
1955
|
+
if (this.useLegacyParameterFilter !== true) {
|
|
1956
|
+
if (param !== null && param !== undefined) {
|
|
1957
|
+
if (typeof param === "boolean") {
|
|
1958
|
+
return param.toString().toLowerCase();
|
|
1959
|
+
} else if (param instanceof Boolean) {
|
|
1960
|
+
return param.toString().toLowerCase();
|
|
1961
|
+
} else if (typeof param === "number") {
|
|
1962
|
+
return param.toString();
|
|
1963
|
+
}
|
|
1964
|
+
}
|
|
1965
|
+
}
|
|
1939
1966
|
if (!param) {
|
|
1940
1967
|
return '';
|
|
1941
1968
|
}
|
|
@@ -2099,16 +2126,16 @@ class ApiClient {
|
|
|
2099
2126
|
|
|
2100
2127
|
switch (collectionFormat) {
|
|
2101
2128
|
case 'csv':
|
|
2102
|
-
return param.map(this.paramToString).join(',');
|
|
2129
|
+
return param.map((x) => this.paramToString(x)).join(',');
|
|
2103
2130
|
case 'ssv':
|
|
2104
|
-
return param.map(this.paramToString).join(' ');
|
|
2131
|
+
return param.map((x) => this.paramToString(x)).join(' ');
|
|
2105
2132
|
case 'tsv':
|
|
2106
|
-
return param.map(this.paramToString).join('\t');
|
|
2133
|
+
return param.map((x) => this.paramToString(x)).join('\t');
|
|
2107
2134
|
case 'pipes':
|
|
2108
|
-
return param.map(this.paramToString).join('|');
|
|
2135
|
+
return param.map((x) => this.paramToString(x)).join('|');
|
|
2109
2136
|
case 'multi':
|
|
2110
2137
|
// return the array directly as axios will handle it as expected
|
|
2111
|
-
return param.map(this.paramToString);
|
|
2138
|
+
return param.map((x) => this.paramToString(x));
|
|
2112
2139
|
default:
|
|
2113
2140
|
throw new Error(`Unknown collection format: ${collectionFormat}`);
|
|
2114
2141
|
}
|
|
@@ -2290,7 +2317,7 @@ class AIStudioApi {
|
|
|
2290
2317
|
/**
|
|
2291
2318
|
* AIStudio service.
|
|
2292
2319
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2293
|
-
* @version
|
|
2320
|
+
* @version 232.0.0
|
|
2294
2321
|
*/
|
|
2295
2322
|
|
|
2296
2323
|
/**
|
|
@@ -2305,6 +2332,31 @@ class AIStudioApi {
|
|
|
2305
2332
|
}
|
|
2306
2333
|
|
|
2307
2334
|
|
|
2335
|
+
/**
|
|
2336
|
+
* Delete a summary setting.
|
|
2337
|
+
*
|
|
2338
|
+
* @param {String} summarySettingId Summary setting id
|
|
2339
|
+
*/
|
|
2340
|
+
deleteConversationsSummariesSetting(summarySettingId) {
|
|
2341
|
+
// verify the required parameter 'summarySettingId' is set
|
|
2342
|
+
if (summarySettingId === undefined || summarySettingId === null || summarySettingId === '') {
|
|
2343
|
+
throw 'Missing the required parameter "summarySettingId" when calling deleteConversationsSummariesSetting';
|
|
2344
|
+
}
|
|
2345
|
+
|
|
2346
|
+
return this.apiClient.callApi(
|
|
2347
|
+
'/api/v2/conversations/summaries/settings/{summarySettingId}',
|
|
2348
|
+
'DELETE',
|
|
2349
|
+
{ 'summarySettingId': summarySettingId },
|
|
2350
|
+
{ },
|
|
2351
|
+
{ },
|
|
2352
|
+
{ },
|
|
2353
|
+
null,
|
|
2354
|
+
['PureCloud OAuth'],
|
|
2355
|
+
['application/json'],
|
|
2356
|
+
['application/json']
|
|
2357
|
+
);
|
|
2358
|
+
}
|
|
2359
|
+
|
|
2308
2360
|
/**
|
|
2309
2361
|
* Start the deletion of a guide.
|
|
2310
2362
|
*
|
|
@@ -2331,6 +2383,60 @@ class AIStudioApi {
|
|
|
2331
2383
|
);
|
|
2332
2384
|
}
|
|
2333
2385
|
|
|
2386
|
+
/**
|
|
2387
|
+
* Receive a summary setting.
|
|
2388
|
+
*
|
|
2389
|
+
* @param {String} summarySettingId Summary setting id
|
|
2390
|
+
*/
|
|
2391
|
+
getConversationsSummariesSetting(summarySettingId) {
|
|
2392
|
+
// verify the required parameter 'summarySettingId' is set
|
|
2393
|
+
if (summarySettingId === undefined || summarySettingId === null || summarySettingId === '') {
|
|
2394
|
+
throw 'Missing the required parameter "summarySettingId" when calling getConversationsSummariesSetting';
|
|
2395
|
+
}
|
|
2396
|
+
|
|
2397
|
+
return this.apiClient.callApi(
|
|
2398
|
+
'/api/v2/conversations/summaries/settings/{summarySettingId}',
|
|
2399
|
+
'GET',
|
|
2400
|
+
{ 'summarySettingId': summarySettingId },
|
|
2401
|
+
{ },
|
|
2402
|
+
{ },
|
|
2403
|
+
{ },
|
|
2404
|
+
null,
|
|
2405
|
+
['PureCloud OAuth'],
|
|
2406
|
+
['application/json'],
|
|
2407
|
+
['application/json']
|
|
2408
|
+
);
|
|
2409
|
+
}
|
|
2410
|
+
|
|
2411
|
+
/**
|
|
2412
|
+
* Get all summary settings.
|
|
2413
|
+
*
|
|
2414
|
+
* @param {Object} opts Optional parameters
|
|
2415
|
+
* @param {String} opts.language Filter by matching language - case insensitive.
|
|
2416
|
+
* @param {String} opts.name Filter by partially matching name - case insensitive.
|
|
2417
|
+
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
2418
|
+
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
2419
|
+
* @param {Number} opts.pageNumber Page number. (default to 1)
|
|
2420
|
+
* @param {Number} opts.pageSize Page size. The maximum page size is 100. (default to 25)
|
|
2421
|
+
*/
|
|
2422
|
+
getConversationsSummariesSettings(opts) {
|
|
2423
|
+
opts = opts || {};
|
|
2424
|
+
|
|
2425
|
+
|
|
2426
|
+
return this.apiClient.callApi(
|
|
2427
|
+
'/api/v2/conversations/summaries/settings',
|
|
2428
|
+
'GET',
|
|
2429
|
+
{ },
|
|
2430
|
+
{ 'language': opts['language'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
2431
|
+
{ },
|
|
2432
|
+
{ },
|
|
2433
|
+
null,
|
|
2434
|
+
['PureCloud OAuth'],
|
|
2435
|
+
['application/json'],
|
|
2436
|
+
['application/json']
|
|
2437
|
+
);
|
|
2438
|
+
}
|
|
2439
|
+
|
|
2334
2440
|
/**
|
|
2335
2441
|
* Get guide.
|
|
2336
2442
|
*
|
|
@@ -2579,6 +2685,56 @@ class AIStudioApi {
|
|
|
2579
2685
|
);
|
|
2580
2686
|
}
|
|
2581
2687
|
|
|
2688
|
+
/**
|
|
2689
|
+
* Trigger summary preview event generation.
|
|
2690
|
+
*
|
|
2691
|
+
* @param {Object} body
|
|
2692
|
+
*/
|
|
2693
|
+
postConversationsSummariesPreview(body) {
|
|
2694
|
+
// verify the required parameter 'body' is set
|
|
2695
|
+
if (body === undefined || body === null) {
|
|
2696
|
+
throw 'Missing the required parameter "body" when calling postConversationsSummariesPreview';
|
|
2697
|
+
}
|
|
2698
|
+
|
|
2699
|
+
return this.apiClient.callApi(
|
|
2700
|
+
'/api/v2/conversations/summaries/preview',
|
|
2701
|
+
'POST',
|
|
2702
|
+
{ },
|
|
2703
|
+
{ },
|
|
2704
|
+
{ },
|
|
2705
|
+
{ },
|
|
2706
|
+
body,
|
|
2707
|
+
['PureCloud OAuth'],
|
|
2708
|
+
['application/json'],
|
|
2709
|
+
['application/json']
|
|
2710
|
+
);
|
|
2711
|
+
}
|
|
2712
|
+
|
|
2713
|
+
/**
|
|
2714
|
+
* Create a summary setting.
|
|
2715
|
+
*
|
|
2716
|
+
* @param {Object} body
|
|
2717
|
+
*/
|
|
2718
|
+
postConversationsSummariesSettings(body) {
|
|
2719
|
+
// verify the required parameter 'body' is set
|
|
2720
|
+
if (body === undefined || body === null) {
|
|
2721
|
+
throw 'Missing the required parameter "body" when calling postConversationsSummariesSettings';
|
|
2722
|
+
}
|
|
2723
|
+
|
|
2724
|
+
return this.apiClient.callApi(
|
|
2725
|
+
'/api/v2/conversations/summaries/settings',
|
|
2726
|
+
'POST',
|
|
2727
|
+
{ },
|
|
2728
|
+
{ },
|
|
2729
|
+
{ },
|
|
2730
|
+
{ },
|
|
2731
|
+
body,
|
|
2732
|
+
['PureCloud OAuth'],
|
|
2733
|
+
['application/json'],
|
|
2734
|
+
['application/json']
|
|
2735
|
+
);
|
|
2736
|
+
}
|
|
2737
|
+
|
|
2582
2738
|
/**
|
|
2583
2739
|
* Start the publishing of a guide version.
|
|
2584
2740
|
*
|
|
@@ -2697,13 +2853,43 @@ class AIStudioApi {
|
|
|
2697
2853
|
);
|
|
2698
2854
|
}
|
|
2699
2855
|
|
|
2856
|
+
/**
|
|
2857
|
+
* Update a summary setting.
|
|
2858
|
+
*
|
|
2859
|
+
* @param {String} summarySettingId Summary setting id
|
|
2860
|
+
* @param {Object} body
|
|
2861
|
+
*/
|
|
2862
|
+
putConversationsSummariesSetting(summarySettingId, body) {
|
|
2863
|
+
// verify the required parameter 'summarySettingId' is set
|
|
2864
|
+
if (summarySettingId === undefined || summarySettingId === null || summarySettingId === '') {
|
|
2865
|
+
throw 'Missing the required parameter "summarySettingId" when calling putConversationsSummariesSetting';
|
|
2866
|
+
}
|
|
2867
|
+
// verify the required parameter 'body' is set
|
|
2868
|
+
if (body === undefined || body === null) {
|
|
2869
|
+
throw 'Missing the required parameter "body" when calling putConversationsSummariesSetting';
|
|
2870
|
+
}
|
|
2871
|
+
|
|
2872
|
+
return this.apiClient.callApi(
|
|
2873
|
+
'/api/v2/conversations/summaries/settings/{summarySettingId}',
|
|
2874
|
+
'PUT',
|
|
2875
|
+
{ 'summarySettingId': summarySettingId },
|
|
2876
|
+
{ },
|
|
2877
|
+
{ },
|
|
2878
|
+
{ },
|
|
2879
|
+
body,
|
|
2880
|
+
['PureCloud OAuth'],
|
|
2881
|
+
['application/json'],
|
|
2882
|
+
['application/json']
|
|
2883
|
+
);
|
|
2884
|
+
}
|
|
2885
|
+
|
|
2700
2886
|
}
|
|
2701
2887
|
|
|
2702
2888
|
class AgentAssistantsApi {
|
|
2703
2889
|
/**
|
|
2704
2890
|
* AgentAssistants service.
|
|
2705
2891
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2706
|
-
* @version
|
|
2892
|
+
* @version 232.0.0
|
|
2707
2893
|
*/
|
|
2708
2894
|
|
|
2709
2895
|
/**
|
|
@@ -3189,7 +3375,7 @@ class AgentCopilotApi {
|
|
|
3189
3375
|
/**
|
|
3190
3376
|
* AgentCopilot service.
|
|
3191
3377
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3192
|
-
* @version
|
|
3378
|
+
* @version 232.0.0
|
|
3193
3379
|
*/
|
|
3194
3380
|
|
|
3195
3381
|
/**
|
|
@@ -3229,6 +3415,30 @@ class AgentCopilotApi {
|
|
|
3229
3415
|
);
|
|
3230
3416
|
}
|
|
3231
3417
|
|
|
3418
|
+
/**
|
|
3419
|
+
* Get information about the support of features for all the languages or only for a certain language.
|
|
3420
|
+
*
|
|
3421
|
+
* @param {Object} opts Optional parameters
|
|
3422
|
+
* @param {String} opts.language Which language are the features supported for
|
|
3423
|
+
*/
|
|
3424
|
+
getAssistantsCopilotFeaturesupport(opts) {
|
|
3425
|
+
opts = opts || {};
|
|
3426
|
+
|
|
3427
|
+
|
|
3428
|
+
return this.apiClient.callApi(
|
|
3429
|
+
'/api/v2/assistants/copilot/featuresupport',
|
|
3430
|
+
'GET',
|
|
3431
|
+
{ },
|
|
3432
|
+
{ 'language': opts['language'] },
|
|
3433
|
+
{ },
|
|
3434
|
+
{ },
|
|
3435
|
+
null,
|
|
3436
|
+
['PureCloud OAuth'],
|
|
3437
|
+
['application/json'],
|
|
3438
|
+
['application/json']
|
|
3439
|
+
);
|
|
3440
|
+
}
|
|
3441
|
+
|
|
3232
3442
|
/**
|
|
3233
3443
|
* Update agent copilot configuration
|
|
3234
3444
|
*
|
|
@@ -3265,7 +3475,7 @@ class AgentUIApi {
|
|
|
3265
3475
|
/**
|
|
3266
3476
|
* AgentUI service.
|
|
3267
3477
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
3268
|
-
* @version
|
|
3478
|
+
* @version 232.0.0
|
|
3269
3479
|
*/
|
|
3270
3480
|
|
|
3271
3481
|
/**
|
|
@@ -3396,7 +3606,7 @@ class AlertingApi {
|
|
|
3396
3606
|
/**
|
|
3397
3607
|
* Alerting service.
|
|
3398
3608
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3399
|
-
* @version
|
|
3609
|
+
* @version 232.0.0
|
|
3400
3610
|
*/
|
|
3401
3611
|
|
|
3402
3612
|
/**
|
|
@@ -3797,7 +4007,7 @@ class AnalyticsApi {
|
|
|
3797
4007
|
/**
|
|
3798
4008
|
* Analytics service.
|
|
3799
4009
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3800
|
-
* @version
|
|
4010
|
+
* @version 232.0.0
|
|
3801
4011
|
*/
|
|
3802
4012
|
|
|
3803
4013
|
/**
|
|
@@ -4729,6 +4939,62 @@ class AnalyticsApi {
|
|
|
4729
4939
|
);
|
|
4730
4940
|
}
|
|
4731
4941
|
|
|
4942
|
+
/**
|
|
4943
|
+
* Get analytics data warehouse file download
|
|
4944
|
+
*
|
|
4945
|
+
* @param {String} downloadId Unique file Id to download
|
|
4946
|
+
* getAnalyticsDataextractionDownload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4947
|
+
*/
|
|
4948
|
+
getAnalyticsDataextractionDownload(downloadId) {
|
|
4949
|
+
// verify the required parameter 'downloadId' is set
|
|
4950
|
+
if (downloadId === undefined || downloadId === null || downloadId === '') {
|
|
4951
|
+
throw 'Missing the required parameter "downloadId" when calling getAnalyticsDataextractionDownload';
|
|
4952
|
+
}
|
|
4953
|
+
|
|
4954
|
+
return this.apiClient.callApi(
|
|
4955
|
+
'/api/v2/analytics/dataextraction/downloads/{downloadId}',
|
|
4956
|
+
'GET',
|
|
4957
|
+
{ 'downloadId': downloadId },
|
|
4958
|
+
{ },
|
|
4959
|
+
{ },
|
|
4960
|
+
{ },
|
|
4961
|
+
null,
|
|
4962
|
+
['PureCloud OAuth'],
|
|
4963
|
+
['application/json'],
|
|
4964
|
+
['application/json']
|
|
4965
|
+
);
|
|
4966
|
+
}
|
|
4967
|
+
|
|
4968
|
+
/**
|
|
4969
|
+
* Get metadata on files available for extraction
|
|
4970
|
+
*
|
|
4971
|
+
* @param {Object} opts Optional parameters
|
|
4972
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
4973
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
4974
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
4975
|
+
* @param {String} opts.dataSchema Data schema like conversations
|
|
4976
|
+
* @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
|
|
4977
|
+
* @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
|
|
4978
|
+
* getAnalyticsDataextractionDownloadsMetadata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4979
|
+
*/
|
|
4980
|
+
getAnalyticsDataextractionDownloadsMetadata(opts) {
|
|
4981
|
+
opts = opts || {};
|
|
4982
|
+
|
|
4983
|
+
|
|
4984
|
+
return this.apiClient.callApi(
|
|
4985
|
+
'/api/v2/analytics/dataextraction/downloads/metadata',
|
|
4986
|
+
'GET',
|
|
4987
|
+
{ },
|
|
4988
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'dataSchema': opts['dataSchema'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'] },
|
|
4989
|
+
{ },
|
|
4990
|
+
{ },
|
|
4991
|
+
null,
|
|
4992
|
+
['PureCloud OAuth'],
|
|
4993
|
+
['application/json'],
|
|
4994
|
+
['application/json']
|
|
4995
|
+
);
|
|
4996
|
+
}
|
|
4997
|
+
|
|
4732
4998
|
/**
|
|
4733
4999
|
* Get analytics data retention setting
|
|
4734
5000
|
*
|
|
@@ -6021,6 +6287,32 @@ class AnalyticsApi {
|
|
|
6021
6287
|
);
|
|
6022
6288
|
}
|
|
6023
6289
|
|
|
6290
|
+
/**
|
|
6291
|
+
* Get download URLs for analytics data warehouse files
|
|
6292
|
+
*
|
|
6293
|
+
* @param {Object} body request
|
|
6294
|
+
* postAnalyticsDataextractionDownloadsBulk is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6295
|
+
*/
|
|
6296
|
+
postAnalyticsDataextractionDownloadsBulk(body) {
|
|
6297
|
+
// verify the required parameter 'body' is set
|
|
6298
|
+
if (body === undefined || body === null) {
|
|
6299
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsDataextractionDownloadsBulk';
|
|
6300
|
+
}
|
|
6301
|
+
|
|
6302
|
+
return this.apiClient.callApi(
|
|
6303
|
+
'/api/v2/analytics/dataextraction/downloads/bulk',
|
|
6304
|
+
'POST',
|
|
6305
|
+
{ },
|
|
6306
|
+
{ },
|
|
6307
|
+
{ },
|
|
6308
|
+
{ },
|
|
6309
|
+
body,
|
|
6310
|
+
['PureCloud OAuth'],
|
|
6311
|
+
['application/json'],
|
|
6312
|
+
['application/json']
|
|
6313
|
+
);
|
|
6314
|
+
}
|
|
6315
|
+
|
|
6024
6316
|
/**
|
|
6025
6317
|
* Query for evaluation aggregates asynchronously
|
|
6026
6318
|
*
|
|
@@ -6983,7 +7275,7 @@ class ArchitectApi {
|
|
|
6983
7275
|
/**
|
|
6984
7276
|
* Architect service.
|
|
6985
7277
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6986
|
-
* @version
|
|
7278
|
+
* @version 232.0.0
|
|
6987
7279
|
*/
|
|
6988
7280
|
|
|
6989
7281
|
/**
|
|
@@ -11278,7 +11570,7 @@ class AuditApi {
|
|
|
11278
11570
|
/**
|
|
11279
11571
|
* Audit service.
|
|
11280
11572
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
11281
|
-
* @version
|
|
11573
|
+
* @version 232.0.0
|
|
11282
11574
|
*/
|
|
11283
11575
|
|
|
11284
11576
|
/**
|
|
@@ -11479,7 +11771,7 @@ class AuthorizationApi {
|
|
|
11479
11771
|
/**
|
|
11480
11772
|
* Authorization service.
|
|
11481
11773
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
11482
|
-
* @version
|
|
11774
|
+
* @version 232.0.0
|
|
11483
11775
|
*/
|
|
11484
11776
|
|
|
11485
11777
|
/**
|
|
@@ -13194,7 +13486,7 @@ class BillingApi {
|
|
|
13194
13486
|
/**
|
|
13195
13487
|
* Billing service.
|
|
13196
13488
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
13197
|
-
* @version
|
|
13489
|
+
* @version 232.0.0
|
|
13198
13490
|
*/
|
|
13199
13491
|
|
|
13200
13492
|
/**
|
|
@@ -13450,7 +13742,7 @@ class BusinessRulesApi {
|
|
|
13450
13742
|
/**
|
|
13451
13743
|
* BusinessRules service.
|
|
13452
13744
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
13453
|
-
* @version
|
|
13745
|
+
* @version 232.0.0
|
|
13454
13746
|
*/
|
|
13455
13747
|
|
|
13456
13748
|
/**
|
|
@@ -14366,7 +14658,7 @@ class CarrierServicesApi {
|
|
|
14366
14658
|
/**
|
|
14367
14659
|
* CarrierServices service.
|
|
14368
14660
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
14369
|
-
* @version
|
|
14661
|
+
* @version 232.0.0
|
|
14370
14662
|
*/
|
|
14371
14663
|
|
|
14372
14664
|
/**
|
|
@@ -14436,7 +14728,7 @@ class ChatApi {
|
|
|
14436
14728
|
/**
|
|
14437
14729
|
* Chat service.
|
|
14438
14730
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
14439
|
-
* @version
|
|
14731
|
+
* @version 232.0.0
|
|
14440
14732
|
*/
|
|
14441
14733
|
|
|
14442
14734
|
/**
|
|
@@ -15417,7 +15709,7 @@ class CoachingApi {
|
|
|
15417
15709
|
/**
|
|
15418
15710
|
* Coaching service.
|
|
15419
15711
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
15420
|
-
* @version
|
|
15712
|
+
* @version 232.0.0
|
|
15421
15713
|
*/
|
|
15422
15714
|
|
|
15423
15715
|
/**
|
|
@@ -15994,7 +16286,7 @@ class ContentManagementApi {
|
|
|
15994
16286
|
/**
|
|
15995
16287
|
* ContentManagement service.
|
|
15996
16288
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
15997
|
-
* @version
|
|
16289
|
+
* @version 232.0.0
|
|
15998
16290
|
*/
|
|
15999
16291
|
|
|
16000
16292
|
/**
|
|
@@ -17075,7 +17367,7 @@ class ConversationsApi {
|
|
|
17075
17367
|
/**
|
|
17076
17368
|
* Conversations service.
|
|
17077
17369
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
17078
|
-
* @version
|
|
17370
|
+
* @version 232.0.0
|
|
17079
17371
|
*/
|
|
17080
17372
|
|
|
17081
17373
|
/**
|
|
@@ -17316,6 +17608,31 @@ class ConversationsApi {
|
|
|
17316
17608
|
);
|
|
17317
17609
|
}
|
|
17318
17610
|
|
|
17611
|
+
/**
|
|
17612
|
+
* Delete an Apple messaging integration
|
|
17613
|
+
*
|
|
17614
|
+
* @param {String} integrationId Integration ID
|
|
17615
|
+
*/
|
|
17616
|
+
deleteConversationsMessagingIntegrationsAppleIntegrationId(integrationId) {
|
|
17617
|
+
// verify the required parameter 'integrationId' is set
|
|
17618
|
+
if (integrationId === undefined || integrationId === null || integrationId === '') {
|
|
17619
|
+
throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsAppleIntegrationId';
|
|
17620
|
+
}
|
|
17621
|
+
|
|
17622
|
+
return this.apiClient.callApi(
|
|
17623
|
+
'/api/v2/conversations/messaging/integrations/apple/{integrationId}',
|
|
17624
|
+
'DELETE',
|
|
17625
|
+
{ 'integrationId': integrationId },
|
|
17626
|
+
{ },
|
|
17627
|
+
{ },
|
|
17628
|
+
{ },
|
|
17629
|
+
null,
|
|
17630
|
+
['PureCloud OAuth'],
|
|
17631
|
+
['application/json'],
|
|
17632
|
+
['application/json']
|
|
17633
|
+
);
|
|
17634
|
+
}
|
|
17635
|
+
|
|
17319
17636
|
/**
|
|
17320
17637
|
* Delete a Facebook messaging integration
|
|
17321
17638
|
*
|
|
@@ -19451,7 +19768,6 @@ class ConversationsApi {
|
|
|
19451
19768
|
* Get Apple messaging integration identity resolution settings
|
|
19452
19769
|
*
|
|
19453
19770
|
* @param {String} integrationId Integration ID
|
|
19454
|
-
* getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19455
19771
|
*/
|
|
19456
19772
|
getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId) {
|
|
19457
19773
|
// verify the required parameter 'integrationId' is set
|
|
@@ -19651,6 +19967,63 @@ class ConversationsApi {
|
|
|
19651
19967
|
);
|
|
19652
19968
|
}
|
|
19653
19969
|
|
|
19970
|
+
/**
|
|
19971
|
+
* Get a list of Apple Integrations
|
|
19972
|
+
*
|
|
19973
|
+
* @param {Object} opts Optional parameters
|
|
19974
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
19975
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
19976
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
19977
|
+
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
19978
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
19979
|
+
*/
|
|
19980
|
+
getConversationsMessagingIntegrationsApple(opts) {
|
|
19981
|
+
opts = opts || {};
|
|
19982
|
+
|
|
19983
|
+
|
|
19984
|
+
return this.apiClient.callApi(
|
|
19985
|
+
'/api/v2/conversations/messaging/integrations/apple',
|
|
19986
|
+
'GET',
|
|
19987
|
+
{ },
|
|
19988
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
19989
|
+
{ },
|
|
19990
|
+
{ },
|
|
19991
|
+
null,
|
|
19992
|
+
['PureCloud OAuth'],
|
|
19993
|
+
['application/json'],
|
|
19994
|
+
['application/json']
|
|
19995
|
+
);
|
|
19996
|
+
}
|
|
19997
|
+
|
|
19998
|
+
/**
|
|
19999
|
+
* Get an Apple messaging integration
|
|
20000
|
+
*
|
|
20001
|
+
* @param {String} integrationId Integration ID
|
|
20002
|
+
* @param {Object} opts Optional parameters
|
|
20003
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
20004
|
+
*/
|
|
20005
|
+
getConversationsMessagingIntegrationsAppleIntegrationId(integrationId, opts) {
|
|
20006
|
+
opts = opts || {};
|
|
20007
|
+
|
|
20008
|
+
// verify the required parameter 'integrationId' is set
|
|
20009
|
+
if (integrationId === undefined || integrationId === null || integrationId === '') {
|
|
20010
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsAppleIntegrationId';
|
|
20011
|
+
}
|
|
20012
|
+
|
|
20013
|
+
return this.apiClient.callApi(
|
|
20014
|
+
'/api/v2/conversations/messaging/integrations/apple/{integrationId}',
|
|
20015
|
+
'GET',
|
|
20016
|
+
{ 'integrationId': integrationId },
|
|
20017
|
+
{ 'expand': opts['expand'] },
|
|
20018
|
+
{ },
|
|
20019
|
+
{ },
|
|
20020
|
+
null,
|
|
20021
|
+
['PureCloud OAuth'],
|
|
20022
|
+
['application/json'],
|
|
20023
|
+
['application/json']
|
|
20024
|
+
);
|
|
20025
|
+
}
|
|
20026
|
+
|
|
19654
20027
|
/**
|
|
19655
20028
|
* Get a list of Facebook Integrations
|
|
19656
20029
|
*
|
|
@@ -19956,6 +20329,40 @@ class ConversationsApi {
|
|
|
19956
20329
|
);
|
|
19957
20330
|
}
|
|
19958
20331
|
|
|
20332
|
+
/**
|
|
20333
|
+
* Call Authentication provider callback to validate state and code
|
|
20334
|
+
*
|
|
20335
|
+
* @param {String} code The authorization code to be sent to the authentication server during the token request.
|
|
20336
|
+
* @param {String} state The state/nonce value generated by Genesys Auth-Client Service.
|
|
20337
|
+
* @param {Object} opts Optional parameters
|
|
20338
|
+
* @param {String} opts.error Error parameter from OAuth provider
|
|
20339
|
+
*/
|
|
20340
|
+
getConversationsMessagingOauthAppleCallback(code, state, opts) {
|
|
20341
|
+
opts = opts || {};
|
|
20342
|
+
|
|
20343
|
+
// verify the required parameter 'code' is set
|
|
20344
|
+
if (code === undefined || code === null) {
|
|
20345
|
+
throw 'Missing the required parameter "code" when calling getConversationsMessagingOauthAppleCallback';
|
|
20346
|
+
}
|
|
20347
|
+
// verify the required parameter 'state' is set
|
|
20348
|
+
if (state === undefined || state === null) {
|
|
20349
|
+
throw 'Missing the required parameter "state" when calling getConversationsMessagingOauthAppleCallback';
|
|
20350
|
+
}
|
|
20351
|
+
|
|
20352
|
+
return this.apiClient.callApi(
|
|
20353
|
+
'/api/v2/conversations/messaging/oauth/apple/callback',
|
|
20354
|
+
'GET',
|
|
20355
|
+
{ },
|
|
20356
|
+
{ 'code': code,'state': state,'error': opts['error'] },
|
|
20357
|
+
{ },
|
|
20358
|
+
{ },
|
|
20359
|
+
null,
|
|
20360
|
+
['PureCloud OAuth'],
|
|
20361
|
+
['application/json'],
|
|
20362
|
+
['application/json']
|
|
20363
|
+
);
|
|
20364
|
+
}
|
|
20365
|
+
|
|
19959
20366
|
/**
|
|
19960
20367
|
* Get a messaging setting
|
|
19961
20368
|
*
|
|
@@ -21574,6 +21981,36 @@ class ConversationsApi {
|
|
|
21574
21981
|
);
|
|
21575
21982
|
}
|
|
21576
21983
|
|
|
21984
|
+
/**
|
|
21985
|
+
* Update an Apple messaging integration
|
|
21986
|
+
*
|
|
21987
|
+
* @param {String} integrationId Integration ID
|
|
21988
|
+
* @param {Object} body AppleIntegrationUpdateRequest
|
|
21989
|
+
*/
|
|
21990
|
+
patchConversationsMessagingIntegrationsAppleIntegrationId(integrationId, body) {
|
|
21991
|
+
// verify the required parameter 'integrationId' is set
|
|
21992
|
+
if (integrationId === undefined || integrationId === null || integrationId === '') {
|
|
21993
|
+
throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsAppleIntegrationId';
|
|
21994
|
+
}
|
|
21995
|
+
// verify the required parameter 'body' is set
|
|
21996
|
+
if (body === undefined || body === null) {
|
|
21997
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsAppleIntegrationId';
|
|
21998
|
+
}
|
|
21999
|
+
|
|
22000
|
+
return this.apiClient.callApi(
|
|
22001
|
+
'/api/v2/conversations/messaging/integrations/apple/{integrationId}',
|
|
22002
|
+
'PATCH',
|
|
22003
|
+
{ 'integrationId': integrationId },
|
|
22004
|
+
{ },
|
|
22005
|
+
{ },
|
|
22006
|
+
{ },
|
|
22007
|
+
body,
|
|
22008
|
+
['PureCloud OAuth'],
|
|
22009
|
+
['application/json'],
|
|
22010
|
+
['application/json']
|
|
22011
|
+
);
|
|
22012
|
+
}
|
|
22013
|
+
|
|
21577
22014
|
/**
|
|
21578
22015
|
* Update Facebook messaging integration
|
|
21579
22016
|
*
|
|
@@ -23027,6 +23464,41 @@ class ConversationsApi {
|
|
|
23027
23464
|
);
|
|
23028
23465
|
}
|
|
23029
23466
|
|
|
23467
|
+
/**
|
|
23468
|
+
* Add participants to a conversation on behalf of a user
|
|
23469
|
+
*
|
|
23470
|
+
* @param {String} conversationId conversationId
|
|
23471
|
+
* @param {String} userId userId
|
|
23472
|
+
* @param {Object} body Conversation
|
|
23473
|
+
*/
|
|
23474
|
+
postConversationsCallParticipantsUserUserId(conversationId, userId, body) {
|
|
23475
|
+
// verify the required parameter 'conversationId' is set
|
|
23476
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
23477
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantsUserUserId';
|
|
23478
|
+
}
|
|
23479
|
+
// verify the required parameter 'userId' is set
|
|
23480
|
+
if (userId === undefined || userId === null || userId === '') {
|
|
23481
|
+
throw 'Missing the required parameter "userId" when calling postConversationsCallParticipantsUserUserId';
|
|
23482
|
+
}
|
|
23483
|
+
// verify the required parameter 'body' is set
|
|
23484
|
+
if (body === undefined || body === null) {
|
|
23485
|
+
throw 'Missing the required parameter "body" when calling postConversationsCallParticipantsUserUserId';
|
|
23486
|
+
}
|
|
23487
|
+
|
|
23488
|
+
return this.apiClient.callApi(
|
|
23489
|
+
'/api/v2/conversations/calls/{conversationId}/participants/user/{userId}',
|
|
23490
|
+
'POST',
|
|
23491
|
+
{ 'conversationId': conversationId,'userId': userId },
|
|
23492
|
+
{ },
|
|
23493
|
+
{ },
|
|
23494
|
+
{ },
|
|
23495
|
+
body,
|
|
23496
|
+
['PureCloud OAuth'],
|
|
23497
|
+
['application/json'],
|
|
23498
|
+
['application/json']
|
|
23499
|
+
);
|
|
23500
|
+
}
|
|
23501
|
+
|
|
23030
23502
|
/**
|
|
23031
23503
|
* Apply wrap-up for this conversation communication
|
|
23032
23504
|
*
|
|
@@ -23201,6 +23673,36 @@ class ConversationsApi {
|
|
|
23201
23673
|
);
|
|
23202
23674
|
}
|
|
23203
23675
|
|
|
23676
|
+
/**
|
|
23677
|
+
* Create a call conversation on behalf of a user
|
|
23678
|
+
*
|
|
23679
|
+
* @param {String} userId userId
|
|
23680
|
+
* @param {Object} body Call request
|
|
23681
|
+
*/
|
|
23682
|
+
postConversationsCallsUserUserId(userId, body) {
|
|
23683
|
+
// verify the required parameter 'userId' is set
|
|
23684
|
+
if (userId === undefined || userId === null || userId === '') {
|
|
23685
|
+
throw 'Missing the required parameter "userId" when calling postConversationsCallsUserUserId';
|
|
23686
|
+
}
|
|
23687
|
+
// verify the required parameter 'body' is set
|
|
23688
|
+
if (body === undefined || body === null) {
|
|
23689
|
+
throw 'Missing the required parameter "body" when calling postConversationsCallsUserUserId';
|
|
23690
|
+
}
|
|
23691
|
+
|
|
23692
|
+
return this.apiClient.callApi(
|
|
23693
|
+
'/api/v2/conversations/calls/user/{userId}',
|
|
23694
|
+
'POST',
|
|
23695
|
+
{ 'userId': userId },
|
|
23696
|
+
{ },
|
|
23697
|
+
{ },
|
|
23698
|
+
{ },
|
|
23699
|
+
body,
|
|
23700
|
+
['PureCloud OAuth'],
|
|
23701
|
+
['application/json'],
|
|
23702
|
+
['application/json']
|
|
23703
|
+
);
|
|
23704
|
+
}
|
|
23705
|
+
|
|
23204
23706
|
/**
|
|
23205
23707
|
* Send a message on behalf of a communication in a chat conversation.
|
|
23206
23708
|
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
@@ -23611,7 +24113,7 @@ class ConversationsApi {
|
|
|
23611
24113
|
|
|
23612
24114
|
/**
|
|
23613
24115
|
* Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation
|
|
23614
|
-
*
|
|
24116
|
+
* This request is not valid when using the Client Credentials OAuth grant.
|
|
23615
24117
|
* @param {String} conversationId conversationId
|
|
23616
24118
|
*/
|
|
23617
24119
|
postConversationsEmailReconnect(conversationId) {
|
|
@@ -24272,6 +24774,31 @@ class ConversationsApi {
|
|
|
24272
24774
|
);
|
|
24273
24775
|
}
|
|
24274
24776
|
|
|
24777
|
+
/**
|
|
24778
|
+
* Create Apple Integration
|
|
24779
|
+
*
|
|
24780
|
+
* @param {Object} body AppleIntegrationRequest
|
|
24781
|
+
*/
|
|
24782
|
+
postConversationsMessagingIntegrationsApple(body) {
|
|
24783
|
+
// verify the required parameter 'body' is set
|
|
24784
|
+
if (body === undefined || body === null) {
|
|
24785
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsApple';
|
|
24786
|
+
}
|
|
24787
|
+
|
|
24788
|
+
return this.apiClient.callApi(
|
|
24789
|
+
'/api/v2/conversations/messaging/integrations/apple',
|
|
24790
|
+
'POST',
|
|
24791
|
+
{ },
|
|
24792
|
+
{ },
|
|
24793
|
+
{ },
|
|
24794
|
+
{ },
|
|
24795
|
+
body,
|
|
24796
|
+
['PureCloud OAuth'],
|
|
24797
|
+
['application/json'],
|
|
24798
|
+
['application/json']
|
|
24799
|
+
);
|
|
24800
|
+
}
|
|
24801
|
+
|
|
24275
24802
|
/**
|
|
24276
24803
|
* Create a Facebook Integration
|
|
24277
24804
|
*
|
|
@@ -25050,7 +25577,6 @@ class ConversationsApi {
|
|
|
25050
25577
|
*
|
|
25051
25578
|
* @param {String} integrationId Integration ID
|
|
25052
25579
|
* @param {Object} body IdentityResolutionConfig
|
|
25053
|
-
* putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25054
25580
|
*/
|
|
25055
25581
|
putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId, body) {
|
|
25056
25582
|
// verify the required parameter 'integrationId' is set
|
|
@@ -25398,7 +25924,7 @@ class DataExtensionsApi {
|
|
|
25398
25924
|
/**
|
|
25399
25925
|
* DataExtensions service.
|
|
25400
25926
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
25401
|
-
* @version
|
|
25927
|
+
* @version 232.0.0
|
|
25402
25928
|
*/
|
|
25403
25929
|
|
|
25404
25930
|
/**
|
|
@@ -25484,7 +26010,7 @@ class DataPrivacyApi {
|
|
|
25484
26010
|
/**
|
|
25485
26011
|
* DataPrivacy service.
|
|
25486
26012
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
25487
|
-
* @version
|
|
26013
|
+
* @version 232.0.0
|
|
25488
26014
|
*/
|
|
25489
26015
|
|
|
25490
26016
|
/**
|
|
@@ -25654,7 +26180,7 @@ class DownloadsApi {
|
|
|
25654
26180
|
/**
|
|
25655
26181
|
* Downloads service.
|
|
25656
26182
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
25657
|
-
* @version
|
|
26183
|
+
* @version 232.0.0
|
|
25658
26184
|
*/
|
|
25659
26185
|
|
|
25660
26186
|
/**
|
|
@@ -25706,7 +26232,7 @@ class EmailsApi {
|
|
|
25706
26232
|
/**
|
|
25707
26233
|
* Emails service.
|
|
25708
26234
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
25709
|
-
* @version
|
|
26235
|
+
* @version 232.0.0
|
|
25710
26236
|
*/
|
|
25711
26237
|
|
|
25712
26238
|
/**
|
|
@@ -25835,7 +26361,7 @@ class EmployeeEngagementApi {
|
|
|
25835
26361
|
/**
|
|
25836
26362
|
* EmployeeEngagement service.
|
|
25837
26363
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
25838
|
-
* @version
|
|
26364
|
+
* @version 232.0.0
|
|
25839
26365
|
*/
|
|
25840
26366
|
|
|
25841
26367
|
/**
|
|
@@ -25986,7 +26512,7 @@ class EventsApi {
|
|
|
25986
26512
|
/**
|
|
25987
26513
|
* Events service.
|
|
25988
26514
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
25989
|
-
* @version
|
|
26515
|
+
* @version 232.0.0
|
|
25990
26516
|
*/
|
|
25991
26517
|
|
|
25992
26518
|
/**
|
|
@@ -26082,7 +26608,7 @@ class ExternalContactsApi {
|
|
|
26082
26608
|
/**
|
|
26083
26609
|
* ExternalContacts service.
|
|
26084
26610
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
26085
|
-
* @version
|
|
26611
|
+
* @version 232.0.0
|
|
26086
26612
|
*/
|
|
26087
26613
|
|
|
26088
26614
|
/**
|
|
@@ -29329,7 +29855,7 @@ class FaxApi {
|
|
|
29329
29855
|
/**
|
|
29330
29856
|
* Fax service.
|
|
29331
29857
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
29332
|
-
* @version
|
|
29858
|
+
* @version 232.0.0
|
|
29333
29859
|
*/
|
|
29334
29860
|
|
|
29335
29861
|
/**
|
|
@@ -29544,7 +30070,7 @@ class FlowsApi {
|
|
|
29544
30070
|
/**
|
|
29545
30071
|
* Flows service.
|
|
29546
30072
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
29547
|
-
* @version
|
|
30073
|
+
* @version 232.0.0
|
|
29548
30074
|
*/
|
|
29549
30075
|
|
|
29550
30076
|
/**
|
|
@@ -29753,7 +30279,7 @@ class GamificationApi {
|
|
|
29753
30279
|
/**
|
|
29754
30280
|
* Gamification service.
|
|
29755
30281
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
29756
|
-
* @version
|
|
30282
|
+
* @version 232.0.0
|
|
29757
30283
|
*/
|
|
29758
30284
|
|
|
29759
30285
|
/**
|
|
@@ -32260,7 +32786,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
32260
32786
|
/**
|
|
32261
32787
|
* GeneralDataProtectionRegulation service.
|
|
32262
32788
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
32263
|
-
* @version
|
|
32789
|
+
* @version 232.0.0
|
|
32264
32790
|
*/
|
|
32265
32791
|
|
|
32266
32792
|
/**
|
|
@@ -32390,7 +32916,7 @@ class GeolocationApi {
|
|
|
32390
32916
|
/**
|
|
32391
32917
|
* Geolocation service.
|
|
32392
32918
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
32393
|
-
* @version
|
|
32919
|
+
* @version 232.0.0
|
|
32394
32920
|
*/
|
|
32395
32921
|
|
|
32396
32922
|
/**
|
|
@@ -32521,7 +33047,7 @@ class GreetingsApi {
|
|
|
32521
33047
|
/**
|
|
32522
33048
|
* Greetings service.
|
|
32523
33049
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
32524
|
-
* @version
|
|
33050
|
+
* @version 232.0.0
|
|
32525
33051
|
*/
|
|
32526
33052
|
|
|
32527
33053
|
/**
|
|
@@ -33063,7 +33589,7 @@ class GroupsApi {
|
|
|
33063
33589
|
/**
|
|
33064
33590
|
* Groups service.
|
|
33065
33591
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
33066
|
-
* @version
|
|
33592
|
+
* @version 232.0.0
|
|
33067
33593
|
*/
|
|
33068
33594
|
|
|
33069
33595
|
/**
|
|
@@ -33582,7 +34108,7 @@ class IdentityProviderApi {
|
|
|
33582
34108
|
/**
|
|
33583
34109
|
* IdentityProvider service.
|
|
33584
34110
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
33585
|
-
* @version
|
|
34111
|
+
* @version 232.0.0
|
|
33586
34112
|
*/
|
|
33587
34113
|
|
|
33588
34114
|
/**
|
|
@@ -34443,7 +34969,7 @@ class InfrastructureAsCodeApi {
|
|
|
34443
34969
|
/**
|
|
34444
34970
|
* InfrastructureAsCode service.
|
|
34445
34971
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
34446
|
-
* @version
|
|
34972
|
+
* @version 232.0.0
|
|
34447
34973
|
*/
|
|
34448
34974
|
|
|
34449
34975
|
/**
|
|
@@ -34610,7 +35136,7 @@ class IntegrationsApi {
|
|
|
34610
35136
|
/**
|
|
34611
35137
|
* Integrations service.
|
|
34612
35138
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
34613
|
-
* @version
|
|
35139
|
+
* @version 232.0.0
|
|
34614
35140
|
*/
|
|
34615
35141
|
|
|
34616
35142
|
/**
|
|
@@ -34794,6 +35320,9 @@ class IntegrationsApi {
|
|
|
34794
35320
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
34795
35321
|
* @param {String} opts.nextPage next page token
|
|
34796
35322
|
* @param {String} opts.previousPage Previous page token
|
|
35323
|
+
* @param {Array.<String>} opts.ids Comma-separated list of integration IDs to filter by (max 100)
|
|
35324
|
+
* @param {String} opts.integrationType Filter integrations by integration type ID
|
|
35325
|
+
* @param {Object} opts.reportedState Filter integrations by reported state (case-insensitive)
|
|
34797
35326
|
*/
|
|
34798
35327
|
getIntegrations(opts) {
|
|
34799
35328
|
opts = opts || {};
|
|
@@ -34803,7 +35332,7 @@ class IntegrationsApi {
|
|
|
34803
35332
|
'/api/v2/integrations',
|
|
34804
35333
|
'GET',
|
|
34805
35334
|
{ },
|
|
34806
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'] },
|
|
35335
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi'),'integrationType': opts['integrationType'],'reportedState': opts['reportedState'] },
|
|
34807
35336
|
{ },
|
|
34808
35337
|
{ },
|
|
34809
35338
|
null,
|
|
@@ -37255,7 +37784,7 @@ class JourneyApi {
|
|
|
37255
37784
|
/**
|
|
37256
37785
|
* Journey service.
|
|
37257
37786
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
37258
|
-
* @version
|
|
37787
|
+
* @version 232.0.0
|
|
37259
37788
|
*/
|
|
37260
37789
|
|
|
37261
37790
|
/**
|
|
@@ -38543,6 +39072,33 @@ class JourneyApi {
|
|
|
38543
39072
|
);
|
|
38544
39073
|
}
|
|
38545
39074
|
|
|
39075
|
+
/**
|
|
39076
|
+
* Get my jobs
|
|
39077
|
+
*
|
|
39078
|
+
* @param {Object} opts Optional parameters
|
|
39079
|
+
* @param {Number} opts.pageNumber The number of the page to return (default to 1)
|
|
39080
|
+
* @param {Number} opts.pageSize Max number of entities to return (default to 25)
|
|
39081
|
+
* @param {String} opts.interval An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.
|
|
39082
|
+
* @param {String} opts.statuses Job statuses to filter for
|
|
39083
|
+
*/
|
|
39084
|
+
getJourneyViewsJobsMe(opts) {
|
|
39085
|
+
opts = opts || {};
|
|
39086
|
+
|
|
39087
|
+
|
|
39088
|
+
return this.apiClient.callApi(
|
|
39089
|
+
'/api/v2/journey/views/jobs/me',
|
|
39090
|
+
'GET',
|
|
39091
|
+
{ },
|
|
39092
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'interval': opts['interval'],'statuses': opts['statuses'] },
|
|
39093
|
+
{ },
|
|
39094
|
+
{ },
|
|
39095
|
+
null,
|
|
39096
|
+
['PureCloud OAuth'],
|
|
39097
|
+
['application/json'],
|
|
39098
|
+
['application/json']
|
|
39099
|
+
);
|
|
39100
|
+
}
|
|
39101
|
+
|
|
38546
39102
|
/**
|
|
38547
39103
|
* Get the journey schedules for an organization.
|
|
38548
39104
|
*
|
|
@@ -39325,7 +39881,7 @@ class KnowledgeApi {
|
|
|
39325
39881
|
/**
|
|
39326
39882
|
* Knowledge service.
|
|
39327
39883
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
39328
|
-
* @version
|
|
39884
|
+
* @version 232.0.0
|
|
39329
39885
|
*/
|
|
39330
39886
|
|
|
39331
39887
|
/**
|
|
@@ -43227,7 +43783,7 @@ class LanguageUnderstandingApi {
|
|
|
43227
43783
|
/**
|
|
43228
43784
|
* LanguageUnderstanding service.
|
|
43229
43785
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
43230
|
-
* @version
|
|
43786
|
+
* @version 232.0.0
|
|
43231
43787
|
*/
|
|
43232
43788
|
|
|
43233
43789
|
/**
|
|
@@ -43601,6 +44157,72 @@ class LanguageUnderstandingApi {
|
|
|
43601
44157
|
);
|
|
43602
44158
|
}
|
|
43603
44159
|
|
|
44160
|
+
/**
|
|
44161
|
+
* Get list of all ignored phrases of the specified language code
|
|
44162
|
+
*
|
|
44163
|
+
* @param {String} languageCode Language Code
|
|
44164
|
+
* @param {Object} opts Optional parameters
|
|
44165
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 200. (default to 25)
|
|
44166
|
+
* @param {Number} opts.pageNumber The page number for the listing (default to 1)
|
|
44167
|
+
* @param {String} opts.text The phrase text filter applied to the listing
|
|
44168
|
+
* @param {Object} opts.sortOrder The sort order for the listing (default to desc)
|
|
44169
|
+
* @param {Object} opts.sortBy The field to sort by for the listing (default to dateModified)
|
|
44170
|
+
*/
|
|
44171
|
+
getLanguageunderstandingIgnorephrase(languageCode, opts) {
|
|
44172
|
+
opts = opts || {};
|
|
44173
|
+
|
|
44174
|
+
// verify the required parameter 'languageCode' is set
|
|
44175
|
+
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
44176
|
+
throw 'Missing the required parameter "languageCode" when calling getLanguageunderstandingIgnorephrase';
|
|
44177
|
+
}
|
|
44178
|
+
|
|
44179
|
+
return this.apiClient.callApi(
|
|
44180
|
+
'/api/v2/languageunderstanding/ignorephrases/{languageCode}',
|
|
44181
|
+
'GET',
|
|
44182
|
+
{ 'languageCode': languageCode },
|
|
44183
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'text': opts['text'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'] },
|
|
44184
|
+
{ },
|
|
44185
|
+
{ },
|
|
44186
|
+
null,
|
|
44187
|
+
['PureCloud OAuth'],
|
|
44188
|
+
['application/json'],
|
|
44189
|
+
['application/json']
|
|
44190
|
+
);
|
|
44191
|
+
}
|
|
44192
|
+
|
|
44193
|
+
/**
|
|
44194
|
+
* Get list of all ignored topics of the specified language code
|
|
44195
|
+
*
|
|
44196
|
+
* @param {String} languageCode Language Code
|
|
44197
|
+
* @param {Object} opts Optional parameters
|
|
44198
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 200. (default to 25)
|
|
44199
|
+
* @param {Number} opts.pageNumber The page number for the listing (default to 1)
|
|
44200
|
+
* @param {String} opts.text The topic text filter applied to the listing
|
|
44201
|
+
* @param {Object} opts.sortOrder The sort order for the listing (default to desc)
|
|
44202
|
+
* @param {Object} opts.sortBy The field to sort by for the listing (default to dateModified)
|
|
44203
|
+
*/
|
|
44204
|
+
getLanguageunderstandingIgnoretopic(languageCode, opts) {
|
|
44205
|
+
opts = opts || {};
|
|
44206
|
+
|
|
44207
|
+
// verify the required parameter 'languageCode' is set
|
|
44208
|
+
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
44209
|
+
throw 'Missing the required parameter "languageCode" when calling getLanguageunderstandingIgnoretopic';
|
|
44210
|
+
}
|
|
44211
|
+
|
|
44212
|
+
return this.apiClient.callApi(
|
|
44213
|
+
'/api/v2/languageunderstanding/ignoretopics/{languageCode}',
|
|
44214
|
+
'GET',
|
|
44215
|
+
{ 'languageCode': languageCode },
|
|
44216
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'text': opts['text'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'] },
|
|
44217
|
+
{ },
|
|
44218
|
+
{ },
|
|
44219
|
+
null,
|
|
44220
|
+
['PureCloud OAuth'],
|
|
44221
|
+
['application/json'],
|
|
44222
|
+
['application/json']
|
|
44223
|
+
);
|
|
44224
|
+
}
|
|
44225
|
+
|
|
43604
44226
|
/**
|
|
43605
44227
|
* Get information about a miner.
|
|
43606
44228
|
*
|
|
@@ -44135,6 +44757,126 @@ class LanguageUnderstandingApi {
|
|
|
44135
44757
|
);
|
|
44136
44758
|
}
|
|
44137
44759
|
|
|
44760
|
+
/**
|
|
44761
|
+
* Add phrases to the ignored phrases list
|
|
44762
|
+
*
|
|
44763
|
+
* @param {String} languageCode Language Code
|
|
44764
|
+
* @param {Object} body Request body containing phrases to be ignored
|
|
44765
|
+
*/
|
|
44766
|
+
postLanguageunderstandingIgnorephrase(languageCode, body) {
|
|
44767
|
+
// verify the required parameter 'languageCode' is set
|
|
44768
|
+
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
44769
|
+
throw 'Missing the required parameter "languageCode" when calling postLanguageunderstandingIgnorephrase';
|
|
44770
|
+
}
|
|
44771
|
+
// verify the required parameter 'body' is set
|
|
44772
|
+
if (body === undefined || body === null) {
|
|
44773
|
+
throw 'Missing the required parameter "body" when calling postLanguageunderstandingIgnorephrase';
|
|
44774
|
+
}
|
|
44775
|
+
|
|
44776
|
+
return this.apiClient.callApi(
|
|
44777
|
+
'/api/v2/languageunderstanding/ignorephrases/{languageCode}',
|
|
44778
|
+
'POST',
|
|
44779
|
+
{ 'languageCode': languageCode },
|
|
44780
|
+
{ },
|
|
44781
|
+
{ },
|
|
44782
|
+
{ },
|
|
44783
|
+
body,
|
|
44784
|
+
['PureCloud OAuth'],
|
|
44785
|
+
['application/json'],
|
|
44786
|
+
['application/json']
|
|
44787
|
+
);
|
|
44788
|
+
}
|
|
44789
|
+
|
|
44790
|
+
/**
|
|
44791
|
+
* Delete ignored phrases
|
|
44792
|
+
*
|
|
44793
|
+
* @param {String} languageCode Language Code
|
|
44794
|
+
* @param {Object} body Request body containing entities to be removed
|
|
44795
|
+
*/
|
|
44796
|
+
postLanguageunderstandingIgnorephraseRemove(languageCode, body) {
|
|
44797
|
+
// verify the required parameter 'languageCode' is set
|
|
44798
|
+
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
44799
|
+
throw 'Missing the required parameter "languageCode" when calling postLanguageunderstandingIgnorephraseRemove';
|
|
44800
|
+
}
|
|
44801
|
+
// verify the required parameter 'body' is set
|
|
44802
|
+
if (body === undefined || body === null) {
|
|
44803
|
+
throw 'Missing the required parameter "body" when calling postLanguageunderstandingIgnorephraseRemove';
|
|
44804
|
+
}
|
|
44805
|
+
|
|
44806
|
+
return this.apiClient.callApi(
|
|
44807
|
+
'/api/v2/languageunderstanding/ignorephrases/{languageCode}/remove',
|
|
44808
|
+
'POST',
|
|
44809
|
+
{ 'languageCode': languageCode },
|
|
44810
|
+
{ },
|
|
44811
|
+
{ },
|
|
44812
|
+
{ },
|
|
44813
|
+
body,
|
|
44814
|
+
['PureCloud OAuth'],
|
|
44815
|
+
['application/json'],
|
|
44816
|
+
['application/json']
|
|
44817
|
+
);
|
|
44818
|
+
}
|
|
44819
|
+
|
|
44820
|
+
/**
|
|
44821
|
+
* Add topics to the ignored topics list
|
|
44822
|
+
*
|
|
44823
|
+
* @param {String} languageCode Language Code
|
|
44824
|
+
* @param {Object} body Request body containing topics to be ignored
|
|
44825
|
+
*/
|
|
44826
|
+
postLanguageunderstandingIgnoretopic(languageCode, body) {
|
|
44827
|
+
// verify the required parameter 'languageCode' is set
|
|
44828
|
+
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
44829
|
+
throw 'Missing the required parameter "languageCode" when calling postLanguageunderstandingIgnoretopic';
|
|
44830
|
+
}
|
|
44831
|
+
// verify the required parameter 'body' is set
|
|
44832
|
+
if (body === undefined || body === null) {
|
|
44833
|
+
throw 'Missing the required parameter "body" when calling postLanguageunderstandingIgnoretopic';
|
|
44834
|
+
}
|
|
44835
|
+
|
|
44836
|
+
return this.apiClient.callApi(
|
|
44837
|
+
'/api/v2/languageunderstanding/ignoretopics/{languageCode}',
|
|
44838
|
+
'POST',
|
|
44839
|
+
{ 'languageCode': languageCode },
|
|
44840
|
+
{ },
|
|
44841
|
+
{ },
|
|
44842
|
+
{ },
|
|
44843
|
+
body,
|
|
44844
|
+
['PureCloud OAuth'],
|
|
44845
|
+
['application/json'],
|
|
44846
|
+
['application/json']
|
|
44847
|
+
);
|
|
44848
|
+
}
|
|
44849
|
+
|
|
44850
|
+
/**
|
|
44851
|
+
* Delete ignored topics
|
|
44852
|
+
*
|
|
44853
|
+
* @param {String} languageCode Language Code
|
|
44854
|
+
* @param {Object} body Request body containing entities to be removed
|
|
44855
|
+
*/
|
|
44856
|
+
postLanguageunderstandingIgnoretopicRemove(languageCode, body) {
|
|
44857
|
+
// verify the required parameter 'languageCode' is set
|
|
44858
|
+
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
44859
|
+
throw 'Missing the required parameter "languageCode" when calling postLanguageunderstandingIgnoretopicRemove';
|
|
44860
|
+
}
|
|
44861
|
+
// verify the required parameter 'body' is set
|
|
44862
|
+
if (body === undefined || body === null) {
|
|
44863
|
+
throw 'Missing the required parameter "body" when calling postLanguageunderstandingIgnoretopicRemove';
|
|
44864
|
+
}
|
|
44865
|
+
|
|
44866
|
+
return this.apiClient.callApi(
|
|
44867
|
+
'/api/v2/languageunderstanding/ignoretopics/{languageCode}/remove',
|
|
44868
|
+
'POST',
|
|
44869
|
+
{ 'languageCode': languageCode },
|
|
44870
|
+
{ },
|
|
44871
|
+
{ },
|
|
44872
|
+
{ },
|
|
44873
|
+
body,
|
|
44874
|
+
['PureCloud OAuth'],
|
|
44875
|
+
['application/json'],
|
|
44876
|
+
['application/json']
|
|
44877
|
+
);
|
|
44878
|
+
}
|
|
44879
|
+
|
|
44138
44880
|
/**
|
|
44139
44881
|
* Create a new draft resource.
|
|
44140
44882
|
*
|
|
@@ -44260,7 +45002,7 @@ class LanguagesApi {
|
|
|
44260
45002
|
/**
|
|
44261
45003
|
* Languages service.
|
|
44262
45004
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
44263
|
-
* @version
|
|
45005
|
+
* @version 232.0.0
|
|
44264
45006
|
*/
|
|
44265
45007
|
|
|
44266
45008
|
/**
|
|
@@ -44482,7 +45224,7 @@ class LearningApi {
|
|
|
44482
45224
|
/**
|
|
44483
45225
|
* Learning service.
|
|
44484
45226
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
44485
|
-
* @version
|
|
45227
|
+
* @version 232.0.0
|
|
44486
45228
|
*/
|
|
44487
45229
|
|
|
44488
45230
|
/**
|
|
@@ -45480,8 +46222,12 @@ class LearningApi {
|
|
|
45480
46222
|
* This will update a learning module rule with the specified fields.
|
|
45481
46223
|
* @param {String} moduleId The ID of the learning module
|
|
45482
46224
|
* @param {Object} body The learning module rule to be updated
|
|
46225
|
+
* @param {Object} opts Optional parameters
|
|
46226
|
+
* @param {Boolean} opts.assign Whether to assign the module to users or not (default to true)
|
|
45483
46227
|
*/
|
|
45484
|
-
putLearningModuleRule(moduleId, body) {
|
|
46228
|
+
putLearningModuleRule(moduleId, body, opts) {
|
|
46229
|
+
opts = opts || {};
|
|
46230
|
+
|
|
45485
46231
|
// verify the required parameter 'moduleId' is set
|
|
45486
46232
|
if (moduleId === undefined || moduleId === null || moduleId === '') {
|
|
45487
46233
|
throw 'Missing the required parameter "moduleId" when calling putLearningModuleRule';
|
|
@@ -45495,7 +46241,7 @@ class LearningApi {
|
|
|
45495
46241
|
'/api/v2/learning/modules/{moduleId}/rule',
|
|
45496
46242
|
'PUT',
|
|
45497
46243
|
{ 'moduleId': moduleId },
|
|
45498
|
-
{
|
|
46244
|
+
{ 'assign': opts['assign'] },
|
|
45499
46245
|
{ },
|
|
45500
46246
|
{ },
|
|
45501
46247
|
body,
|
|
@@ -45511,7 +46257,7 @@ class LicenseApi {
|
|
|
45511
46257
|
/**
|
|
45512
46258
|
* License service.
|
|
45513
46259
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
45514
|
-
* @version
|
|
46260
|
+
* @version 232.0.0
|
|
45515
46261
|
*/
|
|
45516
46262
|
|
|
45517
46263
|
/**
|
|
@@ -45749,7 +46495,7 @@ class LocationsApi {
|
|
|
45749
46495
|
/**
|
|
45750
46496
|
* Locations service.
|
|
45751
46497
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
45752
|
-
* @version
|
|
46498
|
+
* @version 232.0.0
|
|
45753
46499
|
*/
|
|
45754
46500
|
|
|
45755
46501
|
/**
|
|
@@ -45985,7 +46731,7 @@ class LogCaptureApi {
|
|
|
45985
46731
|
/**
|
|
45986
46732
|
* LogCapture service.
|
|
45987
46733
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
45988
|
-
* @version
|
|
46734
|
+
* @version 232.0.0
|
|
45989
46735
|
*/
|
|
45990
46736
|
|
|
45991
46737
|
/**
|
|
@@ -46184,7 +46930,7 @@ class MessagingApi {
|
|
|
46184
46930
|
/**
|
|
46185
46931
|
* Messaging service.
|
|
46186
46932
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
46187
|
-
* @version
|
|
46933
|
+
* @version 232.0.0
|
|
46188
46934
|
*/
|
|
46189
46935
|
|
|
46190
46936
|
/**
|
|
@@ -46543,7 +47289,7 @@ class MobileDevicesApi {
|
|
|
46543
47289
|
/**
|
|
46544
47290
|
* MobileDevices service.
|
|
46545
47291
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
46546
|
-
* @version
|
|
47292
|
+
* @version 232.0.0
|
|
46547
47293
|
*/
|
|
46548
47294
|
|
|
46549
47295
|
/**
|
|
@@ -46694,7 +47440,7 @@ class NotificationsApi {
|
|
|
46694
47440
|
/**
|
|
46695
47441
|
* Notifications service.
|
|
46696
47442
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
46697
|
-
* @version
|
|
47443
|
+
* @version 232.0.0
|
|
46698
47444
|
*/
|
|
46699
47445
|
|
|
46700
47446
|
/**
|
|
@@ -46927,7 +47673,7 @@ class OAuthApi {
|
|
|
46927
47673
|
/**
|
|
46928
47674
|
* OAuth service.
|
|
46929
47675
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
46930
|
-
* @version
|
|
47676
|
+
* @version 232.0.0
|
|
46931
47677
|
*/
|
|
46932
47678
|
|
|
46933
47679
|
/**
|
|
@@ -47293,7 +48039,7 @@ class ObjectsApi {
|
|
|
47293
48039
|
/**
|
|
47294
48040
|
* Objects service.
|
|
47295
48041
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
47296
|
-
* @version
|
|
48042
|
+
* @version 232.0.0
|
|
47297
48043
|
*/
|
|
47298
48044
|
|
|
47299
48045
|
/**
|
|
@@ -47617,7 +48363,7 @@ class OperationalEventsApi {
|
|
|
47617
48363
|
/**
|
|
47618
48364
|
* OperationalEvents service.
|
|
47619
48365
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
47620
|
-
* @version
|
|
48366
|
+
* @version 232.0.0
|
|
47621
48367
|
*/
|
|
47622
48368
|
|
|
47623
48369
|
/**
|
|
@@ -47734,7 +48480,7 @@ class OrganizationApi {
|
|
|
47734
48480
|
/**
|
|
47735
48481
|
* Organization service.
|
|
47736
48482
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
47737
|
-
* @version
|
|
48483
|
+
* @version 232.0.0
|
|
47738
48484
|
*/
|
|
47739
48485
|
|
|
47740
48486
|
/**
|
|
@@ -48209,7 +48955,7 @@ class OrganizationAuthorizationApi {
|
|
|
48209
48955
|
/**
|
|
48210
48956
|
* OrganizationAuthorization service.
|
|
48211
48957
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
48212
|
-
* @version
|
|
48958
|
+
* @version 232.0.0
|
|
48213
48959
|
*/
|
|
48214
48960
|
|
|
48215
48961
|
/**
|
|
@@ -49603,7 +50349,7 @@ class OutboundApi {
|
|
|
49603
50349
|
/**
|
|
49604
50350
|
* Outbound service.
|
|
49605
50351
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
49606
|
-
* @version
|
|
50352
|
+
* @version 232.0.0
|
|
49607
50353
|
*/
|
|
49608
50354
|
|
|
49609
50355
|
/**
|
|
@@ -54325,7 +55071,7 @@ class PresenceApi {
|
|
|
54325
55071
|
/**
|
|
54326
55072
|
* Presence service.
|
|
54327
55073
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
54328
|
-
* @version
|
|
55074
|
+
* @version 232.0.0
|
|
54329
55075
|
*/
|
|
54330
55076
|
|
|
54331
55077
|
/**
|
|
@@ -55069,7 +55815,7 @@ class ProcessAutomationApi {
|
|
|
55069
55815
|
/**
|
|
55070
55816
|
* ProcessAutomation service.
|
|
55071
55817
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
55072
|
-
* @version
|
|
55818
|
+
* @version 232.0.0
|
|
55073
55819
|
*/
|
|
55074
55820
|
|
|
55075
55821
|
/**
|
|
@@ -55308,7 +56054,7 @@ class QualityApi {
|
|
|
55308
56054
|
/**
|
|
55309
56055
|
* Quality service.
|
|
55310
56056
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
55311
|
-
* @version
|
|
56057
|
+
* @version 232.0.0
|
|
55312
56058
|
*/
|
|
55313
56059
|
|
|
55314
56060
|
/**
|
|
@@ -55891,7 +56637,7 @@ class QualityApi {
|
|
|
55891
56637
|
}
|
|
55892
56638
|
|
|
55893
56639
|
/**
|
|
55894
|
-
* Get an evaluator activity
|
|
56640
|
+
* Get an evaluator activity. To ensure optimal performance and prevent timeouts when processing large datasets, startTime and endTime fields are highly recommended for all requests.
|
|
55895
56641
|
*
|
|
55896
56642
|
* @param {Object} opts Optional parameters
|
|
55897
56643
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
@@ -56372,6 +57118,59 @@ class QualityApi {
|
|
|
56372
57118
|
);
|
|
56373
57119
|
}
|
|
56374
57120
|
|
|
57121
|
+
/**
|
|
57122
|
+
* Get the most recent published version of an evaluation form across any division.
|
|
57123
|
+
*
|
|
57124
|
+
* @param {String} evaluationFormId Evaluation Form ID
|
|
57125
|
+
* getQualityPublishedformsEvaluationsDivisionview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57126
|
+
*/
|
|
57127
|
+
getQualityPublishedformsEvaluationsDivisionview(evaluationFormId) {
|
|
57128
|
+
// verify the required parameter 'evaluationFormId' is set
|
|
57129
|
+
if (evaluationFormId === undefined || evaluationFormId === null || evaluationFormId === '') {
|
|
57130
|
+
throw 'Missing the required parameter "evaluationFormId" when calling getQualityPublishedformsEvaluationsDivisionview';
|
|
57131
|
+
}
|
|
57132
|
+
|
|
57133
|
+
return this.apiClient.callApi(
|
|
57134
|
+
'/api/v2/quality/publishedforms/evaluations/divisionviews/{evaluationFormId}',
|
|
57135
|
+
'GET',
|
|
57136
|
+
{ 'evaluationFormId': evaluationFormId },
|
|
57137
|
+
{ },
|
|
57138
|
+
{ },
|
|
57139
|
+
{ },
|
|
57140
|
+
null,
|
|
57141
|
+
['PureCloud OAuth'],
|
|
57142
|
+
['application/json'],
|
|
57143
|
+
['application/json']
|
|
57144
|
+
);
|
|
57145
|
+
}
|
|
57146
|
+
|
|
57147
|
+
/**
|
|
57148
|
+
* Get the published evaluation forms across any division.
|
|
57149
|
+
*
|
|
57150
|
+
* @param {Object} opts Optional parameters
|
|
57151
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
57152
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
57153
|
+
* @param {String} opts.name Name
|
|
57154
|
+
* getQualityPublishedformsEvaluationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57155
|
+
*/
|
|
57156
|
+
getQualityPublishedformsEvaluationsDivisionviews(opts) {
|
|
57157
|
+
opts = opts || {};
|
|
57158
|
+
|
|
57159
|
+
|
|
57160
|
+
return this.apiClient.callApi(
|
|
57161
|
+
'/api/v2/quality/publishedforms/evaluations/divisionviews',
|
|
57162
|
+
'GET',
|
|
57163
|
+
{ },
|
|
57164
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'] },
|
|
57165
|
+
{ },
|
|
57166
|
+
{ },
|
|
57167
|
+
null,
|
|
57168
|
+
['PureCloud OAuth'],
|
|
57169
|
+
['application/json'],
|
|
57170
|
+
['application/json']
|
|
57171
|
+
);
|
|
57172
|
+
}
|
|
57173
|
+
|
|
56375
57174
|
/**
|
|
56376
57175
|
* Get the most recent published version of a survey form.
|
|
56377
57176
|
*
|
|
@@ -56424,6 +57223,59 @@ class QualityApi {
|
|
|
56424
57223
|
);
|
|
56425
57224
|
}
|
|
56426
57225
|
|
|
57226
|
+
/**
|
|
57227
|
+
* Get the most recent published version of an enabled survey form across any division.
|
|
57228
|
+
*
|
|
57229
|
+
* @param {String} surveyFormId Survey Form ID
|
|
57230
|
+
* getQualityPublishedformsSurveysDivisionview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57231
|
+
*/
|
|
57232
|
+
getQualityPublishedformsSurveysDivisionview(surveyFormId) {
|
|
57233
|
+
// verify the required parameter 'surveyFormId' is set
|
|
57234
|
+
if (surveyFormId === undefined || surveyFormId === null || surveyFormId === '') {
|
|
57235
|
+
throw 'Missing the required parameter "surveyFormId" when calling getQualityPublishedformsSurveysDivisionview';
|
|
57236
|
+
}
|
|
57237
|
+
|
|
57238
|
+
return this.apiClient.callApi(
|
|
57239
|
+
'/api/v2/quality/publishedforms/surveys/divisionviews/{surveyFormId}',
|
|
57240
|
+
'GET',
|
|
57241
|
+
{ 'surveyFormId': surveyFormId },
|
|
57242
|
+
{ },
|
|
57243
|
+
{ },
|
|
57244
|
+
{ },
|
|
57245
|
+
null,
|
|
57246
|
+
['PureCloud OAuth'],
|
|
57247
|
+
['application/json'],
|
|
57248
|
+
['application/json']
|
|
57249
|
+
);
|
|
57250
|
+
}
|
|
57251
|
+
|
|
57252
|
+
/**
|
|
57253
|
+
* Get the published and enabled survey forms across any division.
|
|
57254
|
+
*
|
|
57255
|
+
* @param {Object} opts Optional parameters
|
|
57256
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
57257
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
57258
|
+
* @param {String} opts.name Name
|
|
57259
|
+
* getQualityPublishedformsSurveysDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57260
|
+
*/
|
|
57261
|
+
getQualityPublishedformsSurveysDivisionviews(opts) {
|
|
57262
|
+
opts = opts || {};
|
|
57263
|
+
|
|
57264
|
+
|
|
57265
|
+
return this.apiClient.callApi(
|
|
57266
|
+
'/api/v2/quality/publishedforms/surveys/divisionviews',
|
|
57267
|
+
'GET',
|
|
57268
|
+
{ },
|
|
57269
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'] },
|
|
57270
|
+
{ },
|
|
57271
|
+
{ },
|
|
57272
|
+
null,
|
|
57273
|
+
['PureCloud OAuth'],
|
|
57274
|
+
['application/json'],
|
|
57275
|
+
['application/json']
|
|
57276
|
+
);
|
|
57277
|
+
}
|
|
57278
|
+
|
|
56427
57279
|
/**
|
|
56428
57280
|
* Get a survey for a conversation
|
|
56429
57281
|
*
|
|
@@ -57147,7 +57999,7 @@ class RecordingApi {
|
|
|
57147
57999
|
/**
|
|
57148
58000
|
* Recording service.
|
|
57149
58001
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
57150
|
-
* @version
|
|
58002
|
+
* @version 232.0.0
|
|
57151
58003
|
*/
|
|
57152
58004
|
|
|
57153
58005
|
/**
|
|
@@ -58583,7 +59435,7 @@ class RecordingApi {
|
|
|
58583
59435
|
|
|
58584
59436
|
/**
|
|
58585
59437
|
* Execute the recording bulk job.
|
|
58586
|
-
* A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recordings retention.
|
|
59438
|
+
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recordings retention.
|
|
58587
59439
|
* @param {String} jobId jobId
|
|
58588
59440
|
* @param {Object} body query
|
|
58589
59441
|
*/
|
|
@@ -58643,7 +59495,7 @@ class RecordingApi {
|
|
|
58643
59495
|
|
|
58644
59496
|
/**
|
|
58645
59497
|
* Update a media retention policy
|
|
58646
|
-
* Policy does not work retroactively
|
|
59498
|
+
* Policy does not work retroactively. In the conditions.forUsers section, each user object can include the id field containing the users unique identifier. Example: [{"id":"<userId>"}].
|
|
58647
59499
|
* @param {String} policyId Policy ID
|
|
58648
59500
|
* @param {Object} body Policy
|
|
58649
59501
|
*/
|
|
@@ -58752,7 +59604,7 @@ class ResponseManagementApi {
|
|
|
58752
59604
|
/**
|
|
58753
59605
|
* ResponseManagement service.
|
|
58754
59606
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
58755
|
-
* @version
|
|
59607
|
+
* @version 232.0.0
|
|
58756
59608
|
*/
|
|
58757
59609
|
|
|
58758
59610
|
/**
|
|
@@ -59262,7 +60114,7 @@ class RoutingApi {
|
|
|
59262
60114
|
/**
|
|
59263
60115
|
* Routing service.
|
|
59264
60116
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
59265
|
-
* @version
|
|
60117
|
+
* @version 232.0.0
|
|
59266
60118
|
*/
|
|
59267
60119
|
|
|
59268
60120
|
/**
|
|
@@ -60052,8 +60904,12 @@ class RoutingApi {
|
|
|
60052
60904
|
* Get domain
|
|
60053
60905
|
*
|
|
60054
60906
|
* @param {String} domainId domain ID
|
|
60907
|
+
* @param {Object} opts Optional parameters
|
|
60908
|
+
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
60055
60909
|
*/
|
|
60056
|
-
getRoutingEmailDomain(domainId) {
|
|
60910
|
+
getRoutingEmailDomain(domainId, opts) {
|
|
60911
|
+
opts = opts || {};
|
|
60912
|
+
|
|
60057
60913
|
// verify the required parameter 'domainId' is set
|
|
60058
60914
|
if (domainId === undefined || domainId === null || domainId === '') {
|
|
60059
60915
|
throw 'Missing the required parameter "domainId" when calling getRoutingEmailDomain';
|
|
@@ -60063,7 +60919,7 @@ class RoutingApi {
|
|
|
60063
60919
|
'/api/v2/routing/email/domains/{domainId}',
|
|
60064
60920
|
'GET',
|
|
60065
60921
|
{ 'domainId': domainId },
|
|
60066
|
-
{
|
|
60922
|
+
{ 'expand': opts['expand'] },
|
|
60067
60923
|
{ },
|
|
60068
60924
|
{ },
|
|
60069
60925
|
null,
|
|
@@ -60177,6 +61033,7 @@ class RoutingApi {
|
|
|
60177
61033
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
60178
61034
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
60179
61035
|
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
61036
|
+
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
60180
61037
|
*/
|
|
60181
61038
|
getRoutingEmailDomains(opts) {
|
|
60182
61039
|
opts = opts || {};
|
|
@@ -60186,7 +61043,7 @@ class RoutingApi {
|
|
|
60186
61043
|
'/api/v2/routing/email/domains',
|
|
60187
61044
|
'GET',
|
|
60188
61045
|
{ },
|
|
60189
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'],'filter': opts['filter'] },
|
|
61046
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'],'filter': opts['filter'],'expand': opts['expand'] },
|
|
60190
61047
|
{ },
|
|
60191
61048
|
{ },
|
|
60192
61049
|
null,
|
|
@@ -60200,8 +61057,12 @@ class RoutingApi {
|
|
|
60200
61057
|
* Get domain
|
|
60201
61058
|
*
|
|
60202
61059
|
* @param {String} domainId domain ID
|
|
61060
|
+
* @param {Object} opts Optional parameters
|
|
61061
|
+
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
60203
61062
|
*/
|
|
60204
|
-
getRoutingEmailOutboundDomain(domainId) {
|
|
61063
|
+
getRoutingEmailOutboundDomain(domainId, opts) {
|
|
61064
|
+
opts = opts || {};
|
|
61065
|
+
|
|
60205
61066
|
// verify the required parameter 'domainId' is set
|
|
60206
61067
|
if (domainId === undefined || domainId === null || domainId === '') {
|
|
60207
61068
|
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomain';
|
|
@@ -60211,7 +61072,7 @@ class RoutingApi {
|
|
|
60211
61072
|
'/api/v2/routing/email/outbound/domains/{domainId}',
|
|
60212
61073
|
'GET',
|
|
60213
61074
|
{ 'domainId': domainId },
|
|
60214
|
-
{
|
|
61075
|
+
{ 'expand': opts['expand'] },
|
|
60215
61076
|
{ },
|
|
60216
61077
|
{ },
|
|
60217
61078
|
null,
|
|
@@ -60253,6 +61114,7 @@ class RoutingApi {
|
|
|
60253
61114
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
60254
61115
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
60255
61116
|
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
61117
|
+
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
60256
61118
|
*/
|
|
60257
61119
|
getRoutingEmailOutboundDomains(opts) {
|
|
60258
61120
|
opts = opts || {};
|
|
@@ -60262,7 +61124,7 @@ class RoutingApi {
|
|
|
60262
61124
|
'/api/v2/routing/email/outbound/domains',
|
|
60263
61125
|
'GET',
|
|
60264
61126
|
{ },
|
|
60265
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'filter': opts['filter'] },
|
|
61127
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'filter': opts['filter'],'expand': opts['expand'] },
|
|
60266
61128
|
{ },
|
|
60267
61129
|
{ },
|
|
60268
61130
|
null,
|
|
@@ -60486,6 +61348,8 @@ class RoutingApi {
|
|
|
60486
61348
|
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
60487
61349
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
60488
61350
|
* @param {Array.<String>} opts.queueId Comma-separated list of queue Ids to filter by.
|
|
61351
|
+
* @param {String} opts.kpiId Standard or custom KPI id used to filter predictors.
|
|
61352
|
+
* @param {Object} opts.state The state used to filter predictors.
|
|
60489
61353
|
*/
|
|
60490
61354
|
getRoutingPredictors(opts) {
|
|
60491
61355
|
opts = opts || {};
|
|
@@ -60495,7 +61359,7 @@ class RoutingApi {
|
|
|
60495
61359
|
'/api/v2/routing/predictors',
|
|
60496
61360
|
'GET',
|
|
60497
61361
|
{ },
|
|
60498
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'queueId': this.apiClient.buildCollectionParam(opts['queueId'], 'multi') },
|
|
61362
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'queueId': this.apiClient.buildCollectionParam(opts['queueId'], 'multi'),'kpiId': opts['kpiId'],'state': opts['state'] },
|
|
60499
61363
|
{ },
|
|
60500
61364
|
{ },
|
|
60501
61365
|
null,
|
|
@@ -60564,7 +61428,7 @@ class RoutingApi {
|
|
|
60564
61428
|
*
|
|
60565
61429
|
* @param {String} queueId Queue ID
|
|
60566
61430
|
* @param {Object} opts Optional parameters
|
|
60567
|
-
* @param {
|
|
61431
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
60568
61432
|
*/
|
|
60569
61433
|
getRoutingQueueAssistant(queueId, opts) {
|
|
60570
61434
|
opts = opts || {};
|
|
@@ -60578,7 +61442,7 @@ class RoutingApi {
|
|
|
60578
61442
|
'/api/v2/routing/queues/{queueId}/assistant',
|
|
60579
61443
|
'GET',
|
|
60580
61444
|
{ 'queueId': queueId },
|
|
60581
|
-
{ 'expand': opts['expand'] },
|
|
61445
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
60582
61446
|
{ },
|
|
60583
61447
|
{ },
|
|
60584
61448
|
null,
|
|
@@ -63578,7 +64442,7 @@ class SCIMApi {
|
|
|
63578
64442
|
/**
|
|
63579
64443
|
* SCIM service.
|
|
63580
64444
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
63581
|
-
* @version
|
|
64445
|
+
* @version 232.0.0
|
|
63582
64446
|
*/
|
|
63583
64447
|
|
|
63584
64448
|
/**
|
|
@@ -64455,7 +65319,7 @@ class ScreenRecordingApi {
|
|
|
64455
65319
|
/**
|
|
64456
65320
|
* ScreenRecording service.
|
|
64457
65321
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
64458
|
-
* @version
|
|
65322
|
+
* @version 232.0.0
|
|
64459
65323
|
*/
|
|
64460
65324
|
|
|
64461
65325
|
/**
|
|
@@ -64500,7 +65364,7 @@ class ScriptsApi {
|
|
|
64500
65364
|
/**
|
|
64501
65365
|
* Scripts service.
|
|
64502
65366
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
64503
|
-
* @version
|
|
65367
|
+
* @version 232.0.0
|
|
64504
65368
|
*/
|
|
64505
65369
|
|
|
64506
65370
|
/**
|
|
@@ -64976,7 +65840,7 @@ class SearchApi {
|
|
|
64976
65840
|
/**
|
|
64977
65841
|
* Search service.
|
|
64978
65842
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
64979
|
-
* @version
|
|
65843
|
+
* @version 232.0.0
|
|
64980
65844
|
*/
|
|
64981
65845
|
|
|
64982
65846
|
/**
|
|
@@ -65694,7 +66558,7 @@ class SettingsApi {
|
|
|
65694
66558
|
/**
|
|
65695
66559
|
* Settings service.
|
|
65696
66560
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
65697
|
-
* @version
|
|
66561
|
+
* @version 232.0.0
|
|
65698
66562
|
*/
|
|
65699
66563
|
|
|
65700
66564
|
/**
|
|
@@ -66042,7 +66906,7 @@ class SocialMediaApi {
|
|
|
66042
66906
|
/**
|
|
66043
66907
|
* SocialMedia service.
|
|
66044
66908
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
66045
|
-
* @version
|
|
66909
|
+
* @version 232.0.0
|
|
66046
66910
|
*/
|
|
66047
66911
|
|
|
66048
66912
|
/**
|
|
@@ -66171,6 +67035,40 @@ class SocialMediaApi {
|
|
|
66171
67035
|
);
|
|
66172
67036
|
}
|
|
66173
67037
|
|
|
67038
|
+
/**
|
|
67039
|
+
* Delete a Instagram data ingestion rule.
|
|
67040
|
+
*
|
|
67041
|
+
* @param {String} topicId topicId
|
|
67042
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
67043
|
+
* @param {Object} opts Optional parameters
|
|
67044
|
+
* @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)
|
|
67045
|
+
*/
|
|
67046
|
+
deleteSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId(topicId, instagramIngestionRuleId, opts) {
|
|
67047
|
+
opts = opts || {};
|
|
67048
|
+
|
|
67049
|
+
// verify the required parameter 'topicId' is set
|
|
67050
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
67051
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
67052
|
+
}
|
|
67053
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
67054
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
67055
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
67056
|
+
}
|
|
67057
|
+
|
|
67058
|
+
return this.apiClient.callApi(
|
|
67059
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}',
|
|
67060
|
+
'DELETE',
|
|
67061
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
67062
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
67063
|
+
{ },
|
|
67064
|
+
{ },
|
|
67065
|
+
null,
|
|
67066
|
+
['PureCloud OAuth'],
|
|
67067
|
+
['application/json'],
|
|
67068
|
+
['application/json']
|
|
67069
|
+
);
|
|
67070
|
+
}
|
|
67071
|
+
|
|
66174
67072
|
/**
|
|
66175
67073
|
* Delete a open data ingestion rule.
|
|
66176
67074
|
*
|
|
@@ -66571,6 +67469,115 @@ class SocialMediaApi {
|
|
|
66571
67469
|
);
|
|
66572
67470
|
}
|
|
66573
67471
|
|
|
67472
|
+
/**
|
|
67473
|
+
* Get a single Instagram data ingestion rule.
|
|
67474
|
+
*
|
|
67475
|
+
* @param {String} topicId topicId
|
|
67476
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
67477
|
+
* @param {Object} opts Optional parameters
|
|
67478
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
67479
|
+
*/
|
|
67480
|
+
getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId(topicId, instagramIngestionRuleId, opts) {
|
|
67481
|
+
opts = opts || {};
|
|
67482
|
+
|
|
67483
|
+
// verify the required parameter 'topicId' is set
|
|
67484
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
67485
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
67486
|
+
}
|
|
67487
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
67488
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
67489
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
67490
|
+
}
|
|
67491
|
+
|
|
67492
|
+
return this.apiClient.callApi(
|
|
67493
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}',
|
|
67494
|
+
'GET',
|
|
67495
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
67496
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
67497
|
+
{ },
|
|
67498
|
+
{ },
|
|
67499
|
+
null,
|
|
67500
|
+
['PureCloud OAuth'],
|
|
67501
|
+
['application/json'],
|
|
67502
|
+
['application/json']
|
|
67503
|
+
);
|
|
67504
|
+
}
|
|
67505
|
+
|
|
67506
|
+
/**
|
|
67507
|
+
* Get a single Instagram data ingestion rule version.
|
|
67508
|
+
*
|
|
67509
|
+
* @param {String} topicId topicId
|
|
67510
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
67511
|
+
* @param {String} dataIngestionRuleVersion version
|
|
67512
|
+
* @param {Object} opts Optional parameters
|
|
67513
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
67514
|
+
*/
|
|
67515
|
+
getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion(topicId, instagramIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
67516
|
+
opts = opts || {};
|
|
67517
|
+
|
|
67518
|
+
// verify the required parameter 'topicId' is set
|
|
67519
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
67520
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion';
|
|
67521
|
+
}
|
|
67522
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
67523
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
67524
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion';
|
|
67525
|
+
}
|
|
67526
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
67527
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null || dataIngestionRuleVersion === '') {
|
|
67528
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion';
|
|
67529
|
+
}
|
|
67530
|
+
|
|
67531
|
+
return this.apiClient.callApi(
|
|
67532
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}/versions/{dataIngestionRuleVersion}',
|
|
67533
|
+
'GET',
|
|
67534
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
67535
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
67536
|
+
{ },
|
|
67537
|
+
{ },
|
|
67538
|
+
null,
|
|
67539
|
+
['PureCloud OAuth'],
|
|
67540
|
+
['application/json'],
|
|
67541
|
+
['application/json']
|
|
67542
|
+
);
|
|
67543
|
+
}
|
|
67544
|
+
|
|
67545
|
+
/**
|
|
67546
|
+
* Get the Instagram data ingestion rule versions.
|
|
67547
|
+
*
|
|
67548
|
+
* @param {String} topicId topicId
|
|
67549
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
67550
|
+
* @param {Object} opts Optional parameters
|
|
67551
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
67552
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
67553
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
67554
|
+
*/
|
|
67555
|
+
getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersions(topicId, instagramIngestionRuleId, opts) {
|
|
67556
|
+
opts = opts || {};
|
|
67557
|
+
|
|
67558
|
+
// verify the required parameter 'topicId' is set
|
|
67559
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
67560
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersions';
|
|
67561
|
+
}
|
|
67562
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
67563
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
67564
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersions';
|
|
67565
|
+
}
|
|
67566
|
+
|
|
67567
|
+
return this.apiClient.callApi(
|
|
67568
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}/versions',
|
|
67569
|
+
'GET',
|
|
67570
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
67571
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
67572
|
+
{ },
|
|
67573
|
+
{ },
|
|
67574
|
+
null,
|
|
67575
|
+
['PureCloud OAuth'],
|
|
67576
|
+
['application/json'],
|
|
67577
|
+
['application/json']
|
|
67578
|
+
);
|
|
67579
|
+
}
|
|
67580
|
+
|
|
66574
67581
|
/**
|
|
66575
67582
|
* Get a single open data ingestion rule.
|
|
66576
67583
|
*
|
|
@@ -66879,6 +67886,40 @@ class SocialMediaApi {
|
|
|
66879
67886
|
);
|
|
66880
67887
|
}
|
|
66881
67888
|
|
|
67889
|
+
/**
|
|
67890
|
+
* Update the status of a Instagram data ingestion rule.
|
|
67891
|
+
*
|
|
67892
|
+
* @param {String} topicId topicId
|
|
67893
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
67894
|
+
* @param {Object} opts Optional parameters
|
|
67895
|
+
* @param {Object} opts.body
|
|
67896
|
+
*/
|
|
67897
|
+
patchSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId(topicId, instagramIngestionRuleId, opts) {
|
|
67898
|
+
opts = opts || {};
|
|
67899
|
+
|
|
67900
|
+
// verify the required parameter 'topicId' is set
|
|
67901
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
67902
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
67903
|
+
}
|
|
67904
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
67905
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
67906
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
67907
|
+
}
|
|
67908
|
+
|
|
67909
|
+
return this.apiClient.callApi(
|
|
67910
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}',
|
|
67911
|
+
'PATCH',
|
|
67912
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
67913
|
+
{ },
|
|
67914
|
+
{ },
|
|
67915
|
+
{ },
|
|
67916
|
+
opts['body'],
|
|
67917
|
+
['PureCloud OAuth'],
|
|
67918
|
+
['application/json'],
|
|
67919
|
+
['application/json']
|
|
67920
|
+
);
|
|
67921
|
+
}
|
|
67922
|
+
|
|
66882
67923
|
/**
|
|
66883
67924
|
* Update the status of a open data ingestion rule.
|
|
66884
67925
|
*
|
|
@@ -67079,6 +68120,35 @@ class SocialMediaApi {
|
|
|
67079
68120
|
);
|
|
67080
68121
|
}
|
|
67081
68122
|
|
|
68123
|
+
/**
|
|
68124
|
+
* Create an Instagram data ingestion rule.
|
|
68125
|
+
*
|
|
68126
|
+
* @param {String} topicId topicId
|
|
68127
|
+
* @param {Object} opts Optional parameters
|
|
68128
|
+
* @param {Object} opts.body
|
|
68129
|
+
*/
|
|
68130
|
+
postSocialmediaTopicDataingestionrulesInstagram(topicId, opts) {
|
|
68131
|
+
opts = opts || {};
|
|
68132
|
+
|
|
68133
|
+
// verify the required parameter 'topicId' is set
|
|
68134
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
68135
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesInstagram';
|
|
68136
|
+
}
|
|
68137
|
+
|
|
68138
|
+
return this.apiClient.callApi(
|
|
68139
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram',
|
|
68140
|
+
'POST',
|
|
68141
|
+
{ 'topicId': topicId },
|
|
68142
|
+
{ },
|
|
68143
|
+
{ },
|
|
68144
|
+
{ },
|
|
68145
|
+
opts['body'],
|
|
68146
|
+
['PureCloud OAuth'],
|
|
68147
|
+
['application/json'],
|
|
68148
|
+
['application/json']
|
|
68149
|
+
);
|
|
68150
|
+
}
|
|
68151
|
+
|
|
67082
68152
|
/**
|
|
67083
68153
|
* Create an open data ingestion rule.
|
|
67084
68154
|
*
|
|
@@ -67319,6 +68389,40 @@ class SocialMediaApi {
|
|
|
67319
68389
|
);
|
|
67320
68390
|
}
|
|
67321
68391
|
|
|
68392
|
+
/**
|
|
68393
|
+
* Update the Instagram data ingestion rule.
|
|
68394
|
+
*
|
|
68395
|
+
* @param {String} topicId topicId
|
|
68396
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
68397
|
+
* @param {Object} opts Optional parameters
|
|
68398
|
+
* @param {Object} opts.body
|
|
68399
|
+
*/
|
|
68400
|
+
putSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId(topicId, instagramIngestionRuleId, opts) {
|
|
68401
|
+
opts = opts || {};
|
|
68402
|
+
|
|
68403
|
+
// verify the required parameter 'topicId' is set
|
|
68404
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
68405
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
68406
|
+
}
|
|
68407
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
68408
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
68409
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
68410
|
+
}
|
|
68411
|
+
|
|
68412
|
+
return this.apiClient.callApi(
|
|
68413
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}',
|
|
68414
|
+
'PUT',
|
|
68415
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
68416
|
+
{ },
|
|
68417
|
+
{ },
|
|
68418
|
+
{ },
|
|
68419
|
+
opts['body'],
|
|
68420
|
+
['PureCloud OAuth'],
|
|
68421
|
+
['application/json'],
|
|
68422
|
+
['application/json']
|
|
68423
|
+
);
|
|
68424
|
+
}
|
|
68425
|
+
|
|
67322
68426
|
/**
|
|
67323
68427
|
* Update the open data ingestion rule.
|
|
67324
68428
|
*
|
|
@@ -67393,7 +68497,7 @@ class SpeechTextAnalyticsApi {
|
|
|
67393
68497
|
/**
|
|
67394
68498
|
* SpeechTextAnalytics service.
|
|
67395
68499
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
67396
|
-
* @version
|
|
68500
|
+
* @version 232.0.0
|
|
67397
68501
|
*/
|
|
67398
68502
|
|
|
67399
68503
|
/**
|
|
@@ -69039,7 +70143,7 @@ class StationsApi {
|
|
|
69039
70143
|
/**
|
|
69040
70144
|
* Stations service.
|
|
69041
70145
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
69042
|
-
* @version
|
|
70146
|
+
* @version 232.0.0
|
|
69043
70147
|
*/
|
|
69044
70148
|
|
|
69045
70149
|
/**
|
|
@@ -69141,7 +70245,7 @@ class SuggestApi {
|
|
|
69141
70245
|
/**
|
|
69142
70246
|
* Suggest service.
|
|
69143
70247
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
69144
|
-
* @version
|
|
70248
|
+
* @version 232.0.0
|
|
69145
70249
|
*/
|
|
69146
70250
|
|
|
69147
70251
|
/**
|
|
@@ -69280,7 +70384,7 @@ class TaskManagementApi {
|
|
|
69280
70384
|
/**
|
|
69281
70385
|
* TaskManagement service.
|
|
69282
70386
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
69283
|
-
* @version
|
|
70387
|
+
* @version 232.0.0
|
|
69284
70388
|
*/
|
|
69285
70389
|
|
|
69286
70390
|
/**
|
|
@@ -71442,7 +72546,7 @@ class TeamsApi {
|
|
|
71442
72546
|
/**
|
|
71443
72547
|
* Teams service.
|
|
71444
72548
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
71445
|
-
* @version
|
|
72549
|
+
* @version 232.0.0
|
|
71446
72550
|
*/
|
|
71447
72551
|
|
|
71448
72552
|
/**
|
|
@@ -71747,7 +72851,7 @@ class TelephonyApi {
|
|
|
71747
72851
|
/**
|
|
71748
72852
|
* Telephony service.
|
|
71749
72853
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
71750
|
-
* @version
|
|
72854
|
+
* @version 232.0.0
|
|
71751
72855
|
*/
|
|
71752
72856
|
|
|
71753
72857
|
/**
|
|
@@ -72033,7 +73137,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
72033
73137
|
/**
|
|
72034
73138
|
* TelephonyProvidersEdge service.
|
|
72035
73139
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
72036
|
-
* @version
|
|
73140
|
+
* @version 232.0.0
|
|
72037
73141
|
*/
|
|
72038
73142
|
|
|
72039
73143
|
/**
|
|
@@ -75526,7 +76630,7 @@ class TextbotsApi {
|
|
|
75526
76630
|
/**
|
|
75527
76631
|
* Textbots service.
|
|
75528
76632
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
75529
|
-
* @version
|
|
76633
|
+
* @version 232.0.0
|
|
75530
76634
|
*/
|
|
75531
76635
|
|
|
75532
76636
|
/**
|
|
@@ -75655,7 +76759,7 @@ class TokensApi {
|
|
|
75655
76759
|
/**
|
|
75656
76760
|
* Tokens service.
|
|
75657
76761
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
75658
|
-
* @version
|
|
76762
|
+
* @version 232.0.0
|
|
75659
76763
|
*/
|
|
75660
76764
|
|
|
75661
76765
|
/**
|
|
@@ -75809,7 +76913,7 @@ class UploadsApi {
|
|
|
75809
76913
|
/**
|
|
75810
76914
|
* Uploads service.
|
|
75811
76915
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
75812
|
-
* @version
|
|
76916
|
+
* @version 232.0.0
|
|
75813
76917
|
*/
|
|
75814
76918
|
|
|
75815
76919
|
/**
|
|
@@ -76100,7 +77204,7 @@ class UsageApi {
|
|
|
76100
77204
|
/**
|
|
76101
77205
|
* Usage service.
|
|
76102
77206
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
76103
|
-
* @version
|
|
77207
|
+
* @version 232.0.0
|
|
76104
77208
|
*/
|
|
76105
77209
|
|
|
76106
77210
|
/**
|
|
@@ -76435,7 +77539,7 @@ class UserRecordingsApi {
|
|
|
76435
77539
|
/**
|
|
76436
77540
|
* UserRecordings service.
|
|
76437
77541
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
76438
|
-
* @version
|
|
77542
|
+
* @version 232.0.0
|
|
76439
77543
|
*/
|
|
76440
77544
|
|
|
76441
77545
|
/**
|
|
@@ -76504,37 +77608,6 @@ class UserRecordingsApi {
|
|
|
76504
77608
|
);
|
|
76505
77609
|
}
|
|
76506
77610
|
|
|
76507
|
-
/**
|
|
76508
|
-
* Download a user recording.
|
|
76509
|
-
* API should migrate to use GET api/v2/userrecordings/{recordingId}/transcoding
|
|
76510
|
-
* @param {String} recordingId User Recording ID
|
|
76511
|
-
* @param {Object} opts Optional parameters
|
|
76512
|
-
* @param {Object} opts.formatId The desired media format. (default to WEBM)
|
|
76513
|
-
* @param {Boolean} opts.async When set to true, api will return 202 response until the recording is ready for download
|
|
76514
|
-
* @deprecated
|
|
76515
|
-
*/
|
|
76516
|
-
getUserrecordingMedia(recordingId, opts) {
|
|
76517
|
-
opts = opts || {};
|
|
76518
|
-
|
|
76519
|
-
// verify the required parameter 'recordingId' is set
|
|
76520
|
-
if (recordingId === undefined || recordingId === null || recordingId === '') {
|
|
76521
|
-
throw 'Missing the required parameter "recordingId" when calling getUserrecordingMedia';
|
|
76522
|
-
}
|
|
76523
|
-
|
|
76524
|
-
return this.apiClient.callApi(
|
|
76525
|
-
'/api/v2/userrecordings/{recordingId}/media',
|
|
76526
|
-
'GET',
|
|
76527
|
-
{ 'recordingId': recordingId },
|
|
76528
|
-
{ 'formatId': opts['formatId'],'async': opts['async'] },
|
|
76529
|
-
{ },
|
|
76530
|
-
{ },
|
|
76531
|
-
null,
|
|
76532
|
-
['PureCloud OAuth'],
|
|
76533
|
-
['application/json'],
|
|
76534
|
-
['application/json']
|
|
76535
|
-
);
|
|
76536
|
-
}
|
|
76537
|
-
|
|
76538
77611
|
/**
|
|
76539
77612
|
* Download a user recording.
|
|
76540
77613
|
*
|
|
@@ -76650,7 +77723,7 @@ class UsersApi {
|
|
|
76650
77723
|
/**
|
|
76651
77724
|
* Users service.
|
|
76652
77725
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
76653
|
-
* @version
|
|
77726
|
+
* @version 232.0.0
|
|
76654
77727
|
*/
|
|
76655
77728
|
|
|
76656
77729
|
/**
|
|
@@ -79659,7 +80732,7 @@ class UtilitiesApi {
|
|
|
79659
80732
|
/**
|
|
79660
80733
|
* Utilities service.
|
|
79661
80734
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
79662
|
-
* @version
|
|
80735
|
+
* @version 232.0.0
|
|
79663
80736
|
*/
|
|
79664
80737
|
|
|
79665
80738
|
/**
|
|
@@ -79770,7 +80843,7 @@ class VoicemailApi {
|
|
|
79770
80843
|
/**
|
|
79771
80844
|
* Voicemail service.
|
|
79772
80845
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
79773
|
-
* @version
|
|
80846
|
+
* @version 232.0.0
|
|
79774
80847
|
*/
|
|
79775
80848
|
|
|
79776
80849
|
/**
|
|
@@ -80492,7 +81565,7 @@ class WebChatApi {
|
|
|
80492
81565
|
/**
|
|
80493
81566
|
* WebChat service.
|
|
80494
81567
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
80495
|
-
* @version
|
|
81568
|
+
* @version 232.0.0
|
|
80496
81569
|
*/
|
|
80497
81570
|
|
|
80498
81571
|
/**
|
|
@@ -80566,7 +81639,8 @@ class WebChatApi {
|
|
|
80566
81639
|
|
|
80567
81640
|
/**
|
|
80568
81641
|
* Remove WebChat deployment settings
|
|
80569
|
-
*
|
|
81642
|
+
* This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
|
|
81643
|
+
* @deprecated
|
|
80570
81644
|
*/
|
|
80571
81645
|
deleteWebchatSettings() {
|
|
80572
81646
|
|
|
@@ -80817,7 +81891,8 @@ class WebChatApi {
|
|
|
80817
81891
|
|
|
80818
81892
|
/**
|
|
80819
81893
|
* Get WebChat deployment settings
|
|
80820
|
-
*
|
|
81894
|
+
* This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
|
|
81895
|
+
* @deprecated
|
|
80821
81896
|
*/
|
|
80822
81897
|
getWebchatSettings() {
|
|
80823
81898
|
|
|
@@ -81023,8 +82098,9 @@ class WebChatApi {
|
|
|
81023
82098
|
|
|
81024
82099
|
/**
|
|
81025
82100
|
* Update WebChat deployment settings
|
|
81026
|
-
*
|
|
82101
|
+
* This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
|
|
81027
82102
|
* @param {Object} body webChatSettings
|
|
82103
|
+
* @deprecated
|
|
81028
82104
|
*/
|
|
81029
82105
|
putWebchatSettings(body) {
|
|
81030
82106
|
// verify the required parameter 'body' is set
|
|
@@ -81052,7 +82128,7 @@ class WebDeploymentsApi {
|
|
|
81052
82128
|
/**
|
|
81053
82129
|
* WebDeployments service.
|
|
81054
82130
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
81055
|
-
* @version
|
|
82131
|
+
* @version 232.0.0
|
|
81056
82132
|
*/
|
|
81057
82133
|
|
|
81058
82134
|
/**
|
|
@@ -81634,7 +82710,7 @@ class WebMessagingApi {
|
|
|
81634
82710
|
/**
|
|
81635
82711
|
* WebMessaging service.
|
|
81636
82712
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
81637
|
-
* @version
|
|
82713
|
+
* @version 232.0.0
|
|
81638
82714
|
*/
|
|
81639
82715
|
|
|
81640
82716
|
/**
|
|
@@ -81780,7 +82856,7 @@ class WidgetsApi {
|
|
|
81780
82856
|
/**
|
|
81781
82857
|
* Widgets service.
|
|
81782
82858
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
81783
|
-
* @version
|
|
82859
|
+
* @version 232.0.0
|
|
81784
82860
|
*/
|
|
81785
82861
|
|
|
81786
82862
|
/**
|
|
@@ -81931,7 +83007,7 @@ class WorkforceManagementApi {
|
|
|
81931
83007
|
/**
|
|
81932
83008
|
* WorkforceManagement service.
|
|
81933
83009
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
81934
|
-
* @version
|
|
83010
|
+
* @version 232.0.0
|
|
81935
83011
|
*/
|
|
81936
83012
|
|
|
81937
83013
|
/**
|
|
@@ -87067,6 +88143,36 @@ class WorkforceManagementApi {
|
|
|
87067
88143
|
);
|
|
87068
88144
|
}
|
|
87069
88145
|
|
|
88146
|
+
/**
|
|
88147
|
+
* Fetch agent schedules for the logged in user's management unit
|
|
88148
|
+
*
|
|
88149
|
+
* @param {Object} body body
|
|
88150
|
+
* @param {Object} opts Optional parameters
|
|
88151
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
88152
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
88153
|
+
*/
|
|
88154
|
+
postWorkforcemanagementAgentschedulesManagementunitsMine(body, opts) {
|
|
88155
|
+
opts = opts || {};
|
|
88156
|
+
|
|
88157
|
+
// verify the required parameter 'body' is set
|
|
88158
|
+
if (body === undefined || body === null) {
|
|
88159
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentschedulesManagementunitsMine';
|
|
88160
|
+
}
|
|
88161
|
+
|
|
88162
|
+
return this.apiClient.callApi(
|
|
88163
|
+
'/api/v2/workforcemanagement/agentschedules/managementunits/mine',
|
|
88164
|
+
'POST',
|
|
88165
|
+
{ },
|
|
88166
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
88167
|
+
{ },
|
|
88168
|
+
{ },
|
|
88169
|
+
body,
|
|
88170
|
+
['PureCloud OAuth'],
|
|
88171
|
+
['application/json'],
|
|
88172
|
+
['application/json']
|
|
88173
|
+
);
|
|
88174
|
+
}
|
|
88175
|
+
|
|
87070
88176
|
/**
|
|
87071
88177
|
* Get published schedule for the current user
|
|
87072
88178
|
*
|
|
@@ -89901,7 +91007,7 @@ class WorkforceManagementApi {
|
|
|
89901
91007
|
* </pre>
|
|
89902
91008
|
* </p>
|
|
89903
91009
|
* @module purecloud-platform-client-v2/index
|
|
89904
|
-
* @version
|
|
91010
|
+
* @version 232.0.0
|
|
89905
91011
|
*/
|
|
89906
91012
|
class platformClient {
|
|
89907
91013
|
constructor() {
|