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
|
@@ -745,7 +745,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
745
745
|
|
|
746
746
|
/**
|
|
747
747
|
* @module purecloud-platform-client-v2/ApiClient
|
|
748
|
-
* @version
|
|
748
|
+
* @version 252.1.0
|
|
749
749
|
*/
|
|
750
750
|
class ApiClient {
|
|
751
751
|
/**
|
|
@@ -1419,9 +1419,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1419
1419
|
// Get access token from response
|
|
1420
1420
|
var access_token = response.data.access_token;
|
|
1421
1421
|
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
|
|
1422
|
+
let optsSettings = { accessToken: access_token };
|
|
1423
|
+
if (response.data['expires_in'] !== null && response.data['expires_in'] !== undefined) {
|
|
1424
|
+
optsSettings.tokenExpiryTime = new Date().getTime() + response.data['expires_in'] * 1000;
|
|
1425
|
+
optsSettings.tokenExpiryTimeString = new Date(optsSettings.tokenExpiryTime).toUTCString();
|
|
1426
|
+
}
|
|
1427
|
+
this._saveSettings(optsSettings);
|
|
1425
1428
|
|
|
1426
1429
|
// Return auth data
|
|
1427
1430
|
resolve(this.authData);
|
|
@@ -1545,9 +1548,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1545
1548
|
return new Promise((resolve, reject) => {
|
|
1546
1549
|
// Abort if org and provider are not set together
|
|
1547
1550
|
if (opts.org && !opts.provider) {
|
|
1548
|
-
reject(new Error('opts.provider must be set if opts.org is set'));
|
|
1551
|
+
return reject(new Error('opts.provider must be set if opts.org is set'));
|
|
1549
1552
|
} else if (opts.provider && !opts.org) {
|
|
1550
|
-
reject(new Error('opts.org must be set if opts.provider is set'));
|
|
1553
|
+
return reject(new Error('opts.org must be set if opts.provider is set'));
|
|
1551
1554
|
}
|
|
1552
1555
|
|
|
1553
1556
|
// Abort on auth error
|
|
@@ -2433,7 +2436,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2433
2436
|
/**
|
|
2434
2437
|
* AIStudio service.
|
|
2435
2438
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2436
|
-
* @version
|
|
2439
|
+
* @version 252.1.0
|
|
2437
2440
|
*/
|
|
2438
2441
|
|
|
2439
2442
|
/**
|
|
@@ -3148,7 +3151,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3148
3151
|
/**
|
|
3149
3152
|
* AgentAssistants service.
|
|
3150
3153
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
3151
|
-
* @version
|
|
3154
|
+
* @version 252.1.0
|
|
3152
3155
|
*/
|
|
3153
3156
|
|
|
3154
3157
|
/**
|
|
@@ -3952,7 +3955,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3952
3955
|
/**
|
|
3953
3956
|
* AgentCopilot service.
|
|
3954
3957
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3955
|
-
* @version
|
|
3958
|
+
* @version 252.1.0
|
|
3956
3959
|
*/
|
|
3957
3960
|
|
|
3958
3961
|
/**
|
|
@@ -4064,7 +4067,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4064
4067
|
/**
|
|
4065
4068
|
* AgentUI service.
|
|
4066
4069
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
4067
|
-
* @version
|
|
4070
|
+
* @version 252.1.0
|
|
4068
4071
|
*/
|
|
4069
4072
|
|
|
4070
4073
|
/**
|
|
@@ -4215,7 +4218,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4215
4218
|
/**
|
|
4216
4219
|
* Alerting service.
|
|
4217
4220
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
4218
|
-
* @version
|
|
4221
|
+
* @version 252.1.0
|
|
4219
4222
|
*/
|
|
4220
4223
|
|
|
4221
4224
|
/**
|
|
@@ -4676,7 +4679,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4676
4679
|
/**
|
|
4677
4680
|
* Analytics service.
|
|
4678
4681
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4679
|
-
* @version
|
|
4682
|
+
* @version 252.1.0
|
|
4680
4683
|
*/
|
|
4681
4684
|
|
|
4682
4685
|
/**
|
|
@@ -8962,7 +8965,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8962
8965
|
/**
|
|
8963
8966
|
* Architect service.
|
|
8964
8967
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8965
|
-
* @version
|
|
8968
|
+
* @version 252.1.0
|
|
8966
8969
|
*/
|
|
8967
8970
|
|
|
8968
8971
|
/**
|
|
@@ -12954,12 +12957,48 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12954
12957
|
}
|
|
12955
12958
|
|
|
12956
12959
|
/**
|
|
12957
|
-
* Begin an import process for importing rows into a datatable
|
|
12960
|
+
* 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.
|
|
12961
|
+
* 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
|
|
12962
|
+
* @param {String} datatableId id of datatable
|
|
12963
|
+
* @param {Object} body import job information
|
|
12964
|
+
* @param {Object} opts Optional parameters
|
|
12965
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
12966
|
+
*/
|
|
12967
|
+
postFlowsDatatableImportCsvJobs(datatableId, body, opts) {
|
|
12968
|
+
opts = opts || {};
|
|
12969
|
+
|
|
12970
|
+
// verify the required parameter 'datatableId' is set
|
|
12971
|
+
if (datatableId === undefined || datatableId === null || datatableId === '') {
|
|
12972
|
+
throw 'Missing the required parameter "datatableId" when calling postFlowsDatatableImportCsvJobs';
|
|
12973
|
+
}
|
|
12974
|
+
// verify the required parameter 'body' is set
|
|
12975
|
+
if (body === undefined || body === null) {
|
|
12976
|
+
throw 'Missing the required parameter "body" when calling postFlowsDatatableImportCsvJobs';
|
|
12977
|
+
}
|
|
12978
|
+
|
|
12979
|
+
return this.apiClient.callApi(
|
|
12980
|
+
'/api/v2/flows/datatables/{datatableId}/import/csv/jobs',
|
|
12981
|
+
'POST',
|
|
12982
|
+
{ 'datatableId': datatableId },
|
|
12983
|
+
{ },
|
|
12984
|
+
{ },
|
|
12985
|
+
{ },
|
|
12986
|
+
body,
|
|
12987
|
+
['PureCloud OAuth'],
|
|
12988
|
+
['application/json'],
|
|
12989
|
+
['application/json'],
|
|
12990
|
+
opts['customHeaders']
|
|
12991
|
+
);
|
|
12992
|
+
}
|
|
12993
|
+
|
|
12994
|
+
/**
|
|
12995
|
+
* 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
|
|
12958
12996
|
* Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response
|
|
12959
12997
|
* @param {String} datatableId id of datatable
|
|
12960
12998
|
* @param {Object} body import job information
|
|
12961
12999
|
* @param {Object} opts Optional parameters
|
|
12962
13000
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
13001
|
+
* @deprecated
|
|
12963
13002
|
*/
|
|
12964
13003
|
postFlowsDatatableImportJobs(datatableId, body, opts) {
|
|
12965
13004
|
opts = opts || {};
|
|
@@ -13785,7 +13824,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13785
13824
|
/**
|
|
13786
13825
|
* AssistantCopilotVariations service.
|
|
13787
13826
|
* @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
13788
|
-
* @version
|
|
13827
|
+
* @version 252.1.0
|
|
13789
13828
|
*/
|
|
13790
13829
|
|
|
13791
13830
|
/**
|
|
@@ -13981,7 +14020,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13981
14020
|
/**
|
|
13982
14021
|
* Audit service.
|
|
13983
14022
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
13984
|
-
* @version
|
|
14023
|
+
* @version 252.1.0
|
|
13985
14024
|
*/
|
|
13986
14025
|
|
|
13987
14026
|
/**
|
|
@@ -14208,7 +14247,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14208
14247
|
/**
|
|
14209
14248
|
* Authorization service.
|
|
14210
14249
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
14211
|
-
* @version
|
|
14250
|
+
* @version 252.1.0
|
|
14212
14251
|
*/
|
|
14213
14252
|
|
|
14214
14253
|
/**
|
|
@@ -16133,7 +16172,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16133
16172
|
/**
|
|
16134
16173
|
* BackgroundAssistant service.
|
|
16135
16174
|
* @module purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
16136
|
-
* @version
|
|
16175
|
+
* @version 252.1.0
|
|
16137
16176
|
*/
|
|
16138
16177
|
|
|
16139
16178
|
/**
|
|
@@ -16207,7 +16246,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16207
16246
|
/**
|
|
16208
16247
|
* Billing service.
|
|
16209
16248
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16210
|
-
* @version
|
|
16249
|
+
* @version 252.1.0
|
|
16211
16250
|
*/
|
|
16212
16251
|
|
|
16213
16252
|
/**
|
|
@@ -16491,7 +16530,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16491
16530
|
/**
|
|
16492
16531
|
* BusinessRules service.
|
|
16493
16532
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
16494
|
-
* @version
|
|
16533
|
+
* @version 252.1.0
|
|
16495
16534
|
*/
|
|
16496
16535
|
|
|
16497
16536
|
/**
|
|
@@ -17505,7 +17544,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17505
17544
|
/**
|
|
17506
17545
|
* CarrierServices service.
|
|
17507
17546
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
17508
|
-
* @version
|
|
17547
|
+
* @version 252.1.0
|
|
17509
17548
|
*/
|
|
17510
17549
|
|
|
17511
17550
|
/**
|
|
@@ -17582,7 +17621,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17582
17621
|
/**
|
|
17583
17622
|
* CaseManagement service.
|
|
17584
17623
|
* @module purecloud-platform-client-v2/api/CaseManagementApi
|
|
17585
|
-
* @version
|
|
17624
|
+
* @version 252.1.0
|
|
17586
17625
|
*/
|
|
17587
17626
|
|
|
17588
17627
|
/**
|
|
@@ -18744,6 +18783,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18744
18783
|
);
|
|
18745
18784
|
}
|
|
18746
18785
|
|
|
18786
|
+
/**
|
|
18787
|
+
* Query for caseplans
|
|
18788
|
+
*
|
|
18789
|
+
* @param {Object} body CaseplanQueryRequest
|
|
18790
|
+
* @param {Object} opts Optional parameters
|
|
18791
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18792
|
+
* postCasemanagementCaseplansQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18793
|
+
*/
|
|
18794
|
+
postCasemanagementCaseplansQuery(body, opts) {
|
|
18795
|
+
opts = opts || {};
|
|
18796
|
+
|
|
18797
|
+
// verify the required parameter 'body' is set
|
|
18798
|
+
if (body === undefined || body === null) {
|
|
18799
|
+
throw 'Missing the required parameter "body" when calling postCasemanagementCaseplansQuery';
|
|
18800
|
+
}
|
|
18801
|
+
|
|
18802
|
+
return this.apiClient.callApi(
|
|
18803
|
+
'/api/v2/casemanagement/caseplans/query',
|
|
18804
|
+
'POST',
|
|
18805
|
+
{ },
|
|
18806
|
+
{ },
|
|
18807
|
+
{ },
|
|
18808
|
+
{ },
|
|
18809
|
+
body,
|
|
18810
|
+
['PureCloud OAuth'],
|
|
18811
|
+
['application/json'],
|
|
18812
|
+
['application/json'],
|
|
18813
|
+
opts['customHeaders']
|
|
18814
|
+
);
|
|
18815
|
+
}
|
|
18816
|
+
|
|
18747
18817
|
/**
|
|
18748
18818
|
* Create a Case.
|
|
18749
18819
|
*
|
|
@@ -18844,7 +18914,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18844
18914
|
/**
|
|
18845
18915
|
* Chat service.
|
|
18846
18916
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
18847
|
-
* @version
|
|
18917
|
+
* @version 252.1.0
|
|
18848
18918
|
*/
|
|
18849
18919
|
|
|
18850
18920
|
/**
|
|
@@ -19983,7 +20053,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19983
20053
|
/**
|
|
19984
20054
|
* Coaching service.
|
|
19985
20055
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
19986
|
-
* @version
|
|
20056
|
+
* @version 252.1.0
|
|
19987
20057
|
*/
|
|
19988
20058
|
|
|
19989
20059
|
/**
|
|
@@ -20697,7 +20767,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20697
20767
|
/**
|
|
20698
20768
|
* ContentManagement service.
|
|
20699
20769
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
20700
|
-
* @version
|
|
20770
|
+
* @version 252.1.0
|
|
20701
20771
|
*/
|
|
20702
20772
|
|
|
20703
20773
|
/**
|
|
@@ -21892,7 +21962,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21892
21962
|
/**
|
|
21893
21963
|
* Conversations service.
|
|
21894
21964
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
21895
|
-
* @version
|
|
21965
|
+
* @version 252.1.0
|
|
21896
21966
|
*/
|
|
21897
21967
|
|
|
21898
21968
|
/**
|
|
@@ -22780,6 +22850,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22780
22850
|
);
|
|
22781
22851
|
}
|
|
22782
22852
|
|
|
22853
|
+
/**
|
|
22854
|
+
* Get copilot context values for a conversation.
|
|
22855
|
+
*
|
|
22856
|
+
* @param {String} conversationId Conversation ID.
|
|
22857
|
+
* @param {Object} opts Optional parameters
|
|
22858
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
22859
|
+
* getConversationAssistantCopilotcontext is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22860
|
+
*/
|
|
22861
|
+
getConversationAssistantCopilotcontext(conversationId, opts) {
|
|
22862
|
+
opts = opts || {};
|
|
22863
|
+
|
|
22864
|
+
// verify the required parameter 'conversationId' is set
|
|
22865
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
22866
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationAssistantCopilotcontext';
|
|
22867
|
+
}
|
|
22868
|
+
|
|
22869
|
+
return this.apiClient.callApi(
|
|
22870
|
+
'/api/v2/conversations/{conversationId}/assistant/copilotcontext',
|
|
22871
|
+
'GET',
|
|
22872
|
+
{ 'conversationId': conversationId },
|
|
22873
|
+
{ },
|
|
22874
|
+
{ },
|
|
22875
|
+
{ },
|
|
22876
|
+
null,
|
|
22877
|
+
['PureCloud OAuth'],
|
|
22878
|
+
['application/json'],
|
|
22879
|
+
['application/json'],
|
|
22880
|
+
opts['customHeaders']
|
|
22881
|
+
);
|
|
22882
|
+
}
|
|
22883
|
+
|
|
22783
22884
|
/**
|
|
22784
22885
|
* Get checklist info for a single checklist.
|
|
22785
22886
|
*
|
|
@@ -27934,6 +28035,46 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27934
28035
|
);
|
|
27935
28036
|
}
|
|
27936
28037
|
|
|
28038
|
+
/**
|
|
28039
|
+
* Update conversation by setting its parking state
|
|
28040
|
+
*
|
|
28041
|
+
* @param {String} conversationId conversationId
|
|
28042
|
+
* @param {String} participantId participantId
|
|
28043
|
+
* @param {Object} body Parking update request
|
|
28044
|
+
* @param {Object} opts Optional parameters
|
|
28045
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
28046
|
+
*/
|
|
28047
|
+
patchConversationsMessageParticipantParkingstate(conversationId, participantId, body, opts) {
|
|
28048
|
+
opts = opts || {};
|
|
28049
|
+
|
|
28050
|
+
// verify the required parameter 'conversationId' is set
|
|
28051
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
28052
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationsMessageParticipantParkingstate';
|
|
28053
|
+
}
|
|
28054
|
+
// verify the required parameter 'participantId' is set
|
|
28055
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
28056
|
+
throw 'Missing the required parameter "participantId" when calling patchConversationsMessageParticipantParkingstate';
|
|
28057
|
+
}
|
|
28058
|
+
// verify the required parameter 'body' is set
|
|
28059
|
+
if (body === undefined || body === null) {
|
|
28060
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessageParticipantParkingstate';
|
|
28061
|
+
}
|
|
28062
|
+
|
|
28063
|
+
return this.apiClient.callApi(
|
|
28064
|
+
'/api/v2/conversations/messages/{conversationId}/participants/{participantId}/parkingstate',
|
|
28065
|
+
'PATCH',
|
|
28066
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
28067
|
+
{ },
|
|
28068
|
+
{ },
|
|
28069
|
+
{ },
|
|
28070
|
+
body,
|
|
28071
|
+
['PureCloud OAuth'],
|
|
28072
|
+
['application/json'],
|
|
28073
|
+
['application/json'],
|
|
28074
|
+
opts['customHeaders']
|
|
28075
|
+
);
|
|
28076
|
+
}
|
|
28077
|
+
|
|
27937
28078
|
/**
|
|
27938
28079
|
* Update an Apple messaging integration
|
|
27939
28080
|
*
|
|
@@ -32927,7 +33068,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32927
33068
|
/**
|
|
32928
33069
|
* DataExtensions service.
|
|
32929
33070
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
32930
|
-
* @version
|
|
33071
|
+
* @version 252.1.0
|
|
32931
33072
|
*/
|
|
32932
33073
|
|
|
32933
33074
|
/**
|
|
@@ -33028,7 +33169,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33028
33169
|
/**
|
|
33029
33170
|
* DataPrivacy service.
|
|
33030
33171
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
33031
|
-
* @version
|
|
33172
|
+
* @version 252.1.0
|
|
33032
33173
|
*/
|
|
33033
33174
|
|
|
33034
33175
|
/**
|
|
@@ -33225,7 +33366,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33225
33366
|
/**
|
|
33226
33367
|
* Downloads service.
|
|
33227
33368
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
33228
|
-
* @version
|
|
33369
|
+
* @version 252.1.0
|
|
33229
33370
|
*/
|
|
33230
33371
|
|
|
33231
33372
|
/**
|
|
@@ -33279,7 +33420,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33279
33420
|
/**
|
|
33280
33421
|
* Emails service.
|
|
33281
33422
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
33282
|
-
* @version
|
|
33423
|
+
* @version 252.1.0
|
|
33283
33424
|
*/
|
|
33284
33425
|
|
|
33285
33426
|
/**
|
|
@@ -33427,7 +33568,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33427
33568
|
/**
|
|
33428
33569
|
* EmployeeEngagement service.
|
|
33429
33570
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
33430
|
-
* @version
|
|
33571
|
+
* @version 252.1.0
|
|
33431
33572
|
*/
|
|
33432
33573
|
|
|
33433
33574
|
/**
|
|
@@ -33631,7 +33772,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33631
33772
|
/**
|
|
33632
33773
|
* Events service.
|
|
33633
33774
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
33634
|
-
* @version
|
|
33775
|
+
* @version 252.1.0
|
|
33635
33776
|
*/
|
|
33636
33777
|
|
|
33637
33778
|
/**
|
|
@@ -33676,6 +33817,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33676
33817
|
);
|
|
33677
33818
|
}
|
|
33678
33819
|
|
|
33820
|
+
/**
|
|
33821
|
+
* Publish Predictive Routing Custom Kpi Attribution Batch Events
|
|
33822
|
+
*
|
|
33823
|
+
* @param {Object} body batchRequest
|
|
33824
|
+
* @param {Object} opts Optional parameters
|
|
33825
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
33826
|
+
* postEventsRoutingCustomkpiattributions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33827
|
+
*/
|
|
33828
|
+
postEventsRoutingCustomkpiattributions(body, opts) {
|
|
33829
|
+
opts = opts || {};
|
|
33830
|
+
|
|
33831
|
+
// verify the required parameter 'body' is set
|
|
33832
|
+
if (body === undefined || body === null) {
|
|
33833
|
+
throw 'Missing the required parameter "body" when calling postEventsRoutingCustomkpiattributions';
|
|
33834
|
+
}
|
|
33835
|
+
|
|
33836
|
+
return this.apiClient.callApi(
|
|
33837
|
+
'/api/v2/events/routing/customkpiattributions',
|
|
33838
|
+
'POST',
|
|
33839
|
+
{ },
|
|
33840
|
+
{ },
|
|
33841
|
+
{ },
|
|
33842
|
+
{ },
|
|
33843
|
+
body,
|
|
33844
|
+
['PureCloud OAuth'],
|
|
33845
|
+
['application/json'],
|
|
33846
|
+
['application/json'],
|
|
33847
|
+
opts['customHeaders']
|
|
33848
|
+
);
|
|
33849
|
+
}
|
|
33850
|
+
|
|
33679
33851
|
/**
|
|
33680
33852
|
* Publish User Presence Status Batch Events
|
|
33681
33853
|
*
|
|
@@ -33742,7 +33914,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33742
33914
|
/**
|
|
33743
33915
|
* ExternalContacts service.
|
|
33744
33916
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
33745
|
-
* @version
|
|
33917
|
+
* @version 252.1.0
|
|
33746
33918
|
*/
|
|
33747
33919
|
|
|
33748
33920
|
/**
|
|
@@ -37513,7 +37685,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37513
37685
|
/**
|
|
37514
37686
|
* Fax service.
|
|
37515
37687
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
37516
|
-
* @version
|
|
37688
|
+
* @version 252.1.0
|
|
37517
37689
|
*/
|
|
37518
37690
|
|
|
37519
37691
|
/**
|
|
@@ -37762,7 +37934,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37762
37934
|
/**
|
|
37763
37935
|
* Flows service.
|
|
37764
37936
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
37765
|
-
* @version
|
|
37937
|
+
* @version 252.1.0
|
|
37766
37938
|
*/
|
|
37767
37939
|
|
|
37768
37940
|
/**
|
|
@@ -38000,7 +38172,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38000
38172
|
/**
|
|
38001
38173
|
* Gamification service.
|
|
38002
38174
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
38003
|
-
* @version
|
|
38175
|
+
* @version 252.1.0
|
|
38004
38176
|
*/
|
|
38005
38177
|
|
|
38006
38178
|
/**
|
|
@@ -40852,7 +41024,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40852
41024
|
/**
|
|
40853
41025
|
* GeneralDataProtectionRegulation service.
|
|
40854
41026
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
40855
|
-
* @version
|
|
41027
|
+
* @version 252.1.0
|
|
40856
41028
|
*/
|
|
40857
41029
|
|
|
40858
41030
|
/**
|
|
@@ -40996,7 +41168,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40996
41168
|
/**
|
|
40997
41169
|
* Geolocation service.
|
|
40998
41170
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
40999
|
-
* @version
|
|
41171
|
+
* @version 252.1.0
|
|
41000
41172
|
*/
|
|
41001
41173
|
|
|
41002
41174
|
/**
|
|
@@ -41147,7 +41319,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41147
41319
|
/**
|
|
41148
41320
|
* Greetings service.
|
|
41149
41321
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
41150
|
-
* @version
|
|
41322
|
+
* @version 252.1.0
|
|
41151
41323
|
*/
|
|
41152
41324
|
|
|
41153
41325
|
/**
|
|
@@ -41763,7 +41935,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41763
41935
|
/**
|
|
41764
41936
|
* Groups service.
|
|
41765
41937
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
41766
|
-
* @version
|
|
41938
|
+
* @version 252.1.0
|
|
41767
41939
|
*/
|
|
41768
41940
|
|
|
41769
41941
|
/**
|
|
@@ -42354,7 +42526,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42354
42526
|
/**
|
|
42355
42527
|
* IdentityProvider service.
|
|
42356
42528
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
42357
|
-
* @version
|
|
42529
|
+
* @version 252.1.0
|
|
42358
42530
|
*/
|
|
42359
42531
|
|
|
42360
42532
|
/**
|
|
@@ -43405,7 +43577,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43405
43577
|
/**
|
|
43406
43578
|
* InfrastructureAsCode service.
|
|
43407
43579
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
43408
|
-
* @version
|
|
43580
|
+
* @version 252.1.0
|
|
43409
43581
|
*/
|
|
43410
43582
|
|
|
43411
43583
|
/**
|
|
@@ -43585,7 +43757,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43585
43757
|
/**
|
|
43586
43758
|
* Integrations service.
|
|
43587
43759
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
43588
|
-
* @version
|
|
43760
|
+
* @version 252.1.0
|
|
43589
43761
|
*/
|
|
43590
43762
|
|
|
43591
43763
|
/**
|
|
@@ -46557,7 +46729,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46557
46729
|
/**
|
|
46558
46730
|
* Intents service.
|
|
46559
46731
|
* @module purecloud-platform-client-v2/api/IntentsApi
|
|
46560
|
-
* @version
|
|
46732
|
+
* @version 252.1.0
|
|
46561
46733
|
*/
|
|
46562
46734
|
|
|
46563
46735
|
/**
|
|
@@ -47089,7 +47261,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47089
47261
|
/**
|
|
47090
47262
|
* Journey service.
|
|
47091
47263
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
47092
|
-
* @version
|
|
47264
|
+
* @version 252.1.0
|
|
47093
47265
|
*/
|
|
47094
47266
|
|
|
47095
47267
|
/**
|
|
@@ -47257,11 +47429,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47257
47429
|
}
|
|
47258
47430
|
|
|
47259
47431
|
/**
|
|
47260
|
-
* Delete an outcome.
|
|
47261
|
-
*
|
|
47432
|
+
* Deprecated. Delete an outcome.
|
|
47433
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
47262
47434
|
* @param {String} outcomeId ID of the outcome.
|
|
47263
47435
|
* @param {Object} opts Optional parameters
|
|
47264
47436
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47437
|
+
* @deprecated
|
|
47265
47438
|
*/
|
|
47266
47439
|
deleteJourneyOutcome(outcomeId, opts) {
|
|
47267
47440
|
opts = opts || {};
|
|
@@ -47287,11 +47460,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47287
47460
|
}
|
|
47288
47461
|
|
|
47289
47462
|
/**
|
|
47290
|
-
* Delete an outcome predictor.
|
|
47291
|
-
*
|
|
47463
|
+
* Deprecated. Delete an outcome predictor.
|
|
47464
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
47292
47465
|
* @param {String} predictorId ID of predictor
|
|
47293
47466
|
* @param {Object} opts Optional parameters
|
|
47294
47467
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47468
|
+
* @deprecated
|
|
47295
47469
|
*/
|
|
47296
47470
|
deleteJourneyOutcomesPredictor(predictorId, opts) {
|
|
47297
47471
|
opts = opts || {};
|
|
@@ -47598,11 +47772,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47598
47772
|
}
|
|
47599
47773
|
|
|
47600
47774
|
/**
|
|
47601
|
-
* Get status of job.
|
|
47602
|
-
*
|
|
47775
|
+
* Deprecated. Get status of job.
|
|
47776
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
47603
47777
|
* @param {String} jobId ID of the job.
|
|
47604
47778
|
* @param {Object} opts Optional parameters
|
|
47605
47779
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47780
|
+
* @deprecated
|
|
47606
47781
|
*/
|
|
47607
47782
|
getJourneyActionmapsEstimatesJob(jobId, opts) {
|
|
47608
47783
|
opts = opts || {};
|
|
@@ -47628,11 +47803,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47628
47803
|
}
|
|
47629
47804
|
|
|
47630
47805
|
/**
|
|
47631
|
-
* Get estimates from completed job.
|
|
47632
|
-
*
|
|
47806
|
+
* Deprecated. Get estimates from completed job.
|
|
47807
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
47633
47808
|
* @param {String} jobId ID of the job.
|
|
47634
47809
|
* @param {Object} opts Optional parameters
|
|
47635
47810
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47811
|
+
* @deprecated
|
|
47636
47812
|
*/
|
|
47637
47813
|
getJourneyActionmapsEstimatesJobResults(jobId, opts) {
|
|
47638
47814
|
opts = opts || {};
|
|
@@ -48074,11 +48250,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48074
48250
|
}
|
|
48075
48251
|
|
|
48076
48252
|
/**
|
|
48077
|
-
* Retrieve a single outcome.
|
|
48078
|
-
*
|
|
48253
|
+
* Deprecated. Retrieve a single outcome.
|
|
48254
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48079
48255
|
* @param {String} outcomeId ID of the outcome.
|
|
48080
48256
|
* @param {Object} opts Optional parameters
|
|
48081
48257
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48258
|
+
* @deprecated
|
|
48082
48259
|
*/
|
|
48083
48260
|
getJourneyOutcome(outcomeId, opts) {
|
|
48084
48261
|
opts = opts || {};
|
|
@@ -48104,8 +48281,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48104
48281
|
}
|
|
48105
48282
|
|
|
48106
48283
|
/**
|
|
48107
|
-
* Retrieve all outcomes.
|
|
48108
|
-
*
|
|
48284
|
+
* Deprecated. Retrieve all outcomes.
|
|
48285
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48109
48286
|
* @param {Object} opts Optional parameters
|
|
48110
48287
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
48111
48288
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
@@ -48114,6 +48291,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48114
48291
|
* @param {Array.<String>} opts.queryFields Outcome field(s) to query on. Requires 'queryValue' to also be set.
|
|
48115
48292
|
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
48116
48293
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48294
|
+
* @deprecated
|
|
48117
48295
|
*/
|
|
48118
48296
|
getJourneyOutcomes(opts) {
|
|
48119
48297
|
opts = opts || {};
|
|
@@ -48135,11 +48313,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48135
48313
|
}
|
|
48136
48314
|
|
|
48137
48315
|
/**
|
|
48138
|
-
* Get job status.
|
|
48139
|
-
*
|
|
48316
|
+
* Deprecated. Get job status.
|
|
48317
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48140
48318
|
* @param {String} jobId ID of the job.
|
|
48141
48319
|
* @param {Object} opts Optional parameters
|
|
48142
48320
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48321
|
+
* @deprecated
|
|
48143
48322
|
* getJourneyOutcomesAttributionsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48144
48323
|
*/
|
|
48145
48324
|
getJourneyOutcomesAttributionsJob(jobId, opts) {
|
|
@@ -48166,11 +48345,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48166
48345
|
}
|
|
48167
48346
|
|
|
48168
48347
|
/**
|
|
48169
|
-
* Get outcome attribution entities from completed job.
|
|
48170
|
-
*
|
|
48348
|
+
* Deprecated. Get outcome attribution entities from completed job.
|
|
48349
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48171
48350
|
* @param {String} jobId ID of the job.
|
|
48172
48351
|
* @param {Object} opts Optional parameters
|
|
48173
48352
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48353
|
+
* @deprecated
|
|
48174
48354
|
* getJourneyOutcomesAttributionsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48175
48355
|
*/
|
|
48176
48356
|
getJourneyOutcomesAttributionsJobResults(jobId, opts) {
|
|
@@ -48197,11 +48377,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48197
48377
|
}
|
|
48198
48378
|
|
|
48199
48379
|
/**
|
|
48200
|
-
* Retrieve a single outcome predictor.
|
|
48201
|
-
*
|
|
48380
|
+
* Deprecated. Retrieve a single outcome predictor.
|
|
48381
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48202
48382
|
* @param {String} predictorId ID of predictor
|
|
48203
48383
|
* @param {Object} opts Optional parameters
|
|
48204
48384
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48385
|
+
* @deprecated
|
|
48205
48386
|
*/
|
|
48206
48387
|
getJourneyOutcomesPredictor(predictorId, opts) {
|
|
48207
48388
|
opts = opts || {};
|
|
@@ -48227,10 +48408,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48227
48408
|
}
|
|
48228
48409
|
|
|
48229
48410
|
/**
|
|
48230
|
-
* Retrieve all outcome predictors.
|
|
48231
|
-
*
|
|
48411
|
+
* Deprecated. Retrieve all outcome predictors.
|
|
48412
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48232
48413
|
* @param {Object} opts Optional parameters
|
|
48233
48414
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48415
|
+
* @deprecated
|
|
48234
48416
|
*/
|
|
48235
48417
|
getJourneyOutcomesPredictors(opts) {
|
|
48236
48418
|
opts = opts || {};
|
|
@@ -48377,11 +48559,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48377
48559
|
}
|
|
48378
48560
|
|
|
48379
48561
|
/**
|
|
48380
|
-
* Retrieve latest outcome score associated with a session for all outcomes.
|
|
48381
|
-
*
|
|
48562
|
+
* Deprecated. Retrieve latest outcome score associated with a session for all outcomes.
|
|
48563
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48382
48564
|
* @param {String} sessionId ID of the session.
|
|
48383
48565
|
* @param {Object} opts Optional parameters
|
|
48384
48566
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48567
|
+
* @deprecated
|
|
48385
48568
|
*/
|
|
48386
48569
|
getJourneySessionOutcomescores(sessionId, opts) {
|
|
48387
48570
|
opts = opts || {};
|
|
@@ -49066,12 +49249,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49066
49249
|
}
|
|
49067
49250
|
|
|
49068
49251
|
/**
|
|
49069
|
-
* Update an outcome.
|
|
49070
|
-
*
|
|
49252
|
+
* Deprecated. Update an outcome.
|
|
49253
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
49071
49254
|
* @param {String} outcomeId ID of the outcome.
|
|
49072
49255
|
* @param {Object} opts Optional parameters
|
|
49073
49256
|
* @param {Object} opts.body
|
|
49074
49257
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49258
|
+
* @deprecated
|
|
49075
49259
|
*/
|
|
49076
49260
|
patchJourneyOutcome(outcomeId, opts) {
|
|
49077
49261
|
opts = opts || {};
|
|
@@ -49291,11 +49475,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49291
49475
|
}
|
|
49292
49476
|
|
|
49293
49477
|
/**
|
|
49294
|
-
* Query for estimates
|
|
49295
|
-
*
|
|
49478
|
+
* Deprecated. Query for estimates
|
|
49479
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
49296
49480
|
* @param {Object} body audience estimator request
|
|
49297
49481
|
* @param {Object} opts Optional parameters
|
|
49298
49482
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49483
|
+
* @deprecated
|
|
49299
49484
|
*/
|
|
49300
49485
|
postJourneyActionmapsEstimatesJobs(body, opts) {
|
|
49301
49486
|
opts = opts || {};
|
|
@@ -49557,11 +49742,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49557
49742
|
}
|
|
49558
49743
|
|
|
49559
49744
|
/**
|
|
49560
|
-
* Create an outcome.
|
|
49561
|
-
*
|
|
49745
|
+
* Deprecated. Create an outcome.
|
|
49746
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
49562
49747
|
* @param {Object} opts Optional parameters
|
|
49563
49748
|
* @param {Object} opts.body
|
|
49564
49749
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49750
|
+
* @deprecated
|
|
49565
49751
|
*/
|
|
49566
49752
|
postJourneyOutcomes(opts) {
|
|
49567
49753
|
opts = opts || {};
|
|
@@ -49583,11 +49769,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49583
49769
|
}
|
|
49584
49770
|
|
|
49585
49771
|
/**
|
|
49586
|
-
* Create Outcome Attributions
|
|
49587
|
-
*
|
|
49772
|
+
* Deprecated. Create Outcome Attributions
|
|
49773
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
49588
49774
|
* @param {Object} opts Optional parameters
|
|
49589
49775
|
* @param {Object} opts.body outcome attribution request
|
|
49590
49776
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49777
|
+
* @deprecated
|
|
49591
49778
|
* postJourneyOutcomesAttributionsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49592
49779
|
*/
|
|
49593
49780
|
postJourneyOutcomesAttributionsJobs(opts) {
|
|
@@ -49610,11 +49797,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49610
49797
|
}
|
|
49611
49798
|
|
|
49612
49799
|
/**
|
|
49613
|
-
* Create an outcome predictor.
|
|
49614
|
-
*
|
|
49800
|
+
* Deprecated. Create an outcome predictor.
|
|
49801
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
49615
49802
|
* @param {Object} opts Optional parameters
|
|
49616
49803
|
* @param {Object} opts.body
|
|
49617
49804
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49805
|
+
* @deprecated
|
|
49618
49806
|
*/
|
|
49619
49807
|
postJourneyOutcomesPredictors(opts) {
|
|
49620
49808
|
opts = opts || {};
|
|
@@ -49938,7 +50126,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49938
50126
|
/**
|
|
49939
50127
|
* Knowledge service.
|
|
49940
50128
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
49941
|
-
* @version
|
|
50129
|
+
* @version 252.1.0
|
|
49942
50130
|
*/
|
|
49943
50131
|
|
|
49944
50132
|
/**
|
|
@@ -50429,6 +50617,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50429
50617
|
*
|
|
50430
50618
|
* @param {String} connectionId Connection ID
|
|
50431
50619
|
* @param {Object} opts Optional parameters
|
|
50620
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
50621
|
+
* @param {String} opts.pageSize Number of results per page. Minimum: 25, Maximum: 500. (default to 200)
|
|
50432
50622
|
* @param {String} opts.parentId The id of the parent option whose children to be listed.
|
|
50433
50623
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
50434
50624
|
*/
|
|
@@ -50444,7 +50634,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50444
50634
|
'/api/v2/knowledge/connections/{connectionId}/options',
|
|
50445
50635
|
'GET',
|
|
50446
50636
|
{ 'connectionId': connectionId },
|
|
50447
|
-
{ 'parentId': opts['parentId'] },
|
|
50637
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'parentId': opts['parentId'] },
|
|
50448
50638
|
{ },
|
|
50449
50639
|
{ },
|
|
50450
50640
|
null,
|
|
@@ -54146,7 +54336,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54146
54336
|
/**
|
|
54147
54337
|
* LanguageUnderstanding service.
|
|
54148
54338
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
54149
|
-
* @version
|
|
54339
|
+
* @version 252.1.0
|
|
54150
54340
|
*/
|
|
54151
54341
|
|
|
54152
54342
|
/**
|
|
@@ -55520,7 +55710,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55520
55710
|
/**
|
|
55521
55711
|
* Languages service.
|
|
55522
55712
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
55523
|
-
* @version
|
|
55713
|
+
* @version 252.1.0
|
|
55524
55714
|
*/
|
|
55525
55715
|
|
|
55526
55716
|
/**
|
|
@@ -55779,7 +55969,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55779
55969
|
/**
|
|
55780
55970
|
* Learning service.
|
|
55781
55971
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
55782
|
-
* @version
|
|
55972
|
+
* @version 252.1.0
|
|
55783
55973
|
*/
|
|
55784
55974
|
|
|
55785
55975
|
/**
|
|
@@ -57027,7 +57217,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57027
57217
|
/**
|
|
57028
57218
|
* License service.
|
|
57029
57219
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
57030
|
-
* @version
|
|
57220
|
+
* @version 252.1.0
|
|
57031
57221
|
*/
|
|
57032
57222
|
|
|
57033
57223
|
/**
|
|
@@ -57325,7 +57515,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57325
57515
|
/**
|
|
57326
57516
|
* Locations service.
|
|
57327
57517
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
57328
|
-
* @version
|
|
57518
|
+
* @version 252.1.0
|
|
57329
57519
|
*/
|
|
57330
57520
|
|
|
57331
57521
|
/**
|
|
@@ -57592,7 +57782,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57592
57782
|
/**
|
|
57593
57783
|
* LogCapture service.
|
|
57594
57784
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
57595
|
-
* @version
|
|
57785
|
+
* @version 252.1.0
|
|
57596
57786
|
*/
|
|
57597
57787
|
|
|
57598
57788
|
/**
|
|
@@ -57814,7 +58004,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57814
58004
|
/**
|
|
57815
58005
|
* Messaging service.
|
|
57816
58006
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
57817
|
-
* @version
|
|
58007
|
+
* @version 252.1.0
|
|
57818
58008
|
*/
|
|
57819
58009
|
|
|
57820
58010
|
/**
|
|
@@ -58232,7 +58422,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58232
58422
|
/**
|
|
58233
58423
|
* MobileDevices service.
|
|
58234
58424
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
58235
|
-
* @version
|
|
58425
|
+
* @version 252.1.0
|
|
58236
58426
|
*/
|
|
58237
58427
|
|
|
58238
58428
|
/**
|
|
@@ -58402,7 +58592,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58402
58592
|
/**
|
|
58403
58593
|
* Notifications service.
|
|
58404
58594
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
58405
|
-
* @version
|
|
58595
|
+
* @version 252.1.0
|
|
58406
58596
|
*/
|
|
58407
58597
|
|
|
58408
58598
|
/**
|
|
@@ -58663,7 +58853,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58663
58853
|
/**
|
|
58664
58854
|
* OAuth service.
|
|
58665
58855
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
58666
|
-
* @version
|
|
58856
|
+
* @version 252.1.0
|
|
58667
58857
|
*/
|
|
58668
58858
|
|
|
58669
58859
|
/**
|
|
@@ -59079,7 +59269,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59079
59269
|
/**
|
|
59080
59270
|
* Objects service.
|
|
59081
59271
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
59082
|
-
* @version
|
|
59272
|
+
* @version 252.1.0
|
|
59083
59273
|
*/
|
|
59084
59274
|
|
|
59085
59275
|
/**
|
|
@@ -59443,7 +59633,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59443
59633
|
/**
|
|
59444
59634
|
* OperationalEvents service.
|
|
59445
59635
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
59446
|
-
* @version
|
|
59636
|
+
* @version 252.1.0
|
|
59447
59637
|
*/
|
|
59448
59638
|
|
|
59449
59639
|
/**
|
|
@@ -59574,7 +59764,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59574
59764
|
/**
|
|
59575
59765
|
* Organization service.
|
|
59576
59766
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
59577
|
-
* @version
|
|
59767
|
+
* @version 252.1.0
|
|
59578
59768
|
*/
|
|
59579
59769
|
|
|
59580
59770
|
/**
|
|
@@ -60135,7 +60325,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60135
60325
|
/**
|
|
60136
60326
|
* OrganizationAuthorization service.
|
|
60137
60327
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
60138
|
-
* @version
|
|
60328
|
+
* @version 252.1.0
|
|
60139
60329
|
*/
|
|
60140
60330
|
|
|
60141
60331
|
/**
|
|
@@ -61739,7 +61929,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61739
61929
|
/**
|
|
61740
61930
|
* Outbound service.
|
|
61741
61931
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
61742
|
-
* @version
|
|
61932
|
+
* @version 252.1.0
|
|
61743
61933
|
*/
|
|
61744
61934
|
|
|
61745
61935
|
/**
|
|
@@ -67326,7 +67516,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67326
67516
|
/**
|
|
67327
67517
|
* Presence service.
|
|
67328
67518
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
67329
|
-
* @version
|
|
67519
|
+
* @version 252.1.0
|
|
67330
67520
|
*/
|
|
67331
67521
|
|
|
67332
67522
|
/**
|
|
@@ -68184,7 +68374,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68184
68374
|
/**
|
|
68185
68375
|
* ProcessAutomation service.
|
|
68186
68376
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
68187
|
-
* @version
|
|
68377
|
+
* @version 252.1.0
|
|
68188
68378
|
*/
|
|
68189
68379
|
|
|
68190
68380
|
/**
|
|
@@ -68605,7 +68795,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68605
68795
|
/**
|
|
68606
68796
|
* Quality service.
|
|
68607
68797
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
68608
|
-
* @version
|
|
68798
|
+
* @version 252.1.0
|
|
68609
68799
|
*/
|
|
68610
68800
|
|
|
68611
68801
|
/**
|
|
@@ -70963,7 +71153,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70963
71153
|
/**
|
|
70964
71154
|
* Recording service.
|
|
70965
71155
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
70966
|
-
* @version
|
|
71156
|
+
* @version 252.1.0
|
|
70967
71157
|
*/
|
|
70968
71158
|
|
|
70969
71159
|
/**
|
|
@@ -72811,7 +73001,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72811
73001
|
/**
|
|
72812
73002
|
* ResponseManagement service.
|
|
72813
73003
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
72814
|
-
* @version
|
|
73004
|
+
* @version 252.1.0
|
|
72815
73005
|
*/
|
|
72816
73006
|
|
|
72817
73007
|
/**
|
|
@@ -73455,7 +73645,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73455
73645
|
/**
|
|
73456
73646
|
* Routing service.
|
|
73457
73647
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
73458
|
-
* @version
|
|
73648
|
+
* @version 252.1.0
|
|
73459
73649
|
*/
|
|
73460
73650
|
|
|
73461
73651
|
/**
|
|
@@ -78842,7 +79032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78842
79032
|
/**
|
|
78843
79033
|
* SCIM service.
|
|
78844
79034
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
78845
|
-
* @version
|
|
79035
|
+
* @version 252.1.0
|
|
78846
79036
|
*/
|
|
78847
79037
|
|
|
78848
79038
|
/**
|
|
@@ -79803,7 +79993,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79803
79993
|
/**
|
|
79804
79994
|
* Scripts service.
|
|
79805
79995
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
79806
|
-
* @version
|
|
79996
|
+
* @version 252.1.0
|
|
79807
79997
|
*/
|
|
79808
79998
|
|
|
79809
79999
|
/**
|
|
@@ -80312,7 +80502,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80312
80502
|
/**
|
|
80313
80503
|
* Search service.
|
|
80314
80504
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
80315
|
-
* @version
|
|
80505
|
+
* @version 252.1.0
|
|
80316
80506
|
*/
|
|
80317
80507
|
|
|
80318
80508
|
/**
|
|
@@ -81128,7 +81318,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81128
81318
|
/**
|
|
81129
81319
|
* Settings service.
|
|
81130
81320
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
81131
|
-
* @version
|
|
81321
|
+
* @version 252.1.0
|
|
81132
81322
|
*/
|
|
81133
81323
|
|
|
81134
81324
|
/**
|
|
@@ -81537,7 +81727,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81537
81727
|
/**
|
|
81538
81728
|
* SocialMedia service.
|
|
81539
81729
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
81540
|
-
* @version
|
|
81730
|
+
* @version 252.1.0
|
|
81541
81731
|
*/
|
|
81542
81732
|
|
|
81543
81733
|
/**
|
|
@@ -83522,7 +83712,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83522
83712
|
/**
|
|
83523
83713
|
* SpeechTextAnalytics service.
|
|
83524
83714
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
83525
|
-
* @version
|
|
83715
|
+
* @version 252.1.0
|
|
83526
83716
|
*/
|
|
83527
83717
|
|
|
83528
83718
|
/**
|
|
@@ -85474,7 +85664,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85474
85664
|
/**
|
|
85475
85665
|
* Stations service.
|
|
85476
85666
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
85477
|
-
* @version
|
|
85667
|
+
* @version 252.1.0
|
|
85478
85668
|
*/
|
|
85479
85669
|
|
|
85480
85670
|
/**
|
|
@@ -85588,7 +85778,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85588
85778
|
/**
|
|
85589
85779
|
* Suggest service.
|
|
85590
85780
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
85591
|
-
* @version
|
|
85781
|
+
* @version 252.1.0
|
|
85592
85782
|
*/
|
|
85593
85783
|
|
|
85594
85784
|
/**
|
|
@@ -85735,7 +85925,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85735
85925
|
/**
|
|
85736
85926
|
* TaskManagement service.
|
|
85737
85927
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
85738
|
-
* @version
|
|
85928
|
+
* @version 252.1.0
|
|
85739
85929
|
*/
|
|
85740
85930
|
|
|
85741
85931
|
/**
|
|
@@ -88162,7 +88352,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88162
88352
|
|
|
88163
88353
|
/**
|
|
88164
88354
|
* Query for worktypes
|
|
88165
|
-
*
|
|
88355
|
+
* Optional request field expands may include schema to populate the name on each worktypes schema reference.
|
|
88166
88356
|
* @param {Object} body QueryPostRequest
|
|
88167
88357
|
* @param {Object} opts Optional parameters
|
|
88168
88358
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
@@ -88231,7 +88421,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88231
88421
|
/**
|
|
88232
88422
|
* Teams service.
|
|
88233
88423
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
88234
|
-
* @version
|
|
88424
|
+
* @version 252.1.0
|
|
88235
88425
|
*/
|
|
88236
88426
|
|
|
88237
88427
|
/**
|
|
@@ -88574,7 +88764,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88574
88764
|
/**
|
|
88575
88765
|
* Telephony service.
|
|
88576
88766
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
88577
|
-
* @version
|
|
88767
|
+
* @version 252.1.0
|
|
88578
88768
|
*/
|
|
88579
88769
|
|
|
88580
88770
|
/**
|
|
@@ -88981,7 +89171,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88981
89171
|
/**
|
|
88982
89172
|
* TelephonyProvidersEdge service.
|
|
88983
89173
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
88984
|
-
* @version
|
|
89174
|
+
* @version 252.1.0
|
|
88985
89175
|
*/
|
|
88986
89176
|
|
|
88987
89177
|
/**
|
|
@@ -93005,7 +93195,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93005
93195
|
/**
|
|
93006
93196
|
* Textbots service.
|
|
93007
93197
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
93008
|
-
* @version
|
|
93198
|
+
* @version 252.1.0
|
|
93009
93199
|
*/
|
|
93010
93200
|
|
|
93011
93201
|
/**
|
|
@@ -93151,7 +93341,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93151
93341
|
/**
|
|
93152
93342
|
* Tokens service.
|
|
93153
93343
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
93154
|
-
* @version
|
|
93344
|
+
* @version 252.1.0
|
|
93155
93345
|
*/
|
|
93156
93346
|
|
|
93157
93347
|
/**
|
|
@@ -93329,7 +93519,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93329
93519
|
/**
|
|
93330
93520
|
* Uploads service.
|
|
93331
93521
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
93332
|
-
* @version
|
|
93522
|
+
* @version 252.1.0
|
|
93333
93523
|
*/
|
|
93334
93524
|
|
|
93335
93525
|
/**
|
|
@@ -93700,7 +93890,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93700
93890
|
/**
|
|
93701
93891
|
* Usage service.
|
|
93702
93892
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
93703
|
-
* @version
|
|
93893
|
+
* @version 252.1.0
|
|
93704
93894
|
*/
|
|
93705
93895
|
|
|
93706
93896
|
/**
|
|
@@ -94078,7 +94268,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94078
94268
|
/**
|
|
94079
94269
|
* UserRecordings service.
|
|
94080
94270
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
94081
|
-
* @version
|
|
94271
|
+
* @version 252.1.0
|
|
94082
94272
|
*/
|
|
94083
94273
|
|
|
94084
94274
|
/**
|
|
@@ -94280,7 +94470,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94280
94470
|
/**
|
|
94281
94471
|
* Users service.
|
|
94282
94472
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
94283
|
-
* @version
|
|
94473
|
+
* @version 252.1.0
|
|
94284
94474
|
*/
|
|
94285
94475
|
|
|
94286
94476
|
/**
|
|
@@ -94781,6 +94971,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94781
94971
|
);
|
|
94782
94972
|
}
|
|
94783
94973
|
|
|
94974
|
+
/**
|
|
94975
|
+
* Clear self associated station
|
|
94976
|
+
*
|
|
94977
|
+
* @param {Object} opts Optional parameters
|
|
94978
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
94979
|
+
*/
|
|
94980
|
+
deleteUsersStationsMeAssociatedstation(opts) {
|
|
94981
|
+
opts = opts || {};
|
|
94982
|
+
|
|
94983
|
+
|
|
94984
|
+
return this.apiClient.callApi(
|
|
94985
|
+
'/api/v2/users/stations/me/associatedstation',
|
|
94986
|
+
'DELETE',
|
|
94987
|
+
{ },
|
|
94988
|
+
{ },
|
|
94989
|
+
{ },
|
|
94990
|
+
{ },
|
|
94991
|
+
null,
|
|
94992
|
+
['PureCloud OAuth'],
|
|
94993
|
+
['application/json'],
|
|
94994
|
+
['application/json'],
|
|
94995
|
+
opts['customHeaders']
|
|
94996
|
+
);
|
|
94997
|
+
}
|
|
94998
|
+
|
|
94784
94999
|
/**
|
|
94785
95000
|
* Get status for async query for user aggregates
|
|
94786
95001
|
*
|
|
@@ -96049,6 +96264,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
96049
96264
|
* @param {Object} opts Optional parameters
|
|
96050
96265
|
* @param {Boolean} opts.excludeClosed Whether or not to exclude closed chats
|
|
96051
96266
|
* @param {Boolean} opts.includePresence Whether or not to include user presence
|
|
96267
|
+
* @param {Boolean} opts.includeRoomOwners Whether or not to include room owners
|
|
96052
96268
|
* @param {String} opts.after The key to start after
|
|
96053
96269
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
96054
96270
|
*/
|
|
@@ -96060,7 +96276,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
96060
96276
|
'/api/v2/users/chats/me',
|
|
96061
96277
|
'GET',
|
|
96062
96278
|
{ },
|
|
96063
|
-
{ 'excludeClosed': opts['excludeClosed'],'includePresence': opts['includePresence'],'after': opts['after'] },
|
|
96279
|
+
{ 'excludeClosed': opts['excludeClosed'],'includePresence': opts['includePresence'],'includeRoomOwners': opts['includeRoomOwners'],'after': opts['after'] },
|
|
96064
96280
|
{ },
|
|
96065
96281
|
{ },
|
|
96066
96282
|
null,
|
|
@@ -96455,7 +96671,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
96455
96671
|
* @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
|
|
96456
96672
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
96457
96673
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
96458
|
-
* getUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
96459
96674
|
*/
|
|
96460
96675
|
getUsersQuery(opts) {
|
|
96461
96676
|
opts = opts || {};
|
|
@@ -96508,6 +96723,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
96508
96723
|
);
|
|
96509
96724
|
}
|
|
96510
96725
|
|
|
96726
|
+
/**
|
|
96727
|
+
* Get station information for self
|
|
96728
|
+
*
|
|
96729
|
+
* @param {Object} opts Optional parameters
|
|
96730
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
96731
|
+
*/
|
|
96732
|
+
getUsersStationsMe(opts) {
|
|
96733
|
+
opts = opts || {};
|
|
96734
|
+
|
|
96735
|
+
|
|
96736
|
+
return this.apiClient.callApi(
|
|
96737
|
+
'/api/v2/users/stations/me',
|
|
96738
|
+
'GET',
|
|
96739
|
+
{ },
|
|
96740
|
+
{ },
|
|
96741
|
+
{ },
|
|
96742
|
+
{ },
|
|
96743
|
+
null,
|
|
96744
|
+
['PureCloud OAuth'],
|
|
96745
|
+
['application/json'],
|
|
96746
|
+
['application/json'],
|
|
96747
|
+
opts['customHeaders']
|
|
96748
|
+
);
|
|
96749
|
+
}
|
|
96750
|
+
|
|
96511
96751
|
/**
|
|
96512
96752
|
* Update user
|
|
96513
96753
|
*
|
|
@@ -98213,13 +98453,43 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
98213
98453
|
);
|
|
98214
98454
|
}
|
|
98215
98455
|
|
|
98456
|
+
/**
|
|
98457
|
+
* Set self associated station
|
|
98458
|
+
*
|
|
98459
|
+
* @param {String} stationId stationId
|
|
98460
|
+
* @param {Object} opts Optional parameters
|
|
98461
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
98462
|
+
*/
|
|
98463
|
+
putUsersStationsMeAssociatedstationStationId(stationId, opts) {
|
|
98464
|
+
opts = opts || {};
|
|
98465
|
+
|
|
98466
|
+
// verify the required parameter 'stationId' is set
|
|
98467
|
+
if (stationId === undefined || stationId === null || stationId === '') {
|
|
98468
|
+
throw 'Missing the required parameter "stationId" when calling putUsersStationsMeAssociatedstationStationId';
|
|
98469
|
+
}
|
|
98470
|
+
|
|
98471
|
+
return this.apiClient.callApi(
|
|
98472
|
+
'/api/v2/users/stations/me/associatedstation/{stationId}',
|
|
98473
|
+
'PUT',
|
|
98474
|
+
{ 'stationId': stationId },
|
|
98475
|
+
{ },
|
|
98476
|
+
{ },
|
|
98477
|
+
{ },
|
|
98478
|
+
null,
|
|
98479
|
+
['PureCloud OAuth'],
|
|
98480
|
+
['application/json'],
|
|
98481
|
+
['application/json'],
|
|
98482
|
+
opts['customHeaders']
|
|
98483
|
+
);
|
|
98484
|
+
}
|
|
98485
|
+
|
|
98216
98486
|
}
|
|
98217
98487
|
|
|
98218
98488
|
class UsersRulesApi {
|
|
98219
98489
|
/**
|
|
98220
98490
|
* UsersRules service.
|
|
98221
98491
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
98222
|
-
* @version
|
|
98492
|
+
* @version 252.1.0
|
|
98223
98493
|
*/
|
|
98224
98494
|
|
|
98225
98495
|
/**
|
|
@@ -98536,7 +98806,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
98536
98806
|
/**
|
|
98537
98807
|
* Utilities service.
|
|
98538
98808
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
98539
|
-
* @version
|
|
98809
|
+
* @version 252.1.0
|
|
98540
98810
|
*/
|
|
98541
98811
|
|
|
98542
98812
|
/**
|
|
@@ -98664,7 +98934,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
98664
98934
|
/**
|
|
98665
98935
|
* Voicemail service.
|
|
98666
98936
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
98667
|
-
* @version
|
|
98937
|
+
* @version 252.1.0
|
|
98668
98938
|
*/
|
|
98669
98939
|
|
|
98670
98940
|
/**
|
|
@@ -99494,7 +99764,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
99494
99764
|
/**
|
|
99495
99765
|
* WebChat service.
|
|
99496
99766
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
99497
|
-
* @version
|
|
99767
|
+
* @version 252.1.0
|
|
99498
99768
|
*/
|
|
99499
99769
|
|
|
99500
99770
|
/**
|
|
@@ -100146,7 +100416,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
100146
100416
|
/**
|
|
100147
100417
|
* WebDeployments service.
|
|
100148
100418
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
100149
|
-
* @version
|
|
100419
|
+
* @version 252.1.0
|
|
100150
100420
|
*/
|
|
100151
100421
|
|
|
100152
100422
|
/**
|
|
@@ -100824,7 +101094,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
100824
101094
|
/**
|
|
100825
101095
|
* WebMessaging service.
|
|
100826
101096
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
100827
|
-
* @version
|
|
101097
|
+
* @version 252.1.0
|
|
100828
101098
|
*/
|
|
100829
101099
|
|
|
100830
101100
|
/**
|
|
@@ -100987,7 +101257,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
100987
101257
|
/**
|
|
100988
101258
|
* Widgets service.
|
|
100989
101259
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
100990
|
-
* @version
|
|
101260
|
+
* @version 252.1.0
|
|
100991
101261
|
*/
|
|
100992
101262
|
|
|
100993
101263
|
/**
|
|
@@ -101163,7 +101433,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
101163
101433
|
/**
|
|
101164
101434
|
* WorkforceManagement service.
|
|
101165
101435
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
101166
|
-
* @version
|
|
101436
|
+
* @version 252.1.0
|
|
101167
101437
|
*/
|
|
101168
101438
|
|
|
101169
101439
|
/**
|
|
@@ -111499,7 +111769,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
111499
111769
|
* </pre>
|
|
111500
111770
|
* </p>
|
|
111501
111771
|
* @module purecloud-platform-client-v2/index
|
|
111502
|
-
* @version
|
|
111772
|
+
* @version 252.1.0
|
|
111503
111773
|
*/
|
|
111504
111774
|
class platformClient {
|
|
111505
111775
|
constructor() {
|