purecloud-platform-client-v2 169.1.0 → 170.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 +6 -4
- package/dist/node/purecloud-platform-client-v2.js +774 -365
- package/dist/web-amd/purecloud-platform-client-v2.js +774 -365
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +774 -365
- package/dist/web-cjs/purecloud-platform-client-v2.js +774 -365
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +211 -35
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +44 -44
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +6 -4
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +362 -7
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +5 -5
- 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 +9 -9
- 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 +41 -11
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +9 -45
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +30 -29
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +5 -5
- 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/MessagingApi.js +6 -6
- 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/OrganizationApi.js +8 -8
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +69 -16
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +16 -16
- 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 +13 -13
- 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 +5 -5
- 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 +50 -46
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +3 -3
- 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 +13 -13
- 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 +6 -6
- 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 +6 -6
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -9336,7 +9336,7 @@ class Configuration {
|
|
|
9336
9336
|
|
|
9337
9337
|
/**
|
|
9338
9338
|
* @module purecloud-platform-client-v2/ApiClient
|
|
9339
|
-
* @version
|
|
9339
|
+
* @version 170.0.0
|
|
9340
9340
|
*/
|
|
9341
9341
|
class ApiClient {
|
|
9342
9342
|
/**
|
|
@@ -10415,7 +10415,7 @@ class AlertingApi {
|
|
|
10415
10415
|
/**
|
|
10416
10416
|
* Alerting service.
|
|
10417
10417
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
10418
|
-
* @version
|
|
10418
|
+
* @version 170.0.0
|
|
10419
10419
|
*/
|
|
10420
10420
|
|
|
10421
10421
|
/**
|
|
@@ -10729,7 +10729,7 @@ class AnalyticsApi {
|
|
|
10729
10729
|
/**
|
|
10730
10730
|
* Analytics service.
|
|
10731
10731
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
10732
|
-
* @version
|
|
10732
|
+
* @version 170.0.0
|
|
10733
10733
|
*/
|
|
10734
10734
|
|
|
10735
10735
|
/**
|
|
@@ -10823,7 +10823,7 @@ class AnalyticsApi {
|
|
|
10823
10823
|
* Get status for async query for action aggregates
|
|
10824
10824
|
*
|
|
10825
10825
|
* @param {String} jobId jobId
|
|
10826
|
-
*
|
|
10826
|
+
* getAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10827
10827
|
*/
|
|
10828
10828
|
getAnalyticsActionsAggregatesJob(jobId) {
|
|
10829
10829
|
// verify the required parameter 'jobId' is set
|
|
@@ -10851,7 +10851,7 @@ class AnalyticsApi {
|
|
|
10851
10851
|
* @param {String} jobId jobId
|
|
10852
10852
|
* @param {Object} opts Optional parameters
|
|
10853
10853
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
10854
|
-
*
|
|
10854
|
+
* getAnalyticsActionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10855
10855
|
*/
|
|
10856
10856
|
getAnalyticsActionsAggregatesJobResults(jobId, opts) {
|
|
10857
10857
|
opts = opts || {};
|
|
@@ -10913,7 +10913,7 @@ class AnalyticsApi {
|
|
|
10913
10913
|
* Get status for async query for bot aggregates
|
|
10914
10914
|
*
|
|
10915
10915
|
* @param {String} jobId jobId
|
|
10916
|
-
*
|
|
10916
|
+
* getAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10917
10917
|
*/
|
|
10918
10918
|
getAnalyticsBotsAggregatesJob(jobId) {
|
|
10919
10919
|
// verify the required parameter 'jobId' is set
|
|
@@ -10941,7 +10941,7 @@ class AnalyticsApi {
|
|
|
10941
10941
|
* @param {String} jobId jobId
|
|
10942
10942
|
* @param {Object} opts Optional parameters
|
|
10943
10943
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
10944
|
-
*
|
|
10944
|
+
* getAnalyticsBotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10945
10945
|
*/
|
|
10946
10946
|
getAnalyticsBotsAggregatesJobResults(jobId, opts) {
|
|
10947
10947
|
opts = opts || {};
|
|
@@ -10994,7 +10994,7 @@ class AnalyticsApi {
|
|
|
10994
10994
|
* Get status for async query for conversation aggregates
|
|
10995
10995
|
*
|
|
10996
10996
|
* @param {String} jobId jobId
|
|
10997
|
-
*
|
|
10997
|
+
* getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10998
10998
|
*/
|
|
10999
10999
|
getAnalyticsConversationsAggregatesJob(jobId) {
|
|
11000
11000
|
// verify the required parameter 'jobId' is set
|
|
@@ -11022,7 +11022,7 @@ class AnalyticsApi {
|
|
|
11022
11022
|
* @param {String} jobId jobId
|
|
11023
11023
|
* @param {Object} opts Optional parameters
|
|
11024
11024
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
11025
|
-
*
|
|
11025
|
+
* getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11026
11026
|
*/
|
|
11027
11027
|
getAnalyticsConversationsAggregatesJobResults(jobId, opts) {
|
|
11028
11028
|
opts = opts || {};
|
|
@@ -11169,7 +11169,7 @@ class AnalyticsApi {
|
|
|
11169
11169
|
* Get status for async query for evaluation aggregates
|
|
11170
11170
|
*
|
|
11171
11171
|
* @param {String} jobId jobId
|
|
11172
|
-
*
|
|
11172
|
+
* getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11173
11173
|
*/
|
|
11174
11174
|
getAnalyticsEvaluationsAggregatesJob(jobId) {
|
|
11175
11175
|
// verify the required parameter 'jobId' is set
|
|
@@ -11197,7 +11197,7 @@ class AnalyticsApi {
|
|
|
11197
11197
|
* @param {String} jobId jobId
|
|
11198
11198
|
* @param {Object} opts Optional parameters
|
|
11199
11199
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
11200
|
-
*
|
|
11200
|
+
* getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11201
11201
|
*/
|
|
11202
11202
|
getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) {
|
|
11203
11203
|
opts = opts || {};
|
|
@@ -11225,7 +11225,7 @@ class AnalyticsApi {
|
|
|
11225
11225
|
* Get status for async query for Flow aggregates
|
|
11226
11226
|
*
|
|
11227
11227
|
* @param {String} jobId jobId
|
|
11228
|
-
*
|
|
11228
|
+
* getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11229
11229
|
*/
|
|
11230
11230
|
getAnalyticsFlowsAggregatesJob(jobId) {
|
|
11231
11231
|
// verify the required parameter 'jobId' is set
|
|
@@ -11253,7 +11253,7 @@ class AnalyticsApi {
|
|
|
11253
11253
|
* @param {String} jobId jobId
|
|
11254
11254
|
* @param {Object} opts Optional parameters
|
|
11255
11255
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
11256
|
-
*
|
|
11256
|
+
* getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11257
11257
|
*/
|
|
11258
11258
|
getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
|
|
11259
11259
|
opts = opts || {};
|
|
@@ -11281,7 +11281,7 @@ class AnalyticsApi {
|
|
|
11281
11281
|
* Get status for async query for journey aggregates
|
|
11282
11282
|
*
|
|
11283
11283
|
* @param {String} jobId jobId
|
|
11284
|
-
*
|
|
11284
|
+
* getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11285
11285
|
*/
|
|
11286
11286
|
getAnalyticsJourneysAggregatesJob(jobId) {
|
|
11287
11287
|
// verify the required parameter 'jobId' is set
|
|
@@ -11309,7 +11309,7 @@ class AnalyticsApi {
|
|
|
11309
11309
|
* @param {String} jobId jobId
|
|
11310
11310
|
* @param {Object} opts Optional parameters
|
|
11311
11311
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
11312
|
-
*
|
|
11312
|
+
* getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11313
11313
|
*/
|
|
11314
11314
|
getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
|
|
11315
11315
|
opts = opts || {};
|
|
@@ -11337,7 +11337,7 @@ class AnalyticsApi {
|
|
|
11337
11337
|
* Get status for async query for knowledge aggregates
|
|
11338
11338
|
*
|
|
11339
11339
|
* @param {String} jobId jobId
|
|
11340
|
-
*
|
|
11340
|
+
* getAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11341
11341
|
*/
|
|
11342
11342
|
getAnalyticsKnowledgeAggregatesJob(jobId) {
|
|
11343
11343
|
// verify the required parameter 'jobId' is set
|
|
@@ -11365,7 +11365,7 @@ class AnalyticsApi {
|
|
|
11365
11365
|
* @param {String} jobId jobId
|
|
11366
11366
|
* @param {Object} opts Optional parameters
|
|
11367
11367
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
11368
|
-
*
|
|
11368
|
+
* getAnalyticsKnowledgeAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11369
11369
|
*/
|
|
11370
11370
|
getAnalyticsKnowledgeAggregatesJobResults(jobId, opts) {
|
|
11371
11371
|
opts = opts || {};
|
|
@@ -11688,7 +11688,7 @@ class AnalyticsApi {
|
|
|
11688
11688
|
* Get status for async query for resolution aggregates
|
|
11689
11689
|
*
|
|
11690
11690
|
* @param {String} jobId jobId
|
|
11691
|
-
*
|
|
11691
|
+
* getAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11692
11692
|
*/
|
|
11693
11693
|
getAnalyticsResolutionsAggregatesJob(jobId) {
|
|
11694
11694
|
// verify the required parameter 'jobId' is set
|
|
@@ -11716,7 +11716,7 @@ class AnalyticsApi {
|
|
|
11716
11716
|
* @param {String} jobId jobId
|
|
11717
11717
|
* @param {Object} opts Optional parameters
|
|
11718
11718
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
11719
|
-
*
|
|
11719
|
+
* getAnalyticsResolutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11720
11720
|
*/
|
|
11721
11721
|
getAnalyticsResolutionsAggregatesJobResults(jobId, opts) {
|
|
11722
11722
|
opts = opts || {};
|
|
@@ -11744,7 +11744,7 @@ class AnalyticsApi {
|
|
|
11744
11744
|
* Get status for async query for survey aggregates
|
|
11745
11745
|
*
|
|
11746
11746
|
* @param {String} jobId jobId
|
|
11747
|
-
*
|
|
11747
|
+
* getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11748
11748
|
*/
|
|
11749
11749
|
getAnalyticsSurveysAggregatesJob(jobId) {
|
|
11750
11750
|
// verify the required parameter 'jobId' is set
|
|
@@ -11772,7 +11772,7 @@ class AnalyticsApi {
|
|
|
11772
11772
|
* @param {String} jobId jobId
|
|
11773
11773
|
* @param {Object} opts Optional parameters
|
|
11774
11774
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
11775
|
-
*
|
|
11775
|
+
* getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11776
11776
|
*/
|
|
11777
11777
|
getAnalyticsSurveysAggregatesJobResults(jobId, opts) {
|
|
11778
11778
|
opts = opts || {};
|
|
@@ -11800,7 +11800,7 @@ class AnalyticsApi {
|
|
|
11800
11800
|
* Get status for async query for task management aggregates
|
|
11801
11801
|
*
|
|
11802
11802
|
* @param {String} jobId jobId
|
|
11803
|
-
*
|
|
11803
|
+
* getAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11804
11804
|
*/
|
|
11805
11805
|
getAnalyticsTaskmanagementAggregatesJob(jobId) {
|
|
11806
11806
|
// verify the required parameter 'jobId' is set
|
|
@@ -11828,7 +11828,7 @@ class AnalyticsApi {
|
|
|
11828
11828
|
* @param {String} jobId jobId
|
|
11829
11829
|
* @param {Object} opts Optional parameters
|
|
11830
11830
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
11831
|
-
*
|
|
11831
|
+
* getAnalyticsTaskmanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11832
11832
|
*/
|
|
11833
11833
|
getAnalyticsTaskmanagementAggregatesJobResults(jobId, opts) {
|
|
11834
11834
|
opts = opts || {};
|
|
@@ -11856,7 +11856,7 @@ class AnalyticsApi {
|
|
|
11856
11856
|
* Get status for async query for transcript aggregates
|
|
11857
11857
|
*
|
|
11858
11858
|
* @param {String} jobId jobId
|
|
11859
|
-
*
|
|
11859
|
+
* getAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11860
11860
|
*/
|
|
11861
11861
|
getAnalyticsTranscriptsAggregatesJob(jobId) {
|
|
11862
11862
|
// verify the required parameter 'jobId' is set
|
|
@@ -11884,7 +11884,7 @@ class AnalyticsApi {
|
|
|
11884
11884
|
* @param {String} jobId jobId
|
|
11885
11885
|
* @param {Object} opts Optional parameters
|
|
11886
11886
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
11887
|
-
*
|
|
11887
|
+
* getAnalyticsTranscriptsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11888
11888
|
*/
|
|
11889
11889
|
getAnalyticsTranscriptsAggregatesJobResults(jobId, opts) {
|
|
11890
11890
|
opts = opts || {};
|
|
@@ -11912,7 +11912,7 @@ class AnalyticsApi {
|
|
|
11912
11912
|
* Get status for async query for user aggregates
|
|
11913
11913
|
*
|
|
11914
11914
|
* @param {String} jobId jobId
|
|
11915
|
-
*
|
|
11915
|
+
* getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11916
11916
|
*/
|
|
11917
11917
|
getAnalyticsUsersAggregatesJob(jobId) {
|
|
11918
11918
|
// verify the required parameter 'jobId' is set
|
|
@@ -11940,7 +11940,7 @@ class AnalyticsApi {
|
|
|
11940
11940
|
* @param {String} jobId jobId
|
|
11941
11941
|
* @param {Object} opts Optional parameters
|
|
11942
11942
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
11943
|
-
*
|
|
11943
|
+
* getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11944
11944
|
*/
|
|
11945
11945
|
getAnalyticsUsersAggregatesJobResults(jobId, opts) {
|
|
11946
11946
|
opts = opts || {};
|
|
@@ -12068,7 +12068,7 @@ class AnalyticsApi {
|
|
|
12068
12068
|
* Query for action aggregates asynchronously
|
|
12069
12069
|
*
|
|
12070
12070
|
* @param {Object} body query
|
|
12071
|
-
*
|
|
12071
|
+
* postAnalyticsActionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12072
12072
|
*/
|
|
12073
12073
|
postAnalyticsActionsAggregatesJobs(body) {
|
|
12074
12074
|
// verify the required parameter 'body' is set
|
|
@@ -12119,7 +12119,7 @@ class AnalyticsApi {
|
|
|
12119
12119
|
* Query for bot aggregates asynchronously
|
|
12120
12120
|
*
|
|
12121
12121
|
* @param {Object} body query
|
|
12122
|
-
*
|
|
12122
|
+
* postAnalyticsBotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12123
12123
|
*/
|
|
12124
12124
|
postAnalyticsBotsAggregatesJobs(body) {
|
|
12125
12125
|
// verify the required parameter 'body' is set
|
|
@@ -12203,7 +12203,7 @@ class AnalyticsApi {
|
|
|
12203
12203
|
* @param {Object} opts Optional parameters
|
|
12204
12204
|
* @param {Number} opts.pageSize The desired page size
|
|
12205
12205
|
* @param {Number} opts.pageNumber The desired page number
|
|
12206
|
-
*
|
|
12206
|
+
* postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12207
12207
|
*/
|
|
12208
12208
|
postAnalyticsConversationsActivityQuery(body, opts) {
|
|
12209
12209
|
opts = opts || {};
|
|
@@ -12231,7 +12231,7 @@ class AnalyticsApi {
|
|
|
12231
12231
|
* Query for conversation aggregates asynchronously
|
|
12232
12232
|
*
|
|
12233
12233
|
* @param {Object} body query
|
|
12234
|
-
*
|
|
12234
|
+
* postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12235
12235
|
*/
|
|
12236
12236
|
postAnalyticsConversationsAggregatesJobs(body) {
|
|
12237
12237
|
// verify the required parameter 'body' is set
|
|
@@ -12357,7 +12357,7 @@ class AnalyticsApi {
|
|
|
12357
12357
|
* Query for evaluation aggregates asynchronously
|
|
12358
12358
|
*
|
|
12359
12359
|
* @param {Object} body query
|
|
12360
|
-
*
|
|
12360
|
+
* postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12361
12361
|
*/
|
|
12362
12362
|
postAnalyticsEvaluationsAggregatesJobs(body) {
|
|
12363
12363
|
// verify the required parameter 'body' is set
|
|
@@ -12411,7 +12411,7 @@ class AnalyticsApi {
|
|
|
12411
12411
|
* @param {Object} opts Optional parameters
|
|
12412
12412
|
* @param {Number} opts.pageSize The desired page size
|
|
12413
12413
|
* @param {Number} opts.pageNumber The desired page number
|
|
12414
|
-
*
|
|
12414
|
+
* postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12415
12415
|
*/
|
|
12416
12416
|
postAnalyticsFlowsActivityQuery(body, opts) {
|
|
12417
12417
|
opts = opts || {};
|
|
@@ -12439,7 +12439,7 @@ class AnalyticsApi {
|
|
|
12439
12439
|
* Query for flow aggregates asynchronously
|
|
12440
12440
|
*
|
|
12441
12441
|
* @param {Object} body query
|
|
12442
|
-
*
|
|
12442
|
+
* postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12443
12443
|
*/
|
|
12444
12444
|
postAnalyticsFlowsAggregatesJobs(body) {
|
|
12445
12445
|
// verify the required parameter 'body' is set
|
|
@@ -12515,7 +12515,7 @@ class AnalyticsApi {
|
|
|
12515
12515
|
* Query for journey aggregates asynchronously
|
|
12516
12516
|
*
|
|
12517
12517
|
* @param {Object} body query
|
|
12518
|
-
*
|
|
12518
|
+
* postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12519
12519
|
*/
|
|
12520
12520
|
postAnalyticsJourneysAggregatesJobs(body) {
|
|
12521
12521
|
// verify the required parameter 'body' is set
|
|
@@ -12566,7 +12566,7 @@ class AnalyticsApi {
|
|
|
12566
12566
|
* Query for knowledge aggregates asynchronously
|
|
12567
12567
|
*
|
|
12568
12568
|
* @param {Object} body query
|
|
12569
|
-
*
|
|
12569
|
+
* postAnalyticsKnowledgeAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12570
12570
|
*/
|
|
12571
12571
|
postAnalyticsKnowledgeAggregatesJobs(body) {
|
|
12572
12572
|
// verify the required parameter 'body' is set
|
|
@@ -12592,7 +12592,7 @@ class AnalyticsApi {
|
|
|
12592
12592
|
* Query for knowledge aggregates
|
|
12593
12593
|
*
|
|
12594
12594
|
* @param {Object} body query
|
|
12595
|
-
*
|
|
12595
|
+
* postAnalyticsKnowledgeAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12596
12596
|
*/
|
|
12597
12597
|
postAnalyticsKnowledgeAggregatesQuery(body) {
|
|
12598
12598
|
// verify the required parameter 'body' is set
|
|
@@ -12718,7 +12718,7 @@ class AnalyticsApi {
|
|
|
12718
12718
|
* Query for resolution aggregates asynchronously
|
|
12719
12719
|
*
|
|
12720
12720
|
* @param {Object} body query
|
|
12721
|
-
*
|
|
12721
|
+
* postAnalyticsResolutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12722
12722
|
*/
|
|
12723
12723
|
postAnalyticsResolutionsAggregatesJobs(body) {
|
|
12724
12724
|
// verify the required parameter 'body' is set
|
|
@@ -12747,7 +12747,7 @@ class AnalyticsApi {
|
|
|
12747
12747
|
* @param {Object} opts Optional parameters
|
|
12748
12748
|
* @param {Number} opts.pageSize The desired page size
|
|
12749
12749
|
* @param {Number} opts.pageNumber The desired page number
|
|
12750
|
-
*
|
|
12750
|
+
* postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12751
12751
|
*/
|
|
12752
12752
|
postAnalyticsRoutingActivityQuery(body, opts) {
|
|
12753
12753
|
opts = opts || {};
|
|
@@ -12775,7 +12775,7 @@ class AnalyticsApi {
|
|
|
12775
12775
|
* Query for survey aggregates asynchronously
|
|
12776
12776
|
*
|
|
12777
12777
|
* @param {Object} body query
|
|
12778
|
-
*
|
|
12778
|
+
* postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12779
12779
|
*/
|
|
12780
12780
|
postAnalyticsSurveysAggregatesJobs(body) {
|
|
12781
12781
|
// verify the required parameter 'body' is set
|
|
@@ -12826,7 +12826,7 @@ class AnalyticsApi {
|
|
|
12826
12826
|
* Query for task management aggregates asynchronously
|
|
12827
12827
|
*
|
|
12828
12828
|
* @param {Object} body query
|
|
12829
|
-
*
|
|
12829
|
+
* postAnalyticsTaskmanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12830
12830
|
*/
|
|
12831
12831
|
postAnalyticsTaskmanagementAggregatesJobs(body) {
|
|
12832
12832
|
// verify the required parameter 'body' is set
|
|
@@ -12852,7 +12852,7 @@ class AnalyticsApi {
|
|
|
12852
12852
|
* Query for task management aggregates
|
|
12853
12853
|
*
|
|
12854
12854
|
* @param {Object} body query
|
|
12855
|
-
*
|
|
12855
|
+
* postAnalyticsTaskmanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12856
12856
|
*/
|
|
12857
12857
|
postAnalyticsTaskmanagementAggregatesQuery(body) {
|
|
12858
12858
|
// verify the required parameter 'body' is set
|
|
@@ -12881,7 +12881,7 @@ class AnalyticsApi {
|
|
|
12881
12881
|
* @param {Object} opts Optional parameters
|
|
12882
12882
|
* @param {Number} opts.pageSize The desired page size
|
|
12883
12883
|
* @param {Number} opts.pageNumber The desired page number
|
|
12884
|
-
*
|
|
12884
|
+
* postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12885
12885
|
*/
|
|
12886
12886
|
postAnalyticsTeamsActivityQuery(body, opts) {
|
|
12887
12887
|
opts = opts || {};
|
|
@@ -12909,7 +12909,7 @@ class AnalyticsApi {
|
|
|
12909
12909
|
* Query for transcript aggregates asynchronously
|
|
12910
12910
|
*
|
|
12911
12911
|
* @param {Object} body query
|
|
12912
|
-
*
|
|
12912
|
+
* postAnalyticsTranscriptsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12913
12913
|
*/
|
|
12914
12914
|
postAnalyticsTranscriptsAggregatesJobs(body) {
|
|
12915
12915
|
// verify the required parameter 'body' is set
|
|
@@ -12963,7 +12963,7 @@ class AnalyticsApi {
|
|
|
12963
12963
|
* @param {Object} opts Optional parameters
|
|
12964
12964
|
* @param {Number} opts.pageSize The desired page size
|
|
12965
12965
|
* @param {Number} opts.pageNumber The desired page number
|
|
12966
|
-
*
|
|
12966
|
+
* postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12967
12967
|
*/
|
|
12968
12968
|
postAnalyticsUsersActivityQuery(body, opts) {
|
|
12969
12969
|
opts = opts || {};
|
|
@@ -12991,7 +12991,7 @@ class AnalyticsApi {
|
|
|
12991
12991
|
* Query for user aggregates asynchronously
|
|
12992
12992
|
*
|
|
12993
12993
|
* @param {Object} body query
|
|
12994
|
-
*
|
|
12994
|
+
* postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12995
12995
|
*/
|
|
12996
12996
|
postAnalyticsUsersAggregatesJobs(body) {
|
|
12997
12997
|
// verify the required parameter 'body' is set
|
|
@@ -13174,7 +13174,7 @@ class ArchitectApi {
|
|
|
13174
13174
|
/**
|
|
13175
13175
|
* Architect service.
|
|
13176
13176
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
13177
|
-
* @version
|
|
13177
|
+
* @version 170.0.0
|
|
13178
13178
|
*/
|
|
13179
13179
|
|
|
13180
13180
|
/**
|
|
@@ -14947,7 +14947,7 @@ class ArchitectApi {
|
|
|
14947
14947
|
* @param {String} instanceId Instance ID
|
|
14948
14948
|
* @param {Object} opts Optional parameters
|
|
14949
14949
|
* @param {Object} opts.expand Expand various details.
|
|
14950
|
-
*
|
|
14950
|
+
* getFlowsInstance is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14951
14951
|
*/
|
|
14952
14952
|
getFlowsInstance(instanceId, opts) {
|
|
14953
14953
|
opts = opts || {};
|
|
@@ -14975,7 +14975,7 @@ class ArchitectApi {
|
|
|
14975
14975
|
* Get the status and/or results of an asynchronous flow execution data retrieval job
|
|
14976
14976
|
*
|
|
14977
14977
|
* @param {String} jobId The asynchronous job ID
|
|
14978
|
-
*
|
|
14978
|
+
* getFlowsInstancesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14979
14979
|
*/
|
|
14980
14980
|
getFlowsInstancesJob(jobId) {
|
|
14981
14981
|
// verify the required parameter 'jobId' is set
|
|
@@ -15002,7 +15002,7 @@ class ArchitectApi {
|
|
|
15002
15002
|
* Returns the queryable parameters that can be used to build a query for execution data.
|
|
15003
15003
|
* @param {Object} opts Optional parameters
|
|
15004
15004
|
* @param {Object} opts.expand Expand various query types.
|
|
15005
|
-
*
|
|
15005
|
+
* getFlowsInstancesQuerycapabilities is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15006
15006
|
*/
|
|
15007
15007
|
getFlowsInstancesQuerycapabilities(opts) {
|
|
15008
15008
|
opts = opts || {};
|
|
@@ -15859,7 +15859,7 @@ class ArchitectApi {
|
|
|
15859
15859
|
* @param {Object} body Requested Flow Ids
|
|
15860
15860
|
* @param {Object} opts Optional parameters
|
|
15861
15861
|
* @param {Object} opts.expand Expand various query types.
|
|
15862
|
-
*
|
|
15862
|
+
* postFlowsInstancesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15863
15863
|
*/
|
|
15864
15864
|
postFlowsInstancesJobs(body, opts) {
|
|
15865
15865
|
opts = opts || {};
|
|
@@ -15889,7 +15889,7 @@ class ArchitectApi {
|
|
|
15889
15889
|
* @param {Object} body query
|
|
15890
15890
|
* @param {Object} opts Optional parameters
|
|
15891
15891
|
* @param {Boolean} opts.indexOnly indexes only
|
|
15892
|
-
*
|
|
15892
|
+
* postFlowsInstancesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15893
15893
|
*/
|
|
15894
15894
|
postFlowsInstancesQuery(body, opts) {
|
|
15895
15895
|
opts = opts || {};
|
|
@@ -16363,7 +16363,7 @@ class AuditApi {
|
|
|
16363
16363
|
/**
|
|
16364
16364
|
* Audit service.
|
|
16365
16365
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
16366
|
-
* @version
|
|
16366
|
+
* @version 170.0.0
|
|
16367
16367
|
*/
|
|
16368
16368
|
|
|
16369
16369
|
/**
|
|
@@ -16534,7 +16534,7 @@ class AuthorizationApi {
|
|
|
16534
16534
|
/**
|
|
16535
16535
|
* Authorization service.
|
|
16536
16536
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
16537
|
-
* @version
|
|
16537
|
+
* @version 170.0.0
|
|
16538
16538
|
*/
|
|
16539
16539
|
|
|
16540
16540
|
/**
|
|
@@ -16775,7 +16775,7 @@ class AuthorizationApi {
|
|
|
16775
16775
|
* @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
|
|
16776
16776
|
* @param {Object} opts Optional parameters
|
|
16777
16777
|
* @param {String} opts.name Search term to filter by division name
|
|
16778
|
-
|
|
16778
|
+
* @deprecated
|
|
16779
16779
|
*/
|
|
16780
16780
|
getAuthorizationDivisionspermittedMe(permission, opts) {
|
|
16781
16781
|
opts = opts || {};
|
|
@@ -16837,7 +16837,7 @@ class AuthorizationApi {
|
|
|
16837
16837
|
* @param {Object} opts Optional parameters
|
|
16838
16838
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
16839
16839
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
16840
|
-
|
|
16840
|
+
* @deprecated
|
|
16841
16841
|
*/
|
|
16842
16842
|
getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
|
|
16843
16843
|
opts = opts || {};
|
|
@@ -17765,7 +17765,7 @@ class BillingApi {
|
|
|
17765
17765
|
/**
|
|
17766
17766
|
* Billing service.
|
|
17767
17767
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
17768
|
-
* @version
|
|
17768
|
+
* @version 170.0.0
|
|
17769
17769
|
*/
|
|
17770
17770
|
|
|
17771
17771
|
/**
|
|
@@ -17845,7 +17845,7 @@ class CarrierServicesApi {
|
|
|
17845
17845
|
/**
|
|
17846
17846
|
* CarrierServices service.
|
|
17847
17847
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
17848
|
-
* @version
|
|
17848
|
+
* @version 170.0.0
|
|
17849
17849
|
*/
|
|
17850
17850
|
|
|
17851
17851
|
/**
|
|
@@ -17915,7 +17915,7 @@ class ChatApi {
|
|
|
17915
17915
|
/**
|
|
17916
17916
|
* Chat service.
|
|
17917
17917
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
17918
|
-
* @version
|
|
17918
|
+
* @version 170.0.0
|
|
17919
17919
|
*/
|
|
17920
17920
|
|
|
17921
17921
|
/**
|
|
@@ -17933,7 +17933,7 @@ class ChatApi {
|
|
|
17933
17933
|
/**
|
|
17934
17934
|
* Get Chat Settings.
|
|
17935
17935
|
* This route is deprecated, please use /chats/settings instead
|
|
17936
|
-
|
|
17936
|
+
* @deprecated
|
|
17937
17937
|
*/
|
|
17938
17938
|
getChatSettings() {
|
|
17939
17939
|
|
|
@@ -17975,7 +17975,7 @@ class ChatApi {
|
|
|
17975
17975
|
* Patch Chat Settings.
|
|
17976
17976
|
* This route is deprecated, please use /chats/settings instead
|
|
17977
17977
|
* @param {Object} body Chat
|
|
17978
|
-
|
|
17978
|
+
* @deprecated
|
|
17979
17979
|
*/
|
|
17980
17980
|
patchChatSettings(body) {
|
|
17981
17981
|
// verify the required parameter 'body' is set
|
|
@@ -18026,7 +18026,7 @@ class ChatApi {
|
|
|
18026
18026
|
* Update Chat Settings.
|
|
18027
18027
|
* This route is deprecated, please use /chats/settings instead
|
|
18028
18028
|
* @param {Object} body Chat
|
|
18029
|
-
|
|
18029
|
+
* @deprecated
|
|
18030
18030
|
*/
|
|
18031
18031
|
putChatSettings(body) {
|
|
18032
18032
|
// verify the required parameter 'body' is set
|
|
@@ -18079,7 +18079,7 @@ class CoachingApi {
|
|
|
18079
18079
|
/**
|
|
18080
18080
|
* Coaching service.
|
|
18081
18081
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
18082
|
-
* @version
|
|
18082
|
+
* @version 170.0.0
|
|
18083
18083
|
*/
|
|
18084
18084
|
|
|
18085
18085
|
/**
|
|
@@ -18656,7 +18656,7 @@ class ContentManagementApi {
|
|
|
18656
18656
|
/**
|
|
18657
18657
|
* ContentManagement service.
|
|
18658
18658
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
18659
|
-
* @version
|
|
18659
|
+
* @version 170.0.0
|
|
18660
18660
|
*/
|
|
18661
18661
|
|
|
18662
18662
|
/**
|
|
@@ -18870,7 +18870,7 @@ class ContentManagementApi {
|
|
|
18870
18870
|
|
|
18871
18871
|
/**
|
|
18872
18872
|
* Get a list of audits for a document.
|
|
18873
|
-
*
|
|
18873
|
+
* This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
|
|
18874
18874
|
* @param {String} documentId Document ID
|
|
18875
18875
|
* @param {Object} opts Optional parameters
|
|
18876
18876
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
@@ -18879,6 +18879,7 @@ class ContentManagementApi {
|
|
|
18879
18879
|
* @param {String} opts.level level (default to USER)
|
|
18880
18880
|
* @param {String} opts.sortBy Sort by
|
|
18881
18881
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
18882
|
+
* @deprecated
|
|
18882
18883
|
*/
|
|
18883
18884
|
getContentmanagementDocumentAudits(documentId, opts) {
|
|
18884
18885
|
opts = opts || {};
|
|
@@ -18943,7 +18944,7 @@ class ContentManagementApi {
|
|
|
18943
18944
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
18944
18945
|
* @param {String} opts.sortBy name or dateCreated
|
|
18945
18946
|
* @param {String} opts.sortOrder ascending or descending (default to ascending)
|
|
18946
|
-
|
|
18947
|
+
* @deprecated
|
|
18947
18948
|
*/
|
|
18948
18949
|
getContentmanagementDocuments(workspaceId, opts) {
|
|
18949
18950
|
opts = opts || {};
|
|
@@ -19425,8 +19426,9 @@ class ContentManagementApi {
|
|
|
19425
19426
|
|
|
19426
19427
|
/**
|
|
19427
19428
|
* Query audits
|
|
19428
|
-
*
|
|
19429
|
+
* This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
|
|
19429
19430
|
* @param {Object} body Allows for a filtered query returning facet information
|
|
19431
|
+
* @deprecated
|
|
19430
19432
|
*/
|
|
19431
19433
|
postContentmanagementAuditquery(body) {
|
|
19432
19434
|
// verify the required parameter 'body' is set
|
|
@@ -19797,7 +19799,7 @@ class ConversationsApi {
|
|
|
19797
19799
|
/**
|
|
19798
19800
|
* Conversations service.
|
|
19799
19801
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
19800
|
-
* @version
|
|
19802
|
+
* @version 170.0.0
|
|
19801
19803
|
*/
|
|
19802
19804
|
|
|
19803
19805
|
/**
|
|
@@ -19987,6 +19989,31 @@ class ConversationsApi {
|
|
|
19987
19989
|
);
|
|
19988
19990
|
}
|
|
19989
19991
|
|
|
19992
|
+
/**
|
|
19993
|
+
* Delete Instagram messaging integration
|
|
19994
|
+
*
|
|
19995
|
+
* @param {String} integrationId Integration ID
|
|
19996
|
+
*/
|
|
19997
|
+
deleteConversationsMessagingIntegrationsInstagramIntegrationId(integrationId) {
|
|
19998
|
+
// verify the required parameter 'integrationId' is set
|
|
19999
|
+
if (integrationId === undefined || integrationId === null) {
|
|
20000
|
+
throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsInstagramIntegrationId';
|
|
20001
|
+
}
|
|
20002
|
+
|
|
20003
|
+
return this.apiClient.callApi(
|
|
20004
|
+
'/api/v2/conversations/messaging/integrations/instagram/{integrationId}',
|
|
20005
|
+
'DELETE',
|
|
20006
|
+
{ 'integrationId': integrationId },
|
|
20007
|
+
{ },
|
|
20008
|
+
{ },
|
|
20009
|
+
{ },
|
|
20010
|
+
null,
|
|
20011
|
+
['PureCloud OAuth'],
|
|
20012
|
+
['application/json'],
|
|
20013
|
+
['application/json']
|
|
20014
|
+
);
|
|
20015
|
+
}
|
|
20016
|
+
|
|
19990
20017
|
/**
|
|
19991
20018
|
* Delete a LINE messenger integration
|
|
19992
20019
|
*
|
|
@@ -20141,7 +20168,7 @@ class ConversationsApi {
|
|
|
20141
20168
|
* Get status for async query for conversation aggregates
|
|
20142
20169
|
*
|
|
20143
20170
|
* @param {String} jobId jobId
|
|
20144
|
-
*
|
|
20171
|
+
* getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20145
20172
|
*/
|
|
20146
20173
|
getAnalyticsConversationsAggregatesJob(jobId) {
|
|
20147
20174
|
// verify the required parameter 'jobId' is set
|
|
@@ -20169,7 +20196,7 @@ class ConversationsApi {
|
|
|
20169
20196
|
* @param {String} jobId jobId
|
|
20170
20197
|
* @param {Object} opts Optional parameters
|
|
20171
20198
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
20172
|
-
*
|
|
20199
|
+
* getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20173
20200
|
*/
|
|
20174
20201
|
getAnalyticsConversationsAggregatesJobResults(jobId, opts) {
|
|
20175
20202
|
opts = opts || {};
|
|
@@ -21845,6 +21872,63 @@ class ConversationsApi {
|
|
|
21845
21872
|
);
|
|
21846
21873
|
}
|
|
21847
21874
|
|
|
21875
|
+
/**
|
|
21876
|
+
* Get a list of Instagram Integrations
|
|
21877
|
+
*
|
|
21878
|
+
* @param {Object} opts Optional parameters
|
|
21879
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
21880
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
21881
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
21882
|
+
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
21883
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
21884
|
+
*/
|
|
21885
|
+
getConversationsMessagingIntegrationsInstagram(opts) {
|
|
21886
|
+
opts = opts || {};
|
|
21887
|
+
|
|
21888
|
+
|
|
21889
|
+
return this.apiClient.callApi(
|
|
21890
|
+
'/api/v2/conversations/messaging/integrations/instagram',
|
|
21891
|
+
'GET',
|
|
21892
|
+
{ },
|
|
21893
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
21894
|
+
{ },
|
|
21895
|
+
{ },
|
|
21896
|
+
null,
|
|
21897
|
+
['PureCloud OAuth'],
|
|
21898
|
+
['application/json'],
|
|
21899
|
+
['application/json']
|
|
21900
|
+
);
|
|
21901
|
+
}
|
|
21902
|
+
|
|
21903
|
+
/**
|
|
21904
|
+
* Get Instagram messaging integration
|
|
21905
|
+
*
|
|
21906
|
+
* @param {String} integrationId Integration ID
|
|
21907
|
+
* @param {Object} opts Optional parameters
|
|
21908
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
21909
|
+
*/
|
|
21910
|
+
getConversationsMessagingIntegrationsInstagramIntegrationId(integrationId, opts) {
|
|
21911
|
+
opts = opts || {};
|
|
21912
|
+
|
|
21913
|
+
// verify the required parameter 'integrationId' is set
|
|
21914
|
+
if (integrationId === undefined || integrationId === null) {
|
|
21915
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsInstagramIntegrationId';
|
|
21916
|
+
}
|
|
21917
|
+
|
|
21918
|
+
return this.apiClient.callApi(
|
|
21919
|
+
'/api/v2/conversations/messaging/integrations/instagram/{integrationId}',
|
|
21920
|
+
'GET',
|
|
21921
|
+
{ 'integrationId': integrationId },
|
|
21922
|
+
{ 'expand': opts['expand'] },
|
|
21923
|
+
{ },
|
|
21924
|
+
{ },
|
|
21925
|
+
null,
|
|
21926
|
+
['PureCloud OAuth'],
|
|
21927
|
+
['application/json'],
|
|
21928
|
+
['application/json']
|
|
21929
|
+
);
|
|
21930
|
+
}
|
|
21931
|
+
|
|
21848
21932
|
/**
|
|
21849
21933
|
* Get a list of LINE messenger Integrations
|
|
21850
21934
|
*
|
|
@@ -22295,7 +22379,7 @@ class ConversationsApi {
|
|
|
22295
22379
|
* Get video conference details (e.g. the current number of active participants).
|
|
22296
22380
|
*
|
|
22297
22381
|
* @param {String} conferenceId conferenceId
|
|
22298
|
-
*
|
|
22382
|
+
* getConversationsVideoDetails is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22299
22383
|
*/
|
|
22300
22384
|
getConversationsVideoDetails(conferenceId) {
|
|
22301
22385
|
// verify the required parameter 'conferenceId' is set
|
|
@@ -23453,6 +23537,36 @@ class ConversationsApi {
|
|
|
23453
23537
|
);
|
|
23454
23538
|
}
|
|
23455
23539
|
|
|
23540
|
+
/**
|
|
23541
|
+
* Update Instagram messaging integration
|
|
23542
|
+
*
|
|
23543
|
+
* @param {String} integrationId Integration ID
|
|
23544
|
+
* @param {Object} body InstagramIntegrationUpdateRequest
|
|
23545
|
+
*/
|
|
23546
|
+
patchConversationsMessagingIntegrationsInstagramIntegrationId(integrationId, body) {
|
|
23547
|
+
// verify the required parameter 'integrationId' is set
|
|
23548
|
+
if (integrationId === undefined || integrationId === null) {
|
|
23549
|
+
throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsInstagramIntegrationId';
|
|
23550
|
+
}
|
|
23551
|
+
// verify the required parameter 'body' is set
|
|
23552
|
+
if (body === undefined || body === null) {
|
|
23553
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsInstagramIntegrationId';
|
|
23554
|
+
}
|
|
23555
|
+
|
|
23556
|
+
return this.apiClient.callApi(
|
|
23557
|
+
'/api/v2/conversations/messaging/integrations/instagram/{integrationId}',
|
|
23558
|
+
'PATCH',
|
|
23559
|
+
{ 'integrationId': integrationId },
|
|
23560
|
+
{ },
|
|
23561
|
+
{ },
|
|
23562
|
+
{ },
|
|
23563
|
+
body,
|
|
23564
|
+
['PureCloud OAuth'],
|
|
23565
|
+
['application/json'],
|
|
23566
|
+
['application/json']
|
|
23567
|
+
);
|
|
23568
|
+
}
|
|
23569
|
+
|
|
23456
23570
|
/**
|
|
23457
23571
|
* Update an Open messaging integration
|
|
23458
23572
|
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
@@ -23635,7 +23749,7 @@ class ConversationsApi {
|
|
|
23635
23749
|
* @param {Object} opts Optional parameters
|
|
23636
23750
|
* @param {Number} opts.pageSize The desired page size
|
|
23637
23751
|
* @param {Number} opts.pageNumber The desired page number
|
|
23638
|
-
*
|
|
23752
|
+
* postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23639
23753
|
*/
|
|
23640
23754
|
postAnalyticsConversationsActivityQuery(body, opts) {
|
|
23641
23755
|
opts = opts || {};
|
|
@@ -23663,7 +23777,7 @@ class ConversationsApi {
|
|
|
23663
23777
|
* Query for conversation aggregates asynchronously
|
|
23664
23778
|
*
|
|
23665
23779
|
* @param {Object} body query
|
|
23666
|
-
*
|
|
23780
|
+
* postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23667
23781
|
*/
|
|
23668
23782
|
postAnalyticsConversationsAggregatesJobs(body) {
|
|
23669
23783
|
// verify the required parameter 'body' is set
|
|
@@ -23914,6 +24028,7 @@ class ConversationsApi {
|
|
|
23914
24028
|
* @param {String} conversationId conversation ID
|
|
23915
24029
|
* @param {String} participantId participant ID
|
|
23916
24030
|
* @param {Object} body Transfer request
|
|
24031
|
+
* @deprecated
|
|
23917
24032
|
*/
|
|
23918
24033
|
postConversationParticipantReplace(conversationId, participantId, body) {
|
|
23919
24034
|
// verify the required parameter 'conversationId' is set
|
|
@@ -23943,6 +24058,111 @@ class ConversationsApi {
|
|
|
23943
24058
|
);
|
|
23944
24059
|
}
|
|
23945
24060
|
|
|
24061
|
+
/**
|
|
24062
|
+
* Replace this participant with the specified agent
|
|
24063
|
+
*
|
|
24064
|
+
* @param {String} conversationId conversation ID
|
|
24065
|
+
* @param {String} participantId participant ID
|
|
24066
|
+
* @param {Object} body Transfer request
|
|
24067
|
+
*/
|
|
24068
|
+
postConversationParticipantReplaceAgent(conversationId, participantId, body) {
|
|
24069
|
+
// verify the required parameter 'conversationId' is set
|
|
24070
|
+
if (conversationId === undefined || conversationId === null) {
|
|
24071
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceAgent';
|
|
24072
|
+
}
|
|
24073
|
+
// verify the required parameter 'participantId' is set
|
|
24074
|
+
if (participantId === undefined || participantId === null) {
|
|
24075
|
+
throw 'Missing the required parameter "participantId" when calling postConversationParticipantReplaceAgent';
|
|
24076
|
+
}
|
|
24077
|
+
// verify the required parameter 'body' is set
|
|
24078
|
+
if (body === undefined || body === null) {
|
|
24079
|
+
throw 'Missing the required parameter "body" when calling postConversationParticipantReplaceAgent';
|
|
24080
|
+
}
|
|
24081
|
+
|
|
24082
|
+
return this.apiClient.callApi(
|
|
24083
|
+
'/api/v2/conversations/{conversationId}/participants/{participantId}/replace/agent',
|
|
24084
|
+
'POST',
|
|
24085
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
24086
|
+
{ },
|
|
24087
|
+
{ },
|
|
24088
|
+
{ },
|
|
24089
|
+
body,
|
|
24090
|
+
['PureCloud OAuth'],
|
|
24091
|
+
['application/json'],
|
|
24092
|
+
['application/json']
|
|
24093
|
+
);
|
|
24094
|
+
}
|
|
24095
|
+
|
|
24096
|
+
/**
|
|
24097
|
+
* Replace this participant with the an external contact
|
|
24098
|
+
*
|
|
24099
|
+
* @param {String} conversationId conversation ID
|
|
24100
|
+
* @param {String} participantId participant ID
|
|
24101
|
+
* @param {Object} body Transfer request
|
|
24102
|
+
*/
|
|
24103
|
+
postConversationParticipantReplaceExternal(conversationId, participantId, body) {
|
|
24104
|
+
// verify the required parameter 'conversationId' is set
|
|
24105
|
+
if (conversationId === undefined || conversationId === null) {
|
|
24106
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceExternal';
|
|
24107
|
+
}
|
|
24108
|
+
// verify the required parameter 'participantId' is set
|
|
24109
|
+
if (participantId === undefined || participantId === null) {
|
|
24110
|
+
throw 'Missing the required parameter "participantId" when calling postConversationParticipantReplaceExternal';
|
|
24111
|
+
}
|
|
24112
|
+
// verify the required parameter 'body' is set
|
|
24113
|
+
if (body === undefined || body === null) {
|
|
24114
|
+
throw 'Missing the required parameter "body" when calling postConversationParticipantReplaceExternal';
|
|
24115
|
+
}
|
|
24116
|
+
|
|
24117
|
+
return this.apiClient.callApi(
|
|
24118
|
+
'/api/v2/conversations/{conversationId}/participants/{participantId}/replace/external',
|
|
24119
|
+
'POST',
|
|
24120
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
24121
|
+
{ },
|
|
24122
|
+
{ },
|
|
24123
|
+
{ },
|
|
24124
|
+
body,
|
|
24125
|
+
['PureCloud OAuth'],
|
|
24126
|
+
['application/json'],
|
|
24127
|
+
['application/json']
|
|
24128
|
+
);
|
|
24129
|
+
}
|
|
24130
|
+
|
|
24131
|
+
/**
|
|
24132
|
+
* Replace this participant with the specified queue
|
|
24133
|
+
*
|
|
24134
|
+
* @param {String} conversationId conversation ID
|
|
24135
|
+
* @param {String} participantId participant ID
|
|
24136
|
+
* @param {Object} body Transfer request
|
|
24137
|
+
*/
|
|
24138
|
+
postConversationParticipantReplaceQueue(conversationId, participantId, body) {
|
|
24139
|
+
// verify the required parameter 'conversationId' is set
|
|
24140
|
+
if (conversationId === undefined || conversationId === null) {
|
|
24141
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceQueue';
|
|
24142
|
+
}
|
|
24143
|
+
// verify the required parameter 'participantId' is set
|
|
24144
|
+
if (participantId === undefined || participantId === null) {
|
|
24145
|
+
throw 'Missing the required parameter "participantId" when calling postConversationParticipantReplaceQueue';
|
|
24146
|
+
}
|
|
24147
|
+
// verify the required parameter 'body' is set
|
|
24148
|
+
if (body === undefined || body === null) {
|
|
24149
|
+
throw 'Missing the required parameter "body" when calling postConversationParticipantReplaceQueue';
|
|
24150
|
+
}
|
|
24151
|
+
|
|
24152
|
+
return this.apiClient.callApi(
|
|
24153
|
+
'/api/v2/conversations/{conversationId}/participants/{participantId}/replace/queue',
|
|
24154
|
+
'POST',
|
|
24155
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
24156
|
+
{ },
|
|
24157
|
+
{ },
|
|
24158
|
+
{ },
|
|
24159
|
+
body,
|
|
24160
|
+
['PureCloud OAuth'],
|
|
24161
|
+
['application/json'],
|
|
24162
|
+
['application/json']
|
|
24163
|
+
);
|
|
24164
|
+
}
|
|
24165
|
+
|
|
23946
24166
|
/**
|
|
23947
24167
|
* Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.
|
|
23948
24168
|
*
|
|
@@ -24082,6 +24302,7 @@ class ConversationsApi {
|
|
|
24082
24302
|
* @param {String} conversationId conversationId
|
|
24083
24303
|
* @param {String} participantId participantId
|
|
24084
24304
|
* @param {Object} body Destination address and initial speak to
|
|
24305
|
+
* @deprecated
|
|
24085
24306
|
*/
|
|
24086
24307
|
postConversationsCallParticipantConsult(conversationId, participantId, body) {
|
|
24087
24308
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24111,6 +24332,111 @@ class ConversationsApi {
|
|
|
24111
24332
|
);
|
|
24112
24333
|
}
|
|
24113
24334
|
|
|
24335
|
+
/**
|
|
24336
|
+
* Initiate a consult transfer to an agent
|
|
24337
|
+
*
|
|
24338
|
+
* @param {String} conversationId conversationId
|
|
24339
|
+
* @param {String} participantId participantId
|
|
24340
|
+
* @param {Object} body Destination agent and initial speak to
|
|
24341
|
+
*/
|
|
24342
|
+
postConversationsCallParticipantConsultAgent(conversationId, participantId, body) {
|
|
24343
|
+
// verify the required parameter 'conversationId' is set
|
|
24344
|
+
if (conversationId === undefined || conversationId === null) {
|
|
24345
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultAgent';
|
|
24346
|
+
}
|
|
24347
|
+
// verify the required parameter 'participantId' is set
|
|
24348
|
+
if (participantId === undefined || participantId === null) {
|
|
24349
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultAgent';
|
|
24350
|
+
}
|
|
24351
|
+
// verify the required parameter 'body' is set
|
|
24352
|
+
if (body === undefined || body === null) {
|
|
24353
|
+
throw 'Missing the required parameter "body" when calling postConversationsCallParticipantConsultAgent';
|
|
24354
|
+
}
|
|
24355
|
+
|
|
24356
|
+
return this.apiClient.callApi(
|
|
24357
|
+
'/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/agent',
|
|
24358
|
+
'POST',
|
|
24359
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
24360
|
+
{ },
|
|
24361
|
+
{ },
|
|
24362
|
+
{ },
|
|
24363
|
+
body,
|
|
24364
|
+
['PureCloud OAuth'],
|
|
24365
|
+
['application/json'],
|
|
24366
|
+
['application/json']
|
|
24367
|
+
);
|
|
24368
|
+
}
|
|
24369
|
+
|
|
24370
|
+
/**
|
|
24371
|
+
* Initiate a consult transfer to an external contact
|
|
24372
|
+
*
|
|
24373
|
+
* @param {String} conversationId conversationId
|
|
24374
|
+
* @param {String} participantId participantId
|
|
24375
|
+
* @param {Object} body Destination address and initial speak to
|
|
24376
|
+
*/
|
|
24377
|
+
postConversationsCallParticipantConsultExternal(conversationId, participantId, body) {
|
|
24378
|
+
// verify the required parameter 'conversationId' is set
|
|
24379
|
+
if (conversationId === undefined || conversationId === null) {
|
|
24380
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultExternal';
|
|
24381
|
+
}
|
|
24382
|
+
// verify the required parameter 'participantId' is set
|
|
24383
|
+
if (participantId === undefined || participantId === null) {
|
|
24384
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultExternal';
|
|
24385
|
+
}
|
|
24386
|
+
// verify the required parameter 'body' is set
|
|
24387
|
+
if (body === undefined || body === null) {
|
|
24388
|
+
throw 'Missing the required parameter "body" when calling postConversationsCallParticipantConsultExternal';
|
|
24389
|
+
}
|
|
24390
|
+
|
|
24391
|
+
return this.apiClient.callApi(
|
|
24392
|
+
'/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/external',
|
|
24393
|
+
'POST',
|
|
24394
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
24395
|
+
{ },
|
|
24396
|
+
{ },
|
|
24397
|
+
{ },
|
|
24398
|
+
body,
|
|
24399
|
+
['PureCloud OAuth'],
|
|
24400
|
+
['application/json'],
|
|
24401
|
+
['application/json']
|
|
24402
|
+
);
|
|
24403
|
+
}
|
|
24404
|
+
|
|
24405
|
+
/**
|
|
24406
|
+
* Initiate a consult transfer to a queue
|
|
24407
|
+
*
|
|
24408
|
+
* @param {String} conversationId conversationId
|
|
24409
|
+
* @param {String} participantId participantId
|
|
24410
|
+
* @param {Object} body Destination queue and initial speak to
|
|
24411
|
+
*/
|
|
24412
|
+
postConversationsCallParticipantConsultQueue(conversationId, participantId, body) {
|
|
24413
|
+
// verify the required parameter 'conversationId' is set
|
|
24414
|
+
if (conversationId === undefined || conversationId === null) {
|
|
24415
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultQueue';
|
|
24416
|
+
}
|
|
24417
|
+
// verify the required parameter 'participantId' is set
|
|
24418
|
+
if (participantId === undefined || participantId === null) {
|
|
24419
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultQueue';
|
|
24420
|
+
}
|
|
24421
|
+
// verify the required parameter 'body' is set
|
|
24422
|
+
if (body === undefined || body === null) {
|
|
24423
|
+
throw 'Missing the required parameter "body" when calling postConversationsCallParticipantConsultQueue';
|
|
24424
|
+
}
|
|
24425
|
+
|
|
24426
|
+
return this.apiClient.callApi(
|
|
24427
|
+
'/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/queue',
|
|
24428
|
+
'POST',
|
|
24429
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
24430
|
+
{ },
|
|
24431
|
+
{ },
|
|
24432
|
+
{ },
|
|
24433
|
+
body,
|
|
24434
|
+
['PureCloud OAuth'],
|
|
24435
|
+
['application/json'],
|
|
24436
|
+
['application/json']
|
|
24437
|
+
);
|
|
24438
|
+
}
|
|
24439
|
+
|
|
24114
24440
|
/**
|
|
24115
24441
|
* Listen in on the conversation from the point of view of a given participant.
|
|
24116
24442
|
*
|
|
@@ -24147,6 +24473,7 @@ class ConversationsApi {
|
|
|
24147
24473
|
* @param {String} conversationId conversationId
|
|
24148
24474
|
* @param {String} participantId participantId
|
|
24149
24475
|
* @param {Object} body Transfer request
|
|
24476
|
+
* @deprecated
|
|
24150
24477
|
*/
|
|
24151
24478
|
postConversationsCallParticipantReplace(conversationId, participantId, body) {
|
|
24152
24479
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24251,6 +24578,7 @@ class ConversationsApi {
|
|
|
24251
24578
|
* @param {String} conversationId conversationId
|
|
24252
24579
|
* @param {String} participantId participantId
|
|
24253
24580
|
* @param {Object} body Transfer request
|
|
24581
|
+
* @deprecated
|
|
24254
24582
|
*/
|
|
24255
24583
|
postConversationsCallbackParticipantReplace(conversationId, participantId, body) {
|
|
24256
24584
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24490,6 +24818,7 @@ class ConversationsApi {
|
|
|
24490
24818
|
* @param {String} conversationId conversationId
|
|
24491
24819
|
* @param {String} participantId participantId
|
|
24492
24820
|
* @param {Object} body Transfer request
|
|
24821
|
+
* @deprecated
|
|
24493
24822
|
*/
|
|
24494
24823
|
postConversationsChatParticipantReplace(conversationId, participantId, body) {
|
|
24495
24824
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24590,6 +24919,7 @@ class ConversationsApi {
|
|
|
24590
24919
|
* @param {String} participantId participantId
|
|
24591
24920
|
* @param {Object} opts Optional parameters
|
|
24592
24921
|
* @param {Object} opts.body
|
|
24922
|
+
* @deprecated
|
|
24593
24923
|
*/
|
|
24594
24924
|
postConversationsCobrowsesessionParticipantReplace(conversationId, participantId, opts) {
|
|
24595
24925
|
opts = opts || {};
|
|
@@ -24752,6 +25082,7 @@ class ConversationsApi {
|
|
|
24752
25082
|
* @param {String} conversationId conversationId
|
|
24753
25083
|
* @param {String} participantId participantId
|
|
24754
25084
|
* @param {Object} body Transfer request
|
|
25085
|
+
* @deprecated
|
|
24755
25086
|
*/
|
|
24756
25087
|
postConversationsEmailParticipantReplace(conversationId, participantId, body) {
|
|
24757
25088
|
// verify the required parameter 'conversationId' is set
|
|
@@ -25084,7 +25415,7 @@ class ConversationsApi {
|
|
|
25084
25415
|
*
|
|
25085
25416
|
* @param {String} conversationId conversationId
|
|
25086
25417
|
* @param {String} participantId participantId
|
|
25087
|
-
*
|
|
25418
|
+
* postConversationsMessageParticipantMonitor is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25088
25419
|
*/
|
|
25089
25420
|
postConversationsMessageParticipantMonitor(conversationId, participantId) {
|
|
25090
25421
|
// verify the required parameter 'conversationId' is set
|
|
@@ -25116,6 +25447,7 @@ class ConversationsApi {
|
|
|
25116
25447
|
* @param {String} conversationId conversationId
|
|
25117
25448
|
* @param {String} participantId participantId
|
|
25118
25449
|
* @param {Object} body Transfer request
|
|
25450
|
+
* @deprecated
|
|
25119
25451
|
*/
|
|
25120
25452
|
postConversationsMessageParticipantReplace(conversationId, participantId, body) {
|
|
25121
25453
|
// verify the required parameter 'conversationId' is set
|
|
@@ -25245,6 +25577,31 @@ class ConversationsApi {
|
|
|
25245
25577
|
);
|
|
25246
25578
|
}
|
|
25247
25579
|
|
|
25580
|
+
/**
|
|
25581
|
+
* Create Instagram Integration
|
|
25582
|
+
*
|
|
25583
|
+
* @param {Object} body InstagramIntegrationRequest
|
|
25584
|
+
*/
|
|
25585
|
+
postConversationsMessagingIntegrationsInstagram(body) {
|
|
25586
|
+
// verify the required parameter 'body' is set
|
|
25587
|
+
if (body === undefined || body === null) {
|
|
25588
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsInstagram';
|
|
25589
|
+
}
|
|
25590
|
+
|
|
25591
|
+
return this.apiClient.callApi(
|
|
25592
|
+
'/api/v2/conversations/messaging/integrations/instagram',
|
|
25593
|
+
'POST',
|
|
25594
|
+
{ },
|
|
25595
|
+
{ },
|
|
25596
|
+
{ },
|
|
25597
|
+
{ },
|
|
25598
|
+
body,
|
|
25599
|
+
['PureCloud OAuth'],
|
|
25600
|
+
['application/json'],
|
|
25601
|
+
['application/json']
|
|
25602
|
+
);
|
|
25603
|
+
}
|
|
25604
|
+
|
|
25248
25605
|
/**
|
|
25249
25606
|
* Create a LINE messenger Integration
|
|
25250
25607
|
*
|
|
@@ -26058,7 +26415,7 @@ class DataExtensionsApi {
|
|
|
26058
26415
|
/**
|
|
26059
26416
|
* DataExtensions service.
|
|
26060
26417
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
26061
|
-
* @version
|
|
26418
|
+
* @version 170.0.0
|
|
26062
26419
|
*/
|
|
26063
26420
|
|
|
26064
26421
|
/**
|
|
@@ -26144,7 +26501,7 @@ class DownloadsApi {
|
|
|
26144
26501
|
/**
|
|
26145
26502
|
* Downloads service.
|
|
26146
26503
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
26147
|
-
* @version
|
|
26504
|
+
* @version 170.0.0
|
|
26148
26505
|
*/
|
|
26149
26506
|
|
|
26150
26507
|
/**
|
|
@@ -26196,7 +26553,7 @@ class EventsApi {
|
|
|
26196
26553
|
/**
|
|
26197
26554
|
* Events service.
|
|
26198
26555
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
26199
|
-
* @version
|
|
26556
|
+
* @version 170.0.0
|
|
26200
26557
|
*/
|
|
26201
26558
|
|
|
26202
26559
|
/**
|
|
@@ -26292,7 +26649,7 @@ class ExternalContactsApi {
|
|
|
26292
26649
|
/**
|
|
26293
26650
|
* ExternalContacts service.
|
|
26294
26651
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
26295
|
-
* @version
|
|
26652
|
+
* @version 170.0.0
|
|
26296
26653
|
*/
|
|
26297
26654
|
|
|
26298
26655
|
/**
|
|
@@ -28250,7 +28607,7 @@ class FaxApi {
|
|
|
28250
28607
|
/**
|
|
28251
28608
|
* Fax service.
|
|
28252
28609
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
28253
|
-
* @version
|
|
28610
|
+
* @version 170.0.0
|
|
28254
28611
|
*/
|
|
28255
28612
|
|
|
28256
28613
|
/**
|
|
@@ -28421,7 +28778,7 @@ class FlowsApi {
|
|
|
28421
28778
|
/**
|
|
28422
28779
|
* Flows service.
|
|
28423
28780
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
28424
|
-
* @version
|
|
28781
|
+
* @version 170.0.0
|
|
28425
28782
|
*/
|
|
28426
28783
|
|
|
28427
28784
|
/**
|
|
@@ -28440,7 +28797,7 @@ class FlowsApi {
|
|
|
28440
28797
|
* Get status for async query for Flow aggregates
|
|
28441
28798
|
*
|
|
28442
28799
|
* @param {String} jobId jobId
|
|
28443
|
-
*
|
|
28800
|
+
* getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28444
28801
|
*/
|
|
28445
28802
|
getAnalyticsFlowsAggregatesJob(jobId) {
|
|
28446
28803
|
// verify the required parameter 'jobId' is set
|
|
@@ -28468,7 +28825,7 @@ class FlowsApi {
|
|
|
28468
28825
|
* @param {String} jobId jobId
|
|
28469
28826
|
* @param {Object} opts Optional parameters
|
|
28470
28827
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
28471
|
-
*
|
|
28828
|
+
* getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28472
28829
|
*/
|
|
28473
28830
|
getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
|
|
28474
28831
|
opts = opts || {};
|
|
@@ -28499,7 +28856,7 @@ class FlowsApi {
|
|
|
28499
28856
|
* @param {Object} opts Optional parameters
|
|
28500
28857
|
* @param {Number} opts.pageSize The desired page size
|
|
28501
28858
|
* @param {Number} opts.pageNumber The desired page number
|
|
28502
|
-
*
|
|
28859
|
+
* postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28503
28860
|
*/
|
|
28504
28861
|
postAnalyticsFlowsActivityQuery(body, opts) {
|
|
28505
28862
|
opts = opts || {};
|
|
@@ -28527,7 +28884,7 @@ class FlowsApi {
|
|
|
28527
28884
|
* Query for flow aggregates asynchronously
|
|
28528
28885
|
*
|
|
28529
28886
|
* @param {Object} body query
|
|
28530
|
-
*
|
|
28887
|
+
* postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28531
28888
|
*/
|
|
28532
28889
|
postAnalyticsFlowsAggregatesJobs(body) {
|
|
28533
28890
|
// verify the required parameter 'body' is set
|
|
@@ -28605,7 +28962,7 @@ class GamificationApi {
|
|
|
28605
28962
|
/**
|
|
28606
28963
|
* Gamification service.
|
|
28607
28964
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
28608
|
-
* @version
|
|
28965
|
+
* @version 170.0.0
|
|
28609
28966
|
*/
|
|
28610
28967
|
|
|
28611
28968
|
/**
|
|
@@ -30691,7 +31048,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
30691
31048
|
/**
|
|
30692
31049
|
* GeneralDataProtectionRegulation service.
|
|
30693
31050
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
30694
|
-
* @version
|
|
31051
|
+
* @version 170.0.0
|
|
30695
31052
|
*/
|
|
30696
31053
|
|
|
30697
31054
|
/**
|
|
@@ -30821,7 +31178,7 @@ class GeolocationApi {
|
|
|
30821
31178
|
/**
|
|
30822
31179
|
* Geolocation service.
|
|
30823
31180
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
30824
|
-
* @version
|
|
31181
|
+
* @version 170.0.0
|
|
30825
31182
|
*/
|
|
30826
31183
|
|
|
30827
31184
|
/**
|
|
@@ -30952,7 +31309,7 @@ class GreetingsApi {
|
|
|
30952
31309
|
/**
|
|
30953
31310
|
* Greetings service.
|
|
30954
31311
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
30955
|
-
* @version
|
|
31312
|
+
* @version 170.0.0
|
|
30956
31313
|
*/
|
|
30957
31314
|
|
|
30958
31315
|
/**
|
|
@@ -31407,7 +31764,7 @@ class GroupsApi {
|
|
|
31407
31764
|
/**
|
|
31408
31765
|
* Groups service.
|
|
31409
31766
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
31410
|
-
* @version
|
|
31767
|
+
* @version 170.0.0
|
|
31411
31768
|
*/
|
|
31412
31769
|
|
|
31413
31770
|
/**
|
|
@@ -31451,7 +31808,7 @@ class GroupsApi {
|
|
|
31451
31808
|
* Remove dynamic group definition
|
|
31452
31809
|
*
|
|
31453
31810
|
* @param {String} groupId Group ID
|
|
31454
|
-
*
|
|
31811
|
+
* deleteGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31455
31812
|
*/
|
|
31456
31813
|
deleteGroupDynamicsettings(groupId) {
|
|
31457
31814
|
// verify the required parameter 'groupId' is set
|
|
@@ -31507,7 +31864,7 @@ class GroupsApi {
|
|
|
31507
31864
|
* Fetch field config for an entity type
|
|
31508
31865
|
*
|
|
31509
31866
|
* @param {Object} type Field type
|
|
31510
|
-
|
|
31867
|
+
* @deprecated
|
|
31511
31868
|
*/
|
|
31512
31869
|
getFieldconfig(type) {
|
|
31513
31870
|
// verify the required parameter 'type' is set
|
|
@@ -31558,7 +31915,7 @@ class GroupsApi {
|
|
|
31558
31915
|
* Get dynamic group definition
|
|
31559
31916
|
*
|
|
31560
31917
|
* @param {String} groupId Group ID
|
|
31561
|
-
*
|
|
31918
|
+
* getGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31562
31919
|
*/
|
|
31563
31920
|
getGroupDynamicsettings(groupId) {
|
|
31564
31921
|
// verify the required parameter 'groupId' is set
|
|
@@ -31643,7 +32000,7 @@ class GroupsApi {
|
|
|
31643
32000
|
* @param {String} groupId groupId
|
|
31644
32001
|
* @param {Object} opts Optional parameters
|
|
31645
32002
|
* @param {String} opts.fields Comma separated fields to return. Allowable values can be found by querying /api/v2/fieldconfig?type=group and using the key for the elements returned by the fieldList
|
|
31646
|
-
|
|
32003
|
+
* @deprecated
|
|
31647
32004
|
*/
|
|
31648
32005
|
getGroupProfile(groupId, opts) {
|
|
31649
32006
|
opts = opts || {};
|
|
@@ -31733,7 +32090,7 @@ class GroupsApi {
|
|
|
31733
32090
|
* @param {Array.<String>} opts.id id
|
|
31734
32091
|
* @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
|
|
31735
32092
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
31736
|
-
|
|
32093
|
+
* @deprecated
|
|
31737
32094
|
*/
|
|
31738
32095
|
getProfilesGroups(opts) {
|
|
31739
32096
|
opts = opts || {};
|
|
@@ -31812,8 +32169,8 @@ class GroupsApi {
|
|
|
31812
32169
|
* Preview the number of users selected for a dynamic group definition query
|
|
31813
32170
|
*
|
|
31814
32171
|
* @param {Object} body Group query to preview
|
|
31815
|
-
|
|
31816
|
-
*
|
|
32172
|
+
* @deprecated
|
|
32173
|
+
* postGroupsDynamicsettingsPreview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31817
32174
|
*/
|
|
31818
32175
|
postGroupsDynamicsettingsPreview(body) {
|
|
31819
32176
|
// verify the required parameter 'body' is set
|
|
@@ -31894,7 +32251,7 @@ class GroupsApi {
|
|
|
31894
32251
|
*
|
|
31895
32252
|
* @param {String} groupId Group ID
|
|
31896
32253
|
* @param {Object} body Create/Update dynamic groups
|
|
31897
|
-
*
|
|
32254
|
+
* putGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31898
32255
|
*/
|
|
31899
32256
|
putGroupDynamicsettings(groupId, body) {
|
|
31900
32257
|
// verify the required parameter 'groupId' is set
|
|
@@ -31926,7 +32283,7 @@ class IdentityProviderApi {
|
|
|
31926
32283
|
/**
|
|
31927
32284
|
* IdentityProvider service.
|
|
31928
32285
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
31929
|
-
* @version
|
|
32286
|
+
* @version 170.0.0
|
|
31930
32287
|
*/
|
|
31931
32288
|
|
|
31932
32289
|
/**
|
|
@@ -32682,7 +33039,7 @@ class InfrastructureAsCodeApi {
|
|
|
32682
33039
|
/**
|
|
32683
33040
|
* InfrastructureAsCode service.
|
|
32684
33041
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
32685
|
-
* @version
|
|
33042
|
+
* @version 170.0.0
|
|
32686
33043
|
*/
|
|
32687
33044
|
|
|
32688
33045
|
/**
|
|
@@ -32849,7 +33206,7 @@ class IntegrationsApi {
|
|
|
32849
33206
|
/**
|
|
32850
33207
|
* Integrations service.
|
|
32851
33208
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
32852
|
-
* @version
|
|
33209
|
+
* @version 170.0.0
|
|
32853
33210
|
*/
|
|
32854
33211
|
|
|
32855
33212
|
/**
|
|
@@ -33749,7 +34106,7 @@ class IntegrationsApi {
|
|
|
33749
34106
|
* @param {Object} opts Optional parameters
|
|
33750
34107
|
* @param {Array.<String>} opts.expand expand
|
|
33751
34108
|
* @param {Object} opts.targetChannel targetChannel
|
|
33752
|
-
*
|
|
34109
|
+
* getIntegrationsSpeechNuanceNuanceIntegrationIdBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33753
34110
|
*/
|
|
33754
34111
|
getIntegrationsSpeechNuanceNuanceIntegrationIdBot(nuanceIntegrationId, botId, opts) {
|
|
33755
34112
|
opts = opts || {};
|
|
@@ -33783,7 +34140,7 @@ class IntegrationsApi {
|
|
|
33783
34140
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
33784
34141
|
* @param {String} botId The Nuance bot ID
|
|
33785
34142
|
* @param {String} jobId The asynchronous job ID
|
|
33786
|
-
*
|
|
34143
|
+
* getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33787
34144
|
*/
|
|
33788
34145
|
getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob(nuanceIntegrationId, botId, jobId) {
|
|
33789
34146
|
// verify the required parameter 'nuanceIntegrationId' is set
|
|
@@ -33819,7 +34176,7 @@ class IntegrationsApi {
|
|
|
33819
34176
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
33820
34177
|
* @param {String} botId The Nuance bot ID
|
|
33821
34178
|
* @param {String} jobId The asynchronous job ID
|
|
33822
|
-
*
|
|
34179
|
+
* getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33823
34180
|
*/
|
|
33824
34181
|
getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults(nuanceIntegrationId, botId, jobId) {
|
|
33825
34182
|
// verify the required parameter 'nuanceIntegrationId' is set
|
|
@@ -33857,7 +34214,7 @@ class IntegrationsApi {
|
|
|
33857
34214
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
33858
34215
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
33859
34216
|
* @param {Boolean} opts.onlyRegisteredBots Limit bots to the ones configured for Genesys Cloud usage (default to true)
|
|
33860
|
-
*
|
|
34217
|
+
* getIntegrationsSpeechNuanceNuanceIntegrationIdBots is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33861
34218
|
*/
|
|
33862
34219
|
getIntegrationsSpeechNuanceNuanceIntegrationIdBots(nuanceIntegrationId, opts) {
|
|
33863
34220
|
opts = opts || {};
|
|
@@ -33886,7 +34243,7 @@ class IntegrationsApi {
|
|
|
33886
34243
|
*
|
|
33887
34244
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
33888
34245
|
* @param {String} jobId The asynchronous job ID
|
|
33889
|
-
*
|
|
34246
|
+
* getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33890
34247
|
*/
|
|
33891
34248
|
getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob(nuanceIntegrationId, jobId) {
|
|
33892
34249
|
// verify the required parameter 'nuanceIntegrationId' is set
|
|
@@ -33917,7 +34274,7 @@ class IntegrationsApi {
|
|
|
33917
34274
|
*
|
|
33918
34275
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
33919
34276
|
* @param {String} jobId The asynchronous job ID
|
|
33920
|
-
*
|
|
34277
|
+
* getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33921
34278
|
*/
|
|
33922
34279
|
getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults(nuanceIntegrationId, jobId) {
|
|
33923
34280
|
// verify the required parameter 'nuanceIntegrationId' is set
|
|
@@ -34540,7 +34897,7 @@ class IntegrationsApi {
|
|
|
34540
34897
|
* @param {Object} opts Optional parameters
|
|
34541
34898
|
* @param {Array.<String>} opts.expand expand
|
|
34542
34899
|
* @param {String} opts.body targetChannel
|
|
34543
|
-
*
|
|
34900
|
+
* postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34544
34901
|
*/
|
|
34545
34902
|
postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs(nuanceIntegrationId, botId, opts) {
|
|
34546
34903
|
opts = opts || {};
|
|
@@ -34576,7 +34933,7 @@ class IntegrationsApi {
|
|
|
34576
34933
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
34577
34934
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
34578
34935
|
* @param {Boolean} opts.onlyRegisteredBots Limit bots to the ones configured for Genesys Cloud usage (default to true)
|
|
34579
|
-
*
|
|
34936
|
+
* postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34580
34937
|
*/
|
|
34581
34938
|
postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs(nuanceIntegrationId, opts) {
|
|
34582
34939
|
opts = opts || {};
|
|
@@ -34605,7 +34962,7 @@ class IntegrationsApi {
|
|
|
34605
34962
|
*
|
|
34606
34963
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
34607
34964
|
* @param {Object} settings
|
|
34608
|
-
*
|
|
34965
|
+
* postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34609
34966
|
*/
|
|
34610
34967
|
postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate(nuanceIntegrationId, settings) {
|
|
34611
34968
|
// verify the required parameter 'nuanceIntegrationId' is set
|
|
@@ -34724,7 +35081,7 @@ class IntegrationsApi {
|
|
|
34724
35081
|
*
|
|
34725
35082
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
34726
35083
|
* @param {Object} settings
|
|
34727
|
-
*
|
|
35084
|
+
* putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34728
35085
|
*/
|
|
34729
35086
|
putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings(nuanceIntegrationId, settings) {
|
|
34730
35087
|
// verify the required parameter 'nuanceIntegrationId' is set
|
|
@@ -34775,13 +35132,43 @@ class IntegrationsApi {
|
|
|
34775
35132
|
);
|
|
34776
35133
|
}
|
|
34777
35134
|
|
|
35135
|
+
/**
|
|
35136
|
+
* Bulk integration presence ingestion
|
|
35137
|
+
* This endpoint accepts bulk presence updates from a 3rd-party presence integration and maps the 3rd-party user to a Genesys Cloud user via the matching email address. The 3rd-party presence value will be mapped to a Genesys Cloud organization presence definition value.
|
|
35138
|
+
* @param {String} ucIntegrationId UC Integration ID
|
|
35139
|
+
* @param {Array.<Object>} body List of User presences
|
|
35140
|
+
*/
|
|
35141
|
+
putIntegrationsUnifiedcommunicationThirdpartypresences(ucIntegrationId, body) {
|
|
35142
|
+
// verify the required parameter 'ucIntegrationId' is set
|
|
35143
|
+
if (ucIntegrationId === undefined || ucIntegrationId === null) {
|
|
35144
|
+
throw 'Missing the required parameter "ucIntegrationId" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';
|
|
35145
|
+
}
|
|
35146
|
+
// verify the required parameter 'body' is set
|
|
35147
|
+
if (body === undefined || body === null) {
|
|
35148
|
+
throw 'Missing the required parameter "body" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';
|
|
35149
|
+
}
|
|
35150
|
+
|
|
35151
|
+
return this.apiClient.callApi(
|
|
35152
|
+
'/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences',
|
|
35153
|
+
'PUT',
|
|
35154
|
+
{ 'ucIntegrationId': ucIntegrationId },
|
|
35155
|
+
{ },
|
|
35156
|
+
{ },
|
|
35157
|
+
{ },
|
|
35158
|
+
body,
|
|
35159
|
+
['PureCloud OAuth'],
|
|
35160
|
+
['application/json'],
|
|
35161
|
+
['application/json']
|
|
35162
|
+
);
|
|
35163
|
+
}
|
|
35164
|
+
|
|
34778
35165
|
}
|
|
34779
35166
|
|
|
34780
35167
|
class JourneyApi {
|
|
34781
35168
|
/**
|
|
34782
35169
|
* Journey service.
|
|
34783
35170
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
34784
|
-
* @version
|
|
35171
|
+
* @version 170.0.0
|
|
34785
35172
|
*/
|
|
34786
35173
|
|
|
34787
35174
|
/**
|
|
@@ -34929,7 +35316,7 @@ class JourneyApi {
|
|
|
34929
35316
|
* Get status for async query for journey aggregates
|
|
34930
35317
|
*
|
|
34931
35318
|
* @param {String} jobId jobId
|
|
34932
|
-
*
|
|
35319
|
+
* getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34933
35320
|
*/
|
|
34934
35321
|
getAnalyticsJourneysAggregatesJob(jobId) {
|
|
34935
35322
|
// verify the required parameter 'jobId' is set
|
|
@@ -34957,7 +35344,7 @@ class JourneyApi {
|
|
|
34957
35344
|
* @param {String} jobId jobId
|
|
34958
35345
|
* @param {Object} opts Optional parameters
|
|
34959
35346
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
34960
|
-
*
|
|
35347
|
+
* getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34961
35348
|
*/
|
|
34962
35349
|
getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
|
|
34963
35350
|
opts = opts || {};
|
|
@@ -35192,42 +35579,6 @@ class JourneyApi {
|
|
|
35192
35579
|
);
|
|
35193
35580
|
}
|
|
35194
35581
|
|
|
35195
|
-
/**
|
|
35196
|
-
* Retrieve all sessions for a given customer.
|
|
35197
|
-
*
|
|
35198
|
-
* @param {String} customerIdType Type of ID used to identify customer (e.g. email, cookie, and phone).
|
|
35199
|
-
* @param {String} customerId Primary identifier of the customer in the source of the session.
|
|
35200
|
-
* @param {Object} opts Optional parameters
|
|
35201
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
35202
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
35203
|
-
* Preview Endpoint
|
|
35204
|
-
*/
|
|
35205
|
-
getJourneyCustomerCustomerIdSessions(customerIdType, customerId, opts) {
|
|
35206
|
-
opts = opts || {};
|
|
35207
|
-
|
|
35208
|
-
// verify the required parameter 'customerIdType' is set
|
|
35209
|
-
if (customerIdType === undefined || customerIdType === null) {
|
|
35210
|
-
throw 'Missing the required parameter "customerIdType" when calling getJourneyCustomerCustomerIdSessions';
|
|
35211
|
-
}
|
|
35212
|
-
// verify the required parameter 'customerId' is set
|
|
35213
|
-
if (customerId === undefined || customerId === null) {
|
|
35214
|
-
throw 'Missing the required parameter "customerId" when calling getJourneyCustomerCustomerIdSessions';
|
|
35215
|
-
}
|
|
35216
|
-
|
|
35217
|
-
return this.apiClient.callApi(
|
|
35218
|
-
'/api/v2/journey/customers/{customerIdType}/{customerId}/sessions',
|
|
35219
|
-
'GET',
|
|
35220
|
-
{ 'customerIdType': customerIdType,'customerId': customerId },
|
|
35221
|
-
{ 'pageSize': opts['pageSize'],'after': opts['after'] },
|
|
35222
|
-
{ },
|
|
35223
|
-
{ },
|
|
35224
|
-
null,
|
|
35225
|
-
['PureCloud OAuth'],
|
|
35226
|
-
['application/json'],
|
|
35227
|
-
['application/json']
|
|
35228
|
-
);
|
|
35229
|
-
}
|
|
35230
|
-
|
|
35231
35582
|
/**
|
|
35232
35583
|
* Retrieve a single outcome.
|
|
35233
35584
|
*
|
|
@@ -35286,7 +35637,7 @@ class JourneyApi {
|
|
|
35286
35637
|
* Get job status.
|
|
35287
35638
|
*
|
|
35288
35639
|
* @param {String} jobId ID of the job.
|
|
35289
|
-
*
|
|
35640
|
+
* getJourneyOutcomesAttributionsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35290
35641
|
*/
|
|
35291
35642
|
getJourneyOutcomesAttributionsJob(jobId) {
|
|
35292
35643
|
// verify the required parameter 'jobId' is set
|
|
@@ -35312,7 +35663,7 @@ class JourneyApi {
|
|
|
35312
35663
|
* Get outcome attribution entities from completed job.
|
|
35313
35664
|
*
|
|
35314
35665
|
* @param {String} jobId ID of the job.
|
|
35315
|
-
*
|
|
35666
|
+
* getJourneyOutcomesAttributionsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35316
35667
|
*/
|
|
35317
35668
|
getJourneyOutcomesAttributionsJobResults(jobId) {
|
|
35318
35669
|
// verify the required parameter 'jobId' is set
|
|
@@ -35466,7 +35817,7 @@ class JourneyApi {
|
|
|
35466
35817
|
* @param {Object} opts Optional parameters
|
|
35467
35818
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
35468
35819
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
35469
|
-
*
|
|
35820
|
+
* getJourneySessionEvents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35470
35821
|
*/
|
|
35471
35822
|
getJourneySessionEvents(sessionId, opts) {
|
|
35472
35823
|
opts = opts || {};
|
|
@@ -35524,7 +35875,7 @@ class JourneyApi {
|
|
|
35524
35875
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
35525
35876
|
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
35526
35877
|
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
35527
|
-
*
|
|
35878
|
+
* getJourneySessionSegments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35528
35879
|
*/
|
|
35529
35880
|
getJourneySessionSegments(sessionId, opts) {
|
|
35530
35881
|
opts = opts || {};
|
|
@@ -35697,7 +36048,7 @@ class JourneyApi {
|
|
|
35697
36048
|
* Query for journey aggregates asynchronously
|
|
35698
36049
|
*
|
|
35699
36050
|
* @param {Object} body query
|
|
35700
|
-
*
|
|
36051
|
+
* postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35701
36052
|
*/
|
|
35702
36053
|
postAnalyticsJourneysAggregatesJobs(body) {
|
|
35703
36054
|
// verify the required parameter 'body' is set
|
|
@@ -35846,7 +36197,7 @@ class JourneyApi {
|
|
|
35846
36197
|
*
|
|
35847
36198
|
* @param {Object} opts Optional parameters
|
|
35848
36199
|
* @param {Object} opts.body outcome attribution request
|
|
35849
|
-
*
|
|
36200
|
+
* postJourneyOutcomesAttributionsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35850
36201
|
*/
|
|
35851
36202
|
postJourneyOutcomesAttributionsJobs(opts) {
|
|
35852
36203
|
opts = opts || {};
|
|
@@ -35920,7 +36271,7 @@ class KnowledgeApi {
|
|
|
35920
36271
|
/**
|
|
35921
36272
|
* Knowledge service.
|
|
35922
36273
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
35923
|
-
* @version
|
|
36274
|
+
* @version 170.0.0
|
|
35924
36275
|
*/
|
|
35925
36276
|
|
|
35926
36277
|
/**
|
|
@@ -36151,7 +36502,7 @@ class KnowledgeApi {
|
|
|
36151
36502
|
* @param {String} categoryId Category ID
|
|
36152
36503
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36153
36504
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
36154
|
-
|
|
36505
|
+
* @deprecated
|
|
36155
36506
|
*/
|
|
36156
36507
|
deleteKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
|
|
36157
36508
|
// verify the required parameter 'categoryId' is set
|
|
@@ -36187,7 +36538,7 @@ class KnowledgeApi {
|
|
|
36187
36538
|
* @param {String} documentId Document ID
|
|
36188
36539
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36189
36540
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
36190
|
-
|
|
36541
|
+
* @deprecated
|
|
36191
36542
|
*/
|
|
36192
36543
|
deleteKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
|
|
36193
36544
|
// verify the required parameter 'documentId' is set
|
|
@@ -36223,7 +36574,7 @@ class KnowledgeApi {
|
|
|
36223
36574
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36224
36575
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
36225
36576
|
* @param {String} importId Import ID
|
|
36226
|
-
|
|
36577
|
+
* @deprecated
|
|
36227
36578
|
*/
|
|
36228
36579
|
deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
|
|
36229
36580
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36725,6 +37076,7 @@ class KnowledgeApi {
|
|
|
36725
37076
|
* @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
|
|
36726
37077
|
* @param {Array.<String>} opts.labelIds If specified, retrieves documents associated with label ids, comma separated values expected.
|
|
36727
37078
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
37079
|
+
* @param {Array.<String>} opts.externalIds If specified, retrieves documents associated with external ids, comma separated values expected.
|
|
36728
37080
|
*/
|
|
36729
37081
|
getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, opts) {
|
|
36730
37082
|
opts = opts || {};
|
|
@@ -36738,7 +37090,7 @@ class KnowledgeApi {
|
|
|
36738
37090
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
|
|
36739
37091
|
'GET',
|
|
36740
37092
|
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
36741
|
-
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'documentId': this.apiClient.buildCollectionParam(opts['documentId'], 'multi'),'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'includeDrafts': opts['includeDrafts'],'labelIds': this.apiClient.buildCollectionParam(opts['labelIds'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
37093
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'documentId': this.apiClient.buildCollectionParam(opts['documentId'], 'multi'),'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'includeDrafts': opts['includeDrafts'],'labelIds': this.apiClient.buildCollectionParam(opts['labelIds'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'externalIds': this.apiClient.buildCollectionParam(opts['externalIds'], 'multi') },
|
|
36742
37094
|
{ },
|
|
36743
37095
|
{ },
|
|
36744
37096
|
null,
|
|
@@ -36882,7 +37234,7 @@ class KnowledgeApi {
|
|
|
36882
37234
|
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
36883
37235
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
36884
37236
|
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
36885
|
-
|
|
37237
|
+
* @deprecated
|
|
36886
37238
|
*/
|
|
36887
37239
|
getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, opts) {
|
|
36888
37240
|
opts = opts || {};
|
|
@@ -36916,7 +37268,7 @@ class KnowledgeApi {
|
|
|
36916
37268
|
* @param {String} categoryId Category ID
|
|
36917
37269
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36918
37270
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
36919
|
-
|
|
37271
|
+
* @deprecated
|
|
36920
37272
|
*/
|
|
36921
37273
|
getKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
|
|
36922
37274
|
// verify the required parameter 'categoryId' is set
|
|
@@ -36952,7 +37304,7 @@ class KnowledgeApi {
|
|
|
36952
37304
|
* @param {String} documentId Document ID
|
|
36953
37305
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36954
37306
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
36955
|
-
|
|
37307
|
+
* @deprecated
|
|
36956
37308
|
*/
|
|
36957
37309
|
getKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
|
|
36958
37310
|
// verify the required parameter 'documentId' is set
|
|
@@ -36989,8 +37341,8 @@ class KnowledgeApi {
|
|
|
36989
37341
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36990
37342
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
36991
37343
|
* @param {String} uploadId UploadId
|
|
36992
|
-
|
|
36993
|
-
*
|
|
37344
|
+
* @deprecated
|
|
37345
|
+
* getKnowledgeKnowledgebaseLanguageDocumentUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36994
37346
|
*/
|
|
36995
37347
|
getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId, knowledgeBaseId, languageCode, uploadId) {
|
|
36996
37348
|
// verify the required parameter 'documentId' is set
|
|
@@ -37039,7 +37391,7 @@ class KnowledgeApi {
|
|
|
37039
37391
|
* @param {Object} opts.sortBy Sort by.
|
|
37040
37392
|
* @param {Object} opts.sortOrder Sort Order.
|
|
37041
37393
|
* @param {Array.<String>} opts.documentIds Comma-separated list of document identifiers to fetch by.
|
|
37042
|
-
|
|
37394
|
+
* @deprecated
|
|
37043
37395
|
*/
|
|
37044
37396
|
getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
|
|
37045
37397
|
opts = opts || {};
|
|
@@ -37073,7 +37425,7 @@ class KnowledgeApi {
|
|
|
37073
37425
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37074
37426
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
37075
37427
|
* @param {String} importId Import ID
|
|
37076
|
-
|
|
37428
|
+
* @deprecated
|
|
37077
37429
|
*/
|
|
37078
37430
|
getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
|
|
37079
37431
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -37109,7 +37461,7 @@ class KnowledgeApi {
|
|
|
37109
37461
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37110
37462
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
37111
37463
|
* @param {String} trainingId Training ID
|
|
37112
|
-
|
|
37464
|
+
* @deprecated
|
|
37113
37465
|
*/
|
|
37114
37466
|
getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId, languageCode, trainingId) {
|
|
37115
37467
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -37150,7 +37502,7 @@ class KnowledgeApi {
|
|
|
37150
37502
|
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
37151
37503
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
37152
37504
|
* @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
|
|
37153
|
-
|
|
37505
|
+
* @deprecated
|
|
37154
37506
|
*/
|
|
37155
37507
|
getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
|
|
37156
37508
|
opts = opts || {};
|
|
@@ -37598,7 +37950,7 @@ class KnowledgeApi {
|
|
|
37598
37950
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37599
37951
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
37600
37952
|
* @param {Object} body
|
|
37601
|
-
|
|
37953
|
+
* @deprecated
|
|
37602
37954
|
*/
|
|
37603
37955
|
patchKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode, body) {
|
|
37604
37956
|
// verify the required parameter 'categoryId' is set
|
|
@@ -37639,7 +37991,7 @@ class KnowledgeApi {
|
|
|
37639
37991
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37640
37992
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
37641
37993
|
* @param {Object} body
|
|
37642
|
-
|
|
37994
|
+
* @deprecated
|
|
37643
37995
|
*/
|
|
37644
37996
|
patchKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode, body) {
|
|
37645
37997
|
// verify the required parameter 'documentId' is set
|
|
@@ -37679,7 +38031,7 @@ class KnowledgeApi {
|
|
|
37679
38031
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37680
38032
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
37681
38033
|
* @param {Array.<Object>} body
|
|
37682
|
-
|
|
38034
|
+
* @deprecated
|
|
37683
38035
|
*/
|
|
37684
38036
|
patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
|
|
37685
38037
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -37716,7 +38068,7 @@ class KnowledgeApi {
|
|
|
37716
38068
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
37717
38069
|
* @param {String} importId Import ID
|
|
37718
38070
|
* @param {Object} body
|
|
37719
|
-
|
|
38071
|
+
* @deprecated
|
|
37720
38072
|
*/
|
|
37721
38073
|
patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId, body) {
|
|
37722
38074
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38034,7 +38386,7 @@ class KnowledgeApi {
|
|
|
38034
38386
|
*
|
|
38035
38387
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38036
38388
|
* @param {Object} body
|
|
38037
|
-
*
|
|
38389
|
+
* postKnowledgeKnowledgebaseDocumentsBulkRemove is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
38038
38390
|
*/
|
|
38039
38391
|
postKnowledgeKnowledgebaseDocumentsBulkRemove(knowledgeBaseId, body) {
|
|
38040
38392
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38065,7 +38417,7 @@ class KnowledgeApi {
|
|
|
38065
38417
|
*
|
|
38066
38418
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38067
38419
|
* @param {Object} body
|
|
38068
|
-
*
|
|
38420
|
+
* postKnowledgeKnowledgebaseDocumentsBulkUpdate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
38069
38421
|
*/
|
|
38070
38422
|
postKnowledgeKnowledgebaseDocumentsBulkUpdate(knowledgeBaseId, body) {
|
|
38071
38423
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38155,7 +38507,7 @@ class KnowledgeApi {
|
|
|
38155
38507
|
*
|
|
38156
38508
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38157
38509
|
* @param {Object} body
|
|
38158
|
-
*
|
|
38510
|
+
* postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
38159
38511
|
*/
|
|
38160
38512
|
postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(knowledgeBaseId, body) {
|
|
38161
38513
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38277,7 +38629,7 @@ class KnowledgeApi {
|
|
|
38277
38629
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38278
38630
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
38279
38631
|
* @param {Object} body
|
|
38280
|
-
|
|
38632
|
+
* @deprecated
|
|
38281
38633
|
*/
|
|
38282
38634
|
postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, body) {
|
|
38283
38635
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38314,8 +38666,8 @@ class KnowledgeApi {
|
|
|
38314
38666
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38315
38667
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
38316
38668
|
* @param {Object} body
|
|
38317
|
-
|
|
38318
|
-
*
|
|
38669
|
+
* @deprecated
|
|
38670
|
+
* postKnowledgeKnowledgebaseLanguageDocumentUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
38319
38671
|
*/
|
|
38320
38672
|
postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId, knowledgeBaseId, languageCode, body) {
|
|
38321
38673
|
// verify the required parameter 'documentId' is set
|
|
@@ -38355,7 +38707,7 @@ class KnowledgeApi {
|
|
|
38355
38707
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38356
38708
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
38357
38709
|
* @param {Object} body
|
|
38358
|
-
|
|
38710
|
+
* @deprecated
|
|
38359
38711
|
*/
|
|
38360
38712
|
postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
|
|
38361
38713
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38391,7 +38743,7 @@ class KnowledgeApi {
|
|
|
38391
38743
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38392
38744
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
38393
38745
|
* @param {Object} body
|
|
38394
|
-
|
|
38746
|
+
* @deprecated
|
|
38395
38747
|
*/
|
|
38396
38748
|
postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId, languageCode, body) {
|
|
38397
38749
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38427,7 +38779,7 @@ class KnowledgeApi {
|
|
|
38427
38779
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38428
38780
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
38429
38781
|
* @param {String} trainingId Training ID
|
|
38430
|
-
|
|
38782
|
+
* @deprecated
|
|
38431
38783
|
*/
|
|
38432
38784
|
postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId, languageCode, trainingId) {
|
|
38433
38785
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38462,7 +38814,7 @@ class KnowledgeApi {
|
|
|
38462
38814
|
*
|
|
38463
38815
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38464
38816
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
38465
|
-
|
|
38817
|
+
* @deprecated
|
|
38466
38818
|
*/
|
|
38467
38819
|
postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode) {
|
|
38468
38820
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38494,7 +38846,7 @@ class KnowledgeApi {
|
|
|
38494
38846
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38495
38847
|
* @param {Object} opts Optional parameters
|
|
38496
38848
|
* @param {Object} opts.body
|
|
38497
|
-
|
|
38849
|
+
* @deprecated
|
|
38498
38850
|
*/
|
|
38499
38851
|
postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
|
|
38500
38852
|
opts = opts || {};
|
|
@@ -38549,7 +38901,7 @@ class LanguageUnderstandingApi {
|
|
|
38549
38901
|
/**
|
|
38550
38902
|
* LanguageUnderstanding service.
|
|
38551
38903
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
38552
|
-
* @version
|
|
38904
|
+
* @version 170.0.0
|
|
38553
38905
|
*/
|
|
38554
38906
|
|
|
38555
38907
|
/**
|
|
@@ -39562,7 +39914,7 @@ class LanguagesApi {
|
|
|
39562
39914
|
/**
|
|
39563
39915
|
* Languages service.
|
|
39564
39916
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
39565
|
-
* @version
|
|
39917
|
+
* @version 170.0.0
|
|
39566
39918
|
*/
|
|
39567
39919
|
|
|
39568
39920
|
/**
|
|
@@ -39581,7 +39933,7 @@ class LanguagesApi {
|
|
|
39581
39933
|
* Delete Language (Deprecated)
|
|
39582
39934
|
* This endpoint is deprecated. Please see the Routing API (DELETE /api/v2/routing/languages/{languageId})
|
|
39583
39935
|
* @param {String} languageId Language ID
|
|
39584
|
-
|
|
39936
|
+
* @deprecated
|
|
39585
39937
|
*/
|
|
39586
39938
|
deleteLanguage(languageId) {
|
|
39587
39939
|
// verify the required parameter 'languageId' is set
|
|
@@ -39607,7 +39959,7 @@ class LanguagesApi {
|
|
|
39607
39959
|
* Get Language (Deprecated)
|
|
39608
39960
|
* This endpoint is deprecated. Please see the Routing API (GET /api/v2/routing/languages/{languageId})
|
|
39609
39961
|
* @param {String} languageId Language ID
|
|
39610
|
-
|
|
39962
|
+
* @deprecated
|
|
39611
39963
|
*/
|
|
39612
39964
|
getLanguage(languageId) {
|
|
39613
39965
|
// verify the required parameter 'languageId' is set
|
|
@@ -39637,7 +39989,7 @@ class LanguagesApi {
|
|
|
39637
39989
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
39638
39990
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
39639
39991
|
* @param {String} opts.name Name
|
|
39640
|
-
|
|
39992
|
+
* @deprecated
|
|
39641
39993
|
*/
|
|
39642
39994
|
getLanguages(opts) {
|
|
39643
39995
|
opts = opts || {};
|
|
@@ -39756,7 +40108,7 @@ class LanguagesApi {
|
|
|
39756
40108
|
* Create Language (Deprecated)
|
|
39757
40109
|
* This endpoint is deprecated. Please see the Routing API. (POST /api/v2/routing/languages
|
|
39758
40110
|
* @param {Object} body Language
|
|
39759
|
-
|
|
40111
|
+
* @deprecated
|
|
39760
40112
|
*/
|
|
39761
40113
|
postLanguages(body) {
|
|
39762
40114
|
// verify the required parameter 'body' is set
|
|
@@ -39784,7 +40136,7 @@ class LearningApi {
|
|
|
39784
40136
|
/**
|
|
39785
40137
|
* Learning service.
|
|
39786
40138
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
39787
|
-
* @version
|
|
40139
|
+
* @version 170.0.0
|
|
39788
40140
|
*/
|
|
39789
40141
|
|
|
39790
40142
|
/**
|
|
@@ -40599,7 +40951,7 @@ class LicenseApi {
|
|
|
40599
40951
|
/**
|
|
40600
40952
|
* License service.
|
|
40601
40953
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
40602
|
-
* @version
|
|
40954
|
+
* @version 170.0.0
|
|
40603
40955
|
*/
|
|
40604
40956
|
|
|
40605
40957
|
/**
|
|
@@ -40837,7 +41189,7 @@ class LocationsApi {
|
|
|
40837
41189
|
/**
|
|
40838
41190
|
* Locations service.
|
|
40839
41191
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
40840
|
-
* @version
|
|
41192
|
+
* @version 170.0.0
|
|
40841
41193
|
*/
|
|
40842
41194
|
|
|
40843
41195
|
/**
|
|
@@ -41073,7 +41425,7 @@ class MessagingApi {
|
|
|
41073
41425
|
/**
|
|
41074
41426
|
* Messaging service.
|
|
41075
41427
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
41076
|
-
* @version
|
|
41428
|
+
* @version 170.0.0
|
|
41077
41429
|
*/
|
|
41078
41430
|
|
|
41079
41431
|
/**
|
|
@@ -41092,7 +41444,7 @@ class MessagingApi {
|
|
|
41092
41444
|
* Delete a supported content profile
|
|
41093
41445
|
* Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
41094
41446
|
* @param {String} supportedContentId Supported Content ID
|
|
41095
|
-
|
|
41447
|
+
* @deprecated
|
|
41096
41448
|
*/
|
|
41097
41449
|
deleteMessagingSupportedcontentSupportedContentId(supportedContentId) {
|
|
41098
41450
|
// verify the required parameter 'supportedContentId' is set
|
|
@@ -41120,7 +41472,7 @@ class MessagingApi {
|
|
|
41120
41472
|
* @param {Object} opts Optional parameters
|
|
41121
41473
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
41122
41474
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
41123
|
-
|
|
41475
|
+
* @deprecated
|
|
41124
41476
|
*/
|
|
41125
41477
|
getMessagingSupportedcontent(opts) {
|
|
41126
41478
|
opts = opts || {};
|
|
@@ -41144,7 +41496,7 @@ class MessagingApi {
|
|
|
41144
41496
|
* Get a supported content profile
|
|
41145
41497
|
* Deprecated - use GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
41146
41498
|
* @param {String} supportedContentId Supported Content ID
|
|
41147
|
-
|
|
41499
|
+
* @deprecated
|
|
41148
41500
|
*/
|
|
41149
41501
|
getMessagingSupportedcontentSupportedContentId(supportedContentId) {
|
|
41150
41502
|
// verify the required parameter 'supportedContentId' is set
|
|
@@ -41171,7 +41523,7 @@ class MessagingApi {
|
|
|
41171
41523
|
* Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
41172
41524
|
* @param {String} supportedContentId Supported Content ID
|
|
41173
41525
|
* @param {Object} body SupportedContent
|
|
41174
|
-
|
|
41526
|
+
* @deprecated
|
|
41175
41527
|
*/
|
|
41176
41528
|
patchMessagingSupportedcontentSupportedContentId(supportedContentId, body) {
|
|
41177
41529
|
// verify the required parameter 'supportedContentId' is set
|
|
@@ -41201,7 +41553,7 @@ class MessagingApi {
|
|
|
41201
41553
|
* Create a Supported Content profile
|
|
41202
41554
|
* Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
|
|
41203
41555
|
* @param {Object} body SupportedContent
|
|
41204
|
-
|
|
41556
|
+
* @deprecated
|
|
41205
41557
|
*/
|
|
41206
41558
|
postMessagingSupportedcontent(body) {
|
|
41207
41559
|
// verify the required parameter 'body' is set
|
|
@@ -41229,7 +41581,7 @@ class MobileDevicesApi {
|
|
|
41229
41581
|
/**
|
|
41230
41582
|
* MobileDevices service.
|
|
41231
41583
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
41232
|
-
* @version
|
|
41584
|
+
* @version 170.0.0
|
|
41233
41585
|
*/
|
|
41234
41586
|
|
|
41235
41587
|
/**
|
|
@@ -41380,7 +41732,7 @@ class NotificationsApi {
|
|
|
41380
41732
|
/**
|
|
41381
41733
|
* Notifications service.
|
|
41382
41734
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
41383
|
-
* @version
|
|
41735
|
+
* @version 170.0.0
|
|
41384
41736
|
*/
|
|
41385
41737
|
|
|
41386
41738
|
/**
|
|
@@ -41613,7 +41965,7 @@ class OAuthApi {
|
|
|
41613
41965
|
/**
|
|
41614
41966
|
* OAuth service.
|
|
41615
41967
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
41616
|
-
* @version
|
|
41968
|
+
* @version 170.0.0
|
|
41617
41969
|
*/
|
|
41618
41970
|
|
|
41619
41971
|
/**
|
|
@@ -41979,7 +42331,7 @@ class ObjectsApi {
|
|
|
41979
42331
|
/**
|
|
41980
42332
|
* Objects service.
|
|
41981
42333
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
41982
|
-
* @version
|
|
42334
|
+
* @version 170.0.0
|
|
41983
42335
|
*/
|
|
41984
42336
|
|
|
41985
42337
|
/**
|
|
@@ -42250,7 +42602,7 @@ class OrganizationApi {
|
|
|
42250
42602
|
/**
|
|
42251
42603
|
* Organization service.
|
|
42252
42604
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
42253
|
-
* @version
|
|
42605
|
+
* @version 170.0.0
|
|
42254
42606
|
*/
|
|
42255
42607
|
|
|
42256
42608
|
/**
|
|
@@ -42269,7 +42621,7 @@ class OrganizationApi {
|
|
|
42269
42621
|
* Fetch field config for an entity type
|
|
42270
42622
|
*
|
|
42271
42623
|
* @param {Object} type Field type
|
|
42272
|
-
|
|
42624
|
+
* @deprecated
|
|
42273
42625
|
*/
|
|
42274
42626
|
getFieldconfig(type) {
|
|
42275
42627
|
// verify the required parameter 'type' is set
|
|
@@ -42314,7 +42666,7 @@ class OrganizationApi {
|
|
|
42314
42666
|
/**
|
|
42315
42667
|
* Get the list of domains that will be allowed to embed PureCloud applications
|
|
42316
42668
|
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
42317
|
-
|
|
42669
|
+
* @deprecated
|
|
42318
42670
|
*/
|
|
42319
42671
|
getOrganizationsEmbeddedintegration() {
|
|
42320
42672
|
|
|
@@ -42335,7 +42687,7 @@ class OrganizationApi {
|
|
|
42335
42687
|
/**
|
|
42336
42688
|
* Get organization IP address whitelist settings
|
|
42337
42689
|
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
42338
|
-
|
|
42690
|
+
* @deprecated
|
|
42339
42691
|
*/
|
|
42340
42692
|
getOrganizationsIpaddressauthentication() {
|
|
42341
42693
|
|
|
@@ -42524,7 +42876,7 @@ class OrganizationApi {
|
|
|
42524
42876
|
/**
|
|
42525
42877
|
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
42526
42878
|
*
|
|
42527
|
-
|
|
42879
|
+
* @deprecated
|
|
42528
42880
|
*/
|
|
42529
42881
|
getOrganizationsWhitelist() {
|
|
42530
42882
|
|
|
@@ -42601,7 +42953,7 @@ class OrganizationApi {
|
|
|
42601
42953
|
* Update the list of domains that will be allowed to embed PureCloud applications
|
|
42602
42954
|
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
42603
42955
|
* @param {Object} body Whitelist settings
|
|
42604
|
-
|
|
42956
|
+
* @deprecated
|
|
42605
42957
|
*/
|
|
42606
42958
|
putOrganizationsEmbeddedintegration(body) {
|
|
42607
42959
|
// verify the required parameter 'body' is set
|
|
@@ -42627,7 +42979,7 @@ class OrganizationApi {
|
|
|
42627
42979
|
* Update organization IP address whitelist settings
|
|
42628
42980
|
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
42629
42981
|
* @param {Object} body IP address Whitelist settings
|
|
42630
|
-
|
|
42982
|
+
* @deprecated
|
|
42631
42983
|
*/
|
|
42632
42984
|
putOrganizationsIpaddressauthentication(body) {
|
|
42633
42985
|
// verify the required parameter 'body' is set
|
|
@@ -42677,7 +43029,7 @@ class OrganizationApi {
|
|
|
42677
43029
|
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
42678
43030
|
*
|
|
42679
43031
|
* @param {Object} body Whitelist settings
|
|
42680
|
-
|
|
43032
|
+
* @deprecated
|
|
42681
43033
|
*/
|
|
42682
43034
|
putOrganizationsWhitelist(body) {
|
|
42683
43035
|
// verify the required parameter 'body' is set
|
|
@@ -42705,7 +43057,7 @@ class OrganizationAuthorizationApi {
|
|
|
42705
43057
|
/**
|
|
42706
43058
|
* OrganizationAuthorization service.
|
|
42707
43059
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
42708
|
-
* @version
|
|
43060
|
+
* @version 170.0.0
|
|
42709
43061
|
*/
|
|
42710
43062
|
|
|
42711
43063
|
/**
|
|
@@ -42899,7 +43251,7 @@ class OrganizationAuthorizationApi {
|
|
|
42899
43251
|
* Delete Bulk Org Trustees
|
|
42900
43252
|
*
|
|
42901
43253
|
* @param {Array.<String>} id Comma separated list of trustee ids to remove
|
|
42902
|
-
*
|
|
43254
|
+
* deleteOrgauthorizationTrustees is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
42903
43255
|
*/
|
|
42904
43256
|
deleteOrgauthorizationTrustees(id) {
|
|
42905
43257
|
// verify the required parameter 'id' is set
|
|
@@ -43040,7 +43392,7 @@ class OrganizationAuthorizationApi {
|
|
|
43040
43392
|
* Delete Bulk Org Trustors
|
|
43041
43393
|
*
|
|
43042
43394
|
* @param {Array.<String>} id Comma separated list of trustor ids to remove
|
|
43043
|
-
*
|
|
43395
|
+
* deleteOrgauthorizationTrustors is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
43044
43396
|
*/
|
|
43045
43397
|
deleteOrgauthorizationTrustors(id) {
|
|
43046
43398
|
// verify the required parameter 'id' is set
|
|
@@ -44052,7 +44404,7 @@ class OutboundApi {
|
|
|
44052
44404
|
/**
|
|
44053
44405
|
* Outbound service.
|
|
44054
44406
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
44055
|
-
* @version
|
|
44407
|
+
* @version 170.0.0
|
|
44056
44408
|
*/
|
|
44057
44409
|
|
|
44058
44410
|
/**
|
|
@@ -46537,7 +46889,7 @@ class OutboundApi {
|
|
|
46537
46889
|
* This endpoint is deprecated and may have unexpected results. Please use "/conversations/{conversationId}/participants/{participantId}/callbacks instead."
|
|
46538
46890
|
* @param {String} campaignId Campaign ID
|
|
46539
46891
|
* @param {Object} body ContactCallbackRequest
|
|
46540
|
-
|
|
46892
|
+
* @deprecated
|
|
46541
46893
|
*/
|
|
46542
46894
|
postOutboundCampaignCallbackSchedule(campaignId, body) {
|
|
46543
46895
|
// verify the required parameter 'campaignId' is set
|
|
@@ -47674,7 +48026,7 @@ class PresenceApi {
|
|
|
47674
48026
|
/**
|
|
47675
48027
|
* Presence service.
|
|
47676
48028
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
47677
|
-
* @version
|
|
48029
|
+
* @version 170.0.0
|
|
47678
48030
|
*/
|
|
47679
48031
|
|
|
47680
48032
|
/**
|
|
@@ -47693,12 +48045,12 @@ class PresenceApi {
|
|
|
47693
48045
|
* Delete a Presence Definition
|
|
47694
48046
|
*
|
|
47695
48047
|
* @param {String} definitionId Presence Definition ID
|
|
47696
|
-
*
|
|
48048
|
+
* deletePresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
47697
48049
|
*/
|
|
47698
|
-
|
|
48050
|
+
deletePresenceDefinition0(definitionId) {
|
|
47699
48051
|
// verify the required parameter 'definitionId' is set
|
|
47700
48052
|
if (definitionId === undefined || definitionId === null) {
|
|
47701
|
-
throw 'Missing the required parameter "definitionId" when calling
|
|
48053
|
+
throw 'Missing the required parameter "definitionId" when calling deletePresenceDefinition0';
|
|
47702
48054
|
}
|
|
47703
48055
|
|
|
47704
48056
|
return this.apiClient.callApi(
|
|
@@ -47769,12 +48121,12 @@ class PresenceApi {
|
|
|
47769
48121
|
* Get a Presence Definition
|
|
47770
48122
|
*
|
|
47771
48123
|
* @param {String} definitionId Presence Definition ID
|
|
47772
|
-
*
|
|
48124
|
+
* getPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
47773
48125
|
*/
|
|
47774
|
-
|
|
48126
|
+
getPresenceDefinition0(definitionId) {
|
|
47775
48127
|
// verify the required parameter 'definitionId' is set
|
|
47776
48128
|
if (definitionId === undefined || definitionId === null) {
|
|
47777
|
-
throw 'Missing the required parameter "definitionId" when calling
|
|
48129
|
+
throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition0';
|
|
47778
48130
|
}
|
|
47779
48131
|
|
|
47780
48132
|
return this.apiClient.callApi(
|
|
@@ -47797,9 +48149,9 @@ class PresenceApi {
|
|
|
47797
48149
|
* @param {Object} opts Optional parameters
|
|
47798
48150
|
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
47799
48151
|
* @param {Array.<String>} opts.divisionId One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.
|
|
47800
|
-
*
|
|
48152
|
+
* getPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
47801
48153
|
*/
|
|
47802
|
-
|
|
48154
|
+
getPresenceDefinitions0(opts) {
|
|
47803
48155
|
opts = opts || {};
|
|
47804
48156
|
|
|
47805
48157
|
|
|
@@ -48042,6 +48394,59 @@ class PresenceApi {
|
|
|
48042
48394
|
);
|
|
48043
48395
|
}
|
|
48044
48396
|
|
|
48397
|
+
/**
|
|
48398
|
+
* Get bulk user presences for a single presence source
|
|
48399
|
+
*
|
|
48400
|
+
* @param {String} sourceId The requested presence source ID.
|
|
48401
|
+
* @param {Object} opts Optional parameters
|
|
48402
|
+
* @param {Array.<String>} opts.id A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.
|
|
48403
|
+
*/
|
|
48404
|
+
getUsersPresenceBulk(sourceId, opts) {
|
|
48405
|
+
opts = opts || {};
|
|
48406
|
+
|
|
48407
|
+
// verify the required parameter 'sourceId' is set
|
|
48408
|
+
if (sourceId === undefined || sourceId === null) {
|
|
48409
|
+
throw 'Missing the required parameter "sourceId" when calling getUsersPresenceBulk';
|
|
48410
|
+
}
|
|
48411
|
+
|
|
48412
|
+
return this.apiClient.callApi(
|
|
48413
|
+
'/api/v2/users/presences/{sourceId}/bulk',
|
|
48414
|
+
'GET',
|
|
48415
|
+
{ 'sourceId': sourceId },
|
|
48416
|
+
{ 'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
|
|
48417
|
+
{ },
|
|
48418
|
+
{ },
|
|
48419
|
+
null,
|
|
48420
|
+
['PureCloud OAuth'],
|
|
48421
|
+
['application/json'],
|
|
48422
|
+
['application/json']
|
|
48423
|
+
);
|
|
48424
|
+
}
|
|
48425
|
+
|
|
48426
|
+
/**
|
|
48427
|
+
* Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source
|
|
48428
|
+
*
|
|
48429
|
+
* @param {Object} opts Optional parameters
|
|
48430
|
+
* @param {Array.<String>} opts.id A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.
|
|
48431
|
+
*/
|
|
48432
|
+
getUsersPresencesPurecloudBulk(opts) {
|
|
48433
|
+
opts = opts || {};
|
|
48434
|
+
|
|
48435
|
+
|
|
48436
|
+
return this.apiClient.callApi(
|
|
48437
|
+
'/api/v2/users/presences/purecloud/bulk',
|
|
48438
|
+
'GET',
|
|
48439
|
+
{ },
|
|
48440
|
+
{ 'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
|
|
48441
|
+
{ },
|
|
48442
|
+
{ },
|
|
48443
|
+
null,
|
|
48444
|
+
['PureCloud OAuth'],
|
|
48445
|
+
['application/json'],
|
|
48446
|
+
['application/json']
|
|
48447
|
+
);
|
|
48448
|
+
}
|
|
48449
|
+
|
|
48045
48450
|
/**
|
|
48046
48451
|
* Patch a user's Presence
|
|
48047
48452
|
* Patch a users presence for the specified source that is not specifically listed. This endpoint does not support registered presence sources. The presence object can be patched one of three ways. Option 1: Set the primary property to true. This will set the source defined in the path as the users primary presence source. Option 2: Provide the presenceDefinition value. The id is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
@@ -48111,12 +48516,12 @@ class PresenceApi {
|
|
|
48111
48516
|
* Create a Presence Definition
|
|
48112
48517
|
*
|
|
48113
48518
|
* @param {Object} body The Presence Definition to create
|
|
48114
|
-
*
|
|
48519
|
+
* postPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48115
48520
|
*/
|
|
48116
|
-
|
|
48521
|
+
postPresenceDefinitions0(body) {
|
|
48117
48522
|
// verify the required parameter 'body' is set
|
|
48118
48523
|
if (body === undefined || body === null) {
|
|
48119
|
-
throw 'Missing the required parameter "body" when calling
|
|
48524
|
+
throw 'Missing the required parameter "body" when calling postPresenceDefinitions0';
|
|
48120
48525
|
}
|
|
48121
48526
|
|
|
48122
48527
|
return this.apiClient.callApi(
|
|
@@ -48188,16 +48593,16 @@ class PresenceApi {
|
|
|
48188
48593
|
*
|
|
48189
48594
|
* @param {String} definitionId Presence Definition ID
|
|
48190
48595
|
* @param {Object} body The updated Presence Definition
|
|
48191
|
-
*
|
|
48596
|
+
* putPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48192
48597
|
*/
|
|
48193
|
-
|
|
48598
|
+
putPresenceDefinition0(definitionId, body) {
|
|
48194
48599
|
// verify the required parameter 'definitionId' is set
|
|
48195
48600
|
if (definitionId === undefined || definitionId === null) {
|
|
48196
|
-
throw 'Missing the required parameter "definitionId" when calling
|
|
48601
|
+
throw 'Missing the required parameter "definitionId" when calling putPresenceDefinition0';
|
|
48197
48602
|
}
|
|
48198
48603
|
// verify the required parameter 'body' is set
|
|
48199
48604
|
if (body === undefined || body === null) {
|
|
48200
|
-
throw 'Missing the required parameter "body" when calling
|
|
48605
|
+
throw 'Missing the required parameter "body" when calling putPresenceDefinition0';
|
|
48201
48606
|
}
|
|
48202
48607
|
|
|
48203
48608
|
return this.apiClient.callApi(
|
|
@@ -48360,7 +48765,7 @@ class ProcessAutomationApi {
|
|
|
48360
48765
|
/**
|
|
48361
48766
|
* ProcessAutomation service.
|
|
48362
48767
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
48363
|
-
* @version
|
|
48768
|
+
* @version 170.0.0
|
|
48364
48769
|
*/
|
|
48365
48770
|
|
|
48366
48771
|
/**
|
|
@@ -48599,7 +49004,7 @@ class QualityApi {
|
|
|
48599
49004
|
/**
|
|
48600
49005
|
* Quality service.
|
|
48601
49006
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
48602
|
-
* @version
|
|
49007
|
+
* @version 170.0.0
|
|
48603
49008
|
*/
|
|
48604
49009
|
|
|
48605
49010
|
/**
|
|
@@ -48682,7 +49087,7 @@ class QualityApi {
|
|
|
48682
49087
|
* Delete an evaluation form.
|
|
48683
49088
|
*
|
|
48684
49089
|
* @param {String} formId Form ID
|
|
48685
|
-
|
|
49090
|
+
* @deprecated
|
|
48686
49091
|
*/
|
|
48687
49092
|
deleteQualityForm(formId) {
|
|
48688
49093
|
// verify the required parameter 'formId' is set
|
|
@@ -48758,7 +49163,7 @@ class QualityApi {
|
|
|
48758
49163
|
* Get status for async query for evaluation aggregates
|
|
48759
49164
|
*
|
|
48760
49165
|
* @param {String} jobId jobId
|
|
48761
|
-
*
|
|
49166
|
+
* getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48762
49167
|
*/
|
|
48763
49168
|
getAnalyticsEvaluationsAggregatesJob(jobId) {
|
|
48764
49169
|
// verify the required parameter 'jobId' is set
|
|
@@ -48786,7 +49191,7 @@ class QualityApi {
|
|
|
48786
49191
|
* @param {String} jobId jobId
|
|
48787
49192
|
* @param {Object} opts Optional parameters
|
|
48788
49193
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
48789
|
-
*
|
|
49194
|
+
* getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48790
49195
|
*/
|
|
48791
49196
|
getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) {
|
|
48792
49197
|
opts = opts || {};
|
|
@@ -48814,7 +49219,7 @@ class QualityApi {
|
|
|
48814
49219
|
* Get status for async query for survey aggregates
|
|
48815
49220
|
*
|
|
48816
49221
|
* @param {String} jobId jobId
|
|
48817
|
-
*
|
|
49222
|
+
* getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48818
49223
|
*/
|
|
48819
49224
|
getAnalyticsSurveysAggregatesJob(jobId) {
|
|
48820
49225
|
// verify the required parameter 'jobId' is set
|
|
@@ -48842,7 +49247,7 @@ class QualityApi {
|
|
|
48842
49247
|
* @param {String} jobId jobId
|
|
48843
49248
|
* @param {Object} opts Optional parameters
|
|
48844
49249
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
48845
|
-
*
|
|
49250
|
+
* getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48846
49251
|
*/
|
|
48847
49252
|
getAnalyticsSurveysAggregatesJobResults(jobId, opts) {
|
|
48848
49253
|
opts = opts || {};
|
|
@@ -49163,7 +49568,7 @@ class QualityApi {
|
|
|
49163
49568
|
* Get an evaluation form
|
|
49164
49569
|
*
|
|
49165
49570
|
* @param {String} formId Form ID
|
|
49166
|
-
|
|
49571
|
+
* @deprecated
|
|
49167
49572
|
*/
|
|
49168
49573
|
getQualityForm(formId) {
|
|
49169
49574
|
// verify the required parameter 'formId' is set
|
|
@@ -49192,7 +49597,7 @@ class QualityApi {
|
|
|
49192
49597
|
* @param {Object} opts Optional parameters
|
|
49193
49598
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
49194
49599
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
49195
|
-
|
|
49600
|
+
* @deprecated
|
|
49196
49601
|
*/
|
|
49197
49602
|
getQualityFormVersions(formId, opts) {
|
|
49198
49603
|
opts = opts || {};
|
|
@@ -49228,7 +49633,7 @@ class QualityApi {
|
|
|
49228
49633
|
* @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
|
|
49229
49634
|
* @param {String} opts.name Name
|
|
49230
49635
|
* @param {String} opts.sortOrder Order to sort results, either asc or desc
|
|
49231
|
-
|
|
49636
|
+
* @deprecated
|
|
49232
49637
|
*/
|
|
49233
49638
|
getQualityForms(opts) {
|
|
49234
49639
|
opts = opts || {};
|
|
@@ -49504,7 +49909,7 @@ class QualityApi {
|
|
|
49504
49909
|
* Get the published evaluation forms.
|
|
49505
49910
|
*
|
|
49506
49911
|
* @param {String} formId Form ID
|
|
49507
|
-
|
|
49912
|
+
* @deprecated
|
|
49508
49913
|
*/
|
|
49509
49914
|
getQualityPublishedform(formId) {
|
|
49510
49915
|
// verify the required parameter 'formId' is set
|
|
@@ -49534,7 +49939,7 @@ class QualityApi {
|
|
|
49534
49939
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
49535
49940
|
* @param {String} opts.name Name
|
|
49536
49941
|
* @param {Boolean} opts.onlyLatestPerContext onlyLatestPerContext (default to false)
|
|
49537
|
-
|
|
49942
|
+
* @deprecated
|
|
49538
49943
|
*/
|
|
49539
49944
|
getQualityPublishedforms(opts) {
|
|
49540
49945
|
opts = opts || {};
|
|
@@ -49742,7 +50147,7 @@ class QualityApi {
|
|
|
49742
50147
|
* Query for evaluation aggregates asynchronously
|
|
49743
50148
|
*
|
|
49744
50149
|
* @param {Object} body query
|
|
49745
|
-
*
|
|
50150
|
+
* postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49746
50151
|
*/
|
|
49747
50152
|
postAnalyticsEvaluationsAggregatesJobs(body) {
|
|
49748
50153
|
// verify the required parameter 'body' is set
|
|
@@ -49793,7 +50198,7 @@ class QualityApi {
|
|
|
49793
50198
|
* Query for survey aggregates asynchronously
|
|
49794
50199
|
*
|
|
49795
50200
|
* @param {Object} body query
|
|
49796
|
-
*
|
|
50201
|
+
* postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49797
50202
|
*/
|
|
49798
50203
|
postAnalyticsSurveysAggregatesJobs(body) {
|
|
49799
50204
|
// verify the required parameter 'body' is set
|
|
@@ -49982,7 +50387,7 @@ class QualityApi {
|
|
|
49982
50387
|
* Create an evaluation form.
|
|
49983
50388
|
*
|
|
49984
50389
|
* @param {Object} body Evaluation form
|
|
49985
|
-
|
|
50390
|
+
* @deprecated
|
|
49986
50391
|
*/
|
|
49987
50392
|
postQualityForms(body) {
|
|
49988
50393
|
// verify the required parameter 'body' is set
|
|
@@ -50058,7 +50463,7 @@ class QualityApi {
|
|
|
50058
50463
|
* Publish an evaluation form.
|
|
50059
50464
|
*
|
|
50060
50465
|
* @param {Object} body Publish request containing id of form to publish
|
|
50061
|
-
|
|
50466
|
+
* @deprecated
|
|
50062
50467
|
*/
|
|
50063
50468
|
postQualityPublishedforms(body) {
|
|
50064
50469
|
// verify the required parameter 'body' is set
|
|
@@ -50229,7 +50634,7 @@ class QualityApi {
|
|
|
50229
50634
|
*
|
|
50230
50635
|
* @param {String} formId Form ID
|
|
50231
50636
|
* @param {Object} body Evaluation form
|
|
50232
|
-
|
|
50637
|
+
* @deprecated
|
|
50233
50638
|
*/
|
|
50234
50639
|
putQualityForm(formId, body) {
|
|
50235
50640
|
// verify the required parameter 'formId' is set
|
|
@@ -50351,7 +50756,7 @@ class RecordingApi {
|
|
|
50351
50756
|
/**
|
|
50352
50757
|
* Recording service.
|
|
50353
50758
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
50354
|
-
* @version
|
|
50759
|
+
* @version 170.0.0
|
|
50355
50760
|
*/
|
|
50356
50761
|
|
|
50357
50762
|
/**
|
|
@@ -51988,7 +52393,7 @@ class ResponseManagementApi {
|
|
|
51988
52393
|
/**
|
|
51989
52394
|
* ResponseManagement service.
|
|
51990
52395
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
51991
|
-
* @version
|
|
52396
|
+
* @version 170.0.0
|
|
51992
52397
|
*/
|
|
51993
52398
|
|
|
51994
52399
|
/**
|
|
@@ -52473,7 +52878,7 @@ class RoutingApi {
|
|
|
52473
52878
|
/**
|
|
52474
52879
|
* Routing service.
|
|
52475
52880
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
52476
|
-
* @version
|
|
52881
|
+
* @version 170.0.0
|
|
52477
52882
|
*/
|
|
52478
52883
|
|
|
52479
52884
|
/**
|
|
@@ -52707,7 +53112,7 @@ class RoutingApi {
|
|
|
52707
53112
|
*
|
|
52708
53113
|
* @param {String} queueId Queue ID
|
|
52709
53114
|
* @param {String} memberId Member ID
|
|
52710
|
-
|
|
53115
|
+
* @deprecated
|
|
52711
53116
|
*/
|
|
52712
53117
|
deleteRoutingQueueUser(queueId, memberId) {
|
|
52713
53118
|
// verify the required parameter 'queueId' is set
|
|
@@ -52934,7 +53339,7 @@ class RoutingApi {
|
|
|
52934
53339
|
* @param {String} tagId Utilization Tag ID
|
|
52935
53340
|
* @param {Object} opts Optional parameters
|
|
52936
53341
|
* @param {Boolean} opts.forceDelete Remove all tag usages (if found) without warning (default to false)
|
|
52937
|
-
*
|
|
53342
|
+
* deleteRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
52938
53343
|
*/
|
|
52939
53344
|
deleteRoutingUtilizationTag(tagId, opts) {
|
|
52940
53345
|
opts = opts || {};
|
|
@@ -53829,7 +54234,7 @@ class RoutingApi {
|
|
|
53829
54234
|
* @param {Array.<String>} opts.languages Filter by language
|
|
53830
54235
|
* @param {Array.<String>} opts.routingStatus Filter by routing status
|
|
53831
54236
|
* @param {Array.<String>} opts.presence Filter by presence
|
|
53832
|
-
|
|
54237
|
+
* @deprecated
|
|
53833
54238
|
*/
|
|
53834
54239
|
getRoutingQueueUsers(queueId, opts) {
|
|
53835
54240
|
opts = opts || {};
|
|
@@ -54421,7 +54826,7 @@ class RoutingApi {
|
|
|
54421
54826
|
* Get details about this utilization tag
|
|
54422
54827
|
*
|
|
54423
54828
|
* @param {String} tagId Utilization Tag ID
|
|
54424
|
-
*
|
|
54829
|
+
* getRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
54425
54830
|
*/
|
|
54426
54831
|
getRoutingUtilizationTag(tagId) {
|
|
54427
54832
|
// verify the required parameter 'tagId' is set
|
|
@@ -54447,7 +54852,7 @@ class RoutingApi {
|
|
|
54447
54852
|
* Get list of agent ids associated with a utilization tag
|
|
54448
54853
|
*
|
|
54449
54854
|
* @param {String} tagId Utilization Tag ID
|
|
54450
|
-
*
|
|
54855
|
+
* getRoutingUtilizationTagAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
54451
54856
|
*/
|
|
54452
54857
|
getRoutingUtilizationTagAgents(tagId) {
|
|
54453
54858
|
// verify the required parameter 'tagId' is set
|
|
@@ -54477,7 +54882,7 @@ class RoutingApi {
|
|
|
54477
54882
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
54478
54883
|
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
54479
54884
|
* @param {String} opts.name Utilization tag's name (Wildcard is supported, e.g., 'tag1*')
|
|
54480
|
-
*
|
|
54885
|
+
* getRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
54481
54886
|
*/
|
|
54482
54887
|
getRoutingUtilizationTags(opts) {
|
|
54483
54888
|
opts = opts || {};
|
|
@@ -54867,7 +55272,7 @@ class RoutingApi {
|
|
|
54867
55272
|
* @param {String} queueId Queue ID
|
|
54868
55273
|
* @param {String} memberId Member ID
|
|
54869
55274
|
* @param {Object} body Queue Member
|
|
54870
|
-
|
|
55275
|
+
* @deprecated
|
|
54871
55276
|
*/
|
|
54872
55277
|
patchRoutingQueueUser(queueId, memberId, body) {
|
|
54873
55278
|
// verify the required parameter 'queueId' is set
|
|
@@ -54902,7 +55307,7 @@ class RoutingApi {
|
|
|
54902
55307
|
*
|
|
54903
55308
|
* @param {String} queueId Queue ID
|
|
54904
55309
|
* @param {Array.<Object>} body Queue Members
|
|
54905
|
-
|
|
55310
|
+
* @deprecated
|
|
54906
55311
|
*/
|
|
54907
55312
|
patchRoutingQueueUsers(queueId, body) {
|
|
54908
55313
|
// verify the required parameter 'queueId' is set
|
|
@@ -55179,7 +55584,7 @@ class RoutingApi {
|
|
|
55179
55584
|
* @param {Object} opts Optional parameters
|
|
55180
55585
|
* @param {Number} opts.pageSize The desired page size
|
|
55181
55586
|
* @param {Number} opts.pageNumber The desired page number
|
|
55182
|
-
*
|
|
55587
|
+
* postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
55183
55588
|
*/
|
|
55184
55589
|
postAnalyticsRoutingActivityQuery(body, opts) {
|
|
55185
55590
|
opts = opts || {};
|
|
@@ -55475,7 +55880,7 @@ class RoutingApi {
|
|
|
55475
55880
|
* @param {Array.<Object>} body Queue Members
|
|
55476
55881
|
* @param {Object} opts Optional parameters
|
|
55477
55882
|
* @param {Boolean} opts._delete True to delete queue members (default to false)
|
|
55478
|
-
|
|
55883
|
+
* @deprecated
|
|
55479
55884
|
*/
|
|
55480
55885
|
postRoutingQueueUsers(queueId, body, opts) {
|
|
55481
55886
|
opts = opts || {};
|
|
@@ -55691,7 +56096,7 @@ class RoutingApi {
|
|
|
55691
56096
|
* Imports a phone number for SMS
|
|
55692
56097
|
*
|
|
55693
56098
|
* @param {Object} body SmsPhoneNumber
|
|
55694
|
-
*
|
|
56099
|
+
* postRoutingSmsPhonenumbersImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
55695
56100
|
*/
|
|
55696
56101
|
postRoutingSmsPhonenumbersImport(body) {
|
|
55697
56102
|
// verify the required parameter 'body' is set
|
|
@@ -55717,7 +56122,7 @@ class RoutingApi {
|
|
|
55717
56122
|
* Create an utilization tag
|
|
55718
56123
|
*
|
|
55719
56124
|
* @param {Object} body UtilizationTag
|
|
55720
|
-
*
|
|
56125
|
+
* postRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
55721
56126
|
*/
|
|
55722
56127
|
postRoutingUtilizationTags(body) {
|
|
55723
56128
|
// verify the required parameter 'body' is set
|
|
@@ -56180,7 +56585,7 @@ class SCIMApi {
|
|
|
56180
56585
|
/**
|
|
56181
56586
|
* SCIM service.
|
|
56182
56587
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
56183
|
-
* @version
|
|
56588
|
+
* @version 170.0.0
|
|
56184
56589
|
*/
|
|
56185
56590
|
|
|
56186
56591
|
/**
|
|
@@ -57057,7 +57462,7 @@ class ScriptsApi {
|
|
|
57057
57462
|
/**
|
|
57058
57463
|
* Scripts service.
|
|
57059
57464
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
57060
|
-
* @version
|
|
57465
|
+
* @version 170.0.0
|
|
57061
57466
|
*/
|
|
57062
57467
|
|
|
57063
57468
|
/**
|
|
@@ -57476,7 +57881,7 @@ class SearchApi {
|
|
|
57476
57881
|
/**
|
|
57477
57882
|
* Search service.
|
|
57478
57883
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
57479
|
-
* @version
|
|
57884
|
+
* @version 170.0.0
|
|
57480
57885
|
*/
|
|
57481
57886
|
|
|
57482
57887
|
/**
|
|
@@ -57772,7 +58177,7 @@ class SearchApi {
|
|
|
57772
58177
|
* Search all documents
|
|
57773
58178
|
*
|
|
57774
58179
|
* @param {Object} body Search request options
|
|
57775
|
-
*
|
|
58180
|
+
* postDocumentationAllSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57776
58181
|
*/
|
|
57777
58182
|
postDocumentationAllSearch(body) {
|
|
57778
58183
|
// verify the required parameter 'body' is set
|
|
@@ -57875,7 +58280,7 @@ class SearchApi {
|
|
|
57875
58280
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
57876
58281
|
* @param {Object} opts Optional parameters
|
|
57877
58282
|
* @param {Object} opts.body
|
|
57878
|
-
|
|
58283
|
+
* @deprecated
|
|
57879
58284
|
*/
|
|
57880
58285
|
postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
|
|
57881
58286
|
opts = opts || {};
|
|
@@ -58061,7 +58466,7 @@ class SearchApi {
|
|
|
58061
58466
|
* Search users as conversation targets
|
|
58062
58467
|
*
|
|
58063
58468
|
* @param {Object} body Search request options
|
|
58064
|
-
*
|
|
58469
|
+
* postUsersSearchConversationTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58065
58470
|
*/
|
|
58066
58471
|
postUsersSearchConversationTarget(body) {
|
|
58067
58472
|
// verify the required parameter 'body' is set
|
|
@@ -58087,7 +58492,7 @@ class SearchApi {
|
|
|
58087
58492
|
* Search manage queue member
|
|
58088
58493
|
*
|
|
58089
58494
|
* @param {Object} body Search request options
|
|
58090
|
-
*
|
|
58495
|
+
* postUsersSearchQueuemembersManage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58091
58496
|
*/
|
|
58092
58497
|
postUsersSearchQueuemembersManage(body) {
|
|
58093
58498
|
// verify the required parameter 'body' is set
|
|
@@ -58165,7 +58570,7 @@ class SpeechTextAnalyticsApi {
|
|
|
58165
58570
|
/**
|
|
58166
58571
|
* SpeechTextAnalytics service.
|
|
58167
58572
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
58168
|
-
* @version
|
|
58573
|
+
* @version 170.0.0
|
|
58169
58574
|
*/
|
|
58170
58575
|
|
|
58171
58576
|
/**
|
|
@@ -59118,7 +59523,7 @@ class StationsApi {
|
|
|
59118
59523
|
/**
|
|
59119
59524
|
* Stations service.
|
|
59120
59525
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
59121
|
-
* @version
|
|
59526
|
+
* @version 170.0.0
|
|
59122
59527
|
*/
|
|
59123
59528
|
|
|
59124
59529
|
/**
|
|
@@ -59220,7 +59625,7 @@ class SuggestApi {
|
|
|
59220
59625
|
/**
|
|
59221
59626
|
* Suggest service.
|
|
59222
59627
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
59223
|
-
* @version
|
|
59628
|
+
* @version 170.0.0
|
|
59224
59629
|
*/
|
|
59225
59630
|
|
|
59226
59631
|
/**
|
|
@@ -59359,7 +59764,7 @@ class TaskManagementApi {
|
|
|
59359
59764
|
/**
|
|
59360
59765
|
* TaskManagement service.
|
|
59361
59766
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
59362
|
-
* @version
|
|
59767
|
+
* @version 170.0.0
|
|
59363
59768
|
*/
|
|
59364
59769
|
|
|
59365
59770
|
/**
|
|
@@ -59378,7 +59783,7 @@ class TaskManagementApi {
|
|
|
59378
59783
|
* Delete a workbin
|
|
59379
59784
|
*
|
|
59380
59785
|
* @param {String} workbinId Workbin ID
|
|
59381
|
-
*
|
|
59786
|
+
* deleteTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59382
59787
|
*/
|
|
59383
59788
|
deleteTaskmanagementWorkbin(workbinId) {
|
|
59384
59789
|
// verify the required parameter 'workbinId' is set
|
|
@@ -59404,7 +59809,7 @@ class TaskManagementApi {
|
|
|
59404
59809
|
* Delete a workitem
|
|
59405
59810
|
*
|
|
59406
59811
|
* @param {String} workitemId Workitem ID
|
|
59407
|
-
*
|
|
59812
|
+
* deleteTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59408
59813
|
*/
|
|
59409
59814
|
deleteTaskmanagementWorkitem(workitemId) {
|
|
59410
59815
|
// verify the required parameter 'workitemId' is set
|
|
@@ -59430,7 +59835,7 @@ class TaskManagementApi {
|
|
|
59430
59835
|
* Delete a schema
|
|
59431
59836
|
*
|
|
59432
59837
|
* @param {String} schemaId Schema ID
|
|
59433
|
-
*
|
|
59838
|
+
* deleteTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59434
59839
|
*/
|
|
59435
59840
|
deleteTaskmanagementWorkitemsSchema(schemaId) {
|
|
59436
59841
|
// verify the required parameter 'schemaId' is set
|
|
@@ -59456,7 +59861,7 @@ class TaskManagementApi {
|
|
|
59456
59861
|
* Delete a worktype
|
|
59457
59862
|
*
|
|
59458
59863
|
* @param {String} worktypeId Worktype id
|
|
59459
|
-
*
|
|
59864
|
+
* deleteTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59460
59865
|
*/
|
|
59461
59866
|
deleteTaskmanagementWorktype(worktypeId) {
|
|
59462
59867
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -59483,7 +59888,7 @@ class TaskManagementApi {
|
|
|
59483
59888
|
*
|
|
59484
59889
|
* @param {String} worktypeId Worktype id
|
|
59485
59890
|
* @param {String} statusId Status id
|
|
59486
|
-
*
|
|
59891
|
+
* deleteTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59487
59892
|
*/
|
|
59488
59893
|
deleteTaskmanagementWorktypeStatus(worktypeId, statusId) {
|
|
59489
59894
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -59513,7 +59918,7 @@ class TaskManagementApi {
|
|
|
59513
59918
|
* Get a workbin
|
|
59514
59919
|
*
|
|
59515
59920
|
* @param {String} workbinId Workbin ID
|
|
59516
|
-
*
|
|
59921
|
+
* getTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59517
59922
|
*/
|
|
59518
59923
|
getTaskmanagementWorkbin(workbinId) {
|
|
59519
59924
|
// verify the required parameter 'workbinId' is set
|
|
@@ -59543,7 +59948,7 @@ class TaskManagementApi {
|
|
|
59543
59948
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
59544
59949
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
59545
59950
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
59546
|
-
*
|
|
59951
|
+
* getTaskmanagementWorkbinHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59547
59952
|
*/
|
|
59548
59953
|
getTaskmanagementWorkbinHistory(workbinId, opts) {
|
|
59549
59954
|
opts = opts || {};
|
|
@@ -59572,7 +59977,7 @@ class TaskManagementApi {
|
|
|
59572
59977
|
*
|
|
59573
59978
|
* @param {String} workbinId Workbin ID
|
|
59574
59979
|
* @param {Number} entityVersion Workbin version
|
|
59575
|
-
*
|
|
59980
|
+
* getTaskmanagementWorkbinVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59576
59981
|
*/
|
|
59577
59982
|
getTaskmanagementWorkbinVersion(workbinId, entityVersion) {
|
|
59578
59983
|
// verify the required parameter 'workbinId' is set
|
|
@@ -59606,7 +60011,7 @@ class TaskManagementApi {
|
|
|
59606
60011
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
59607
60012
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
59608
60013
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
59609
|
-
*
|
|
60014
|
+
* getTaskmanagementWorkbinVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59610
60015
|
*/
|
|
59611
60016
|
getTaskmanagementWorkbinVersions(workbinId, opts) {
|
|
59612
60017
|
opts = opts || {};
|
|
@@ -59634,9 +60039,13 @@ class TaskManagementApi {
|
|
|
59634
60039
|
* Get a workitem
|
|
59635
60040
|
*
|
|
59636
60041
|
* @param {String} workitemId Workitem ID
|
|
59637
|
-
*
|
|
60042
|
+
* @param {Object} opts Optional parameters
|
|
60043
|
+
* @param {Object} opts.expands Which fields to expand. Comma separated if more than one.
|
|
60044
|
+
* getTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59638
60045
|
*/
|
|
59639
|
-
getTaskmanagementWorkitem(workitemId) {
|
|
60046
|
+
getTaskmanagementWorkitem(workitemId, opts) {
|
|
60047
|
+
opts = opts || {};
|
|
60048
|
+
|
|
59640
60049
|
// verify the required parameter 'workitemId' is set
|
|
59641
60050
|
if (workitemId === undefined || workitemId === null) {
|
|
59642
60051
|
throw 'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitem';
|
|
@@ -59646,7 +60055,7 @@ class TaskManagementApi {
|
|
|
59646
60055
|
'/api/v2/taskmanagement/workitems/{workitemId}',
|
|
59647
60056
|
'GET',
|
|
59648
60057
|
{ 'workitemId': workitemId },
|
|
59649
|
-
{
|
|
60058
|
+
{ 'expands': opts['expands'] },
|
|
59650
60059
|
{ },
|
|
59651
60060
|
{ },
|
|
59652
60061
|
null,
|
|
@@ -59664,7 +60073,7 @@ class TaskManagementApi {
|
|
|
59664
60073
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
59665
60074
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
59666
60075
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
59667
|
-
*
|
|
60076
|
+
* getTaskmanagementWorkitemHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59668
60077
|
*/
|
|
59669
60078
|
getTaskmanagementWorkitemHistory(workitemId, opts) {
|
|
59670
60079
|
opts = opts || {};
|
|
@@ -59698,7 +60107,7 @@ class TaskManagementApi {
|
|
|
59698
60107
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
59699
60108
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50. (default to 25)
|
|
59700
60109
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
59701
|
-
*
|
|
60110
|
+
* getTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59702
60111
|
*/
|
|
59703
60112
|
getTaskmanagementWorkitemUserWrapups(workitemId, userId, opts) {
|
|
59704
60113
|
opts = opts || {};
|
|
@@ -59731,7 +60140,7 @@ class TaskManagementApi {
|
|
|
59731
60140
|
*
|
|
59732
60141
|
* @param {String} workitemId Workitem ID
|
|
59733
60142
|
* @param {Number} entityVersion Workitem version
|
|
59734
|
-
*
|
|
60143
|
+
* getTaskmanagementWorkitemVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59735
60144
|
*/
|
|
59736
60145
|
getTaskmanagementWorkitemVersion(workitemId, entityVersion) {
|
|
59737
60146
|
// verify the required parameter 'workitemId' is set
|
|
@@ -59765,7 +60174,7 @@ class TaskManagementApi {
|
|
|
59765
60174
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
59766
60175
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
59767
60176
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
59768
|
-
*
|
|
60177
|
+
* getTaskmanagementWorkitemVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59769
60178
|
*/
|
|
59770
60179
|
getTaskmanagementWorkitemVersions(workitemId, opts) {
|
|
59771
60180
|
opts = opts || {};
|
|
@@ -59798,7 +60207,7 @@ class TaskManagementApi {
|
|
|
59798
60207
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
59799
60208
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50. (default to 25)
|
|
59800
60209
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
59801
|
-
*
|
|
60210
|
+
* getTaskmanagementWorkitemWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59802
60211
|
*/
|
|
59803
60212
|
getTaskmanagementWorkitemWrapups(workitemId, opts) {
|
|
59804
60213
|
opts = opts || {};
|
|
@@ -59826,7 +60235,7 @@ class TaskManagementApi {
|
|
|
59826
60235
|
* Get a schema
|
|
59827
60236
|
*
|
|
59828
60237
|
* @param {String} schemaId Schema ID
|
|
59829
|
-
*
|
|
60238
|
+
* getTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59830
60239
|
*/
|
|
59831
60240
|
getTaskmanagementWorkitemsSchema(schemaId) {
|
|
59832
60241
|
// verify the required parameter 'schemaId' is set
|
|
@@ -59853,7 +60262,7 @@ class TaskManagementApi {
|
|
|
59853
60262
|
*
|
|
59854
60263
|
* @param {String} schemaId Schema ID
|
|
59855
60264
|
* @param {String} versionId Schema version
|
|
59856
|
-
*
|
|
60265
|
+
* getTaskmanagementWorkitemsSchemaVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59857
60266
|
*/
|
|
59858
60267
|
getTaskmanagementWorkitemsSchemaVersion(schemaId, versionId) {
|
|
59859
60268
|
// verify the required parameter 'schemaId' is set
|
|
@@ -59883,7 +60292,7 @@ class TaskManagementApi {
|
|
|
59883
60292
|
* Get all versions of a schema
|
|
59884
60293
|
*
|
|
59885
60294
|
* @param {String} schemaId Schema ID
|
|
59886
|
-
*
|
|
60295
|
+
* getTaskmanagementWorkitemsSchemaVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59887
60296
|
*/
|
|
59888
60297
|
getTaskmanagementWorkitemsSchemaVersions(schemaId) {
|
|
59889
60298
|
// verify the required parameter 'schemaId' is set
|
|
@@ -59908,7 +60317,7 @@ class TaskManagementApi {
|
|
|
59908
60317
|
/**
|
|
59909
60318
|
* Get a list of schemas.
|
|
59910
60319
|
*
|
|
59911
|
-
*
|
|
60320
|
+
* getTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59912
60321
|
*/
|
|
59913
60322
|
getTaskmanagementWorkitemsSchemas() {
|
|
59914
60323
|
|
|
@@ -59932,7 +60341,7 @@ class TaskManagementApi {
|
|
|
59932
60341
|
* @param {String} worktypeId Worktype id
|
|
59933
60342
|
* @param {Object} opts Optional parameters
|
|
59934
60343
|
* @param {Array.<String>} opts.expands Which fields, if any, to expand.
|
|
59935
|
-
*
|
|
60344
|
+
* getTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59936
60345
|
*/
|
|
59937
60346
|
getTaskmanagementWorktype(worktypeId, opts) {
|
|
59938
60347
|
opts = opts || {};
|
|
@@ -59964,7 +60373,7 @@ class TaskManagementApi {
|
|
|
59964
60373
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
59965
60374
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
59966
60375
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
59967
|
-
*
|
|
60376
|
+
* getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59968
60377
|
*/
|
|
59969
60378
|
getTaskmanagementWorktypeHistory(worktypeId, opts) {
|
|
59970
60379
|
opts = opts || {};
|
|
@@ -59993,7 +60402,7 @@ class TaskManagementApi {
|
|
|
59993
60402
|
*
|
|
59994
60403
|
* @param {String} worktypeId Worktype id
|
|
59995
60404
|
* @param {String} statusId Status id
|
|
59996
|
-
*
|
|
60405
|
+
* getTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59997
60406
|
*/
|
|
59998
60407
|
getTaskmanagementWorktypeStatus(worktypeId, statusId) {
|
|
59999
60408
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -60024,7 +60433,7 @@ class TaskManagementApi {
|
|
|
60024
60433
|
*
|
|
60025
60434
|
* @param {String} worktypeId Worktype id
|
|
60026
60435
|
* @param {Number} entityVersion Worktype version
|
|
60027
|
-
*
|
|
60436
|
+
* getTaskmanagementWorktypeVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60028
60437
|
*/
|
|
60029
60438
|
getTaskmanagementWorktypeVersion(worktypeId, entityVersion) {
|
|
60030
60439
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -60058,7 +60467,7 @@ class TaskManagementApi {
|
|
|
60058
60467
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
60059
60468
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
60060
60469
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
60061
|
-
*
|
|
60470
|
+
* getTaskmanagementWorktypeVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60062
60471
|
*/
|
|
60063
60472
|
getTaskmanagementWorktypeVersions(worktypeId, opts) {
|
|
60064
60473
|
opts = opts || {};
|
|
@@ -60087,7 +60496,7 @@ class TaskManagementApi {
|
|
|
60087
60496
|
*
|
|
60088
60497
|
* @param {String} workbinId Workbin ID
|
|
60089
60498
|
* @param {Object} body Json with attributes and their new values: {description:new description, name:new name}.
|
|
60090
|
-
*
|
|
60499
|
+
* patchTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60091
60500
|
*/
|
|
60092
60501
|
patchTaskmanagementWorkbin(workbinId, body) {
|
|
60093
60502
|
// verify the required parameter 'workbinId' is set
|
|
@@ -60118,7 +60527,7 @@ class TaskManagementApi {
|
|
|
60118
60527
|
*
|
|
60119
60528
|
* @param {String} workitemId Workitem ID
|
|
60120
60529
|
* @param {Object} body Workitem
|
|
60121
|
-
*
|
|
60530
|
+
* patchTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60122
60531
|
*/
|
|
60123
60532
|
patchTaskmanagementWorkitem(workitemId, body) {
|
|
60124
60533
|
// verify the required parameter 'workitemId' is set
|
|
@@ -60149,7 +60558,7 @@ class TaskManagementApi {
|
|
|
60149
60558
|
*
|
|
60150
60559
|
* @param {String} workitemId Workitem ID
|
|
60151
60560
|
* @param {Object} body Targeted user
|
|
60152
|
-
*
|
|
60561
|
+
* patchTaskmanagementWorkitemAssignment is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60153
60562
|
*/
|
|
60154
60563
|
patchTaskmanagementWorkitemAssignment(workitemId, body) {
|
|
60155
60564
|
// verify the required parameter 'workitemId' is set
|
|
@@ -60181,7 +60590,7 @@ class TaskManagementApi {
|
|
|
60181
60590
|
* @param {String} workitemId The ID of the Workitem.
|
|
60182
60591
|
* @param {String} userId The ID of the user
|
|
60183
60592
|
* @param {Object} body Request body to add/remove a wrapup code for a workitem
|
|
60184
|
-
*
|
|
60593
|
+
* patchTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60185
60594
|
*/
|
|
60186
60595
|
patchTaskmanagementWorkitemUserWrapups(workitemId, userId, body) {
|
|
60187
60596
|
// verify the required parameter 'workitemId' is set
|
|
@@ -60216,7 +60625,7 @@ class TaskManagementApi {
|
|
|
60216
60625
|
*
|
|
60217
60626
|
* @param {String} workitemId The ID of the Workitem.
|
|
60218
60627
|
* @param {Object} body Request body to add/remove the wrapup code for workitem
|
|
60219
|
-
*
|
|
60628
|
+
* patchTaskmanagementWorkitemUsersMeWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60220
60629
|
*/
|
|
60221
60630
|
patchTaskmanagementWorkitemUsersMeWrapups(workitemId, body) {
|
|
60222
60631
|
// verify the required parameter 'workitemId' is set
|
|
@@ -60248,7 +60657,7 @@ class TaskManagementApi {
|
|
|
60248
60657
|
* @param {String} worktypeId Worktype id
|
|
60249
60658
|
* @param {Object} opts Optional parameters
|
|
60250
60659
|
* @param {Object} opts.body body
|
|
60251
|
-
*
|
|
60660
|
+
* patchTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60252
60661
|
*/
|
|
60253
60662
|
patchTaskmanagementWorktype(worktypeId, opts) {
|
|
60254
60663
|
opts = opts || {};
|
|
@@ -60279,7 +60688,7 @@ class TaskManagementApi {
|
|
|
60279
60688
|
* @param {String} statusId Status id
|
|
60280
60689
|
* @param {Object} opts Optional parameters
|
|
60281
60690
|
* @param {Object} opts.body body
|
|
60282
|
-
*
|
|
60691
|
+
* patchTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60283
60692
|
*/
|
|
60284
60693
|
patchTaskmanagementWorktypeStatus(worktypeId, statusId, opts) {
|
|
60285
60694
|
opts = opts || {};
|
|
@@ -60312,7 +60721,7 @@ class TaskManagementApi {
|
|
|
60312
60721
|
*
|
|
60313
60722
|
* @param {Object} opts Optional parameters
|
|
60314
60723
|
* @param {Object} opts.body body
|
|
60315
|
-
*
|
|
60724
|
+
* postTaskmanagementWorkbins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60316
60725
|
*/
|
|
60317
60726
|
postTaskmanagementWorkbins(opts) {
|
|
60318
60727
|
opts = opts || {};
|
|
@@ -60336,7 +60745,7 @@ class TaskManagementApi {
|
|
|
60336
60745
|
* Query for workbins
|
|
60337
60746
|
*
|
|
60338
60747
|
* @param {Object} body QueryPostRequest
|
|
60339
|
-
*
|
|
60748
|
+
* postTaskmanagementWorkbinsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60340
60749
|
*/
|
|
60341
60750
|
postTaskmanagementWorkbinsQuery(body) {
|
|
60342
60751
|
// verify the required parameter 'body' is set
|
|
@@ -60362,7 +60771,7 @@ class TaskManagementApi {
|
|
|
60362
60771
|
* Cancel the assignment process for a workitem that is currently queued for assignment through ACD.
|
|
60363
60772
|
*
|
|
60364
60773
|
* @param {String} workitemId Workitem ID
|
|
60365
|
-
*
|
|
60774
|
+
* postTaskmanagementWorkitemAcdCancel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60366
60775
|
*/
|
|
60367
60776
|
postTaskmanagementWorkitemAcdCancel(workitemId) {
|
|
60368
60777
|
// verify the required parameter 'workitemId' is set
|
|
@@ -60388,7 +60797,7 @@ class TaskManagementApi {
|
|
|
60388
60797
|
* Disconnect the assignee of the workitem
|
|
60389
60798
|
*
|
|
60390
60799
|
* @param {String} workitemId Workitem ID
|
|
60391
|
-
*
|
|
60800
|
+
* postTaskmanagementWorkitemDisconnect is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60392
60801
|
*/
|
|
60393
60802
|
postTaskmanagementWorkitemDisconnect(workitemId) {
|
|
60394
60803
|
// verify the required parameter 'workitemId' is set
|
|
@@ -60416,7 +60825,7 @@ class TaskManagementApi {
|
|
|
60416
60825
|
* @param {String} workitemId Workitem ID
|
|
60417
60826
|
* @param {Object} opts Optional parameters
|
|
60418
60827
|
* @param {Object} opts.body Terminated request
|
|
60419
|
-
*
|
|
60828
|
+
* postTaskmanagementWorkitemTerminate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60420
60829
|
*/
|
|
60421
60830
|
postTaskmanagementWorkitemTerminate(workitemId, opts) {
|
|
60422
60831
|
opts = opts || {};
|
|
@@ -60444,7 +60853,7 @@ class TaskManagementApi {
|
|
|
60444
60853
|
* Create a workitem
|
|
60445
60854
|
*
|
|
60446
60855
|
* @param {Object} body Workitem
|
|
60447
|
-
*
|
|
60856
|
+
* postTaskmanagementWorkitems is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60448
60857
|
*/
|
|
60449
60858
|
postTaskmanagementWorkitems(body) {
|
|
60450
60859
|
// verify the required parameter 'body' is set
|
|
@@ -60470,7 +60879,7 @@ class TaskManagementApi {
|
|
|
60470
60879
|
* Query for workitems
|
|
60471
60880
|
* This query requires at least one EQ filter on the workbinId, assigneeId or typeId attributes.
|
|
60472
60881
|
* @param {Object} body WorkitemQueryPostRequest
|
|
60473
|
-
*
|
|
60882
|
+
* postTaskmanagementWorkitemsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60474
60883
|
*/
|
|
60475
60884
|
postTaskmanagementWorkitemsQuery(body) {
|
|
60476
60885
|
// verify the required parameter 'body' is set
|
|
@@ -60496,7 +60905,7 @@ class TaskManagementApi {
|
|
|
60496
60905
|
* Create a schema
|
|
60497
60906
|
*
|
|
60498
60907
|
* @param {Object} body Schema
|
|
60499
|
-
*
|
|
60908
|
+
* postTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60500
60909
|
*/
|
|
60501
60910
|
postTaskmanagementWorkitemsSchemas(body) {
|
|
60502
60911
|
// verify the required parameter 'body' is set
|
|
@@ -60524,7 +60933,7 @@ class TaskManagementApi {
|
|
|
60524
60933
|
* @param {String} worktypeId Worktype id
|
|
60525
60934
|
* @param {Object} opts Optional parameters
|
|
60526
60935
|
* @param {Object} opts.body body
|
|
60527
|
-
*
|
|
60936
|
+
* postTaskmanagementWorktypeStatuses is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60528
60937
|
*/
|
|
60529
60938
|
postTaskmanagementWorktypeStatuses(worktypeId, opts) {
|
|
60530
60939
|
opts = opts || {};
|
|
@@ -60553,7 +60962,7 @@ class TaskManagementApi {
|
|
|
60553
60962
|
*
|
|
60554
60963
|
* @param {Object} opts Optional parameters
|
|
60555
60964
|
* @param {Object} opts.body body
|
|
60556
|
-
*
|
|
60965
|
+
* postTaskmanagementWorktypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60557
60966
|
*/
|
|
60558
60967
|
postTaskmanagementWorktypes(opts) {
|
|
60559
60968
|
opts = opts || {};
|
|
@@ -60577,7 +60986,7 @@ class TaskManagementApi {
|
|
|
60577
60986
|
* Query for worktypes
|
|
60578
60987
|
*
|
|
60579
60988
|
* @param {Object} body QueryPostRequest
|
|
60580
|
-
*
|
|
60989
|
+
* postTaskmanagementWorktypesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60581
60990
|
*/
|
|
60582
60991
|
postTaskmanagementWorktypesQuery(body) {
|
|
60583
60992
|
// verify the required parameter 'body' is set
|
|
@@ -60604,7 +61013,7 @@ class TaskManagementApi {
|
|
|
60604
61013
|
*
|
|
60605
61014
|
* @param {String} schemaId Schema ID
|
|
60606
61015
|
* @param {Object} body Data Schema
|
|
60607
|
-
*
|
|
61016
|
+
* putTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60608
61017
|
*/
|
|
60609
61018
|
putTaskmanagementWorkitemsSchema(schemaId, body) {
|
|
60610
61019
|
// verify the required parameter 'schemaId' is set
|
|
@@ -60636,7 +61045,7 @@ class TeamsApi {
|
|
|
60636
61045
|
/**
|
|
60637
61046
|
* Teams service.
|
|
60638
61047
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
60639
|
-
* @version
|
|
61048
|
+
* @version 170.0.0
|
|
60640
61049
|
*/
|
|
60641
61050
|
|
|
60642
61051
|
/**
|
|
@@ -60828,7 +61237,7 @@ class TeamsApi {
|
|
|
60828
61237
|
* @param {Object} opts Optional parameters
|
|
60829
61238
|
* @param {Number} opts.pageSize The desired page size
|
|
60830
61239
|
* @param {Number} opts.pageNumber The desired page number
|
|
60831
|
-
*
|
|
61240
|
+
* postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60832
61241
|
*/
|
|
60833
61242
|
postAnalyticsTeamsActivityQuery(body, opts) {
|
|
60834
61243
|
opts = opts || {};
|
|
@@ -60938,7 +61347,7 @@ class TelephonyApi {
|
|
|
60938
61347
|
/**
|
|
60939
61348
|
* Telephony service.
|
|
60940
61349
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
60941
|
-
* @version
|
|
61350
|
+
* @version 170.0.0
|
|
60942
61351
|
*/
|
|
60943
61352
|
|
|
60944
61353
|
/**
|
|
@@ -61066,7 +61475,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
61066
61475
|
/**
|
|
61067
61476
|
* TelephonyProvidersEdge service.
|
|
61068
61477
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
61069
|
-
* @version
|
|
61478
|
+
* @version 170.0.0
|
|
61070
61479
|
*/
|
|
61071
61480
|
|
|
61072
61481
|
/**
|
|
@@ -62254,7 +62663,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
62254
62663
|
* @param {Array.<String>} opts.id ID of the Extension Pools to filter by.
|
|
62255
62664
|
* @param {String} opts.name Name of the Extension Pools to filter by.
|
|
62256
62665
|
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
62257
|
-
*
|
|
62666
|
+
* getTelephonyProvidersEdgesExtensionpoolsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
62258
62667
|
*/
|
|
62259
62668
|
getTelephonyProvidersEdgesExtensionpoolsDivisionviews(opts) {
|
|
62260
62669
|
opts = opts || {};
|
|
@@ -62491,7 +62900,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
62491
62900
|
* Get outbound route
|
|
62492
62901
|
* This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
|
|
62493
62902
|
* @param {String} outboundRouteId Outbound route ID
|
|
62494
|
-
|
|
62903
|
+
* @deprecated
|
|
62495
62904
|
*/
|
|
62496
62905
|
getTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
|
|
62497
62906
|
// verify the required parameter 'outboundRouteId' is set
|
|
@@ -62687,7 +63096,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
62687
63096
|
* @param {String} opts.phoneHardwareId Filter by phone_hardwareId
|
|
62688
63097
|
* @param {String} opts.linesId Filter by lines.id
|
|
62689
63098
|
* @param {String} opts.linesName Filter by lines.name
|
|
62690
|
-
* @param {String} opts.name Name of the Phone to filter by
|
|
63099
|
+
* @param {String} opts.name Name of the Phone to filter by, comma-separated
|
|
62691
63100
|
* @param {String} opts.statusOperationalStatus The primary status to filter by
|
|
62692
63101
|
* @param {String} opts.secondaryStatusOperationalStatus The secondary status to filter by
|
|
62693
63102
|
* @param {Array.<String>} opts.expand Fields to expand in the response, comma-separated
|
|
@@ -64298,7 +64707,7 @@ class TextbotsApi {
|
|
|
64298
64707
|
/**
|
|
64299
64708
|
* Textbots service.
|
|
64300
64709
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
64301
|
-
* @version
|
|
64710
|
+
* @version 170.0.0
|
|
64302
64711
|
*/
|
|
64303
64712
|
|
|
64304
64713
|
/**
|
|
@@ -64426,7 +64835,7 @@ class TokensApi {
|
|
|
64426
64835
|
/**
|
|
64427
64836
|
* Tokens service.
|
|
64428
64837
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
64429
|
-
* @version
|
|
64838
|
+
* @version 170.0.0
|
|
64430
64839
|
*/
|
|
64431
64840
|
|
|
64432
64841
|
/**
|
|
@@ -64509,7 +64918,7 @@ class TokensApi {
|
|
|
64509
64918
|
/**
|
|
64510
64919
|
* Get the current Idle Token Timeout Value
|
|
64511
64920
|
*
|
|
64512
|
-
*
|
|
64921
|
+
* getTokensTimeout is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64513
64922
|
*/
|
|
64514
64923
|
getTokensTimeout() {
|
|
64515
64924
|
|
|
@@ -64552,7 +64961,7 @@ class TokensApi {
|
|
|
64552
64961
|
*
|
|
64553
64962
|
* @param {Object} opts Optional parameters
|
|
64554
64963
|
* @param {Object} opts.body
|
|
64555
|
-
*
|
|
64964
|
+
* putTokensTimeout is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64556
64965
|
*/
|
|
64557
64966
|
putTokensTimeout(opts) {
|
|
64558
64967
|
opts = opts || {};
|
|
@@ -64578,7 +64987,7 @@ class UploadsApi {
|
|
|
64578
64987
|
/**
|
|
64579
64988
|
* Uploads service.
|
|
64580
64989
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
64581
|
-
* @version
|
|
64990
|
+
* @version 170.0.0
|
|
64582
64991
|
*/
|
|
64583
64992
|
|
|
64584
64993
|
/**
|
|
@@ -64754,7 +65163,7 @@ class UsageApi {
|
|
|
64754
65163
|
/**
|
|
64755
65164
|
* Usage service.
|
|
64756
65165
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
64757
|
-
* @version
|
|
65166
|
+
* @version 170.0.0
|
|
64758
65167
|
*/
|
|
64759
65168
|
|
|
64760
65169
|
/**
|
|
@@ -64964,7 +65373,7 @@ class UserRecordingsApi {
|
|
|
64964
65373
|
/**
|
|
64965
65374
|
* UserRecordings service.
|
|
64966
65375
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
64967
|
-
* @version
|
|
65376
|
+
* @version 170.0.0
|
|
64968
65377
|
*/
|
|
64969
65378
|
|
|
64970
65379
|
/**
|
|
@@ -65149,7 +65558,7 @@ class UsersApi {
|
|
|
65149
65558
|
/**
|
|
65150
65559
|
* Users service.
|
|
65151
65560
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
65152
|
-
* @version
|
|
65561
|
+
* @version 170.0.0
|
|
65153
65562
|
*/
|
|
65154
65563
|
|
|
65155
65564
|
/**
|
|
@@ -65388,7 +65797,7 @@ class UsersApi {
|
|
|
65388
65797
|
* Get status for async query for user aggregates
|
|
65389
65798
|
*
|
|
65390
65799
|
* @param {String} jobId jobId
|
|
65391
|
-
*
|
|
65800
|
+
* getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
65392
65801
|
*/
|
|
65393
65802
|
getAnalyticsUsersAggregatesJob(jobId) {
|
|
65394
65803
|
// verify the required parameter 'jobId' is set
|
|
@@ -65416,7 +65825,7 @@ class UsersApi {
|
|
|
65416
65825
|
* @param {String} jobId jobId
|
|
65417
65826
|
* @param {Object} opts Optional parameters
|
|
65418
65827
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
65419
|
-
*
|
|
65828
|
+
* getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
65420
65829
|
*/
|
|
65421
65830
|
getAnalyticsUsersAggregatesJobResults(jobId, opts) {
|
|
65422
65831
|
opts = opts || {};
|
|
@@ -65521,7 +65930,7 @@ class UsersApi {
|
|
|
65521
65930
|
* @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
|
|
65522
65931
|
* @param {Object} opts Optional parameters
|
|
65523
65932
|
* @param {String} opts.name Search term to filter by division name
|
|
65524
|
-
|
|
65933
|
+
* @deprecated
|
|
65525
65934
|
*/
|
|
65526
65935
|
getAuthorizationDivisionspermittedMe(permission, opts) {
|
|
65527
65936
|
opts = opts || {};
|
|
@@ -65583,7 +65992,7 @@ class UsersApi {
|
|
|
65583
65992
|
* @param {Object} opts Optional parameters
|
|
65584
65993
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
65585
65994
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
65586
|
-
|
|
65995
|
+
* @deprecated
|
|
65587
65996
|
*/
|
|
65588
65997
|
getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
|
|
65589
65998
|
opts = opts || {};
|
|
@@ -65660,7 +66069,7 @@ class UsersApi {
|
|
|
65660
66069
|
* Fetch field config for an entity type
|
|
65661
66070
|
*
|
|
65662
66071
|
* @param {Object} type Field type
|
|
65663
|
-
|
|
66072
|
+
* @deprecated
|
|
65664
66073
|
*/
|
|
65665
66074
|
getFieldconfig(type) {
|
|
65666
66075
|
// verify the required parameter 'type' is set
|
|
@@ -65693,7 +66102,7 @@ class UsersApi {
|
|
|
65693
66102
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
65694
66103
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
65695
66104
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an expand.
|
|
65696
|
-
|
|
66105
|
+
* @deprecated
|
|
65697
66106
|
*/
|
|
65698
66107
|
getProfilesUsers(opts) {
|
|
65699
66108
|
opts = opts || {};
|
|
@@ -65861,7 +66270,7 @@ class UsersApi {
|
|
|
65861
66270
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
65862
66271
|
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
65863
66272
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
65864
|
-
|
|
66273
|
+
* @deprecated
|
|
65865
66274
|
*/
|
|
65866
66275
|
getUserFavorites(userId, opts) {
|
|
65867
66276
|
opts = opts || {};
|
|
@@ -65947,7 +66356,7 @@ class UsersApi {
|
|
|
65947
66356
|
* @param {Object} opts Optional parameters
|
|
65948
66357
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
65949
66358
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
|
|
65950
|
-
|
|
66359
|
+
* @deprecated
|
|
65951
66360
|
*/
|
|
65952
66361
|
getUserProfile(userId, opts) {
|
|
65953
66362
|
opts = opts || {};
|
|
@@ -66756,7 +67165,7 @@ class UsersApi {
|
|
|
66756
67165
|
* @param {Object} opts Optional parameters
|
|
66757
67166
|
* @param {Number} opts.pageSize The desired page size
|
|
66758
67167
|
* @param {Number} opts.pageNumber The desired page number
|
|
66759
|
-
*
|
|
67168
|
+
* postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
66760
67169
|
*/
|
|
66761
67170
|
postAnalyticsUsersActivityQuery(body, opts) {
|
|
66762
67171
|
opts = opts || {};
|
|
@@ -66784,7 +67193,7 @@ class UsersApi {
|
|
|
66784
67193
|
* Query for user aggregates asynchronously
|
|
66785
67194
|
*
|
|
66786
67195
|
* @param {Object} body query
|
|
66787
|
-
*
|
|
67196
|
+
* postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
66788
67197
|
*/
|
|
66789
67198
|
postAnalyticsUsersAggregatesJobs(body) {
|
|
66790
67199
|
// verify the required parameter 'body' is set
|
|
@@ -67296,7 +67705,7 @@ class UsersApi {
|
|
|
67296
67705
|
* Search users as conversation targets
|
|
67297
67706
|
*
|
|
67298
67707
|
* @param {Object} body Search request options
|
|
67299
|
-
*
|
|
67708
|
+
* postUsersSearchConversationTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
67300
67709
|
*/
|
|
67301
67710
|
postUsersSearchConversationTarget(body) {
|
|
67302
67711
|
// verify the required parameter 'body' is set
|
|
@@ -67322,7 +67731,7 @@ class UsersApi {
|
|
|
67322
67731
|
* Search manage queue member
|
|
67323
67732
|
*
|
|
67324
67733
|
* @param {Object} body Search request options
|
|
67325
|
-
*
|
|
67734
|
+
* postUsersSearchQueuemembersManage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
67326
67735
|
*/
|
|
67327
67736
|
postUsersSearchQueuemembersManage(body) {
|
|
67328
67737
|
// verify the required parameter 'body' is set
|
|
@@ -67710,7 +68119,7 @@ class UtilitiesApi {
|
|
|
67710
68119
|
/**
|
|
67711
68120
|
* Utilities service.
|
|
67712
68121
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
67713
|
-
* @version
|
|
68122
|
+
* @version 170.0.0
|
|
67714
68123
|
*/
|
|
67715
68124
|
|
|
67716
68125
|
/**
|
|
@@ -67821,7 +68230,7 @@ class VoicemailApi {
|
|
|
67821
68230
|
/**
|
|
67822
68231
|
* Voicemail service.
|
|
67823
68232
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
67824
|
-
* @version
|
|
68233
|
+
* @version 170.0.0
|
|
67825
68234
|
*/
|
|
67826
68235
|
|
|
67827
68236
|
/**
|
|
@@ -68488,7 +68897,7 @@ class WebChatApi {
|
|
|
68488
68897
|
/**
|
|
68489
68898
|
* WebChat service.
|
|
68490
68899
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
68491
|
-
* @version
|
|
68900
|
+
* @version 170.0.0
|
|
68492
68901
|
*/
|
|
68493
68902
|
|
|
68494
68903
|
/**
|
|
@@ -68507,7 +68916,7 @@ class WebChatApi {
|
|
|
68507
68916
|
* Delete a WebChat deployment
|
|
68508
68917
|
*
|
|
68509
68918
|
* @param {String} deploymentId Deployment Id
|
|
68510
|
-
|
|
68919
|
+
* @deprecated
|
|
68511
68920
|
*/
|
|
68512
68921
|
deleteWebchatDeployment(deploymentId) {
|
|
68513
68922
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -68583,7 +68992,7 @@ class WebChatApi {
|
|
|
68583
68992
|
* Get a WebChat deployment
|
|
68584
68993
|
*
|
|
68585
68994
|
* @param {String} deploymentId Deployment Id
|
|
68586
|
-
|
|
68995
|
+
* @deprecated
|
|
68587
68996
|
*/
|
|
68588
68997
|
getWebchatDeployment(deploymentId) {
|
|
68589
68998
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -68608,7 +69017,7 @@ class WebChatApi {
|
|
|
68608
69017
|
/**
|
|
68609
69018
|
* List WebChat deployments
|
|
68610
69019
|
*
|
|
68611
|
-
|
|
69020
|
+
* @deprecated
|
|
68612
69021
|
*/
|
|
68613
69022
|
getWebchatDeployments() {
|
|
68614
69023
|
|
|
@@ -68863,7 +69272,7 @@ class WebChatApi {
|
|
|
68863
69272
|
* Create WebChat deployment
|
|
68864
69273
|
*
|
|
68865
69274
|
* @param {Object} body Deployment
|
|
68866
|
-
|
|
69275
|
+
* @deprecated
|
|
68867
69276
|
*/
|
|
68868
69277
|
postWebchatDeployments(body) {
|
|
68869
69278
|
// verify the required parameter 'body' is set
|
|
@@ -68980,7 +69389,7 @@ class WebChatApi {
|
|
|
68980
69389
|
*
|
|
68981
69390
|
* @param {String} deploymentId Deployment Id
|
|
68982
69391
|
* @param {Object} body Deployment
|
|
68983
|
-
|
|
69392
|
+
* @deprecated
|
|
68984
69393
|
*/
|
|
68985
69394
|
putWebchatDeployment(deploymentId, body) {
|
|
68986
69395
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -69037,7 +69446,7 @@ class WebDeploymentsApi {
|
|
|
69037
69446
|
/**
|
|
69038
69447
|
* WebDeployments service.
|
|
69039
69448
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
69040
|
-
* @version
|
|
69449
|
+
* @version 170.0.0
|
|
69041
69450
|
*/
|
|
69042
69451
|
|
|
69043
69452
|
/**
|
|
@@ -69559,7 +69968,7 @@ class WebMessagingApi {
|
|
|
69559
69968
|
/**
|
|
69560
69969
|
* WebMessaging service.
|
|
69561
69970
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
69562
|
-
* @version
|
|
69971
|
+
* @version 170.0.0
|
|
69563
69972
|
*/
|
|
69564
69973
|
|
|
69565
69974
|
/**
|
|
@@ -69605,7 +70014,7 @@ class WidgetsApi {
|
|
|
69605
70014
|
/**
|
|
69606
70015
|
* Widgets service.
|
|
69607
70016
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
69608
|
-
* @version
|
|
70017
|
+
* @version 170.0.0
|
|
69609
70018
|
*/
|
|
69610
70019
|
|
|
69611
70020
|
/**
|
|
@@ -69751,7 +70160,7 @@ class WorkforceManagementApi {
|
|
|
69751
70160
|
/**
|
|
69752
70161
|
* WorkforceManagement service.
|
|
69753
70162
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
69754
|
-
* @version
|
|
70163
|
+
* @version 170.0.0
|
|
69755
70164
|
*/
|
|
69756
70165
|
|
|
69757
70166
|
/**
|
|
@@ -71293,7 +71702,7 @@ class WorkforceManagementApi {
|
|
|
71293
71702
|
* Get activity codes
|
|
71294
71703
|
*
|
|
71295
71704
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
71296
|
-
|
|
71705
|
+
* @deprecated
|
|
71297
71706
|
*/
|
|
71298
71707
|
getWorkforcemanagementManagementunitActivitycodes(managementUnitId) {
|
|
71299
71708
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -71706,7 +72115,7 @@ class WorkforceManagementApi {
|
|
|
71706
72115
|
* @param {Object} opts Optional parameters
|
|
71707
72116
|
* @param {Object} opts.expand Which fields, if any, to expand
|
|
71708
72117
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
71709
|
-
|
|
72118
|
+
* @deprecated
|
|
71710
72119
|
*/
|
|
71711
72120
|
getWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId, opts) {
|
|
71712
72121
|
opts = opts || {};
|
|
@@ -71747,7 +72156,7 @@ class WorkforceManagementApi {
|
|
|
71747
72156
|
* @param {Boolean} opts.includeOnlyPublished Return only published schedules
|
|
71748
72157
|
* @param {String} opts.earliestWeekDate The start date of the earliest week to query in yyyy-MM-dd format
|
|
71749
72158
|
* @param {String} opts.latestWeekDate The start date of the latest week to query in yyyy-MM-dd format
|
|
71750
|
-
|
|
72159
|
+
* @deprecated
|
|
71751
72160
|
*/
|
|
71752
72161
|
getWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId, opts) {
|
|
71753
72162
|
opts = opts || {};
|
|
@@ -73706,7 +74115,7 @@ class WorkforceManagementApi {
|
|
|
73706
74115
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
73707
74116
|
* @param {Object} opts Optional parameters
|
|
73708
74117
|
* @param {Object} opts.body body
|
|
73709
|
-
|
|
74118
|
+
* @deprecated
|
|
73710
74119
|
*/
|
|
73711
74120
|
postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId, opts) {
|
|
73712
74121
|
opts = opts || {};
|
|
@@ -74367,7 +74776,7 @@ class WorkforceManagementApi {
|
|
|
74367
74776
|
*
|
|
74368
74777
|
* @param {Object} opts Optional parameters
|
|
74369
74778
|
* @param {Object} opts.body body
|
|
74370
|
-
|
|
74779
|
+
* @deprecated
|
|
74371
74780
|
*/
|
|
74372
74781
|
postWorkforcemanagementSchedules(opts) {
|
|
74373
74782
|
opts = opts || {};
|
|
@@ -74558,7 +74967,7 @@ class WorkforceManagementApi {
|
|
|
74558
74967
|
* </pre>
|
|
74559
74968
|
* </p>
|
|
74560
74969
|
* @module purecloud-platform-client-v2/index
|
|
74561
|
-
* @version
|
|
74970
|
+
* @version 170.0.0
|
|
74562
74971
|
*/
|
|
74563
74972
|
class platformClient {
|
|
74564
74973
|
constructor() {
|