purecloud-platform-client-v2 251.2.0 → 252.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +400 -130
- package/dist/web-amd/purecloud-platform-client-v2.js +400 -130
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +25684 -25549
- package/dist/web-cjs/purecloud-platform-client-v2.js +25684 -25549
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +312 -94
- package/package.json +6 -5
- package/src/purecloud-platform-client-v2/ApiClient.js +9 -6
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +38 -2
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.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/BackgroundAssistantApi.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/CaseManagementApi.js +32 -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 +72 -1
- 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 +32 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +49 -33
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -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 +2 -2
- 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 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +83 -3
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -748,7 +748,7 @@ class Configuration {
|
|
|
748
748
|
|
|
749
749
|
/**
|
|
750
750
|
* @module purecloud-platform-client-v2/ApiClient
|
|
751
|
-
* @version
|
|
751
|
+
* @version 252.1.0
|
|
752
752
|
*/
|
|
753
753
|
class ApiClient {
|
|
754
754
|
/**
|
|
@@ -1422,9 +1422,12 @@ class ApiClient {
|
|
|
1422
1422
|
// Get access token from response
|
|
1423
1423
|
var access_token = response.data.access_token;
|
|
1424
1424
|
|
|
1425
|
-
|
|
1426
|
-
|
|
1427
|
-
|
|
1425
|
+
let optsSettings = { accessToken: access_token };
|
|
1426
|
+
if (response.data['expires_in'] !== null && response.data['expires_in'] !== undefined) {
|
|
1427
|
+
optsSettings.tokenExpiryTime = new Date().getTime() + response.data['expires_in'] * 1000;
|
|
1428
|
+
optsSettings.tokenExpiryTimeString = new Date(optsSettings.tokenExpiryTime).toUTCString();
|
|
1429
|
+
}
|
|
1430
|
+
this._saveSettings(optsSettings);
|
|
1428
1431
|
|
|
1429
1432
|
// Return auth data
|
|
1430
1433
|
resolve(this.authData);
|
|
@@ -1548,9 +1551,9 @@ class ApiClient {
|
|
|
1548
1551
|
return new Promise((resolve, reject) => {
|
|
1549
1552
|
// Abort if org and provider are not set together
|
|
1550
1553
|
if (opts.org && !opts.provider) {
|
|
1551
|
-
reject(new Error('opts.provider must be set if opts.org is set'));
|
|
1554
|
+
return reject(new Error('opts.provider must be set if opts.org is set'));
|
|
1552
1555
|
} else if (opts.provider && !opts.org) {
|
|
1553
|
-
reject(new Error('opts.org must be set if opts.provider is set'));
|
|
1556
|
+
return reject(new Error('opts.org must be set if opts.provider is set'));
|
|
1554
1557
|
}
|
|
1555
1558
|
|
|
1556
1559
|
// Abort on auth error
|
|
@@ -2436,7 +2439,7 @@ class AIStudioApi {
|
|
|
2436
2439
|
/**
|
|
2437
2440
|
* AIStudio service.
|
|
2438
2441
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2439
|
-
* @version
|
|
2442
|
+
* @version 252.1.0
|
|
2440
2443
|
*/
|
|
2441
2444
|
|
|
2442
2445
|
/**
|
|
@@ -3151,7 +3154,7 @@ class AgentAssistantsApi {
|
|
|
3151
3154
|
/**
|
|
3152
3155
|
* AgentAssistants service.
|
|
3153
3156
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
3154
|
-
* @version
|
|
3157
|
+
* @version 252.1.0
|
|
3155
3158
|
*/
|
|
3156
3159
|
|
|
3157
3160
|
/**
|
|
@@ -3955,7 +3958,7 @@ class AgentCopilotApi {
|
|
|
3955
3958
|
/**
|
|
3956
3959
|
* AgentCopilot service.
|
|
3957
3960
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3958
|
-
* @version
|
|
3961
|
+
* @version 252.1.0
|
|
3959
3962
|
*/
|
|
3960
3963
|
|
|
3961
3964
|
/**
|
|
@@ -4067,7 +4070,7 @@ class AgentUIApi {
|
|
|
4067
4070
|
/**
|
|
4068
4071
|
* AgentUI service.
|
|
4069
4072
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
4070
|
-
* @version
|
|
4073
|
+
* @version 252.1.0
|
|
4071
4074
|
*/
|
|
4072
4075
|
|
|
4073
4076
|
/**
|
|
@@ -4218,7 +4221,7 @@ class AlertingApi {
|
|
|
4218
4221
|
/**
|
|
4219
4222
|
* Alerting service.
|
|
4220
4223
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
4221
|
-
* @version
|
|
4224
|
+
* @version 252.1.0
|
|
4222
4225
|
*/
|
|
4223
4226
|
|
|
4224
4227
|
/**
|
|
@@ -4679,7 +4682,7 @@ class AnalyticsApi {
|
|
|
4679
4682
|
/**
|
|
4680
4683
|
* Analytics service.
|
|
4681
4684
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4682
|
-
* @version
|
|
4685
|
+
* @version 252.1.0
|
|
4683
4686
|
*/
|
|
4684
4687
|
|
|
4685
4688
|
/**
|
|
@@ -8965,7 +8968,7 @@ class ArchitectApi {
|
|
|
8965
8968
|
/**
|
|
8966
8969
|
* Architect service.
|
|
8967
8970
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8968
|
-
* @version
|
|
8971
|
+
* @version 252.1.0
|
|
8969
8972
|
*/
|
|
8970
8973
|
|
|
8971
8974
|
/**
|
|
@@ -12957,12 +12960,48 @@ class ArchitectApi {
|
|
|
12957
12960
|
}
|
|
12958
12961
|
|
|
12959
12962
|
/**
|
|
12960
|
-
* Begin an import process for importing rows into a datatable
|
|
12963
|
+
* Begin an import process for importing rows from a CSV file into a datatable. CSV file is uploaded by performing a PUT request against the URL in the returned 'uploadURI' field. Headers for the PUT request must contain all headers contained in the returned 'uploadHeaders' field.
|
|
12964
|
+
* Create an import job for importing rows from a CSV file. The caller can then poll for status of the import using the token returned in the response
|
|
12965
|
+
* @param {String} datatableId id of datatable
|
|
12966
|
+
* @param {Object} body import job information
|
|
12967
|
+
* @param {Object} opts Optional parameters
|
|
12968
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
12969
|
+
*/
|
|
12970
|
+
postFlowsDatatableImportCsvJobs(datatableId, body, opts) {
|
|
12971
|
+
opts = opts || {};
|
|
12972
|
+
|
|
12973
|
+
// verify the required parameter 'datatableId' is set
|
|
12974
|
+
if (datatableId === undefined || datatableId === null || datatableId === '') {
|
|
12975
|
+
throw 'Missing the required parameter "datatableId" when calling postFlowsDatatableImportCsvJobs';
|
|
12976
|
+
}
|
|
12977
|
+
// verify the required parameter 'body' is set
|
|
12978
|
+
if (body === undefined || body === null) {
|
|
12979
|
+
throw 'Missing the required parameter "body" when calling postFlowsDatatableImportCsvJobs';
|
|
12980
|
+
}
|
|
12981
|
+
|
|
12982
|
+
return this.apiClient.callApi(
|
|
12983
|
+
'/api/v2/flows/datatables/{datatableId}/import/csv/jobs',
|
|
12984
|
+
'POST',
|
|
12985
|
+
{ 'datatableId': datatableId },
|
|
12986
|
+
{ },
|
|
12987
|
+
{ },
|
|
12988
|
+
{ },
|
|
12989
|
+
body,
|
|
12990
|
+
['PureCloud OAuth'],
|
|
12991
|
+
['application/json'],
|
|
12992
|
+
['application/json'],
|
|
12993
|
+
opts['customHeaders']
|
|
12994
|
+
);
|
|
12995
|
+
}
|
|
12996
|
+
|
|
12997
|
+
/**
|
|
12998
|
+
* Begin an import process for importing rows into a datatable. Apps should migrate to use POST /api/v2/flows/datatables/{datatableId}/import/csv/jobs instead
|
|
12961
12999
|
* Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response
|
|
12962
13000
|
* @param {String} datatableId id of datatable
|
|
12963
13001
|
* @param {Object} body import job information
|
|
12964
13002
|
* @param {Object} opts Optional parameters
|
|
12965
13003
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
13004
|
+
* @deprecated
|
|
12966
13005
|
*/
|
|
12967
13006
|
postFlowsDatatableImportJobs(datatableId, body, opts) {
|
|
12968
13007
|
opts = opts || {};
|
|
@@ -13788,7 +13827,7 @@ class AssistantCopilotVariationsApi {
|
|
|
13788
13827
|
/**
|
|
13789
13828
|
* AssistantCopilotVariations service.
|
|
13790
13829
|
* @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
13791
|
-
* @version
|
|
13830
|
+
* @version 252.1.0
|
|
13792
13831
|
*/
|
|
13793
13832
|
|
|
13794
13833
|
/**
|
|
@@ -13984,7 +14023,7 @@ class AuditApi {
|
|
|
13984
14023
|
/**
|
|
13985
14024
|
* Audit service.
|
|
13986
14025
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
13987
|
-
* @version
|
|
14026
|
+
* @version 252.1.0
|
|
13988
14027
|
*/
|
|
13989
14028
|
|
|
13990
14029
|
/**
|
|
@@ -14211,7 +14250,7 @@ class AuthorizationApi {
|
|
|
14211
14250
|
/**
|
|
14212
14251
|
* Authorization service.
|
|
14213
14252
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
14214
|
-
* @version
|
|
14253
|
+
* @version 252.1.0
|
|
14215
14254
|
*/
|
|
14216
14255
|
|
|
14217
14256
|
/**
|
|
@@ -16136,7 +16175,7 @@ class BackgroundAssistantApi {
|
|
|
16136
16175
|
/**
|
|
16137
16176
|
* BackgroundAssistant service.
|
|
16138
16177
|
* @module purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
16139
|
-
* @version
|
|
16178
|
+
* @version 252.1.0
|
|
16140
16179
|
*/
|
|
16141
16180
|
|
|
16142
16181
|
/**
|
|
@@ -16210,7 +16249,7 @@ class BillingApi {
|
|
|
16210
16249
|
/**
|
|
16211
16250
|
* Billing service.
|
|
16212
16251
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16213
|
-
* @version
|
|
16252
|
+
* @version 252.1.0
|
|
16214
16253
|
*/
|
|
16215
16254
|
|
|
16216
16255
|
/**
|
|
@@ -16494,7 +16533,7 @@ class BusinessRulesApi {
|
|
|
16494
16533
|
/**
|
|
16495
16534
|
* BusinessRules service.
|
|
16496
16535
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
16497
|
-
* @version
|
|
16536
|
+
* @version 252.1.0
|
|
16498
16537
|
*/
|
|
16499
16538
|
|
|
16500
16539
|
/**
|
|
@@ -17508,7 +17547,7 @@ class CarrierServicesApi {
|
|
|
17508
17547
|
/**
|
|
17509
17548
|
* CarrierServices service.
|
|
17510
17549
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
17511
|
-
* @version
|
|
17550
|
+
* @version 252.1.0
|
|
17512
17551
|
*/
|
|
17513
17552
|
|
|
17514
17553
|
/**
|
|
@@ -17585,7 +17624,7 @@ class CaseManagementApi {
|
|
|
17585
17624
|
/**
|
|
17586
17625
|
* CaseManagement service.
|
|
17587
17626
|
* @module purecloud-platform-client-v2/api/CaseManagementApi
|
|
17588
|
-
* @version
|
|
17627
|
+
* @version 252.1.0
|
|
17589
17628
|
*/
|
|
17590
17629
|
|
|
17591
17630
|
/**
|
|
@@ -18747,6 +18786,37 @@ class CaseManagementApi {
|
|
|
18747
18786
|
);
|
|
18748
18787
|
}
|
|
18749
18788
|
|
|
18789
|
+
/**
|
|
18790
|
+
* Query for caseplans
|
|
18791
|
+
*
|
|
18792
|
+
* @param {Object} body CaseplanQueryRequest
|
|
18793
|
+
* @param {Object} opts Optional parameters
|
|
18794
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18795
|
+
* postCasemanagementCaseplansQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18796
|
+
*/
|
|
18797
|
+
postCasemanagementCaseplansQuery(body, opts) {
|
|
18798
|
+
opts = opts || {};
|
|
18799
|
+
|
|
18800
|
+
// verify the required parameter 'body' is set
|
|
18801
|
+
if (body === undefined || body === null) {
|
|
18802
|
+
throw 'Missing the required parameter "body" when calling postCasemanagementCaseplansQuery';
|
|
18803
|
+
}
|
|
18804
|
+
|
|
18805
|
+
return this.apiClient.callApi(
|
|
18806
|
+
'/api/v2/casemanagement/caseplans/query',
|
|
18807
|
+
'POST',
|
|
18808
|
+
{ },
|
|
18809
|
+
{ },
|
|
18810
|
+
{ },
|
|
18811
|
+
{ },
|
|
18812
|
+
body,
|
|
18813
|
+
['PureCloud OAuth'],
|
|
18814
|
+
['application/json'],
|
|
18815
|
+
['application/json'],
|
|
18816
|
+
opts['customHeaders']
|
|
18817
|
+
);
|
|
18818
|
+
}
|
|
18819
|
+
|
|
18750
18820
|
/**
|
|
18751
18821
|
* Create a Case.
|
|
18752
18822
|
*
|
|
@@ -18847,7 +18917,7 @@ class ChatApi {
|
|
|
18847
18917
|
/**
|
|
18848
18918
|
* Chat service.
|
|
18849
18919
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
18850
|
-
* @version
|
|
18920
|
+
* @version 252.1.0
|
|
18851
18921
|
*/
|
|
18852
18922
|
|
|
18853
18923
|
/**
|
|
@@ -19986,7 +20056,7 @@ class CoachingApi {
|
|
|
19986
20056
|
/**
|
|
19987
20057
|
* Coaching service.
|
|
19988
20058
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
19989
|
-
* @version
|
|
20059
|
+
* @version 252.1.0
|
|
19990
20060
|
*/
|
|
19991
20061
|
|
|
19992
20062
|
/**
|
|
@@ -20700,7 +20770,7 @@ class ContentManagementApi {
|
|
|
20700
20770
|
/**
|
|
20701
20771
|
* ContentManagement service.
|
|
20702
20772
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
20703
|
-
* @version
|
|
20773
|
+
* @version 252.1.0
|
|
20704
20774
|
*/
|
|
20705
20775
|
|
|
20706
20776
|
/**
|
|
@@ -21895,7 +21965,7 @@ class ConversationsApi {
|
|
|
21895
21965
|
/**
|
|
21896
21966
|
* Conversations service.
|
|
21897
21967
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
21898
|
-
* @version
|
|
21968
|
+
* @version 252.1.0
|
|
21899
21969
|
*/
|
|
21900
21970
|
|
|
21901
21971
|
/**
|
|
@@ -22783,6 +22853,37 @@ class ConversationsApi {
|
|
|
22783
22853
|
);
|
|
22784
22854
|
}
|
|
22785
22855
|
|
|
22856
|
+
/**
|
|
22857
|
+
* Get copilot context values for a conversation.
|
|
22858
|
+
*
|
|
22859
|
+
* @param {String} conversationId Conversation ID.
|
|
22860
|
+
* @param {Object} opts Optional parameters
|
|
22861
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
22862
|
+
* getConversationAssistantCopilotcontext is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22863
|
+
*/
|
|
22864
|
+
getConversationAssistantCopilotcontext(conversationId, opts) {
|
|
22865
|
+
opts = opts || {};
|
|
22866
|
+
|
|
22867
|
+
// verify the required parameter 'conversationId' is set
|
|
22868
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
22869
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationAssistantCopilotcontext';
|
|
22870
|
+
}
|
|
22871
|
+
|
|
22872
|
+
return this.apiClient.callApi(
|
|
22873
|
+
'/api/v2/conversations/{conversationId}/assistant/copilotcontext',
|
|
22874
|
+
'GET',
|
|
22875
|
+
{ 'conversationId': conversationId },
|
|
22876
|
+
{ },
|
|
22877
|
+
{ },
|
|
22878
|
+
{ },
|
|
22879
|
+
null,
|
|
22880
|
+
['PureCloud OAuth'],
|
|
22881
|
+
['application/json'],
|
|
22882
|
+
['application/json'],
|
|
22883
|
+
opts['customHeaders']
|
|
22884
|
+
);
|
|
22885
|
+
}
|
|
22886
|
+
|
|
22786
22887
|
/**
|
|
22787
22888
|
* Get checklist info for a single checklist.
|
|
22788
22889
|
*
|
|
@@ -27937,6 +28038,46 @@ class ConversationsApi {
|
|
|
27937
28038
|
);
|
|
27938
28039
|
}
|
|
27939
28040
|
|
|
28041
|
+
/**
|
|
28042
|
+
* Update conversation by setting its parking state
|
|
28043
|
+
*
|
|
28044
|
+
* @param {String} conversationId conversationId
|
|
28045
|
+
* @param {String} participantId participantId
|
|
28046
|
+
* @param {Object} body Parking update request
|
|
28047
|
+
* @param {Object} opts Optional parameters
|
|
28048
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
28049
|
+
*/
|
|
28050
|
+
patchConversationsMessageParticipantParkingstate(conversationId, participantId, body, opts) {
|
|
28051
|
+
opts = opts || {};
|
|
28052
|
+
|
|
28053
|
+
// verify the required parameter 'conversationId' is set
|
|
28054
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
28055
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationsMessageParticipantParkingstate';
|
|
28056
|
+
}
|
|
28057
|
+
// verify the required parameter 'participantId' is set
|
|
28058
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
28059
|
+
throw 'Missing the required parameter "participantId" when calling patchConversationsMessageParticipantParkingstate';
|
|
28060
|
+
}
|
|
28061
|
+
// verify the required parameter 'body' is set
|
|
28062
|
+
if (body === undefined || body === null) {
|
|
28063
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessageParticipantParkingstate';
|
|
28064
|
+
}
|
|
28065
|
+
|
|
28066
|
+
return this.apiClient.callApi(
|
|
28067
|
+
'/api/v2/conversations/messages/{conversationId}/participants/{participantId}/parkingstate',
|
|
28068
|
+
'PATCH',
|
|
28069
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
28070
|
+
{ },
|
|
28071
|
+
{ },
|
|
28072
|
+
{ },
|
|
28073
|
+
body,
|
|
28074
|
+
['PureCloud OAuth'],
|
|
28075
|
+
['application/json'],
|
|
28076
|
+
['application/json'],
|
|
28077
|
+
opts['customHeaders']
|
|
28078
|
+
);
|
|
28079
|
+
}
|
|
28080
|
+
|
|
27940
28081
|
/**
|
|
27941
28082
|
* Update an Apple messaging integration
|
|
27942
28083
|
*
|
|
@@ -32930,7 +33071,7 @@ class DataExtensionsApi {
|
|
|
32930
33071
|
/**
|
|
32931
33072
|
* DataExtensions service.
|
|
32932
33073
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
32933
|
-
* @version
|
|
33074
|
+
* @version 252.1.0
|
|
32934
33075
|
*/
|
|
32935
33076
|
|
|
32936
33077
|
/**
|
|
@@ -33031,7 +33172,7 @@ class DataPrivacyApi {
|
|
|
33031
33172
|
/**
|
|
33032
33173
|
* DataPrivacy service.
|
|
33033
33174
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
33034
|
-
* @version
|
|
33175
|
+
* @version 252.1.0
|
|
33035
33176
|
*/
|
|
33036
33177
|
|
|
33037
33178
|
/**
|
|
@@ -33228,7 +33369,7 @@ class DownloadsApi {
|
|
|
33228
33369
|
/**
|
|
33229
33370
|
* Downloads service.
|
|
33230
33371
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
33231
|
-
* @version
|
|
33372
|
+
* @version 252.1.0
|
|
33232
33373
|
*/
|
|
33233
33374
|
|
|
33234
33375
|
/**
|
|
@@ -33282,7 +33423,7 @@ class EmailsApi {
|
|
|
33282
33423
|
/**
|
|
33283
33424
|
* Emails service.
|
|
33284
33425
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
33285
|
-
* @version
|
|
33426
|
+
* @version 252.1.0
|
|
33286
33427
|
*/
|
|
33287
33428
|
|
|
33288
33429
|
/**
|
|
@@ -33430,7 +33571,7 @@ class EmployeeEngagementApi {
|
|
|
33430
33571
|
/**
|
|
33431
33572
|
* EmployeeEngagement service.
|
|
33432
33573
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
33433
|
-
* @version
|
|
33574
|
+
* @version 252.1.0
|
|
33434
33575
|
*/
|
|
33435
33576
|
|
|
33436
33577
|
/**
|
|
@@ -33634,7 +33775,7 @@ class EventsApi {
|
|
|
33634
33775
|
/**
|
|
33635
33776
|
* Events service.
|
|
33636
33777
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
33637
|
-
* @version
|
|
33778
|
+
* @version 252.1.0
|
|
33638
33779
|
*/
|
|
33639
33780
|
|
|
33640
33781
|
/**
|
|
@@ -33679,6 +33820,37 @@ class EventsApi {
|
|
|
33679
33820
|
);
|
|
33680
33821
|
}
|
|
33681
33822
|
|
|
33823
|
+
/**
|
|
33824
|
+
* Publish Predictive Routing Custom Kpi Attribution Batch Events
|
|
33825
|
+
*
|
|
33826
|
+
* @param {Object} body batchRequest
|
|
33827
|
+
* @param {Object} opts Optional parameters
|
|
33828
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
33829
|
+
* postEventsRoutingCustomkpiattributions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33830
|
+
*/
|
|
33831
|
+
postEventsRoutingCustomkpiattributions(body, opts) {
|
|
33832
|
+
opts = opts || {};
|
|
33833
|
+
|
|
33834
|
+
// verify the required parameter 'body' is set
|
|
33835
|
+
if (body === undefined || body === null) {
|
|
33836
|
+
throw 'Missing the required parameter "body" when calling postEventsRoutingCustomkpiattributions';
|
|
33837
|
+
}
|
|
33838
|
+
|
|
33839
|
+
return this.apiClient.callApi(
|
|
33840
|
+
'/api/v2/events/routing/customkpiattributions',
|
|
33841
|
+
'POST',
|
|
33842
|
+
{ },
|
|
33843
|
+
{ },
|
|
33844
|
+
{ },
|
|
33845
|
+
{ },
|
|
33846
|
+
body,
|
|
33847
|
+
['PureCloud OAuth'],
|
|
33848
|
+
['application/json'],
|
|
33849
|
+
['application/json'],
|
|
33850
|
+
opts['customHeaders']
|
|
33851
|
+
);
|
|
33852
|
+
}
|
|
33853
|
+
|
|
33682
33854
|
/**
|
|
33683
33855
|
* Publish User Presence Status Batch Events
|
|
33684
33856
|
*
|
|
@@ -33745,7 +33917,7 @@ class ExternalContactsApi {
|
|
|
33745
33917
|
/**
|
|
33746
33918
|
* ExternalContacts service.
|
|
33747
33919
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
33748
|
-
* @version
|
|
33920
|
+
* @version 252.1.0
|
|
33749
33921
|
*/
|
|
33750
33922
|
|
|
33751
33923
|
/**
|
|
@@ -37516,7 +37688,7 @@ class FaxApi {
|
|
|
37516
37688
|
/**
|
|
37517
37689
|
* Fax service.
|
|
37518
37690
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
37519
|
-
* @version
|
|
37691
|
+
* @version 252.1.0
|
|
37520
37692
|
*/
|
|
37521
37693
|
|
|
37522
37694
|
/**
|
|
@@ -37765,7 +37937,7 @@ class FlowsApi {
|
|
|
37765
37937
|
/**
|
|
37766
37938
|
* Flows service.
|
|
37767
37939
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
37768
|
-
* @version
|
|
37940
|
+
* @version 252.1.0
|
|
37769
37941
|
*/
|
|
37770
37942
|
|
|
37771
37943
|
/**
|
|
@@ -38003,7 +38175,7 @@ class GamificationApi {
|
|
|
38003
38175
|
/**
|
|
38004
38176
|
* Gamification service.
|
|
38005
38177
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
38006
|
-
* @version
|
|
38178
|
+
* @version 252.1.0
|
|
38007
38179
|
*/
|
|
38008
38180
|
|
|
38009
38181
|
/**
|
|
@@ -40855,7 +41027,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
40855
41027
|
/**
|
|
40856
41028
|
* GeneralDataProtectionRegulation service.
|
|
40857
41029
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
40858
|
-
* @version
|
|
41030
|
+
* @version 252.1.0
|
|
40859
41031
|
*/
|
|
40860
41032
|
|
|
40861
41033
|
/**
|
|
@@ -40999,7 +41171,7 @@ class GeolocationApi {
|
|
|
40999
41171
|
/**
|
|
41000
41172
|
* Geolocation service.
|
|
41001
41173
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
41002
|
-
* @version
|
|
41174
|
+
* @version 252.1.0
|
|
41003
41175
|
*/
|
|
41004
41176
|
|
|
41005
41177
|
/**
|
|
@@ -41150,7 +41322,7 @@ class GreetingsApi {
|
|
|
41150
41322
|
/**
|
|
41151
41323
|
* Greetings service.
|
|
41152
41324
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
41153
|
-
* @version
|
|
41325
|
+
* @version 252.1.0
|
|
41154
41326
|
*/
|
|
41155
41327
|
|
|
41156
41328
|
/**
|
|
@@ -41766,7 +41938,7 @@ class GroupsApi {
|
|
|
41766
41938
|
/**
|
|
41767
41939
|
* Groups service.
|
|
41768
41940
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
41769
|
-
* @version
|
|
41941
|
+
* @version 252.1.0
|
|
41770
41942
|
*/
|
|
41771
41943
|
|
|
41772
41944
|
/**
|
|
@@ -42357,7 +42529,7 @@ class IdentityProviderApi {
|
|
|
42357
42529
|
/**
|
|
42358
42530
|
* IdentityProvider service.
|
|
42359
42531
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
42360
|
-
* @version
|
|
42532
|
+
* @version 252.1.0
|
|
42361
42533
|
*/
|
|
42362
42534
|
|
|
42363
42535
|
/**
|
|
@@ -43408,7 +43580,7 @@ class InfrastructureAsCodeApi {
|
|
|
43408
43580
|
/**
|
|
43409
43581
|
* InfrastructureAsCode service.
|
|
43410
43582
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
43411
|
-
* @version
|
|
43583
|
+
* @version 252.1.0
|
|
43412
43584
|
*/
|
|
43413
43585
|
|
|
43414
43586
|
/**
|
|
@@ -43588,7 +43760,7 @@ class IntegrationsApi {
|
|
|
43588
43760
|
/**
|
|
43589
43761
|
* Integrations service.
|
|
43590
43762
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
43591
|
-
* @version
|
|
43763
|
+
* @version 252.1.0
|
|
43592
43764
|
*/
|
|
43593
43765
|
|
|
43594
43766
|
/**
|
|
@@ -46560,7 +46732,7 @@ class IntentsApi {
|
|
|
46560
46732
|
/**
|
|
46561
46733
|
* Intents service.
|
|
46562
46734
|
* @module purecloud-platform-client-v2/api/IntentsApi
|
|
46563
|
-
* @version
|
|
46735
|
+
* @version 252.1.0
|
|
46564
46736
|
*/
|
|
46565
46737
|
|
|
46566
46738
|
/**
|
|
@@ -47092,7 +47264,7 @@ class JourneyApi {
|
|
|
47092
47264
|
/**
|
|
47093
47265
|
* Journey service.
|
|
47094
47266
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
47095
|
-
* @version
|
|
47267
|
+
* @version 252.1.0
|
|
47096
47268
|
*/
|
|
47097
47269
|
|
|
47098
47270
|
/**
|
|
@@ -47260,11 +47432,12 @@ class JourneyApi {
|
|
|
47260
47432
|
}
|
|
47261
47433
|
|
|
47262
47434
|
/**
|
|
47263
|
-
* Delete an outcome.
|
|
47264
|
-
*
|
|
47435
|
+
* Deprecated. Delete an outcome.
|
|
47436
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
47265
47437
|
* @param {String} outcomeId ID of the outcome.
|
|
47266
47438
|
* @param {Object} opts Optional parameters
|
|
47267
47439
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47440
|
+
* @deprecated
|
|
47268
47441
|
*/
|
|
47269
47442
|
deleteJourneyOutcome(outcomeId, opts) {
|
|
47270
47443
|
opts = opts || {};
|
|
@@ -47290,11 +47463,12 @@ class JourneyApi {
|
|
|
47290
47463
|
}
|
|
47291
47464
|
|
|
47292
47465
|
/**
|
|
47293
|
-
* Delete an outcome predictor.
|
|
47294
|
-
*
|
|
47466
|
+
* Deprecated. Delete an outcome predictor.
|
|
47467
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
47295
47468
|
* @param {String} predictorId ID of predictor
|
|
47296
47469
|
* @param {Object} opts Optional parameters
|
|
47297
47470
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47471
|
+
* @deprecated
|
|
47298
47472
|
*/
|
|
47299
47473
|
deleteJourneyOutcomesPredictor(predictorId, opts) {
|
|
47300
47474
|
opts = opts || {};
|
|
@@ -47601,11 +47775,12 @@ class JourneyApi {
|
|
|
47601
47775
|
}
|
|
47602
47776
|
|
|
47603
47777
|
/**
|
|
47604
|
-
* Get status of job.
|
|
47605
|
-
*
|
|
47778
|
+
* Deprecated. Get status of job.
|
|
47779
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
47606
47780
|
* @param {String} jobId ID of the job.
|
|
47607
47781
|
* @param {Object} opts Optional parameters
|
|
47608
47782
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47783
|
+
* @deprecated
|
|
47609
47784
|
*/
|
|
47610
47785
|
getJourneyActionmapsEstimatesJob(jobId, opts) {
|
|
47611
47786
|
opts = opts || {};
|
|
@@ -47631,11 +47806,12 @@ class JourneyApi {
|
|
|
47631
47806
|
}
|
|
47632
47807
|
|
|
47633
47808
|
/**
|
|
47634
|
-
* Get estimates from completed job.
|
|
47635
|
-
*
|
|
47809
|
+
* Deprecated. Get estimates from completed job.
|
|
47810
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
47636
47811
|
* @param {String} jobId ID of the job.
|
|
47637
47812
|
* @param {Object} opts Optional parameters
|
|
47638
47813
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47814
|
+
* @deprecated
|
|
47639
47815
|
*/
|
|
47640
47816
|
getJourneyActionmapsEstimatesJobResults(jobId, opts) {
|
|
47641
47817
|
opts = opts || {};
|
|
@@ -48077,11 +48253,12 @@ class JourneyApi {
|
|
|
48077
48253
|
}
|
|
48078
48254
|
|
|
48079
48255
|
/**
|
|
48080
|
-
* Retrieve a single outcome.
|
|
48081
|
-
*
|
|
48256
|
+
* Deprecated. Retrieve a single outcome.
|
|
48257
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48082
48258
|
* @param {String} outcomeId ID of the outcome.
|
|
48083
48259
|
* @param {Object} opts Optional parameters
|
|
48084
48260
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48261
|
+
* @deprecated
|
|
48085
48262
|
*/
|
|
48086
48263
|
getJourneyOutcome(outcomeId, opts) {
|
|
48087
48264
|
opts = opts || {};
|
|
@@ -48107,8 +48284,8 @@ class JourneyApi {
|
|
|
48107
48284
|
}
|
|
48108
48285
|
|
|
48109
48286
|
/**
|
|
48110
|
-
* Retrieve all outcomes.
|
|
48111
|
-
*
|
|
48287
|
+
* Deprecated. Retrieve all outcomes.
|
|
48288
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48112
48289
|
* @param {Object} opts Optional parameters
|
|
48113
48290
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
48114
48291
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
@@ -48117,6 +48294,7 @@ class JourneyApi {
|
|
|
48117
48294
|
* @param {Array.<String>} opts.queryFields Outcome field(s) to query on. Requires 'queryValue' to also be set.
|
|
48118
48295
|
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
48119
48296
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48297
|
+
* @deprecated
|
|
48120
48298
|
*/
|
|
48121
48299
|
getJourneyOutcomes(opts) {
|
|
48122
48300
|
opts = opts || {};
|
|
@@ -48138,11 +48316,12 @@ class JourneyApi {
|
|
|
48138
48316
|
}
|
|
48139
48317
|
|
|
48140
48318
|
/**
|
|
48141
|
-
* Get job status.
|
|
48142
|
-
*
|
|
48319
|
+
* Deprecated. Get job status.
|
|
48320
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48143
48321
|
* @param {String} jobId ID of the job.
|
|
48144
48322
|
* @param {Object} opts Optional parameters
|
|
48145
48323
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48324
|
+
* @deprecated
|
|
48146
48325
|
* getJourneyOutcomesAttributionsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48147
48326
|
*/
|
|
48148
48327
|
getJourneyOutcomesAttributionsJob(jobId, opts) {
|
|
@@ -48169,11 +48348,12 @@ class JourneyApi {
|
|
|
48169
48348
|
}
|
|
48170
48349
|
|
|
48171
48350
|
/**
|
|
48172
|
-
* Get outcome attribution entities from completed job.
|
|
48173
|
-
*
|
|
48351
|
+
* Deprecated. Get outcome attribution entities from completed job.
|
|
48352
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48174
48353
|
* @param {String} jobId ID of the job.
|
|
48175
48354
|
* @param {Object} opts Optional parameters
|
|
48176
48355
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48356
|
+
* @deprecated
|
|
48177
48357
|
* getJourneyOutcomesAttributionsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48178
48358
|
*/
|
|
48179
48359
|
getJourneyOutcomesAttributionsJobResults(jobId, opts) {
|
|
@@ -48200,11 +48380,12 @@ class JourneyApi {
|
|
|
48200
48380
|
}
|
|
48201
48381
|
|
|
48202
48382
|
/**
|
|
48203
|
-
* Retrieve a single outcome predictor.
|
|
48204
|
-
*
|
|
48383
|
+
* Deprecated. Retrieve a single outcome predictor.
|
|
48384
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48205
48385
|
* @param {String} predictorId ID of predictor
|
|
48206
48386
|
* @param {Object} opts Optional parameters
|
|
48207
48387
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48388
|
+
* @deprecated
|
|
48208
48389
|
*/
|
|
48209
48390
|
getJourneyOutcomesPredictor(predictorId, opts) {
|
|
48210
48391
|
opts = opts || {};
|
|
@@ -48230,10 +48411,11 @@ class JourneyApi {
|
|
|
48230
48411
|
}
|
|
48231
48412
|
|
|
48232
48413
|
/**
|
|
48233
|
-
* Retrieve all outcome predictors.
|
|
48234
|
-
*
|
|
48414
|
+
* Deprecated. Retrieve all outcome predictors.
|
|
48415
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48235
48416
|
* @param {Object} opts Optional parameters
|
|
48236
48417
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48418
|
+
* @deprecated
|
|
48237
48419
|
*/
|
|
48238
48420
|
getJourneyOutcomesPredictors(opts) {
|
|
48239
48421
|
opts = opts || {};
|
|
@@ -48380,11 +48562,12 @@ class JourneyApi {
|
|
|
48380
48562
|
}
|
|
48381
48563
|
|
|
48382
48564
|
/**
|
|
48383
|
-
* Retrieve latest outcome score associated with a session for all outcomes.
|
|
48384
|
-
*
|
|
48565
|
+
* Deprecated. Retrieve latest outcome score associated with a session for all outcomes.
|
|
48566
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48385
48567
|
* @param {String} sessionId ID of the session.
|
|
48386
48568
|
* @param {Object} opts Optional parameters
|
|
48387
48569
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48570
|
+
* @deprecated
|
|
48388
48571
|
*/
|
|
48389
48572
|
getJourneySessionOutcomescores(sessionId, opts) {
|
|
48390
48573
|
opts = opts || {};
|
|
@@ -49069,12 +49252,13 @@ class JourneyApi {
|
|
|
49069
49252
|
}
|
|
49070
49253
|
|
|
49071
49254
|
/**
|
|
49072
|
-
* Update an outcome.
|
|
49073
|
-
*
|
|
49255
|
+
* Deprecated. Update an outcome.
|
|
49256
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
49074
49257
|
* @param {String} outcomeId ID of the outcome.
|
|
49075
49258
|
* @param {Object} opts Optional parameters
|
|
49076
49259
|
* @param {Object} opts.body
|
|
49077
49260
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49261
|
+
* @deprecated
|
|
49078
49262
|
*/
|
|
49079
49263
|
patchJourneyOutcome(outcomeId, opts) {
|
|
49080
49264
|
opts = opts || {};
|
|
@@ -49294,11 +49478,12 @@ class JourneyApi {
|
|
|
49294
49478
|
}
|
|
49295
49479
|
|
|
49296
49480
|
/**
|
|
49297
|
-
* Query for estimates
|
|
49298
|
-
*
|
|
49481
|
+
* Deprecated. Query for estimates
|
|
49482
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
49299
49483
|
* @param {Object} body audience estimator request
|
|
49300
49484
|
* @param {Object} opts Optional parameters
|
|
49301
49485
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49486
|
+
* @deprecated
|
|
49302
49487
|
*/
|
|
49303
49488
|
postJourneyActionmapsEstimatesJobs(body, opts) {
|
|
49304
49489
|
opts = opts || {};
|
|
@@ -49560,11 +49745,12 @@ class JourneyApi {
|
|
|
49560
49745
|
}
|
|
49561
49746
|
|
|
49562
49747
|
/**
|
|
49563
|
-
* Create an outcome.
|
|
49564
|
-
*
|
|
49748
|
+
* Deprecated. Create an outcome.
|
|
49749
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
49565
49750
|
* @param {Object} opts Optional parameters
|
|
49566
49751
|
* @param {Object} opts.body
|
|
49567
49752
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49753
|
+
* @deprecated
|
|
49568
49754
|
*/
|
|
49569
49755
|
postJourneyOutcomes(opts) {
|
|
49570
49756
|
opts = opts || {};
|
|
@@ -49586,11 +49772,12 @@ class JourneyApi {
|
|
|
49586
49772
|
}
|
|
49587
49773
|
|
|
49588
49774
|
/**
|
|
49589
|
-
* Create Outcome Attributions
|
|
49590
|
-
*
|
|
49775
|
+
* Deprecated. Create Outcome Attributions
|
|
49776
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
49591
49777
|
* @param {Object} opts Optional parameters
|
|
49592
49778
|
* @param {Object} opts.body outcome attribution request
|
|
49593
49779
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49780
|
+
* @deprecated
|
|
49594
49781
|
* postJourneyOutcomesAttributionsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49595
49782
|
*/
|
|
49596
49783
|
postJourneyOutcomesAttributionsJobs(opts) {
|
|
@@ -49613,11 +49800,12 @@ class JourneyApi {
|
|
|
49613
49800
|
}
|
|
49614
49801
|
|
|
49615
49802
|
/**
|
|
49616
|
-
* Create an outcome predictor.
|
|
49617
|
-
*
|
|
49803
|
+
* Deprecated. Create an outcome predictor.
|
|
49804
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
49618
49805
|
* @param {Object} opts Optional parameters
|
|
49619
49806
|
* @param {Object} opts.body
|
|
49620
49807
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49808
|
+
* @deprecated
|
|
49621
49809
|
*/
|
|
49622
49810
|
postJourneyOutcomesPredictors(opts) {
|
|
49623
49811
|
opts = opts || {};
|
|
@@ -49941,7 +50129,7 @@ class KnowledgeApi {
|
|
|
49941
50129
|
/**
|
|
49942
50130
|
* Knowledge service.
|
|
49943
50131
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
49944
|
-
* @version
|
|
50132
|
+
* @version 252.1.0
|
|
49945
50133
|
*/
|
|
49946
50134
|
|
|
49947
50135
|
/**
|
|
@@ -50432,6 +50620,8 @@ class KnowledgeApi {
|
|
|
50432
50620
|
*
|
|
50433
50621
|
* @param {String} connectionId Connection ID
|
|
50434
50622
|
* @param {Object} opts Optional parameters
|
|
50623
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
50624
|
+
* @param {String} opts.pageSize Number of results per page. Minimum: 25, Maximum: 500. (default to 200)
|
|
50435
50625
|
* @param {String} opts.parentId The id of the parent option whose children to be listed.
|
|
50436
50626
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
50437
50627
|
*/
|
|
@@ -50447,7 +50637,7 @@ class KnowledgeApi {
|
|
|
50447
50637
|
'/api/v2/knowledge/connections/{connectionId}/options',
|
|
50448
50638
|
'GET',
|
|
50449
50639
|
{ 'connectionId': connectionId },
|
|
50450
|
-
{ 'parentId': opts['parentId'] },
|
|
50640
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'parentId': opts['parentId'] },
|
|
50451
50641
|
{ },
|
|
50452
50642
|
{ },
|
|
50453
50643
|
null,
|
|
@@ -54149,7 +54339,7 @@ class LanguageUnderstandingApi {
|
|
|
54149
54339
|
/**
|
|
54150
54340
|
* LanguageUnderstanding service.
|
|
54151
54341
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
54152
|
-
* @version
|
|
54342
|
+
* @version 252.1.0
|
|
54153
54343
|
*/
|
|
54154
54344
|
|
|
54155
54345
|
/**
|
|
@@ -55523,7 +55713,7 @@ class LanguagesApi {
|
|
|
55523
55713
|
/**
|
|
55524
55714
|
* Languages service.
|
|
55525
55715
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
55526
|
-
* @version
|
|
55716
|
+
* @version 252.1.0
|
|
55527
55717
|
*/
|
|
55528
55718
|
|
|
55529
55719
|
/**
|
|
@@ -55782,7 +55972,7 @@ class LearningApi {
|
|
|
55782
55972
|
/**
|
|
55783
55973
|
* Learning service.
|
|
55784
55974
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
55785
|
-
* @version
|
|
55975
|
+
* @version 252.1.0
|
|
55786
55976
|
*/
|
|
55787
55977
|
|
|
55788
55978
|
/**
|
|
@@ -57030,7 +57220,7 @@ class LicenseApi {
|
|
|
57030
57220
|
/**
|
|
57031
57221
|
* License service.
|
|
57032
57222
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
57033
|
-
* @version
|
|
57223
|
+
* @version 252.1.0
|
|
57034
57224
|
*/
|
|
57035
57225
|
|
|
57036
57226
|
/**
|
|
@@ -57328,7 +57518,7 @@ class LocationsApi {
|
|
|
57328
57518
|
/**
|
|
57329
57519
|
* Locations service.
|
|
57330
57520
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
57331
|
-
* @version
|
|
57521
|
+
* @version 252.1.0
|
|
57332
57522
|
*/
|
|
57333
57523
|
|
|
57334
57524
|
/**
|
|
@@ -57595,7 +57785,7 @@ class LogCaptureApi {
|
|
|
57595
57785
|
/**
|
|
57596
57786
|
* LogCapture service.
|
|
57597
57787
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
57598
|
-
* @version
|
|
57788
|
+
* @version 252.1.0
|
|
57599
57789
|
*/
|
|
57600
57790
|
|
|
57601
57791
|
/**
|
|
@@ -57817,7 +58007,7 @@ class MessagingApi {
|
|
|
57817
58007
|
/**
|
|
57818
58008
|
* Messaging service.
|
|
57819
58009
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
57820
|
-
* @version
|
|
58010
|
+
* @version 252.1.0
|
|
57821
58011
|
*/
|
|
57822
58012
|
|
|
57823
58013
|
/**
|
|
@@ -58235,7 +58425,7 @@ class MobileDevicesApi {
|
|
|
58235
58425
|
/**
|
|
58236
58426
|
* MobileDevices service.
|
|
58237
58427
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
58238
|
-
* @version
|
|
58428
|
+
* @version 252.1.0
|
|
58239
58429
|
*/
|
|
58240
58430
|
|
|
58241
58431
|
/**
|
|
@@ -58405,7 +58595,7 @@ class NotificationsApi {
|
|
|
58405
58595
|
/**
|
|
58406
58596
|
* Notifications service.
|
|
58407
58597
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
58408
|
-
* @version
|
|
58598
|
+
* @version 252.1.0
|
|
58409
58599
|
*/
|
|
58410
58600
|
|
|
58411
58601
|
/**
|
|
@@ -58666,7 +58856,7 @@ class OAuthApi {
|
|
|
58666
58856
|
/**
|
|
58667
58857
|
* OAuth service.
|
|
58668
58858
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
58669
|
-
* @version
|
|
58859
|
+
* @version 252.1.0
|
|
58670
58860
|
*/
|
|
58671
58861
|
|
|
58672
58862
|
/**
|
|
@@ -59082,7 +59272,7 @@ class ObjectsApi {
|
|
|
59082
59272
|
/**
|
|
59083
59273
|
* Objects service.
|
|
59084
59274
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
59085
|
-
* @version
|
|
59275
|
+
* @version 252.1.0
|
|
59086
59276
|
*/
|
|
59087
59277
|
|
|
59088
59278
|
/**
|
|
@@ -59446,7 +59636,7 @@ class OperationalEventsApi {
|
|
|
59446
59636
|
/**
|
|
59447
59637
|
* OperationalEvents service.
|
|
59448
59638
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
59449
|
-
* @version
|
|
59639
|
+
* @version 252.1.0
|
|
59450
59640
|
*/
|
|
59451
59641
|
|
|
59452
59642
|
/**
|
|
@@ -59577,7 +59767,7 @@ class OrganizationApi {
|
|
|
59577
59767
|
/**
|
|
59578
59768
|
* Organization service.
|
|
59579
59769
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
59580
|
-
* @version
|
|
59770
|
+
* @version 252.1.0
|
|
59581
59771
|
*/
|
|
59582
59772
|
|
|
59583
59773
|
/**
|
|
@@ -60138,7 +60328,7 @@ class OrganizationAuthorizationApi {
|
|
|
60138
60328
|
/**
|
|
60139
60329
|
* OrganizationAuthorization service.
|
|
60140
60330
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
60141
|
-
* @version
|
|
60331
|
+
* @version 252.1.0
|
|
60142
60332
|
*/
|
|
60143
60333
|
|
|
60144
60334
|
/**
|
|
@@ -61742,7 +61932,7 @@ class OutboundApi {
|
|
|
61742
61932
|
/**
|
|
61743
61933
|
* Outbound service.
|
|
61744
61934
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
61745
|
-
* @version
|
|
61935
|
+
* @version 252.1.0
|
|
61746
61936
|
*/
|
|
61747
61937
|
|
|
61748
61938
|
/**
|
|
@@ -67329,7 +67519,7 @@ class PresenceApi {
|
|
|
67329
67519
|
/**
|
|
67330
67520
|
* Presence service.
|
|
67331
67521
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
67332
|
-
* @version
|
|
67522
|
+
* @version 252.1.0
|
|
67333
67523
|
*/
|
|
67334
67524
|
|
|
67335
67525
|
/**
|
|
@@ -68187,7 +68377,7 @@ class ProcessAutomationApi {
|
|
|
68187
68377
|
/**
|
|
68188
68378
|
* ProcessAutomation service.
|
|
68189
68379
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
68190
|
-
* @version
|
|
68380
|
+
* @version 252.1.0
|
|
68191
68381
|
*/
|
|
68192
68382
|
|
|
68193
68383
|
/**
|
|
@@ -68608,7 +68798,7 @@ class QualityApi {
|
|
|
68608
68798
|
/**
|
|
68609
68799
|
* Quality service.
|
|
68610
68800
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
68611
|
-
* @version
|
|
68801
|
+
* @version 252.1.0
|
|
68612
68802
|
*/
|
|
68613
68803
|
|
|
68614
68804
|
/**
|
|
@@ -70966,7 +71156,7 @@ class RecordingApi {
|
|
|
70966
71156
|
/**
|
|
70967
71157
|
* Recording service.
|
|
70968
71158
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
70969
|
-
* @version
|
|
71159
|
+
* @version 252.1.0
|
|
70970
71160
|
*/
|
|
70971
71161
|
|
|
70972
71162
|
/**
|
|
@@ -72814,7 +73004,7 @@ class ResponseManagementApi {
|
|
|
72814
73004
|
/**
|
|
72815
73005
|
* ResponseManagement service.
|
|
72816
73006
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
72817
|
-
* @version
|
|
73007
|
+
* @version 252.1.0
|
|
72818
73008
|
*/
|
|
72819
73009
|
|
|
72820
73010
|
/**
|
|
@@ -73458,7 +73648,7 @@ class RoutingApi {
|
|
|
73458
73648
|
/**
|
|
73459
73649
|
* Routing service.
|
|
73460
73650
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
73461
|
-
* @version
|
|
73651
|
+
* @version 252.1.0
|
|
73462
73652
|
*/
|
|
73463
73653
|
|
|
73464
73654
|
/**
|
|
@@ -78845,7 +79035,7 @@ class SCIMApi {
|
|
|
78845
79035
|
/**
|
|
78846
79036
|
* SCIM service.
|
|
78847
79037
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
78848
|
-
* @version
|
|
79038
|
+
* @version 252.1.0
|
|
78849
79039
|
*/
|
|
78850
79040
|
|
|
78851
79041
|
/**
|
|
@@ -79806,7 +79996,7 @@ class ScriptsApi {
|
|
|
79806
79996
|
/**
|
|
79807
79997
|
* Scripts service.
|
|
79808
79998
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
79809
|
-
* @version
|
|
79999
|
+
* @version 252.1.0
|
|
79810
80000
|
*/
|
|
79811
80001
|
|
|
79812
80002
|
/**
|
|
@@ -80315,7 +80505,7 @@ class SearchApi {
|
|
|
80315
80505
|
/**
|
|
80316
80506
|
* Search service.
|
|
80317
80507
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
80318
|
-
* @version
|
|
80508
|
+
* @version 252.1.0
|
|
80319
80509
|
*/
|
|
80320
80510
|
|
|
80321
80511
|
/**
|
|
@@ -81131,7 +81321,7 @@ class SettingsApi {
|
|
|
81131
81321
|
/**
|
|
81132
81322
|
* Settings service.
|
|
81133
81323
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
81134
|
-
* @version
|
|
81324
|
+
* @version 252.1.0
|
|
81135
81325
|
*/
|
|
81136
81326
|
|
|
81137
81327
|
/**
|
|
@@ -81540,7 +81730,7 @@ class SocialMediaApi {
|
|
|
81540
81730
|
/**
|
|
81541
81731
|
* SocialMedia service.
|
|
81542
81732
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
81543
|
-
* @version
|
|
81733
|
+
* @version 252.1.0
|
|
81544
81734
|
*/
|
|
81545
81735
|
|
|
81546
81736
|
/**
|
|
@@ -83525,7 +83715,7 @@ class SpeechTextAnalyticsApi {
|
|
|
83525
83715
|
/**
|
|
83526
83716
|
* SpeechTextAnalytics service.
|
|
83527
83717
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
83528
|
-
* @version
|
|
83718
|
+
* @version 252.1.0
|
|
83529
83719
|
*/
|
|
83530
83720
|
|
|
83531
83721
|
/**
|
|
@@ -85477,7 +85667,7 @@ class StationsApi {
|
|
|
85477
85667
|
/**
|
|
85478
85668
|
* Stations service.
|
|
85479
85669
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
85480
|
-
* @version
|
|
85670
|
+
* @version 252.1.0
|
|
85481
85671
|
*/
|
|
85482
85672
|
|
|
85483
85673
|
/**
|
|
@@ -85591,7 +85781,7 @@ class SuggestApi {
|
|
|
85591
85781
|
/**
|
|
85592
85782
|
* Suggest service.
|
|
85593
85783
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
85594
|
-
* @version
|
|
85784
|
+
* @version 252.1.0
|
|
85595
85785
|
*/
|
|
85596
85786
|
|
|
85597
85787
|
/**
|
|
@@ -85738,7 +85928,7 @@ class TaskManagementApi {
|
|
|
85738
85928
|
/**
|
|
85739
85929
|
* TaskManagement service.
|
|
85740
85930
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
85741
|
-
* @version
|
|
85931
|
+
* @version 252.1.0
|
|
85742
85932
|
*/
|
|
85743
85933
|
|
|
85744
85934
|
/**
|
|
@@ -88165,7 +88355,7 @@ class TaskManagementApi {
|
|
|
88165
88355
|
|
|
88166
88356
|
/**
|
|
88167
88357
|
* Query for worktypes
|
|
88168
|
-
*
|
|
88358
|
+
* Optional request field expands may include schema to populate the name on each worktypes schema reference.
|
|
88169
88359
|
* @param {Object} body QueryPostRequest
|
|
88170
88360
|
* @param {Object} opts Optional parameters
|
|
88171
88361
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
@@ -88234,7 +88424,7 @@ class TeamsApi {
|
|
|
88234
88424
|
/**
|
|
88235
88425
|
* Teams service.
|
|
88236
88426
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
88237
|
-
* @version
|
|
88427
|
+
* @version 252.1.0
|
|
88238
88428
|
*/
|
|
88239
88429
|
|
|
88240
88430
|
/**
|
|
@@ -88577,7 +88767,7 @@ class TelephonyApi {
|
|
|
88577
88767
|
/**
|
|
88578
88768
|
* Telephony service.
|
|
88579
88769
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
88580
|
-
* @version
|
|
88770
|
+
* @version 252.1.0
|
|
88581
88771
|
*/
|
|
88582
88772
|
|
|
88583
88773
|
/**
|
|
@@ -88984,7 +89174,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
88984
89174
|
/**
|
|
88985
89175
|
* TelephonyProvidersEdge service.
|
|
88986
89176
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
88987
|
-
* @version
|
|
89177
|
+
* @version 252.1.0
|
|
88988
89178
|
*/
|
|
88989
89179
|
|
|
88990
89180
|
/**
|
|
@@ -93008,7 +93198,7 @@ class TextbotsApi {
|
|
|
93008
93198
|
/**
|
|
93009
93199
|
* Textbots service.
|
|
93010
93200
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
93011
|
-
* @version
|
|
93201
|
+
* @version 252.1.0
|
|
93012
93202
|
*/
|
|
93013
93203
|
|
|
93014
93204
|
/**
|
|
@@ -93154,7 +93344,7 @@ class TokensApi {
|
|
|
93154
93344
|
/**
|
|
93155
93345
|
* Tokens service.
|
|
93156
93346
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
93157
|
-
* @version
|
|
93347
|
+
* @version 252.1.0
|
|
93158
93348
|
*/
|
|
93159
93349
|
|
|
93160
93350
|
/**
|
|
@@ -93332,7 +93522,7 @@ class UploadsApi {
|
|
|
93332
93522
|
/**
|
|
93333
93523
|
* Uploads service.
|
|
93334
93524
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
93335
|
-
* @version
|
|
93525
|
+
* @version 252.1.0
|
|
93336
93526
|
*/
|
|
93337
93527
|
|
|
93338
93528
|
/**
|
|
@@ -93703,7 +93893,7 @@ class UsageApi {
|
|
|
93703
93893
|
/**
|
|
93704
93894
|
* Usage service.
|
|
93705
93895
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
93706
|
-
* @version
|
|
93896
|
+
* @version 252.1.0
|
|
93707
93897
|
*/
|
|
93708
93898
|
|
|
93709
93899
|
/**
|
|
@@ -94081,7 +94271,7 @@ class UserRecordingsApi {
|
|
|
94081
94271
|
/**
|
|
94082
94272
|
* UserRecordings service.
|
|
94083
94273
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
94084
|
-
* @version
|
|
94274
|
+
* @version 252.1.0
|
|
94085
94275
|
*/
|
|
94086
94276
|
|
|
94087
94277
|
/**
|
|
@@ -94283,7 +94473,7 @@ class UsersApi {
|
|
|
94283
94473
|
/**
|
|
94284
94474
|
* Users service.
|
|
94285
94475
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
94286
|
-
* @version
|
|
94476
|
+
* @version 252.1.0
|
|
94287
94477
|
*/
|
|
94288
94478
|
|
|
94289
94479
|
/**
|
|
@@ -94784,6 +94974,31 @@ class UsersApi {
|
|
|
94784
94974
|
);
|
|
94785
94975
|
}
|
|
94786
94976
|
|
|
94977
|
+
/**
|
|
94978
|
+
* Clear self associated station
|
|
94979
|
+
*
|
|
94980
|
+
* @param {Object} opts Optional parameters
|
|
94981
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
94982
|
+
*/
|
|
94983
|
+
deleteUsersStationsMeAssociatedstation(opts) {
|
|
94984
|
+
opts = opts || {};
|
|
94985
|
+
|
|
94986
|
+
|
|
94987
|
+
return this.apiClient.callApi(
|
|
94988
|
+
'/api/v2/users/stations/me/associatedstation',
|
|
94989
|
+
'DELETE',
|
|
94990
|
+
{ },
|
|
94991
|
+
{ },
|
|
94992
|
+
{ },
|
|
94993
|
+
{ },
|
|
94994
|
+
null,
|
|
94995
|
+
['PureCloud OAuth'],
|
|
94996
|
+
['application/json'],
|
|
94997
|
+
['application/json'],
|
|
94998
|
+
opts['customHeaders']
|
|
94999
|
+
);
|
|
95000
|
+
}
|
|
95001
|
+
|
|
94787
95002
|
/**
|
|
94788
95003
|
* Get status for async query for user aggregates
|
|
94789
95004
|
*
|
|
@@ -96052,6 +96267,7 @@ class UsersApi {
|
|
|
96052
96267
|
* @param {Object} opts Optional parameters
|
|
96053
96268
|
* @param {Boolean} opts.excludeClosed Whether or not to exclude closed chats
|
|
96054
96269
|
* @param {Boolean} opts.includePresence Whether or not to include user presence
|
|
96270
|
+
* @param {Boolean} opts.includeRoomOwners Whether or not to include room owners
|
|
96055
96271
|
* @param {String} opts.after The key to start after
|
|
96056
96272
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
96057
96273
|
*/
|
|
@@ -96063,7 +96279,7 @@ class UsersApi {
|
|
|
96063
96279
|
'/api/v2/users/chats/me',
|
|
96064
96280
|
'GET',
|
|
96065
96281
|
{ },
|
|
96066
|
-
{ 'excludeClosed': opts['excludeClosed'],'includePresence': opts['includePresence'],'after': opts['after'] },
|
|
96282
|
+
{ 'excludeClosed': opts['excludeClosed'],'includePresence': opts['includePresence'],'includeRoomOwners': opts['includeRoomOwners'],'after': opts['after'] },
|
|
96067
96283
|
{ },
|
|
96068
96284
|
{ },
|
|
96069
96285
|
null,
|
|
@@ -96458,7 +96674,6 @@ class UsersApi {
|
|
|
96458
96674
|
* @param {Array.<String>} opts.userCustomAttributeSchemaIds Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an expand. The maximum number of schemaIds that can be requested is 5
|
|
96459
96675
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
96460
96676
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
96461
|
-
* getUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
96462
96677
|
*/
|
|
96463
96678
|
getUsersQuery(opts) {
|
|
96464
96679
|
opts = opts || {};
|
|
@@ -96511,6 +96726,31 @@ class UsersApi {
|
|
|
96511
96726
|
);
|
|
96512
96727
|
}
|
|
96513
96728
|
|
|
96729
|
+
/**
|
|
96730
|
+
* Get station information for self
|
|
96731
|
+
*
|
|
96732
|
+
* @param {Object} opts Optional parameters
|
|
96733
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
96734
|
+
*/
|
|
96735
|
+
getUsersStationsMe(opts) {
|
|
96736
|
+
opts = opts || {};
|
|
96737
|
+
|
|
96738
|
+
|
|
96739
|
+
return this.apiClient.callApi(
|
|
96740
|
+
'/api/v2/users/stations/me',
|
|
96741
|
+
'GET',
|
|
96742
|
+
{ },
|
|
96743
|
+
{ },
|
|
96744
|
+
{ },
|
|
96745
|
+
{ },
|
|
96746
|
+
null,
|
|
96747
|
+
['PureCloud OAuth'],
|
|
96748
|
+
['application/json'],
|
|
96749
|
+
['application/json'],
|
|
96750
|
+
opts['customHeaders']
|
|
96751
|
+
);
|
|
96752
|
+
}
|
|
96753
|
+
|
|
96514
96754
|
/**
|
|
96515
96755
|
* Update user
|
|
96516
96756
|
*
|
|
@@ -98216,13 +98456,43 @@ class UsersApi {
|
|
|
98216
98456
|
);
|
|
98217
98457
|
}
|
|
98218
98458
|
|
|
98459
|
+
/**
|
|
98460
|
+
* Set self associated station
|
|
98461
|
+
*
|
|
98462
|
+
* @param {String} stationId stationId
|
|
98463
|
+
* @param {Object} opts Optional parameters
|
|
98464
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
98465
|
+
*/
|
|
98466
|
+
putUsersStationsMeAssociatedstationStationId(stationId, opts) {
|
|
98467
|
+
opts = opts || {};
|
|
98468
|
+
|
|
98469
|
+
// verify the required parameter 'stationId' is set
|
|
98470
|
+
if (stationId === undefined || stationId === null || stationId === '') {
|
|
98471
|
+
throw 'Missing the required parameter "stationId" when calling putUsersStationsMeAssociatedstationStationId';
|
|
98472
|
+
}
|
|
98473
|
+
|
|
98474
|
+
return this.apiClient.callApi(
|
|
98475
|
+
'/api/v2/users/stations/me/associatedstation/{stationId}',
|
|
98476
|
+
'PUT',
|
|
98477
|
+
{ 'stationId': stationId },
|
|
98478
|
+
{ },
|
|
98479
|
+
{ },
|
|
98480
|
+
{ },
|
|
98481
|
+
null,
|
|
98482
|
+
['PureCloud OAuth'],
|
|
98483
|
+
['application/json'],
|
|
98484
|
+
['application/json'],
|
|
98485
|
+
opts['customHeaders']
|
|
98486
|
+
);
|
|
98487
|
+
}
|
|
98488
|
+
|
|
98219
98489
|
}
|
|
98220
98490
|
|
|
98221
98491
|
class UsersRulesApi {
|
|
98222
98492
|
/**
|
|
98223
98493
|
* UsersRules service.
|
|
98224
98494
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
98225
|
-
* @version
|
|
98495
|
+
* @version 252.1.0
|
|
98226
98496
|
*/
|
|
98227
98497
|
|
|
98228
98498
|
/**
|
|
@@ -98539,7 +98809,7 @@ class UtilitiesApi {
|
|
|
98539
98809
|
/**
|
|
98540
98810
|
* Utilities service.
|
|
98541
98811
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
98542
|
-
* @version
|
|
98812
|
+
* @version 252.1.0
|
|
98543
98813
|
*/
|
|
98544
98814
|
|
|
98545
98815
|
/**
|
|
@@ -98667,7 +98937,7 @@ class VoicemailApi {
|
|
|
98667
98937
|
/**
|
|
98668
98938
|
* Voicemail service.
|
|
98669
98939
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
98670
|
-
* @version
|
|
98940
|
+
* @version 252.1.0
|
|
98671
98941
|
*/
|
|
98672
98942
|
|
|
98673
98943
|
/**
|
|
@@ -99497,7 +99767,7 @@ class WebChatApi {
|
|
|
99497
99767
|
/**
|
|
99498
99768
|
* WebChat service.
|
|
99499
99769
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
99500
|
-
* @version
|
|
99770
|
+
* @version 252.1.0
|
|
99501
99771
|
*/
|
|
99502
99772
|
|
|
99503
99773
|
/**
|
|
@@ -100149,7 +100419,7 @@ class WebDeploymentsApi {
|
|
|
100149
100419
|
/**
|
|
100150
100420
|
* WebDeployments service.
|
|
100151
100421
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
100152
|
-
* @version
|
|
100422
|
+
* @version 252.1.0
|
|
100153
100423
|
*/
|
|
100154
100424
|
|
|
100155
100425
|
/**
|
|
@@ -100827,7 +101097,7 @@ class WebMessagingApi {
|
|
|
100827
101097
|
/**
|
|
100828
101098
|
* WebMessaging service.
|
|
100829
101099
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
100830
|
-
* @version
|
|
101100
|
+
* @version 252.1.0
|
|
100831
101101
|
*/
|
|
100832
101102
|
|
|
100833
101103
|
/**
|
|
@@ -100990,7 +101260,7 @@ class WidgetsApi {
|
|
|
100990
101260
|
/**
|
|
100991
101261
|
* Widgets service.
|
|
100992
101262
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
100993
|
-
* @version
|
|
101263
|
+
* @version 252.1.0
|
|
100994
101264
|
*/
|
|
100995
101265
|
|
|
100996
101266
|
/**
|
|
@@ -101166,7 +101436,7 @@ class WorkforceManagementApi {
|
|
|
101166
101436
|
/**
|
|
101167
101437
|
* WorkforceManagement service.
|
|
101168
101438
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
101169
|
-
* @version
|
|
101439
|
+
* @version 252.1.0
|
|
101170
101440
|
*/
|
|
101171
101441
|
|
|
101172
101442
|
/**
|
|
@@ -111502,7 +111772,7 @@ class WorkforceManagementApi {
|
|
|
111502
111772
|
* </pre>
|
|
111503
111773
|
* </p>
|
|
111504
111774
|
* @module purecloud-platform-client-v2/index
|
|
111505
|
-
* @version
|
|
111775
|
+
* @version 252.1.0
|
|
111506
111776
|
*/
|
|
111507
111777
|
class platformClient {
|
|
111508
111778
|
constructor() {
|