purecloud-platform-client-v2 251.2.0 → 252.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +392 -125
- package/dist/web-amd/purecloud-platform-client-v2.js +392 -125
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +25682 -25547
- package/dist/web-cjs/purecloud-platform-client-v2.js +25682 -25547
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +312 -94
- package/package.json +2 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- 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.0.0
|
|
749
749
|
*/
|
|
750
750
|
class ApiClient {
|
|
751
751
|
/**
|
|
@@ -2433,7 +2433,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2433
2433
|
/**
|
|
2434
2434
|
* AIStudio service.
|
|
2435
2435
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2436
|
-
* @version
|
|
2436
|
+
* @version 252.0.0
|
|
2437
2437
|
*/
|
|
2438
2438
|
|
|
2439
2439
|
/**
|
|
@@ -3148,7 +3148,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3148
3148
|
/**
|
|
3149
3149
|
* AgentAssistants service.
|
|
3150
3150
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
3151
|
-
* @version
|
|
3151
|
+
* @version 252.0.0
|
|
3152
3152
|
*/
|
|
3153
3153
|
|
|
3154
3154
|
/**
|
|
@@ -3952,7 +3952,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3952
3952
|
/**
|
|
3953
3953
|
* AgentCopilot service.
|
|
3954
3954
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3955
|
-
* @version
|
|
3955
|
+
* @version 252.0.0
|
|
3956
3956
|
*/
|
|
3957
3957
|
|
|
3958
3958
|
/**
|
|
@@ -4064,7 +4064,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4064
4064
|
/**
|
|
4065
4065
|
* AgentUI service.
|
|
4066
4066
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
4067
|
-
* @version
|
|
4067
|
+
* @version 252.0.0
|
|
4068
4068
|
*/
|
|
4069
4069
|
|
|
4070
4070
|
/**
|
|
@@ -4215,7 +4215,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4215
4215
|
/**
|
|
4216
4216
|
* Alerting service.
|
|
4217
4217
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
4218
|
-
* @version
|
|
4218
|
+
* @version 252.0.0
|
|
4219
4219
|
*/
|
|
4220
4220
|
|
|
4221
4221
|
/**
|
|
@@ -4676,7 +4676,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4676
4676
|
/**
|
|
4677
4677
|
* Analytics service.
|
|
4678
4678
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4679
|
-
* @version
|
|
4679
|
+
* @version 252.0.0
|
|
4680
4680
|
*/
|
|
4681
4681
|
|
|
4682
4682
|
/**
|
|
@@ -8962,7 +8962,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8962
8962
|
/**
|
|
8963
8963
|
* Architect service.
|
|
8964
8964
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8965
|
-
* @version
|
|
8965
|
+
* @version 252.0.0
|
|
8966
8966
|
*/
|
|
8967
8967
|
|
|
8968
8968
|
/**
|
|
@@ -12954,12 +12954,48 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12954
12954
|
}
|
|
12955
12955
|
|
|
12956
12956
|
/**
|
|
12957
|
-
* Begin an import process for importing rows into a datatable
|
|
12957
|
+
* 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.
|
|
12958
|
+
* 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
|
|
12959
|
+
* @param {String} datatableId id of datatable
|
|
12960
|
+
* @param {Object} body import job information
|
|
12961
|
+
* @param {Object} opts Optional parameters
|
|
12962
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
12963
|
+
*/
|
|
12964
|
+
postFlowsDatatableImportCsvJobs(datatableId, body, opts) {
|
|
12965
|
+
opts = opts || {};
|
|
12966
|
+
|
|
12967
|
+
// verify the required parameter 'datatableId' is set
|
|
12968
|
+
if (datatableId === undefined || datatableId === null || datatableId === '') {
|
|
12969
|
+
throw 'Missing the required parameter "datatableId" when calling postFlowsDatatableImportCsvJobs';
|
|
12970
|
+
}
|
|
12971
|
+
// verify the required parameter 'body' is set
|
|
12972
|
+
if (body === undefined || body === null) {
|
|
12973
|
+
throw 'Missing the required parameter "body" when calling postFlowsDatatableImportCsvJobs';
|
|
12974
|
+
}
|
|
12975
|
+
|
|
12976
|
+
return this.apiClient.callApi(
|
|
12977
|
+
'/api/v2/flows/datatables/{datatableId}/import/csv/jobs',
|
|
12978
|
+
'POST',
|
|
12979
|
+
{ 'datatableId': datatableId },
|
|
12980
|
+
{ },
|
|
12981
|
+
{ },
|
|
12982
|
+
{ },
|
|
12983
|
+
body,
|
|
12984
|
+
['PureCloud OAuth'],
|
|
12985
|
+
['application/json'],
|
|
12986
|
+
['application/json'],
|
|
12987
|
+
opts['customHeaders']
|
|
12988
|
+
);
|
|
12989
|
+
}
|
|
12990
|
+
|
|
12991
|
+
/**
|
|
12992
|
+
* 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
12993
|
* 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
12994
|
* @param {String} datatableId id of datatable
|
|
12960
12995
|
* @param {Object} body import job information
|
|
12961
12996
|
* @param {Object} opts Optional parameters
|
|
12962
12997
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
12998
|
+
* @deprecated
|
|
12963
12999
|
*/
|
|
12964
13000
|
postFlowsDatatableImportJobs(datatableId, body, opts) {
|
|
12965
13001
|
opts = opts || {};
|
|
@@ -13785,7 +13821,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13785
13821
|
/**
|
|
13786
13822
|
* AssistantCopilotVariations service.
|
|
13787
13823
|
* @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
13788
|
-
* @version
|
|
13824
|
+
* @version 252.0.0
|
|
13789
13825
|
*/
|
|
13790
13826
|
|
|
13791
13827
|
/**
|
|
@@ -13981,7 +14017,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13981
14017
|
/**
|
|
13982
14018
|
* Audit service.
|
|
13983
14019
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
13984
|
-
* @version
|
|
14020
|
+
* @version 252.0.0
|
|
13985
14021
|
*/
|
|
13986
14022
|
|
|
13987
14023
|
/**
|
|
@@ -14208,7 +14244,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14208
14244
|
/**
|
|
14209
14245
|
* Authorization service.
|
|
14210
14246
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
14211
|
-
* @version
|
|
14247
|
+
* @version 252.0.0
|
|
14212
14248
|
*/
|
|
14213
14249
|
|
|
14214
14250
|
/**
|
|
@@ -16133,7 +16169,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16133
16169
|
/**
|
|
16134
16170
|
* BackgroundAssistant service.
|
|
16135
16171
|
* @module purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
16136
|
-
* @version
|
|
16172
|
+
* @version 252.0.0
|
|
16137
16173
|
*/
|
|
16138
16174
|
|
|
16139
16175
|
/**
|
|
@@ -16207,7 +16243,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16207
16243
|
/**
|
|
16208
16244
|
* Billing service.
|
|
16209
16245
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16210
|
-
* @version
|
|
16246
|
+
* @version 252.0.0
|
|
16211
16247
|
*/
|
|
16212
16248
|
|
|
16213
16249
|
/**
|
|
@@ -16491,7 +16527,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16491
16527
|
/**
|
|
16492
16528
|
* BusinessRules service.
|
|
16493
16529
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
16494
|
-
* @version
|
|
16530
|
+
* @version 252.0.0
|
|
16495
16531
|
*/
|
|
16496
16532
|
|
|
16497
16533
|
/**
|
|
@@ -17505,7 +17541,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17505
17541
|
/**
|
|
17506
17542
|
* CarrierServices service.
|
|
17507
17543
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
17508
|
-
* @version
|
|
17544
|
+
* @version 252.0.0
|
|
17509
17545
|
*/
|
|
17510
17546
|
|
|
17511
17547
|
/**
|
|
@@ -17582,7 +17618,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17582
17618
|
/**
|
|
17583
17619
|
* CaseManagement service.
|
|
17584
17620
|
* @module purecloud-platform-client-v2/api/CaseManagementApi
|
|
17585
|
-
* @version
|
|
17621
|
+
* @version 252.0.0
|
|
17586
17622
|
*/
|
|
17587
17623
|
|
|
17588
17624
|
/**
|
|
@@ -18744,6 +18780,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18744
18780
|
);
|
|
18745
18781
|
}
|
|
18746
18782
|
|
|
18783
|
+
/**
|
|
18784
|
+
* Query for caseplans
|
|
18785
|
+
*
|
|
18786
|
+
* @param {Object} body CaseplanQueryRequest
|
|
18787
|
+
* @param {Object} opts Optional parameters
|
|
18788
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18789
|
+
* postCasemanagementCaseplansQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18790
|
+
*/
|
|
18791
|
+
postCasemanagementCaseplansQuery(body, opts) {
|
|
18792
|
+
opts = opts || {};
|
|
18793
|
+
|
|
18794
|
+
// verify the required parameter 'body' is set
|
|
18795
|
+
if (body === undefined || body === null) {
|
|
18796
|
+
throw 'Missing the required parameter "body" when calling postCasemanagementCaseplansQuery';
|
|
18797
|
+
}
|
|
18798
|
+
|
|
18799
|
+
return this.apiClient.callApi(
|
|
18800
|
+
'/api/v2/casemanagement/caseplans/query',
|
|
18801
|
+
'POST',
|
|
18802
|
+
{ },
|
|
18803
|
+
{ },
|
|
18804
|
+
{ },
|
|
18805
|
+
{ },
|
|
18806
|
+
body,
|
|
18807
|
+
['PureCloud OAuth'],
|
|
18808
|
+
['application/json'],
|
|
18809
|
+
['application/json'],
|
|
18810
|
+
opts['customHeaders']
|
|
18811
|
+
);
|
|
18812
|
+
}
|
|
18813
|
+
|
|
18747
18814
|
/**
|
|
18748
18815
|
* Create a Case.
|
|
18749
18816
|
*
|
|
@@ -18844,7 +18911,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18844
18911
|
/**
|
|
18845
18912
|
* Chat service.
|
|
18846
18913
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
18847
|
-
* @version
|
|
18914
|
+
* @version 252.0.0
|
|
18848
18915
|
*/
|
|
18849
18916
|
|
|
18850
18917
|
/**
|
|
@@ -19983,7 +20050,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19983
20050
|
/**
|
|
19984
20051
|
* Coaching service.
|
|
19985
20052
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
19986
|
-
* @version
|
|
20053
|
+
* @version 252.0.0
|
|
19987
20054
|
*/
|
|
19988
20055
|
|
|
19989
20056
|
/**
|
|
@@ -20697,7 +20764,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20697
20764
|
/**
|
|
20698
20765
|
* ContentManagement service.
|
|
20699
20766
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
20700
|
-
* @version
|
|
20767
|
+
* @version 252.0.0
|
|
20701
20768
|
*/
|
|
20702
20769
|
|
|
20703
20770
|
/**
|
|
@@ -21892,7 +21959,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21892
21959
|
/**
|
|
21893
21960
|
* Conversations service.
|
|
21894
21961
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
21895
|
-
* @version
|
|
21962
|
+
* @version 252.0.0
|
|
21896
21963
|
*/
|
|
21897
21964
|
|
|
21898
21965
|
/**
|
|
@@ -22780,6 +22847,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22780
22847
|
);
|
|
22781
22848
|
}
|
|
22782
22849
|
|
|
22850
|
+
/**
|
|
22851
|
+
* Get copilot context values for a conversation.
|
|
22852
|
+
*
|
|
22853
|
+
* @param {String} conversationId Conversation ID.
|
|
22854
|
+
* @param {Object} opts Optional parameters
|
|
22855
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
22856
|
+
* getConversationAssistantCopilotcontext is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22857
|
+
*/
|
|
22858
|
+
getConversationAssistantCopilotcontext(conversationId, opts) {
|
|
22859
|
+
opts = opts || {};
|
|
22860
|
+
|
|
22861
|
+
// verify the required parameter 'conversationId' is set
|
|
22862
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
22863
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationAssistantCopilotcontext';
|
|
22864
|
+
}
|
|
22865
|
+
|
|
22866
|
+
return this.apiClient.callApi(
|
|
22867
|
+
'/api/v2/conversations/{conversationId}/assistant/copilotcontext',
|
|
22868
|
+
'GET',
|
|
22869
|
+
{ 'conversationId': conversationId },
|
|
22870
|
+
{ },
|
|
22871
|
+
{ },
|
|
22872
|
+
{ },
|
|
22873
|
+
null,
|
|
22874
|
+
['PureCloud OAuth'],
|
|
22875
|
+
['application/json'],
|
|
22876
|
+
['application/json'],
|
|
22877
|
+
opts['customHeaders']
|
|
22878
|
+
);
|
|
22879
|
+
}
|
|
22880
|
+
|
|
22783
22881
|
/**
|
|
22784
22882
|
* Get checklist info for a single checklist.
|
|
22785
22883
|
*
|
|
@@ -27934,6 +28032,46 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27934
28032
|
);
|
|
27935
28033
|
}
|
|
27936
28034
|
|
|
28035
|
+
/**
|
|
28036
|
+
* Update conversation by setting its parking state
|
|
28037
|
+
*
|
|
28038
|
+
* @param {String} conversationId conversationId
|
|
28039
|
+
* @param {String} participantId participantId
|
|
28040
|
+
* @param {Object} body Parking update request
|
|
28041
|
+
* @param {Object} opts Optional parameters
|
|
28042
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
28043
|
+
*/
|
|
28044
|
+
patchConversationsMessageParticipantParkingstate(conversationId, participantId, body, opts) {
|
|
28045
|
+
opts = opts || {};
|
|
28046
|
+
|
|
28047
|
+
// verify the required parameter 'conversationId' is set
|
|
28048
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
28049
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationsMessageParticipantParkingstate';
|
|
28050
|
+
}
|
|
28051
|
+
// verify the required parameter 'participantId' is set
|
|
28052
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
28053
|
+
throw 'Missing the required parameter "participantId" when calling patchConversationsMessageParticipantParkingstate';
|
|
28054
|
+
}
|
|
28055
|
+
// verify the required parameter 'body' is set
|
|
28056
|
+
if (body === undefined || body === null) {
|
|
28057
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessageParticipantParkingstate';
|
|
28058
|
+
}
|
|
28059
|
+
|
|
28060
|
+
return this.apiClient.callApi(
|
|
28061
|
+
'/api/v2/conversations/messages/{conversationId}/participants/{participantId}/parkingstate',
|
|
28062
|
+
'PATCH',
|
|
28063
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
28064
|
+
{ },
|
|
28065
|
+
{ },
|
|
28066
|
+
{ },
|
|
28067
|
+
body,
|
|
28068
|
+
['PureCloud OAuth'],
|
|
28069
|
+
['application/json'],
|
|
28070
|
+
['application/json'],
|
|
28071
|
+
opts['customHeaders']
|
|
28072
|
+
);
|
|
28073
|
+
}
|
|
28074
|
+
|
|
27937
28075
|
/**
|
|
27938
28076
|
* Update an Apple messaging integration
|
|
27939
28077
|
*
|
|
@@ -32927,7 +33065,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32927
33065
|
/**
|
|
32928
33066
|
* DataExtensions service.
|
|
32929
33067
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
32930
|
-
* @version
|
|
33068
|
+
* @version 252.0.0
|
|
32931
33069
|
*/
|
|
32932
33070
|
|
|
32933
33071
|
/**
|
|
@@ -33028,7 +33166,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33028
33166
|
/**
|
|
33029
33167
|
* DataPrivacy service.
|
|
33030
33168
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
33031
|
-
* @version
|
|
33169
|
+
* @version 252.0.0
|
|
33032
33170
|
*/
|
|
33033
33171
|
|
|
33034
33172
|
/**
|
|
@@ -33225,7 +33363,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33225
33363
|
/**
|
|
33226
33364
|
* Downloads service.
|
|
33227
33365
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
33228
|
-
* @version
|
|
33366
|
+
* @version 252.0.0
|
|
33229
33367
|
*/
|
|
33230
33368
|
|
|
33231
33369
|
/**
|
|
@@ -33279,7 +33417,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33279
33417
|
/**
|
|
33280
33418
|
* Emails service.
|
|
33281
33419
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
33282
|
-
* @version
|
|
33420
|
+
* @version 252.0.0
|
|
33283
33421
|
*/
|
|
33284
33422
|
|
|
33285
33423
|
/**
|
|
@@ -33427,7 +33565,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33427
33565
|
/**
|
|
33428
33566
|
* EmployeeEngagement service.
|
|
33429
33567
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
33430
|
-
* @version
|
|
33568
|
+
* @version 252.0.0
|
|
33431
33569
|
*/
|
|
33432
33570
|
|
|
33433
33571
|
/**
|
|
@@ -33631,7 +33769,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33631
33769
|
/**
|
|
33632
33770
|
* Events service.
|
|
33633
33771
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
33634
|
-
* @version
|
|
33772
|
+
* @version 252.0.0
|
|
33635
33773
|
*/
|
|
33636
33774
|
|
|
33637
33775
|
/**
|
|
@@ -33676,6 +33814,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33676
33814
|
);
|
|
33677
33815
|
}
|
|
33678
33816
|
|
|
33817
|
+
/**
|
|
33818
|
+
* Publish Predictive Routing Custom Kpi Attribution Batch Events
|
|
33819
|
+
*
|
|
33820
|
+
* @param {Object} body batchRequest
|
|
33821
|
+
* @param {Object} opts Optional parameters
|
|
33822
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
33823
|
+
* postEventsRoutingCustomkpiattributions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33824
|
+
*/
|
|
33825
|
+
postEventsRoutingCustomkpiattributions(body, opts) {
|
|
33826
|
+
opts = opts || {};
|
|
33827
|
+
|
|
33828
|
+
// verify the required parameter 'body' is set
|
|
33829
|
+
if (body === undefined || body === null) {
|
|
33830
|
+
throw 'Missing the required parameter "body" when calling postEventsRoutingCustomkpiattributions';
|
|
33831
|
+
}
|
|
33832
|
+
|
|
33833
|
+
return this.apiClient.callApi(
|
|
33834
|
+
'/api/v2/events/routing/customkpiattributions',
|
|
33835
|
+
'POST',
|
|
33836
|
+
{ },
|
|
33837
|
+
{ },
|
|
33838
|
+
{ },
|
|
33839
|
+
{ },
|
|
33840
|
+
body,
|
|
33841
|
+
['PureCloud OAuth'],
|
|
33842
|
+
['application/json'],
|
|
33843
|
+
['application/json'],
|
|
33844
|
+
opts['customHeaders']
|
|
33845
|
+
);
|
|
33846
|
+
}
|
|
33847
|
+
|
|
33679
33848
|
/**
|
|
33680
33849
|
* Publish User Presence Status Batch Events
|
|
33681
33850
|
*
|
|
@@ -33742,7 +33911,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33742
33911
|
/**
|
|
33743
33912
|
* ExternalContacts service.
|
|
33744
33913
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
33745
|
-
* @version
|
|
33914
|
+
* @version 252.0.0
|
|
33746
33915
|
*/
|
|
33747
33916
|
|
|
33748
33917
|
/**
|
|
@@ -37513,7 +37682,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37513
37682
|
/**
|
|
37514
37683
|
* Fax service.
|
|
37515
37684
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
37516
|
-
* @version
|
|
37685
|
+
* @version 252.0.0
|
|
37517
37686
|
*/
|
|
37518
37687
|
|
|
37519
37688
|
/**
|
|
@@ -37762,7 +37931,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37762
37931
|
/**
|
|
37763
37932
|
* Flows service.
|
|
37764
37933
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
37765
|
-
* @version
|
|
37934
|
+
* @version 252.0.0
|
|
37766
37935
|
*/
|
|
37767
37936
|
|
|
37768
37937
|
/**
|
|
@@ -38000,7 +38169,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38000
38169
|
/**
|
|
38001
38170
|
* Gamification service.
|
|
38002
38171
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
38003
|
-
* @version
|
|
38172
|
+
* @version 252.0.0
|
|
38004
38173
|
*/
|
|
38005
38174
|
|
|
38006
38175
|
/**
|
|
@@ -40852,7 +41021,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40852
41021
|
/**
|
|
40853
41022
|
* GeneralDataProtectionRegulation service.
|
|
40854
41023
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
40855
|
-
* @version
|
|
41024
|
+
* @version 252.0.0
|
|
40856
41025
|
*/
|
|
40857
41026
|
|
|
40858
41027
|
/**
|
|
@@ -40996,7 +41165,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40996
41165
|
/**
|
|
40997
41166
|
* Geolocation service.
|
|
40998
41167
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
40999
|
-
* @version
|
|
41168
|
+
* @version 252.0.0
|
|
41000
41169
|
*/
|
|
41001
41170
|
|
|
41002
41171
|
/**
|
|
@@ -41147,7 +41316,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41147
41316
|
/**
|
|
41148
41317
|
* Greetings service.
|
|
41149
41318
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
41150
|
-
* @version
|
|
41319
|
+
* @version 252.0.0
|
|
41151
41320
|
*/
|
|
41152
41321
|
|
|
41153
41322
|
/**
|
|
@@ -41763,7 +41932,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41763
41932
|
/**
|
|
41764
41933
|
* Groups service.
|
|
41765
41934
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
41766
|
-
* @version
|
|
41935
|
+
* @version 252.0.0
|
|
41767
41936
|
*/
|
|
41768
41937
|
|
|
41769
41938
|
/**
|
|
@@ -42354,7 +42523,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42354
42523
|
/**
|
|
42355
42524
|
* IdentityProvider service.
|
|
42356
42525
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
42357
|
-
* @version
|
|
42526
|
+
* @version 252.0.0
|
|
42358
42527
|
*/
|
|
42359
42528
|
|
|
42360
42529
|
/**
|
|
@@ -43405,7 +43574,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43405
43574
|
/**
|
|
43406
43575
|
* InfrastructureAsCode service.
|
|
43407
43576
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
43408
|
-
* @version
|
|
43577
|
+
* @version 252.0.0
|
|
43409
43578
|
*/
|
|
43410
43579
|
|
|
43411
43580
|
/**
|
|
@@ -43585,7 +43754,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43585
43754
|
/**
|
|
43586
43755
|
* Integrations service.
|
|
43587
43756
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
43588
|
-
* @version
|
|
43757
|
+
* @version 252.0.0
|
|
43589
43758
|
*/
|
|
43590
43759
|
|
|
43591
43760
|
/**
|
|
@@ -46557,7 +46726,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46557
46726
|
/**
|
|
46558
46727
|
* Intents service.
|
|
46559
46728
|
* @module purecloud-platform-client-v2/api/IntentsApi
|
|
46560
|
-
* @version
|
|
46729
|
+
* @version 252.0.0
|
|
46561
46730
|
*/
|
|
46562
46731
|
|
|
46563
46732
|
/**
|
|
@@ -47089,7 +47258,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47089
47258
|
/**
|
|
47090
47259
|
* Journey service.
|
|
47091
47260
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
47092
|
-
* @version
|
|
47261
|
+
* @version 252.0.0
|
|
47093
47262
|
*/
|
|
47094
47263
|
|
|
47095
47264
|
/**
|
|
@@ -47257,11 +47426,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47257
47426
|
}
|
|
47258
47427
|
|
|
47259
47428
|
/**
|
|
47260
|
-
* Delete an outcome.
|
|
47261
|
-
*
|
|
47429
|
+
* Deprecated. Delete an outcome.
|
|
47430
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
47262
47431
|
* @param {String} outcomeId ID of the outcome.
|
|
47263
47432
|
* @param {Object} opts Optional parameters
|
|
47264
47433
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47434
|
+
* @deprecated
|
|
47265
47435
|
*/
|
|
47266
47436
|
deleteJourneyOutcome(outcomeId, opts) {
|
|
47267
47437
|
opts = opts || {};
|
|
@@ -47287,11 +47457,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47287
47457
|
}
|
|
47288
47458
|
|
|
47289
47459
|
/**
|
|
47290
|
-
* Delete an outcome predictor.
|
|
47291
|
-
*
|
|
47460
|
+
* Deprecated. Delete an outcome predictor.
|
|
47461
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
47292
47462
|
* @param {String} predictorId ID of predictor
|
|
47293
47463
|
* @param {Object} opts Optional parameters
|
|
47294
47464
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47465
|
+
* @deprecated
|
|
47295
47466
|
*/
|
|
47296
47467
|
deleteJourneyOutcomesPredictor(predictorId, opts) {
|
|
47297
47468
|
opts = opts || {};
|
|
@@ -47598,11 +47769,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47598
47769
|
}
|
|
47599
47770
|
|
|
47600
47771
|
/**
|
|
47601
|
-
* Get status of job.
|
|
47602
|
-
*
|
|
47772
|
+
* Deprecated. Get status of job.
|
|
47773
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
47603
47774
|
* @param {String} jobId ID of the job.
|
|
47604
47775
|
* @param {Object} opts Optional parameters
|
|
47605
47776
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47777
|
+
* @deprecated
|
|
47606
47778
|
*/
|
|
47607
47779
|
getJourneyActionmapsEstimatesJob(jobId, opts) {
|
|
47608
47780
|
opts = opts || {};
|
|
@@ -47628,11 +47800,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47628
47800
|
}
|
|
47629
47801
|
|
|
47630
47802
|
/**
|
|
47631
|
-
* Get estimates from completed job.
|
|
47632
|
-
*
|
|
47803
|
+
* Deprecated. Get estimates from completed job.
|
|
47804
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
47633
47805
|
* @param {String} jobId ID of the job.
|
|
47634
47806
|
* @param {Object} opts Optional parameters
|
|
47635
47807
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47808
|
+
* @deprecated
|
|
47636
47809
|
*/
|
|
47637
47810
|
getJourneyActionmapsEstimatesJobResults(jobId, opts) {
|
|
47638
47811
|
opts = opts || {};
|
|
@@ -48074,11 +48247,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48074
48247
|
}
|
|
48075
48248
|
|
|
48076
48249
|
/**
|
|
48077
|
-
* Retrieve a single outcome.
|
|
48078
|
-
*
|
|
48250
|
+
* Deprecated. Retrieve a single outcome.
|
|
48251
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48079
48252
|
* @param {String} outcomeId ID of the outcome.
|
|
48080
48253
|
* @param {Object} opts Optional parameters
|
|
48081
48254
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48255
|
+
* @deprecated
|
|
48082
48256
|
*/
|
|
48083
48257
|
getJourneyOutcome(outcomeId, opts) {
|
|
48084
48258
|
opts = opts || {};
|
|
@@ -48104,8 +48278,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48104
48278
|
}
|
|
48105
48279
|
|
|
48106
48280
|
/**
|
|
48107
|
-
* Retrieve all outcomes.
|
|
48108
|
-
*
|
|
48281
|
+
* Deprecated. Retrieve all outcomes.
|
|
48282
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48109
48283
|
* @param {Object} opts Optional parameters
|
|
48110
48284
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
48111
48285
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
@@ -48114,6 +48288,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48114
48288
|
* @param {Array.<String>} opts.queryFields Outcome field(s) to query on. Requires 'queryValue' to also be set.
|
|
48115
48289
|
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
48116
48290
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48291
|
+
* @deprecated
|
|
48117
48292
|
*/
|
|
48118
48293
|
getJourneyOutcomes(opts) {
|
|
48119
48294
|
opts = opts || {};
|
|
@@ -48135,11 +48310,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48135
48310
|
}
|
|
48136
48311
|
|
|
48137
48312
|
/**
|
|
48138
|
-
* Get job status.
|
|
48139
|
-
*
|
|
48313
|
+
* Deprecated. Get job status.
|
|
48314
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48140
48315
|
* @param {String} jobId ID of the job.
|
|
48141
48316
|
* @param {Object} opts Optional parameters
|
|
48142
48317
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48318
|
+
* @deprecated
|
|
48143
48319
|
* getJourneyOutcomesAttributionsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48144
48320
|
*/
|
|
48145
48321
|
getJourneyOutcomesAttributionsJob(jobId, opts) {
|
|
@@ -48166,11 +48342,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48166
48342
|
}
|
|
48167
48343
|
|
|
48168
48344
|
/**
|
|
48169
|
-
* Get outcome attribution entities from completed job.
|
|
48170
|
-
*
|
|
48345
|
+
* Deprecated. Get outcome attribution entities from completed job.
|
|
48346
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48171
48347
|
* @param {String} jobId ID of the job.
|
|
48172
48348
|
* @param {Object} opts Optional parameters
|
|
48173
48349
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48350
|
+
* @deprecated
|
|
48174
48351
|
* getJourneyOutcomesAttributionsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48175
48352
|
*/
|
|
48176
48353
|
getJourneyOutcomesAttributionsJobResults(jobId, opts) {
|
|
@@ -48197,11 +48374,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48197
48374
|
}
|
|
48198
48375
|
|
|
48199
48376
|
/**
|
|
48200
|
-
* Retrieve a single outcome predictor.
|
|
48201
|
-
*
|
|
48377
|
+
* Deprecated. Retrieve a single outcome predictor.
|
|
48378
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48202
48379
|
* @param {String} predictorId ID of predictor
|
|
48203
48380
|
* @param {Object} opts Optional parameters
|
|
48204
48381
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48382
|
+
* @deprecated
|
|
48205
48383
|
*/
|
|
48206
48384
|
getJourneyOutcomesPredictor(predictorId, opts) {
|
|
48207
48385
|
opts = opts || {};
|
|
@@ -48227,10 +48405,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48227
48405
|
}
|
|
48228
48406
|
|
|
48229
48407
|
/**
|
|
48230
|
-
* Retrieve all outcome predictors.
|
|
48231
|
-
*
|
|
48408
|
+
* Deprecated. Retrieve all outcome predictors.
|
|
48409
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48232
48410
|
* @param {Object} opts Optional parameters
|
|
48233
48411
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48412
|
+
* @deprecated
|
|
48234
48413
|
*/
|
|
48235
48414
|
getJourneyOutcomesPredictors(opts) {
|
|
48236
48415
|
opts = opts || {};
|
|
@@ -48377,11 +48556,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48377
48556
|
}
|
|
48378
48557
|
|
|
48379
48558
|
/**
|
|
48380
|
-
* Retrieve latest outcome score associated with a session for all outcomes.
|
|
48381
|
-
*
|
|
48559
|
+
* Deprecated. Retrieve latest outcome score associated with a session for all outcomes.
|
|
48560
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
48382
48561
|
* @param {String} sessionId ID of the session.
|
|
48383
48562
|
* @param {Object} opts Optional parameters
|
|
48384
48563
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48564
|
+
* @deprecated
|
|
48385
48565
|
*/
|
|
48386
48566
|
getJourneySessionOutcomescores(sessionId, opts) {
|
|
48387
48567
|
opts = opts || {};
|
|
@@ -49066,12 +49246,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49066
49246
|
}
|
|
49067
49247
|
|
|
49068
49248
|
/**
|
|
49069
|
-
* Update an outcome.
|
|
49070
|
-
*
|
|
49249
|
+
* Deprecated. Update an outcome.
|
|
49250
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
49071
49251
|
* @param {String} outcomeId ID of the outcome.
|
|
49072
49252
|
* @param {Object} opts Optional parameters
|
|
49073
49253
|
* @param {Object} opts.body
|
|
49074
49254
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49255
|
+
* @deprecated
|
|
49075
49256
|
*/
|
|
49076
49257
|
patchJourneyOutcome(outcomeId, opts) {
|
|
49077
49258
|
opts = opts || {};
|
|
@@ -49291,11 +49472,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49291
49472
|
}
|
|
49292
49473
|
|
|
49293
49474
|
/**
|
|
49294
|
-
* Query for estimates
|
|
49295
|
-
*
|
|
49475
|
+
* Deprecated. Query for estimates
|
|
49476
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
49296
49477
|
* @param {Object} body audience estimator request
|
|
49297
49478
|
* @param {Object} opts Optional parameters
|
|
49298
49479
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49480
|
+
* @deprecated
|
|
49299
49481
|
*/
|
|
49300
49482
|
postJourneyActionmapsEstimatesJobs(body, opts) {
|
|
49301
49483
|
opts = opts || {};
|
|
@@ -49557,11 +49739,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49557
49739
|
}
|
|
49558
49740
|
|
|
49559
49741
|
/**
|
|
49560
|
-
* Create an outcome.
|
|
49561
|
-
*
|
|
49742
|
+
* Deprecated. Create an outcome.
|
|
49743
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
49562
49744
|
* @param {Object} opts Optional parameters
|
|
49563
49745
|
* @param {Object} opts.body
|
|
49564
49746
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49747
|
+
* @deprecated
|
|
49565
49748
|
*/
|
|
49566
49749
|
postJourneyOutcomes(opts) {
|
|
49567
49750
|
opts = opts || {};
|
|
@@ -49583,11 +49766,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49583
49766
|
}
|
|
49584
49767
|
|
|
49585
49768
|
/**
|
|
49586
|
-
* Create Outcome Attributions
|
|
49587
|
-
*
|
|
49769
|
+
* Deprecated. Create Outcome Attributions
|
|
49770
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
49588
49771
|
* @param {Object} opts Optional parameters
|
|
49589
49772
|
* @param {Object} opts.body outcome attribution request
|
|
49590
49773
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49774
|
+
* @deprecated
|
|
49591
49775
|
* postJourneyOutcomesAttributionsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49592
49776
|
*/
|
|
49593
49777
|
postJourneyOutcomesAttributionsJobs(opts) {
|
|
@@ -49610,11 +49794,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49610
49794
|
}
|
|
49611
49795
|
|
|
49612
49796
|
/**
|
|
49613
|
-
* Create an outcome predictor.
|
|
49614
|
-
*
|
|
49797
|
+
* Deprecated. Create an outcome predictor.
|
|
49798
|
+
* Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
|
|
49615
49799
|
* @param {Object} opts Optional parameters
|
|
49616
49800
|
* @param {Object} opts.body
|
|
49617
49801
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49802
|
+
* @deprecated
|
|
49618
49803
|
*/
|
|
49619
49804
|
postJourneyOutcomesPredictors(opts) {
|
|
49620
49805
|
opts = opts || {};
|
|
@@ -49938,7 +50123,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49938
50123
|
/**
|
|
49939
50124
|
* Knowledge service.
|
|
49940
50125
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
49941
|
-
* @version
|
|
50126
|
+
* @version 252.0.0
|
|
49942
50127
|
*/
|
|
49943
50128
|
|
|
49944
50129
|
/**
|
|
@@ -50429,6 +50614,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50429
50614
|
*
|
|
50430
50615
|
* @param {String} connectionId Connection ID
|
|
50431
50616
|
* @param {Object} opts Optional parameters
|
|
50617
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
50618
|
+
* @param {String} opts.pageSize Number of results per page. Minimum: 25, Maximum: 500. (default to 200)
|
|
50432
50619
|
* @param {String} opts.parentId The id of the parent option whose children to be listed.
|
|
50433
50620
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
50434
50621
|
*/
|
|
@@ -50444,7 +50631,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50444
50631
|
'/api/v2/knowledge/connections/{connectionId}/options',
|
|
50445
50632
|
'GET',
|
|
50446
50633
|
{ 'connectionId': connectionId },
|
|
50447
|
-
{ 'parentId': opts['parentId'] },
|
|
50634
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'parentId': opts['parentId'] },
|
|
50448
50635
|
{ },
|
|
50449
50636
|
{ },
|
|
50450
50637
|
null,
|
|
@@ -54146,7 +54333,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54146
54333
|
/**
|
|
54147
54334
|
* LanguageUnderstanding service.
|
|
54148
54335
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
54149
|
-
* @version
|
|
54336
|
+
* @version 252.0.0
|
|
54150
54337
|
*/
|
|
54151
54338
|
|
|
54152
54339
|
/**
|
|
@@ -55520,7 +55707,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55520
55707
|
/**
|
|
55521
55708
|
* Languages service.
|
|
55522
55709
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
55523
|
-
* @version
|
|
55710
|
+
* @version 252.0.0
|
|
55524
55711
|
*/
|
|
55525
55712
|
|
|
55526
55713
|
/**
|
|
@@ -55779,7 +55966,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55779
55966
|
/**
|
|
55780
55967
|
* Learning service.
|
|
55781
55968
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
55782
|
-
* @version
|
|
55969
|
+
* @version 252.0.0
|
|
55783
55970
|
*/
|
|
55784
55971
|
|
|
55785
55972
|
/**
|
|
@@ -57027,7 +57214,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57027
57214
|
/**
|
|
57028
57215
|
* License service.
|
|
57029
57216
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
57030
|
-
* @version
|
|
57217
|
+
* @version 252.0.0
|
|
57031
57218
|
*/
|
|
57032
57219
|
|
|
57033
57220
|
/**
|
|
@@ -57325,7 +57512,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57325
57512
|
/**
|
|
57326
57513
|
* Locations service.
|
|
57327
57514
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
57328
|
-
* @version
|
|
57515
|
+
* @version 252.0.0
|
|
57329
57516
|
*/
|
|
57330
57517
|
|
|
57331
57518
|
/**
|
|
@@ -57592,7 +57779,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57592
57779
|
/**
|
|
57593
57780
|
* LogCapture service.
|
|
57594
57781
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
57595
|
-
* @version
|
|
57782
|
+
* @version 252.0.0
|
|
57596
57783
|
*/
|
|
57597
57784
|
|
|
57598
57785
|
/**
|
|
@@ -57814,7 +58001,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57814
58001
|
/**
|
|
57815
58002
|
* Messaging service.
|
|
57816
58003
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
57817
|
-
* @version
|
|
58004
|
+
* @version 252.0.0
|
|
57818
58005
|
*/
|
|
57819
58006
|
|
|
57820
58007
|
/**
|
|
@@ -58232,7 +58419,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58232
58419
|
/**
|
|
58233
58420
|
* MobileDevices service.
|
|
58234
58421
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
58235
|
-
* @version
|
|
58422
|
+
* @version 252.0.0
|
|
58236
58423
|
*/
|
|
58237
58424
|
|
|
58238
58425
|
/**
|
|
@@ -58402,7 +58589,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58402
58589
|
/**
|
|
58403
58590
|
* Notifications service.
|
|
58404
58591
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
58405
|
-
* @version
|
|
58592
|
+
* @version 252.0.0
|
|
58406
58593
|
*/
|
|
58407
58594
|
|
|
58408
58595
|
/**
|
|
@@ -58663,7 +58850,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58663
58850
|
/**
|
|
58664
58851
|
* OAuth service.
|
|
58665
58852
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
58666
|
-
* @version
|
|
58853
|
+
* @version 252.0.0
|
|
58667
58854
|
*/
|
|
58668
58855
|
|
|
58669
58856
|
/**
|
|
@@ -59079,7 +59266,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59079
59266
|
/**
|
|
59080
59267
|
* Objects service.
|
|
59081
59268
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
59082
|
-
* @version
|
|
59269
|
+
* @version 252.0.0
|
|
59083
59270
|
*/
|
|
59084
59271
|
|
|
59085
59272
|
/**
|
|
@@ -59443,7 +59630,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59443
59630
|
/**
|
|
59444
59631
|
* OperationalEvents service.
|
|
59445
59632
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
59446
|
-
* @version
|
|
59633
|
+
* @version 252.0.0
|
|
59447
59634
|
*/
|
|
59448
59635
|
|
|
59449
59636
|
/**
|
|
@@ -59574,7 +59761,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59574
59761
|
/**
|
|
59575
59762
|
* Organization service.
|
|
59576
59763
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
59577
|
-
* @version
|
|
59764
|
+
* @version 252.0.0
|
|
59578
59765
|
*/
|
|
59579
59766
|
|
|
59580
59767
|
/**
|
|
@@ -60135,7 +60322,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60135
60322
|
/**
|
|
60136
60323
|
* OrganizationAuthorization service.
|
|
60137
60324
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
60138
|
-
* @version
|
|
60325
|
+
* @version 252.0.0
|
|
60139
60326
|
*/
|
|
60140
60327
|
|
|
60141
60328
|
/**
|
|
@@ -61739,7 +61926,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61739
61926
|
/**
|
|
61740
61927
|
* Outbound service.
|
|
61741
61928
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
61742
|
-
* @version
|
|
61929
|
+
* @version 252.0.0
|
|
61743
61930
|
*/
|
|
61744
61931
|
|
|
61745
61932
|
/**
|
|
@@ -67326,7 +67513,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67326
67513
|
/**
|
|
67327
67514
|
* Presence service.
|
|
67328
67515
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
67329
|
-
* @version
|
|
67516
|
+
* @version 252.0.0
|
|
67330
67517
|
*/
|
|
67331
67518
|
|
|
67332
67519
|
/**
|
|
@@ -68184,7 +68371,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68184
68371
|
/**
|
|
68185
68372
|
* ProcessAutomation service.
|
|
68186
68373
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
68187
|
-
* @version
|
|
68374
|
+
* @version 252.0.0
|
|
68188
68375
|
*/
|
|
68189
68376
|
|
|
68190
68377
|
/**
|
|
@@ -68605,7 +68792,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68605
68792
|
/**
|
|
68606
68793
|
* Quality service.
|
|
68607
68794
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
68608
|
-
* @version
|
|
68795
|
+
* @version 252.0.0
|
|
68609
68796
|
*/
|
|
68610
68797
|
|
|
68611
68798
|
/**
|
|
@@ -70963,7 +71150,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70963
71150
|
/**
|
|
70964
71151
|
* Recording service.
|
|
70965
71152
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
70966
|
-
* @version
|
|
71153
|
+
* @version 252.0.0
|
|
70967
71154
|
*/
|
|
70968
71155
|
|
|
70969
71156
|
/**
|
|
@@ -72811,7 +72998,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72811
72998
|
/**
|
|
72812
72999
|
* ResponseManagement service.
|
|
72813
73000
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
72814
|
-
* @version
|
|
73001
|
+
* @version 252.0.0
|
|
72815
73002
|
*/
|
|
72816
73003
|
|
|
72817
73004
|
/**
|
|
@@ -73455,7 +73642,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73455
73642
|
/**
|
|
73456
73643
|
* Routing service.
|
|
73457
73644
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
73458
|
-
* @version
|
|
73645
|
+
* @version 252.0.0
|
|
73459
73646
|
*/
|
|
73460
73647
|
|
|
73461
73648
|
/**
|
|
@@ -78842,7 +79029,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78842
79029
|
/**
|
|
78843
79030
|
* SCIM service.
|
|
78844
79031
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
78845
|
-
* @version
|
|
79032
|
+
* @version 252.0.0
|
|
78846
79033
|
*/
|
|
78847
79034
|
|
|
78848
79035
|
/**
|
|
@@ -79803,7 +79990,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79803
79990
|
/**
|
|
79804
79991
|
* Scripts service.
|
|
79805
79992
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
79806
|
-
* @version
|
|
79993
|
+
* @version 252.0.0
|
|
79807
79994
|
*/
|
|
79808
79995
|
|
|
79809
79996
|
/**
|
|
@@ -80312,7 +80499,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80312
80499
|
/**
|
|
80313
80500
|
* Search service.
|
|
80314
80501
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
80315
|
-
* @version
|
|
80502
|
+
* @version 252.0.0
|
|
80316
80503
|
*/
|
|
80317
80504
|
|
|
80318
80505
|
/**
|
|
@@ -81128,7 +81315,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81128
81315
|
/**
|
|
81129
81316
|
* Settings service.
|
|
81130
81317
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
81131
|
-
* @version
|
|
81318
|
+
* @version 252.0.0
|
|
81132
81319
|
*/
|
|
81133
81320
|
|
|
81134
81321
|
/**
|
|
@@ -81537,7 +81724,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81537
81724
|
/**
|
|
81538
81725
|
* SocialMedia service.
|
|
81539
81726
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
81540
|
-
* @version
|
|
81727
|
+
* @version 252.0.0
|
|
81541
81728
|
*/
|
|
81542
81729
|
|
|
81543
81730
|
/**
|
|
@@ -83522,7 +83709,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83522
83709
|
/**
|
|
83523
83710
|
* SpeechTextAnalytics service.
|
|
83524
83711
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
83525
|
-
* @version
|
|
83712
|
+
* @version 252.0.0
|
|
83526
83713
|
*/
|
|
83527
83714
|
|
|
83528
83715
|
/**
|
|
@@ -85474,7 +85661,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85474
85661
|
/**
|
|
85475
85662
|
* Stations service.
|
|
85476
85663
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
85477
|
-
* @version
|
|
85664
|
+
* @version 252.0.0
|
|
85478
85665
|
*/
|
|
85479
85666
|
|
|
85480
85667
|
/**
|
|
@@ -85588,7 +85775,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85588
85775
|
/**
|
|
85589
85776
|
* Suggest service.
|
|
85590
85777
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
85591
|
-
* @version
|
|
85778
|
+
* @version 252.0.0
|
|
85592
85779
|
*/
|
|
85593
85780
|
|
|
85594
85781
|
/**
|
|
@@ -85735,7 +85922,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85735
85922
|
/**
|
|
85736
85923
|
* TaskManagement service.
|
|
85737
85924
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
85738
|
-
* @version
|
|
85925
|
+
* @version 252.0.0
|
|
85739
85926
|
*/
|
|
85740
85927
|
|
|
85741
85928
|
/**
|
|
@@ -88162,7 +88349,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88162
88349
|
|
|
88163
88350
|
/**
|
|
88164
88351
|
* Query for worktypes
|
|
88165
|
-
*
|
|
88352
|
+
* Optional request field expands may include schema to populate the name on each worktypes schema reference.
|
|
88166
88353
|
* @param {Object} body QueryPostRequest
|
|
88167
88354
|
* @param {Object} opts Optional parameters
|
|
88168
88355
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
@@ -88231,7 +88418,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88231
88418
|
/**
|
|
88232
88419
|
* Teams service.
|
|
88233
88420
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
88234
|
-
* @version
|
|
88421
|
+
* @version 252.0.0
|
|
88235
88422
|
*/
|
|
88236
88423
|
|
|
88237
88424
|
/**
|
|
@@ -88574,7 +88761,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88574
88761
|
/**
|
|
88575
88762
|
* Telephony service.
|
|
88576
88763
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
88577
|
-
* @version
|
|
88764
|
+
* @version 252.0.0
|
|
88578
88765
|
*/
|
|
88579
88766
|
|
|
88580
88767
|
/**
|
|
@@ -88981,7 +89168,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88981
89168
|
/**
|
|
88982
89169
|
* TelephonyProvidersEdge service.
|
|
88983
89170
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
88984
|
-
* @version
|
|
89171
|
+
* @version 252.0.0
|
|
88985
89172
|
*/
|
|
88986
89173
|
|
|
88987
89174
|
/**
|
|
@@ -93005,7 +93192,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93005
93192
|
/**
|
|
93006
93193
|
* Textbots service.
|
|
93007
93194
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
93008
|
-
* @version
|
|
93195
|
+
* @version 252.0.0
|
|
93009
93196
|
*/
|
|
93010
93197
|
|
|
93011
93198
|
/**
|
|
@@ -93151,7 +93338,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93151
93338
|
/**
|
|
93152
93339
|
* Tokens service.
|
|
93153
93340
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
93154
|
-
* @version
|
|
93341
|
+
* @version 252.0.0
|
|
93155
93342
|
*/
|
|
93156
93343
|
|
|
93157
93344
|
/**
|
|
@@ -93329,7 +93516,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93329
93516
|
/**
|
|
93330
93517
|
* Uploads service.
|
|
93331
93518
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
93332
|
-
* @version
|
|
93519
|
+
* @version 252.0.0
|
|
93333
93520
|
*/
|
|
93334
93521
|
|
|
93335
93522
|
/**
|
|
@@ -93700,7 +93887,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93700
93887
|
/**
|
|
93701
93888
|
* Usage service.
|
|
93702
93889
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
93703
|
-
* @version
|
|
93890
|
+
* @version 252.0.0
|
|
93704
93891
|
*/
|
|
93705
93892
|
|
|
93706
93893
|
/**
|
|
@@ -94078,7 +94265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94078
94265
|
/**
|
|
94079
94266
|
* UserRecordings service.
|
|
94080
94267
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
94081
|
-
* @version
|
|
94268
|
+
* @version 252.0.0
|
|
94082
94269
|
*/
|
|
94083
94270
|
|
|
94084
94271
|
/**
|
|
@@ -94280,7 +94467,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94280
94467
|
/**
|
|
94281
94468
|
* Users service.
|
|
94282
94469
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
94283
|
-
* @version
|
|
94470
|
+
* @version 252.0.0
|
|
94284
94471
|
*/
|
|
94285
94472
|
|
|
94286
94473
|
/**
|
|
@@ -94781,6 +94968,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94781
94968
|
);
|
|
94782
94969
|
}
|
|
94783
94970
|
|
|
94971
|
+
/**
|
|
94972
|
+
* Clear self associated station
|
|
94973
|
+
*
|
|
94974
|
+
* @param {Object} opts Optional parameters
|
|
94975
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
94976
|
+
*/
|
|
94977
|
+
deleteUsersStationsMeAssociatedstation(opts) {
|
|
94978
|
+
opts = opts || {};
|
|
94979
|
+
|
|
94980
|
+
|
|
94981
|
+
return this.apiClient.callApi(
|
|
94982
|
+
'/api/v2/users/stations/me/associatedstation',
|
|
94983
|
+
'DELETE',
|
|
94984
|
+
{ },
|
|
94985
|
+
{ },
|
|
94986
|
+
{ },
|
|
94987
|
+
{ },
|
|
94988
|
+
null,
|
|
94989
|
+
['PureCloud OAuth'],
|
|
94990
|
+
['application/json'],
|
|
94991
|
+
['application/json'],
|
|
94992
|
+
opts['customHeaders']
|
|
94993
|
+
);
|
|
94994
|
+
}
|
|
94995
|
+
|
|
94784
94996
|
/**
|
|
94785
94997
|
* Get status for async query for user aggregates
|
|
94786
94998
|
*
|
|
@@ -96049,6 +96261,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
96049
96261
|
* @param {Object} opts Optional parameters
|
|
96050
96262
|
* @param {Boolean} opts.excludeClosed Whether or not to exclude closed chats
|
|
96051
96263
|
* @param {Boolean} opts.includePresence Whether or not to include user presence
|
|
96264
|
+
* @param {Boolean} opts.includeRoomOwners Whether or not to include room owners
|
|
96052
96265
|
* @param {String} opts.after The key to start after
|
|
96053
96266
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
96054
96267
|
*/
|
|
@@ -96060,7 +96273,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
96060
96273
|
'/api/v2/users/chats/me',
|
|
96061
96274
|
'GET',
|
|
96062
96275
|
{ },
|
|
96063
|
-
{ 'excludeClosed': opts['excludeClosed'],'includePresence': opts['includePresence'],'after': opts['after'] },
|
|
96276
|
+
{ 'excludeClosed': opts['excludeClosed'],'includePresence': opts['includePresence'],'includeRoomOwners': opts['includeRoomOwners'],'after': opts['after'] },
|
|
96064
96277
|
{ },
|
|
96065
96278
|
{ },
|
|
96066
96279
|
null,
|
|
@@ -96455,7 +96668,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
96455
96668
|
* @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
96669
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
96457
96670
|
* @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
96671
|
*/
|
|
96460
96672
|
getUsersQuery(opts) {
|
|
96461
96673
|
opts = opts || {};
|
|
@@ -96508,6 +96720,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
96508
96720
|
);
|
|
96509
96721
|
}
|
|
96510
96722
|
|
|
96723
|
+
/**
|
|
96724
|
+
* Get station information for self
|
|
96725
|
+
*
|
|
96726
|
+
* @param {Object} opts Optional parameters
|
|
96727
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
96728
|
+
*/
|
|
96729
|
+
getUsersStationsMe(opts) {
|
|
96730
|
+
opts = opts || {};
|
|
96731
|
+
|
|
96732
|
+
|
|
96733
|
+
return this.apiClient.callApi(
|
|
96734
|
+
'/api/v2/users/stations/me',
|
|
96735
|
+
'GET',
|
|
96736
|
+
{ },
|
|
96737
|
+
{ },
|
|
96738
|
+
{ },
|
|
96739
|
+
{ },
|
|
96740
|
+
null,
|
|
96741
|
+
['PureCloud OAuth'],
|
|
96742
|
+
['application/json'],
|
|
96743
|
+
['application/json'],
|
|
96744
|
+
opts['customHeaders']
|
|
96745
|
+
);
|
|
96746
|
+
}
|
|
96747
|
+
|
|
96511
96748
|
/**
|
|
96512
96749
|
* Update user
|
|
96513
96750
|
*
|
|
@@ -98213,13 +98450,43 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
98213
98450
|
);
|
|
98214
98451
|
}
|
|
98215
98452
|
|
|
98453
|
+
/**
|
|
98454
|
+
* Set self associated station
|
|
98455
|
+
*
|
|
98456
|
+
* @param {String} stationId stationId
|
|
98457
|
+
* @param {Object} opts Optional parameters
|
|
98458
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
98459
|
+
*/
|
|
98460
|
+
putUsersStationsMeAssociatedstationStationId(stationId, opts) {
|
|
98461
|
+
opts = opts || {};
|
|
98462
|
+
|
|
98463
|
+
// verify the required parameter 'stationId' is set
|
|
98464
|
+
if (stationId === undefined || stationId === null || stationId === '') {
|
|
98465
|
+
throw 'Missing the required parameter "stationId" when calling putUsersStationsMeAssociatedstationStationId';
|
|
98466
|
+
}
|
|
98467
|
+
|
|
98468
|
+
return this.apiClient.callApi(
|
|
98469
|
+
'/api/v2/users/stations/me/associatedstation/{stationId}',
|
|
98470
|
+
'PUT',
|
|
98471
|
+
{ 'stationId': stationId },
|
|
98472
|
+
{ },
|
|
98473
|
+
{ },
|
|
98474
|
+
{ },
|
|
98475
|
+
null,
|
|
98476
|
+
['PureCloud OAuth'],
|
|
98477
|
+
['application/json'],
|
|
98478
|
+
['application/json'],
|
|
98479
|
+
opts['customHeaders']
|
|
98480
|
+
);
|
|
98481
|
+
}
|
|
98482
|
+
|
|
98216
98483
|
}
|
|
98217
98484
|
|
|
98218
98485
|
class UsersRulesApi {
|
|
98219
98486
|
/**
|
|
98220
98487
|
* UsersRules service.
|
|
98221
98488
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
98222
|
-
* @version
|
|
98489
|
+
* @version 252.0.0
|
|
98223
98490
|
*/
|
|
98224
98491
|
|
|
98225
98492
|
/**
|
|
@@ -98536,7 +98803,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
98536
98803
|
/**
|
|
98537
98804
|
* Utilities service.
|
|
98538
98805
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
98539
|
-
* @version
|
|
98806
|
+
* @version 252.0.0
|
|
98540
98807
|
*/
|
|
98541
98808
|
|
|
98542
98809
|
/**
|
|
@@ -98664,7 +98931,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
98664
98931
|
/**
|
|
98665
98932
|
* Voicemail service.
|
|
98666
98933
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
98667
|
-
* @version
|
|
98934
|
+
* @version 252.0.0
|
|
98668
98935
|
*/
|
|
98669
98936
|
|
|
98670
98937
|
/**
|
|
@@ -99494,7 +99761,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
99494
99761
|
/**
|
|
99495
99762
|
* WebChat service.
|
|
99496
99763
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
99497
|
-
* @version
|
|
99764
|
+
* @version 252.0.0
|
|
99498
99765
|
*/
|
|
99499
99766
|
|
|
99500
99767
|
/**
|
|
@@ -100146,7 +100413,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
100146
100413
|
/**
|
|
100147
100414
|
* WebDeployments service.
|
|
100148
100415
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
100149
|
-
* @version
|
|
100416
|
+
* @version 252.0.0
|
|
100150
100417
|
*/
|
|
100151
100418
|
|
|
100152
100419
|
/**
|
|
@@ -100824,7 +101091,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
100824
101091
|
/**
|
|
100825
101092
|
* WebMessaging service.
|
|
100826
101093
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
100827
|
-
* @version
|
|
101094
|
+
* @version 252.0.0
|
|
100828
101095
|
*/
|
|
100829
101096
|
|
|
100830
101097
|
/**
|
|
@@ -100987,7 +101254,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
100987
101254
|
/**
|
|
100988
101255
|
* Widgets service.
|
|
100989
101256
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
100990
|
-
* @version
|
|
101257
|
+
* @version 252.0.0
|
|
100991
101258
|
*/
|
|
100992
101259
|
|
|
100993
101260
|
/**
|
|
@@ -101163,7 +101430,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
101163
101430
|
/**
|
|
101164
101431
|
* WorkforceManagement service.
|
|
101165
101432
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
101166
|
-
* @version
|
|
101433
|
+
* @version 252.0.0
|
|
101167
101434
|
*/
|
|
101168
101435
|
|
|
101169
101436
|
/**
|
|
@@ -111499,7 +111766,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
111499
111766
|
* </pre>
|
|
111500
111767
|
* </p>
|
|
111501
111768
|
* @module purecloud-platform-client-v2/index
|
|
111502
|
-
* @version
|
|
111769
|
+
* @version 252.0.0
|
|
111503
111770
|
*/
|
|
111504
111771
|
class platformClient {
|
|
111505
111772
|
constructor() {
|