purecloud-platform-client-v2 229.2.0 → 230.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +381 -112
- package/dist/web-amd/purecloud-platform-client-v2.js +381 -112
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +161 -93
- package/dist/web-cjs/purecloud-platform-client-v2.js +161 -93
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +425 -287
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +110 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +86 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +3 -28
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +101 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -743,7 +743,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
743
743
|
|
|
744
744
|
/**
|
|
745
745
|
* @module purecloud-platform-client-v2/ApiClient
|
|
746
|
-
* @version
|
|
746
|
+
* @version 230.0.0
|
|
747
747
|
*/
|
|
748
748
|
class ApiClient {
|
|
749
749
|
/**
|
|
@@ -2287,7 +2287,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2287
2287
|
/**
|
|
2288
2288
|
* AIStudio service.
|
|
2289
2289
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2290
|
-
* @version
|
|
2290
|
+
* @version 230.0.0
|
|
2291
2291
|
*/
|
|
2292
2292
|
|
|
2293
2293
|
/**
|
|
@@ -2700,7 +2700,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2700
2700
|
/**
|
|
2701
2701
|
* AgentAssistants service.
|
|
2702
2702
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2703
|
-
* @version
|
|
2703
|
+
* @version 230.0.0
|
|
2704
2704
|
*/
|
|
2705
2705
|
|
|
2706
2706
|
/**
|
|
@@ -3011,6 +3011,115 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3011
3011
|
);
|
|
3012
3012
|
}
|
|
3013
3013
|
|
|
3014
|
+
/**
|
|
3015
|
+
* Bulk add users to assistant-queue (requires manual assignment mode).
|
|
3016
|
+
*
|
|
3017
|
+
* @param {String} assistantId Assistant ID
|
|
3018
|
+
* @param {String} queueId Queue ID
|
|
3019
|
+
* @param {Object} body
|
|
3020
|
+
*/
|
|
3021
|
+
postAssistantQueueUsersBulkAdd(assistantId, queueId, body) {
|
|
3022
|
+
// verify the required parameter 'assistantId' is set
|
|
3023
|
+
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
3024
|
+
throw 'Missing the required parameter "assistantId" when calling postAssistantQueueUsersBulkAdd';
|
|
3025
|
+
}
|
|
3026
|
+
// verify the required parameter 'queueId' is set
|
|
3027
|
+
if (queueId === undefined || queueId === null || queueId === '') {
|
|
3028
|
+
throw 'Missing the required parameter "queueId" when calling postAssistantQueueUsersBulkAdd';
|
|
3029
|
+
}
|
|
3030
|
+
// verify the required parameter 'body' is set
|
|
3031
|
+
if (body === undefined || body === null) {
|
|
3032
|
+
throw 'Missing the required parameter "body" when calling postAssistantQueueUsersBulkAdd';
|
|
3033
|
+
}
|
|
3034
|
+
|
|
3035
|
+
return this.apiClient.callApi(
|
|
3036
|
+
'/api/v2/assistants/{assistantId}/queues/{queueId}/users/bulk/add',
|
|
3037
|
+
'POST',
|
|
3038
|
+
{ 'assistantId': assistantId,'queueId': queueId },
|
|
3039
|
+
{ },
|
|
3040
|
+
{ },
|
|
3041
|
+
{ },
|
|
3042
|
+
body,
|
|
3043
|
+
['PureCloud OAuth'],
|
|
3044
|
+
['application/json'],
|
|
3045
|
+
['application/json']
|
|
3046
|
+
);
|
|
3047
|
+
}
|
|
3048
|
+
|
|
3049
|
+
/**
|
|
3050
|
+
* Bulk remove users from assistant-queue (requires manual assignment mode).
|
|
3051
|
+
*
|
|
3052
|
+
* @param {String} assistantId Assistant ID
|
|
3053
|
+
* @param {String} queueId Queue ID
|
|
3054
|
+
* @param {Object} body
|
|
3055
|
+
*/
|
|
3056
|
+
postAssistantQueueUsersBulkRemove(assistantId, queueId, body) {
|
|
3057
|
+
// verify the required parameter 'assistantId' is set
|
|
3058
|
+
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
3059
|
+
throw 'Missing the required parameter "assistantId" when calling postAssistantQueueUsersBulkRemove';
|
|
3060
|
+
}
|
|
3061
|
+
// verify the required parameter 'queueId' is set
|
|
3062
|
+
if (queueId === undefined || queueId === null || queueId === '') {
|
|
3063
|
+
throw 'Missing the required parameter "queueId" when calling postAssistantQueueUsersBulkRemove';
|
|
3064
|
+
}
|
|
3065
|
+
// verify the required parameter 'body' is set
|
|
3066
|
+
if (body === undefined || body === null) {
|
|
3067
|
+
throw 'Missing the required parameter "body" when calling postAssistantQueueUsersBulkRemove';
|
|
3068
|
+
}
|
|
3069
|
+
|
|
3070
|
+
return this.apiClient.callApi(
|
|
3071
|
+
'/api/v2/assistants/{assistantId}/queues/{queueId}/users/bulk/remove',
|
|
3072
|
+
'POST',
|
|
3073
|
+
{ 'assistantId': assistantId,'queueId': queueId },
|
|
3074
|
+
{ },
|
|
3075
|
+
{ },
|
|
3076
|
+
{ },
|
|
3077
|
+
body,
|
|
3078
|
+
['PureCloud OAuth'],
|
|
3079
|
+
['application/json'],
|
|
3080
|
+
['application/json']
|
|
3081
|
+
);
|
|
3082
|
+
}
|
|
3083
|
+
|
|
3084
|
+
/**
|
|
3085
|
+
* Query for users in the assistant-queue (requires manual assignment mode).
|
|
3086
|
+
*
|
|
3087
|
+
* @param {String} assistantId Assistant ID
|
|
3088
|
+
* @param {String} queueId Queue ID
|
|
3089
|
+
* @param {Object} body
|
|
3090
|
+
* @param {Object} opts Optional parameters
|
|
3091
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand with.
|
|
3092
|
+
*/
|
|
3093
|
+
postAssistantQueueUsersQuery(assistantId, queueId, body, opts) {
|
|
3094
|
+
opts = opts || {};
|
|
3095
|
+
|
|
3096
|
+
// verify the required parameter 'assistantId' is set
|
|
3097
|
+
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
3098
|
+
throw 'Missing the required parameter "assistantId" when calling postAssistantQueueUsersQuery';
|
|
3099
|
+
}
|
|
3100
|
+
// verify the required parameter 'queueId' is set
|
|
3101
|
+
if (queueId === undefined || queueId === null || queueId === '') {
|
|
3102
|
+
throw 'Missing the required parameter "queueId" when calling postAssistantQueueUsersQuery';
|
|
3103
|
+
}
|
|
3104
|
+
// verify the required parameter 'body' is set
|
|
3105
|
+
if (body === undefined || body === null) {
|
|
3106
|
+
throw 'Missing the required parameter "body" when calling postAssistantQueueUsersQuery';
|
|
3107
|
+
}
|
|
3108
|
+
|
|
3109
|
+
return this.apiClient.callApi(
|
|
3110
|
+
'/api/v2/assistants/{assistantId}/queues/{queueId}/users/query',
|
|
3111
|
+
'POST',
|
|
3112
|
+
{ 'assistantId': assistantId,'queueId': queueId },
|
|
3113
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3114
|
+
{ },
|
|
3115
|
+
{ },
|
|
3116
|
+
body,
|
|
3117
|
+
['PureCloud OAuth'],
|
|
3118
|
+
['application/json'],
|
|
3119
|
+
['application/json']
|
|
3120
|
+
);
|
|
3121
|
+
}
|
|
3122
|
+
|
|
3014
3123
|
/**
|
|
3015
3124
|
* Create an Assistant.
|
|
3016
3125
|
*
|
|
@@ -3077,7 +3186,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3077
3186
|
/**
|
|
3078
3187
|
* AgentCopilot service.
|
|
3079
3188
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3080
|
-
* @version
|
|
3189
|
+
* @version 230.0.0
|
|
3081
3190
|
*/
|
|
3082
3191
|
|
|
3083
3192
|
/**
|
|
@@ -3153,7 +3262,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3153
3262
|
/**
|
|
3154
3263
|
* AgentUI service.
|
|
3155
3264
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
3156
|
-
* @version
|
|
3265
|
+
* @version 230.0.0
|
|
3157
3266
|
*/
|
|
3158
3267
|
|
|
3159
3268
|
/**
|
|
@@ -3284,7 +3393,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3284
3393
|
/**
|
|
3285
3394
|
* Alerting service.
|
|
3286
3395
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3287
|
-
* @version
|
|
3396
|
+
* @version 230.0.0
|
|
3288
3397
|
*/
|
|
3289
3398
|
|
|
3290
3399
|
/**
|
|
@@ -3685,7 +3794,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3685
3794
|
/**
|
|
3686
3795
|
* Analytics service.
|
|
3687
3796
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3688
|
-
* @version
|
|
3797
|
+
* @version 230.0.0
|
|
3689
3798
|
*/
|
|
3690
3799
|
|
|
3691
3800
|
/**
|
|
@@ -6871,7 +6980,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6871
6980
|
/**
|
|
6872
6981
|
* Architect service.
|
|
6873
6982
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6874
|
-
* @version
|
|
6983
|
+
* @version 230.0.0
|
|
6875
6984
|
*/
|
|
6876
6985
|
|
|
6877
6986
|
/**
|
|
@@ -11166,7 +11275,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11166
11275
|
/**
|
|
11167
11276
|
* Audit service.
|
|
11168
11277
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
11169
|
-
* @version
|
|
11278
|
+
* @version 230.0.0
|
|
11170
11279
|
*/
|
|
11171
11280
|
|
|
11172
11281
|
/**
|
|
@@ -11367,7 +11476,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11367
11476
|
/**
|
|
11368
11477
|
* Authorization service.
|
|
11369
11478
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
11370
|
-
* @version
|
|
11479
|
+
* @version 230.0.0
|
|
11371
11480
|
*/
|
|
11372
11481
|
|
|
11373
11482
|
/**
|
|
@@ -13082,7 +13191,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13082
13191
|
/**
|
|
13083
13192
|
* Billing service.
|
|
13084
13193
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
13085
|
-
* @version
|
|
13194
|
+
* @version 230.0.0
|
|
13086
13195
|
*/
|
|
13087
13196
|
|
|
13088
13197
|
/**
|
|
@@ -13338,7 +13447,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13338
13447
|
/**
|
|
13339
13448
|
* BusinessRules service.
|
|
13340
13449
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
13341
|
-
* @version
|
|
13450
|
+
* @version 230.0.0
|
|
13342
13451
|
*/
|
|
13343
13452
|
|
|
13344
13453
|
/**
|
|
@@ -14254,7 +14363,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14254
14363
|
/**
|
|
14255
14364
|
* CarrierServices service.
|
|
14256
14365
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
14257
|
-
* @version
|
|
14366
|
+
* @version 230.0.0
|
|
14258
14367
|
*/
|
|
14259
14368
|
|
|
14260
14369
|
/**
|
|
@@ -14324,7 +14433,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14324
14433
|
/**
|
|
14325
14434
|
* Chat service.
|
|
14326
14435
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
14327
|
-
* @version
|
|
14436
|
+
* @version 230.0.0
|
|
14328
14437
|
*/
|
|
14329
14438
|
|
|
14330
14439
|
/**
|
|
@@ -15305,7 +15414,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15305
15414
|
/**
|
|
15306
15415
|
* Coaching service.
|
|
15307
15416
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
15308
|
-
* @version
|
|
15417
|
+
* @version 230.0.0
|
|
15309
15418
|
*/
|
|
15310
15419
|
|
|
15311
15420
|
/**
|
|
@@ -15882,7 +15991,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15882
15991
|
/**
|
|
15883
15992
|
* ContentManagement service.
|
|
15884
15993
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
15885
|
-
* @version
|
|
15994
|
+
* @version 230.0.0
|
|
15886
15995
|
*/
|
|
15887
15996
|
|
|
15888
15997
|
/**
|
|
@@ -16963,7 +17072,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16963
17072
|
/**
|
|
16964
17073
|
* Conversations service.
|
|
16965
17074
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
16966
|
-
* @version
|
|
17075
|
+
* @version 230.0.0
|
|
16967
17076
|
*/
|
|
16968
17077
|
|
|
16969
17078
|
/**
|
|
@@ -17029,6 +17138,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17029
17138
|
);
|
|
17030
17139
|
}
|
|
17031
17140
|
|
|
17141
|
+
/**
|
|
17142
|
+
* Update a conversation by disconnecting all of the participants
|
|
17143
|
+
*
|
|
17144
|
+
* @param {String} conversationId conversation ID
|
|
17145
|
+
*/
|
|
17146
|
+
deleteConversation(conversationId) {
|
|
17147
|
+
// verify the required parameter 'conversationId' is set
|
|
17148
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
17149
|
+
throw 'Missing the required parameter "conversationId" when calling deleteConversation';
|
|
17150
|
+
}
|
|
17151
|
+
|
|
17152
|
+
return this.apiClient.callApi(
|
|
17153
|
+
'/api/v2/conversations/{conversationId}',
|
|
17154
|
+
'DELETE',
|
|
17155
|
+
{ 'conversationId': conversationId },
|
|
17156
|
+
{ },
|
|
17157
|
+
{ },
|
|
17158
|
+
{ },
|
|
17159
|
+
null,
|
|
17160
|
+
['PureCloud OAuth'],
|
|
17161
|
+
['application/json'],
|
|
17162
|
+
['application/json']
|
|
17163
|
+
);
|
|
17164
|
+
}
|
|
17165
|
+
|
|
17032
17166
|
/**
|
|
17033
17167
|
* Delete a code used to add a communication to this participant
|
|
17034
17168
|
*
|
|
@@ -20239,6 +20373,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20239
20373
|
);
|
|
20240
20374
|
}
|
|
20241
20375
|
|
|
20376
|
+
/**
|
|
20377
|
+
* Update a conversation by setting its recording state
|
|
20378
|
+
*
|
|
20379
|
+
* @param {String} conversationId conversation ID
|
|
20380
|
+
* @param {Object} body SetRecordingState
|
|
20381
|
+
*/
|
|
20382
|
+
patchConversationRecordingstate(conversationId, body) {
|
|
20383
|
+
// verify the required parameter 'conversationId' is set
|
|
20384
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
20385
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationRecordingstate';
|
|
20386
|
+
}
|
|
20387
|
+
// verify the required parameter 'body' is set
|
|
20388
|
+
if (body === undefined || body === null) {
|
|
20389
|
+
throw 'Missing the required parameter "body" when calling patchConversationRecordingstate';
|
|
20390
|
+
}
|
|
20391
|
+
|
|
20392
|
+
return this.apiClient.callApi(
|
|
20393
|
+
'/api/v2/conversations/{conversationId}/recordingstate',
|
|
20394
|
+
'PATCH',
|
|
20395
|
+
{ 'conversationId': conversationId },
|
|
20396
|
+
{ },
|
|
20397
|
+
{ },
|
|
20398
|
+
{ },
|
|
20399
|
+
body,
|
|
20400
|
+
['PureCloud OAuth'],
|
|
20401
|
+
['application/json'],
|
|
20402
|
+
['application/json']
|
|
20403
|
+
);
|
|
20404
|
+
}
|
|
20405
|
+
|
|
20242
20406
|
/**
|
|
20243
20407
|
* Update the secure attributes on a conversation.
|
|
20244
20408
|
*
|
|
@@ -20437,6 +20601,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20437
20601
|
);
|
|
20438
20602
|
}
|
|
20439
20603
|
|
|
20604
|
+
/**
|
|
20605
|
+
* Update a conversation by merging in other conversations to create a conference
|
|
20606
|
+
*
|
|
20607
|
+
* @param {String} conversationId conversationId
|
|
20608
|
+
* @param {Object} body UpdateConferenceRequest
|
|
20609
|
+
*/
|
|
20610
|
+
patchConversationsCallConference(conversationId, body) {
|
|
20611
|
+
// verify the required parameter 'conversationId' is set
|
|
20612
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
20613
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationsCallConference';
|
|
20614
|
+
}
|
|
20615
|
+
// verify the required parameter 'body' is set
|
|
20616
|
+
if (body === undefined || body === null) {
|
|
20617
|
+
throw 'Missing the required parameter "body" when calling patchConversationsCallConference';
|
|
20618
|
+
}
|
|
20619
|
+
|
|
20620
|
+
return this.apiClient.callApi(
|
|
20621
|
+
'/api/v2/conversations/calls/{conversationId}/conference',
|
|
20622
|
+
'PATCH',
|
|
20623
|
+
{ 'conversationId': conversationId },
|
|
20624
|
+
{ },
|
|
20625
|
+
{ },
|
|
20626
|
+
{ },
|
|
20627
|
+
body,
|
|
20628
|
+
['PureCloud OAuth'],
|
|
20629
|
+
['application/json'],
|
|
20630
|
+
['application/json']
|
|
20631
|
+
);
|
|
20632
|
+
}
|
|
20633
|
+
|
|
20440
20634
|
/**
|
|
20441
20635
|
* Update conversation participant
|
|
20442
20636
|
*
|
|
@@ -25201,7 +25395,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25201
25395
|
/**
|
|
25202
25396
|
* DataExtensions service.
|
|
25203
25397
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
25204
|
-
* @version
|
|
25398
|
+
* @version 230.0.0
|
|
25205
25399
|
*/
|
|
25206
25400
|
|
|
25207
25401
|
/**
|
|
@@ -25287,7 +25481,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25287
25481
|
/**
|
|
25288
25482
|
* DataPrivacy service.
|
|
25289
25483
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
25290
|
-
* @version
|
|
25484
|
+
* @version 230.0.0
|
|
25291
25485
|
*/
|
|
25292
25486
|
|
|
25293
25487
|
/**
|
|
@@ -25457,7 +25651,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25457
25651
|
/**
|
|
25458
25652
|
* Downloads service.
|
|
25459
25653
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
25460
|
-
* @version
|
|
25654
|
+
* @version 230.0.0
|
|
25461
25655
|
*/
|
|
25462
25656
|
|
|
25463
25657
|
/**
|
|
@@ -25509,7 +25703,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25509
25703
|
/**
|
|
25510
25704
|
* Emails service.
|
|
25511
25705
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
25512
|
-
* @version
|
|
25706
|
+
* @version 230.0.0
|
|
25513
25707
|
*/
|
|
25514
25708
|
|
|
25515
25709
|
/**
|
|
@@ -25638,7 +25832,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25638
25832
|
/**
|
|
25639
25833
|
* EmployeeEngagement service.
|
|
25640
25834
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
25641
|
-
* @version
|
|
25835
|
+
* @version 230.0.0
|
|
25642
25836
|
*/
|
|
25643
25837
|
|
|
25644
25838
|
/**
|
|
@@ -25789,7 +25983,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25789
25983
|
/**
|
|
25790
25984
|
* Events service.
|
|
25791
25985
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
25792
|
-
* @version
|
|
25986
|
+
* @version 230.0.0
|
|
25793
25987
|
*/
|
|
25794
25988
|
|
|
25795
25989
|
/**
|
|
@@ -25885,7 +26079,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25885
26079
|
/**
|
|
25886
26080
|
* ExternalContacts service.
|
|
25887
26081
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
25888
|
-
* @version
|
|
26082
|
+
* @version 230.0.0
|
|
25889
26083
|
*/
|
|
25890
26084
|
|
|
25891
26085
|
/**
|
|
@@ -29132,7 +29326,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29132
29326
|
/**
|
|
29133
29327
|
* Fax service.
|
|
29134
29328
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
29135
|
-
* @version
|
|
29329
|
+
* @version 230.0.0
|
|
29136
29330
|
*/
|
|
29137
29331
|
|
|
29138
29332
|
/**
|
|
@@ -29347,7 +29541,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29347
29541
|
/**
|
|
29348
29542
|
* Flows service.
|
|
29349
29543
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
29350
|
-
* @version
|
|
29544
|
+
* @version 230.0.0
|
|
29351
29545
|
*/
|
|
29352
29546
|
|
|
29353
29547
|
/**
|
|
@@ -29556,7 +29750,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29556
29750
|
/**
|
|
29557
29751
|
* Gamification service.
|
|
29558
29752
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
29559
|
-
* @version
|
|
29753
|
+
* @version 230.0.0
|
|
29560
29754
|
*/
|
|
29561
29755
|
|
|
29562
29756
|
/**
|
|
@@ -32063,7 +32257,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32063
32257
|
/**
|
|
32064
32258
|
* GeneralDataProtectionRegulation service.
|
|
32065
32259
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
32066
|
-
* @version
|
|
32260
|
+
* @version 230.0.0
|
|
32067
32261
|
*/
|
|
32068
32262
|
|
|
32069
32263
|
/**
|
|
@@ -32193,7 +32387,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32193
32387
|
/**
|
|
32194
32388
|
* Geolocation service.
|
|
32195
32389
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
32196
|
-
* @version
|
|
32390
|
+
* @version 230.0.0
|
|
32197
32391
|
*/
|
|
32198
32392
|
|
|
32199
32393
|
/**
|
|
@@ -32324,7 +32518,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32324
32518
|
/**
|
|
32325
32519
|
* Greetings service.
|
|
32326
32520
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
32327
|
-
* @version
|
|
32521
|
+
* @version 230.0.0
|
|
32328
32522
|
*/
|
|
32329
32523
|
|
|
32330
32524
|
/**
|
|
@@ -32866,7 +33060,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32866
33060
|
/**
|
|
32867
33061
|
* Groups service.
|
|
32868
33062
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
32869
|
-
* @version
|
|
33063
|
+
* @version 230.0.0
|
|
32870
33064
|
*/
|
|
32871
33065
|
|
|
32872
33066
|
/**
|
|
@@ -33385,7 +33579,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33385
33579
|
/**
|
|
33386
33580
|
* IdentityProvider service.
|
|
33387
33581
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
33388
|
-
* @version
|
|
33582
|
+
* @version 230.0.0
|
|
33389
33583
|
*/
|
|
33390
33584
|
|
|
33391
33585
|
/**
|
|
@@ -34246,7 +34440,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34246
34440
|
/**
|
|
34247
34441
|
* InfrastructureAsCode service.
|
|
34248
34442
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
34249
|
-
* @version
|
|
34443
|
+
* @version 230.0.0
|
|
34250
34444
|
*/
|
|
34251
34445
|
|
|
34252
34446
|
/**
|
|
@@ -34413,7 +34607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34413
34607
|
/**
|
|
34414
34608
|
* Integrations service.
|
|
34415
34609
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
34416
|
-
* @version
|
|
34610
|
+
* @version 230.0.0
|
|
34417
34611
|
*/
|
|
34418
34612
|
|
|
34419
34613
|
/**
|
|
@@ -37058,7 +37252,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37058
37252
|
/**
|
|
37059
37253
|
* Journey service.
|
|
37060
37254
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
37061
|
-
* @version
|
|
37255
|
+
* @version 230.0.0
|
|
37062
37256
|
*/
|
|
37063
37257
|
|
|
37064
37258
|
/**
|
|
@@ -39128,7 +39322,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39128
39322
|
/**
|
|
39129
39323
|
* Knowledge service.
|
|
39130
39324
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
39131
|
-
* @version
|
|
39325
|
+
* @version 230.0.0
|
|
39132
39326
|
*/
|
|
39133
39327
|
|
|
39134
39328
|
/**
|
|
@@ -43030,7 +43224,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43030
43224
|
/**
|
|
43031
43225
|
* LanguageUnderstanding service.
|
|
43032
43226
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
43033
|
-
* @version
|
|
43227
|
+
* @version 230.0.0
|
|
43034
43228
|
*/
|
|
43035
43229
|
|
|
43036
43230
|
/**
|
|
@@ -44063,7 +44257,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44063
44257
|
/**
|
|
44064
44258
|
* Languages service.
|
|
44065
44259
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
44066
|
-
* @version
|
|
44260
|
+
* @version 230.0.0
|
|
44067
44261
|
*/
|
|
44068
44262
|
|
|
44069
44263
|
/**
|
|
@@ -44285,7 +44479,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44285
44479
|
/**
|
|
44286
44480
|
* Learning service.
|
|
44287
44481
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
44288
|
-
* @version
|
|
44482
|
+
* @version 230.0.0
|
|
44289
44483
|
*/
|
|
44290
44484
|
|
|
44291
44485
|
/**
|
|
@@ -45314,7 +45508,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45314
45508
|
/**
|
|
45315
45509
|
* License service.
|
|
45316
45510
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
45317
|
-
* @version
|
|
45511
|
+
* @version 230.0.0
|
|
45318
45512
|
*/
|
|
45319
45513
|
|
|
45320
45514
|
/**
|
|
@@ -45552,7 +45746,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45552
45746
|
/**
|
|
45553
45747
|
* Locations service.
|
|
45554
45748
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
45555
|
-
* @version
|
|
45749
|
+
* @version 230.0.0
|
|
45556
45750
|
*/
|
|
45557
45751
|
|
|
45558
45752
|
/**
|
|
@@ -45788,7 +45982,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45788
45982
|
/**
|
|
45789
45983
|
* LogCapture service.
|
|
45790
45984
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
45791
|
-
* @version
|
|
45985
|
+
* @version 230.0.0
|
|
45792
45986
|
*/
|
|
45793
45987
|
|
|
45794
45988
|
/**
|
|
@@ -45987,7 +46181,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45987
46181
|
/**
|
|
45988
46182
|
* Messaging service.
|
|
45989
46183
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
45990
|
-
* @version
|
|
46184
|
+
* @version 230.0.0
|
|
45991
46185
|
*/
|
|
45992
46186
|
|
|
45993
46187
|
/**
|
|
@@ -46346,7 +46540,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46346
46540
|
/**
|
|
46347
46541
|
* MobileDevices service.
|
|
46348
46542
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
46349
|
-
* @version
|
|
46543
|
+
* @version 230.0.0
|
|
46350
46544
|
*/
|
|
46351
46545
|
|
|
46352
46546
|
/**
|
|
@@ -46497,7 +46691,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46497
46691
|
/**
|
|
46498
46692
|
* Notifications service.
|
|
46499
46693
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
46500
|
-
* @version
|
|
46694
|
+
* @version 230.0.0
|
|
46501
46695
|
*/
|
|
46502
46696
|
|
|
46503
46697
|
/**
|
|
@@ -46730,7 +46924,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46730
46924
|
/**
|
|
46731
46925
|
* OAuth service.
|
|
46732
46926
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
46733
|
-
* @version
|
|
46927
|
+
* @version 230.0.0
|
|
46734
46928
|
*/
|
|
46735
46929
|
|
|
46736
46930
|
/**
|
|
@@ -47096,7 +47290,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47096
47290
|
/**
|
|
47097
47291
|
* Objects service.
|
|
47098
47292
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
47099
|
-
* @version
|
|
47293
|
+
* @version 230.0.0
|
|
47100
47294
|
*/
|
|
47101
47295
|
|
|
47102
47296
|
/**
|
|
@@ -47420,7 +47614,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47420
47614
|
/**
|
|
47421
47615
|
* OperationalEvents service.
|
|
47422
47616
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
47423
|
-
* @version
|
|
47617
|
+
* @version 230.0.0
|
|
47424
47618
|
*/
|
|
47425
47619
|
|
|
47426
47620
|
/**
|
|
@@ -47537,7 +47731,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47537
47731
|
/**
|
|
47538
47732
|
* Organization service.
|
|
47539
47733
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
47540
|
-
* @version
|
|
47734
|
+
* @version 230.0.0
|
|
47541
47735
|
*/
|
|
47542
47736
|
|
|
47543
47737
|
/**
|
|
@@ -48012,7 +48206,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48012
48206
|
/**
|
|
48013
48207
|
* OrganizationAuthorization service.
|
|
48014
48208
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
48015
|
-
* @version
|
|
48209
|
+
* @version 230.0.0
|
|
48016
48210
|
*/
|
|
48017
48211
|
|
|
48018
48212
|
/**
|
|
@@ -49406,7 +49600,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49406
49600
|
/**
|
|
49407
49601
|
* Outbound service.
|
|
49408
49602
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
49409
|
-
* @version
|
|
49603
|
+
* @version 230.0.0
|
|
49410
49604
|
*/
|
|
49411
49605
|
|
|
49412
49606
|
/**
|
|
@@ -54128,7 +54322,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54128
54322
|
/**
|
|
54129
54323
|
* Presence service.
|
|
54130
54324
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
54131
|
-
* @version
|
|
54325
|
+
* @version 230.0.0
|
|
54132
54326
|
*/
|
|
54133
54327
|
|
|
54134
54328
|
/**
|
|
@@ -54872,7 +55066,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54872
55066
|
/**
|
|
54873
55067
|
* ProcessAutomation service.
|
|
54874
55068
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
54875
|
-
* @version
|
|
55069
|
+
* @version 230.0.0
|
|
54876
55070
|
*/
|
|
54877
55071
|
|
|
54878
55072
|
/**
|
|
@@ -55111,7 +55305,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55111
55305
|
/**
|
|
55112
55306
|
* Quality service.
|
|
55113
55307
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
55114
|
-
* @version
|
|
55308
|
+
* @version 230.0.0
|
|
55115
55309
|
*/
|
|
55116
55310
|
|
|
55117
55311
|
/**
|
|
@@ -56950,7 +57144,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56950
57144
|
/**
|
|
56951
57145
|
* Recording service.
|
|
56952
57146
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
56953
|
-
* @version
|
|
57147
|
+
* @version 230.0.0
|
|
56954
57148
|
*/
|
|
56955
57149
|
|
|
56956
57150
|
/**
|
|
@@ -58003,7 +58197,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58003
58197
|
|
|
58004
58198
|
/**
|
|
58005
58199
|
* Create a recording bulk job.
|
|
58006
|
-
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data when redaction is enabled for their organization. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected.
|
|
58200
|
+
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data when redaction is enabled for their organization. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected. It is recommended to query over smaller time periods so your request does not time out.
|
|
58007
58201
|
* @param {Object} body query
|
|
58008
58202
|
*/
|
|
58009
58203
|
postRecordingJobs(body) {
|
|
@@ -58555,7 +58749,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58555
58749
|
/**
|
|
58556
58750
|
* ResponseManagement service.
|
|
58557
58751
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
58558
|
-
* @version
|
|
58752
|
+
* @version 230.0.0
|
|
58559
58753
|
*/
|
|
58560
58754
|
|
|
58561
58755
|
/**
|
|
@@ -59065,7 +59259,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59065
59259
|
/**
|
|
59066
59260
|
* Routing service.
|
|
59067
59261
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
59068
|
-
* @version
|
|
59262
|
+
* @version 230.0.0
|
|
59069
59263
|
*/
|
|
59070
59264
|
|
|
59071
59265
|
/**
|
|
@@ -60049,31 +60243,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60049
60243
|
);
|
|
60050
60244
|
}
|
|
60051
60245
|
|
|
60052
|
-
/**
|
|
60053
|
-
* Search a domain across organizations
|
|
60054
|
-
*
|
|
60055
|
-
* @param {String} domainId domain ID
|
|
60056
|
-
*/
|
|
60057
|
-
getRoutingEmailOutboundDomainSearch(domainId) {
|
|
60058
|
-
// verify the required parameter 'domainId' is set
|
|
60059
|
-
if (domainId === undefined || domainId === null || domainId === '') {
|
|
60060
|
-
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomainSearch';
|
|
60061
|
-
}
|
|
60062
|
-
|
|
60063
|
-
return this.apiClient.callApi(
|
|
60064
|
-
'/api/v2/routing/email/outbound/domains/{domainId}/search',
|
|
60065
|
-
'GET',
|
|
60066
|
-
{ 'domainId': domainId },
|
|
60067
|
-
{ },
|
|
60068
|
-
{ },
|
|
60069
|
-
{ },
|
|
60070
|
-
null,
|
|
60071
|
-
['PureCloud OAuth'],
|
|
60072
|
-
['application/json'],
|
|
60073
|
-
['application/json']
|
|
60074
|
-
);
|
|
60075
|
-
}
|
|
60076
|
-
|
|
60077
60246
|
/**
|
|
60078
60247
|
* Get outbound domains
|
|
60079
60248
|
*
|
|
@@ -62308,8 +62477,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62308
62477
|
}
|
|
62309
62478
|
|
|
62310
62479
|
/**
|
|
62311
|
-
* Tests the custom SMTP server integration connection set on this domain
|
|
62312
|
-
* The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server. If the body is specified, there will be an attempt to send an email message to the server.
|
|
62480
|
+
* Tests the custom SMTP server integration connection set on this ACD domain
|
|
62481
|
+
* The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server used by the ACD domain. If the body is specified, there will be an attempt to send an email message to the server.
|
|
62313
62482
|
* @param {String} domainId domain ID
|
|
62314
62483
|
* @param {Object} opts Optional parameters
|
|
62315
62484
|
* @param {Object} opts.body TestMessage
|
|
@@ -63406,7 +63575,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63406
63575
|
/**
|
|
63407
63576
|
* SCIM service.
|
|
63408
63577
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
63409
|
-
* @version
|
|
63578
|
+
* @version 230.0.0
|
|
63410
63579
|
*/
|
|
63411
63580
|
|
|
63412
63581
|
/**
|
|
@@ -64283,7 +64452,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64283
64452
|
/**
|
|
64284
64453
|
* ScreenRecording service.
|
|
64285
64454
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
64286
|
-
* @version
|
|
64455
|
+
* @version 230.0.0
|
|
64287
64456
|
*/
|
|
64288
64457
|
|
|
64289
64458
|
/**
|
|
@@ -64328,7 +64497,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64328
64497
|
/**
|
|
64329
64498
|
* Scripts service.
|
|
64330
64499
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
64331
|
-
* @version
|
|
64500
|
+
* @version 230.0.0
|
|
64332
64501
|
*/
|
|
64333
64502
|
|
|
64334
64503
|
/**
|
|
@@ -64804,7 +64973,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64804
64973
|
/**
|
|
64805
64974
|
* Search service.
|
|
64806
64975
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
64807
|
-
* @version
|
|
64976
|
+
* @version 230.0.0
|
|
64808
64977
|
*/
|
|
64809
64978
|
|
|
64810
64979
|
/**
|
|
@@ -65522,7 +65691,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65522
65691
|
/**
|
|
65523
65692
|
* Settings service.
|
|
65524
65693
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
65525
|
-
* @version
|
|
65694
|
+
* @version 230.0.0
|
|
65526
65695
|
*/
|
|
65527
65696
|
|
|
65528
65697
|
/**
|
|
@@ -65870,7 +66039,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65870
66039
|
/**
|
|
65871
66040
|
* SocialMedia service.
|
|
65872
66041
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
65873
|
-
* @version
|
|
66042
|
+
* @version 230.0.0
|
|
65874
66043
|
*/
|
|
65875
66044
|
|
|
65876
66045
|
/**
|
|
@@ -67221,7 +67390,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67221
67390
|
/**
|
|
67222
67391
|
* SpeechTextAnalytics service.
|
|
67223
67392
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
67224
|
-
* @version
|
|
67393
|
+
* @version 230.0.0
|
|
67225
67394
|
*/
|
|
67226
67395
|
|
|
67227
67396
|
/**
|
|
@@ -68867,7 +69036,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68867
69036
|
/**
|
|
68868
69037
|
* Stations service.
|
|
68869
69038
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
68870
|
-
* @version
|
|
69039
|
+
* @version 230.0.0
|
|
68871
69040
|
*/
|
|
68872
69041
|
|
|
68873
69042
|
/**
|
|
@@ -68969,7 +69138,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68969
69138
|
/**
|
|
68970
69139
|
* Suggest service.
|
|
68971
69140
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
68972
|
-
* @version
|
|
69141
|
+
* @version 230.0.0
|
|
68973
69142
|
*/
|
|
68974
69143
|
|
|
68975
69144
|
/**
|
|
@@ -69108,7 +69277,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69108
69277
|
/**
|
|
69109
69278
|
* TaskManagement service.
|
|
69110
69279
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
69111
|
-
* @version
|
|
69280
|
+
* @version 230.0.0
|
|
69112
69281
|
*/
|
|
69113
69282
|
|
|
69114
69283
|
/**
|
|
@@ -71270,7 +71439,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71270
71439
|
/**
|
|
71271
71440
|
* Teams service.
|
|
71272
71441
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
71273
|
-
* @version
|
|
71442
|
+
* @version 230.0.0
|
|
71274
71443
|
*/
|
|
71275
71444
|
|
|
71276
71445
|
/**
|
|
@@ -71575,7 +71744,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71575
71744
|
/**
|
|
71576
71745
|
* Telephony service.
|
|
71577
71746
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
71578
|
-
* @version
|
|
71747
|
+
* @version 230.0.0
|
|
71579
71748
|
*/
|
|
71580
71749
|
|
|
71581
71750
|
/**
|
|
@@ -71861,7 +72030,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71861
72030
|
/**
|
|
71862
72031
|
* TelephonyProvidersEdge service.
|
|
71863
72032
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
71864
|
-
* @version
|
|
72033
|
+
* @version 230.0.0
|
|
71865
72034
|
*/
|
|
71866
72035
|
|
|
71867
72036
|
/**
|
|
@@ -75354,7 +75523,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75354
75523
|
/**
|
|
75355
75524
|
* Textbots service.
|
|
75356
75525
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
75357
|
-
* @version
|
|
75526
|
+
* @version 230.0.0
|
|
75358
75527
|
*/
|
|
75359
75528
|
|
|
75360
75529
|
/**
|
|
@@ -75483,7 +75652,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75483
75652
|
/**
|
|
75484
75653
|
* Tokens service.
|
|
75485
75654
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
75486
|
-
* @version
|
|
75655
|
+
* @version 230.0.0
|
|
75487
75656
|
*/
|
|
75488
75657
|
|
|
75489
75658
|
/**
|
|
@@ -75637,7 +75806,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75637
75806
|
/**
|
|
75638
75807
|
* Uploads service.
|
|
75639
75808
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
75640
|
-
* @version
|
|
75809
|
+
* @version 230.0.0
|
|
75641
75810
|
*/
|
|
75642
75811
|
|
|
75643
75812
|
/**
|
|
@@ -75928,7 +76097,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75928
76097
|
/**
|
|
75929
76098
|
* Usage service.
|
|
75930
76099
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
75931
|
-
* @version
|
|
76100
|
+
* @version 230.0.0
|
|
75932
76101
|
*/
|
|
75933
76102
|
|
|
75934
76103
|
/**
|
|
@@ -76263,7 +76432,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76263
76432
|
/**
|
|
76264
76433
|
* UserRecordings service.
|
|
76265
76434
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
76266
|
-
* @version
|
|
76435
|
+
* @version 230.0.0
|
|
76267
76436
|
*/
|
|
76268
76437
|
|
|
76269
76438
|
/**
|
|
@@ -76478,7 +76647,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76478
76647
|
/**
|
|
76479
76648
|
* Users service.
|
|
76480
76649
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
76481
|
-
* @version
|
|
76650
|
+
* @version 230.0.0
|
|
76482
76651
|
*/
|
|
76483
76652
|
|
|
76484
76653
|
/**
|
|
@@ -79487,7 +79656,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79487
79656
|
/**
|
|
79488
79657
|
* Utilities service.
|
|
79489
79658
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
79490
|
-
* @version
|
|
79659
|
+
* @version 230.0.0
|
|
79491
79660
|
*/
|
|
79492
79661
|
|
|
79493
79662
|
/**
|
|
@@ -79598,7 +79767,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79598
79767
|
/**
|
|
79599
79768
|
* Voicemail service.
|
|
79600
79769
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
79601
|
-
* @version
|
|
79770
|
+
* @version 230.0.0
|
|
79602
79771
|
*/
|
|
79603
79772
|
|
|
79604
79773
|
/**
|
|
@@ -80320,7 +80489,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80320
80489
|
/**
|
|
80321
80490
|
* WebChat service.
|
|
80322
80491
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
80323
|
-
* @version
|
|
80492
|
+
* @version 230.0.0
|
|
80324
80493
|
*/
|
|
80325
80494
|
|
|
80326
80495
|
/**
|
|
@@ -80880,7 +81049,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80880
81049
|
/**
|
|
80881
81050
|
* WebDeployments service.
|
|
80882
81051
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
80883
|
-
* @version
|
|
81052
|
+
* @version 230.0.0
|
|
80884
81053
|
*/
|
|
80885
81054
|
|
|
80886
81055
|
/**
|
|
@@ -81462,7 +81631,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81462
81631
|
/**
|
|
81463
81632
|
* WebMessaging service.
|
|
81464
81633
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
81465
|
-
* @version
|
|
81634
|
+
* @version 230.0.0
|
|
81466
81635
|
*/
|
|
81467
81636
|
|
|
81468
81637
|
/**
|
|
@@ -81477,6 +81646,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81477
81646
|
}
|
|
81478
81647
|
|
|
81479
81648
|
|
|
81649
|
+
/**
|
|
81650
|
+
* Delete device information
|
|
81651
|
+
*
|
|
81652
|
+
* @param {String} deploymentId WebMessaging deployment id
|
|
81653
|
+
* @param {String} tokenId Device token id or cookie id
|
|
81654
|
+
*/
|
|
81655
|
+
deleteWebmessagingDeploymentPushdevice(deploymentId, tokenId) {
|
|
81656
|
+
// verify the required parameter 'deploymentId' is set
|
|
81657
|
+
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
81658
|
+
throw 'Missing the required parameter "deploymentId" when calling deleteWebmessagingDeploymentPushdevice';
|
|
81659
|
+
}
|
|
81660
|
+
// verify the required parameter 'tokenId' is set
|
|
81661
|
+
if (tokenId === undefined || tokenId === null || tokenId === '') {
|
|
81662
|
+
throw 'Missing the required parameter "tokenId" when calling deleteWebmessagingDeploymentPushdevice';
|
|
81663
|
+
}
|
|
81664
|
+
|
|
81665
|
+
return this.apiClient.callApi(
|
|
81666
|
+
'/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}',
|
|
81667
|
+
'DELETE',
|
|
81668
|
+
{ 'deploymentId': deploymentId,'tokenId': tokenId },
|
|
81669
|
+
{ },
|
|
81670
|
+
{ },
|
|
81671
|
+
{ },
|
|
81672
|
+
null,
|
|
81673
|
+
['PureCloud OAuth'],
|
|
81674
|
+
['application/json'],
|
|
81675
|
+
['application/json']
|
|
81676
|
+
);
|
|
81677
|
+
}
|
|
81678
|
+
|
|
81480
81679
|
/**
|
|
81481
81680
|
* Get the messages for a web messaging session.
|
|
81482
81681
|
*
|
|
@@ -81502,13 +81701,83 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81502
81701
|
);
|
|
81503
81702
|
}
|
|
81504
81703
|
|
|
81704
|
+
/**
|
|
81705
|
+
* Edit device information
|
|
81706
|
+
*
|
|
81707
|
+
* @param {String} deploymentId WebMessaging deployment id
|
|
81708
|
+
* @param {String} tokenId Device token id or cookie id
|
|
81709
|
+
* @param {Object} body Request body
|
|
81710
|
+
*/
|
|
81711
|
+
patchWebmessagingDeploymentPushdevice(deploymentId, tokenId, body) {
|
|
81712
|
+
// verify the required parameter 'deploymentId' is set
|
|
81713
|
+
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
81714
|
+
throw 'Missing the required parameter "deploymentId" when calling patchWebmessagingDeploymentPushdevice';
|
|
81715
|
+
}
|
|
81716
|
+
// verify the required parameter 'tokenId' is set
|
|
81717
|
+
if (tokenId === undefined || tokenId === null || tokenId === '') {
|
|
81718
|
+
throw 'Missing the required parameter "tokenId" when calling patchWebmessagingDeploymentPushdevice';
|
|
81719
|
+
}
|
|
81720
|
+
// verify the required parameter 'body' is set
|
|
81721
|
+
if (body === undefined || body === null) {
|
|
81722
|
+
throw 'Missing the required parameter "body" when calling patchWebmessagingDeploymentPushdevice';
|
|
81723
|
+
}
|
|
81724
|
+
|
|
81725
|
+
return this.apiClient.callApi(
|
|
81726
|
+
'/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}',
|
|
81727
|
+
'PATCH',
|
|
81728
|
+
{ 'deploymentId': deploymentId,'tokenId': tokenId },
|
|
81729
|
+
{ },
|
|
81730
|
+
{ },
|
|
81731
|
+
{ },
|
|
81732
|
+
body,
|
|
81733
|
+
['PureCloud OAuth'],
|
|
81734
|
+
['application/json'],
|
|
81735
|
+
['application/json']
|
|
81736
|
+
);
|
|
81737
|
+
}
|
|
81738
|
+
|
|
81739
|
+
/**
|
|
81740
|
+
* Add a new device information
|
|
81741
|
+
*
|
|
81742
|
+
* @param {String} deploymentId WebMessaging deployment id
|
|
81743
|
+
* @param {String} tokenId Device token id or cookie id
|
|
81744
|
+
* @param {Object} body Request body
|
|
81745
|
+
*/
|
|
81746
|
+
postWebmessagingDeploymentPushdevice(deploymentId, tokenId, body) {
|
|
81747
|
+
// verify the required parameter 'deploymentId' is set
|
|
81748
|
+
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
81749
|
+
throw 'Missing the required parameter "deploymentId" when calling postWebmessagingDeploymentPushdevice';
|
|
81750
|
+
}
|
|
81751
|
+
// verify the required parameter 'tokenId' is set
|
|
81752
|
+
if (tokenId === undefined || tokenId === null || tokenId === '') {
|
|
81753
|
+
throw 'Missing the required parameter "tokenId" when calling postWebmessagingDeploymentPushdevice';
|
|
81754
|
+
}
|
|
81755
|
+
// verify the required parameter 'body' is set
|
|
81756
|
+
if (body === undefined || body === null) {
|
|
81757
|
+
throw 'Missing the required parameter "body" when calling postWebmessagingDeploymentPushdevice';
|
|
81758
|
+
}
|
|
81759
|
+
|
|
81760
|
+
return this.apiClient.callApi(
|
|
81761
|
+
'/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}',
|
|
81762
|
+
'POST',
|
|
81763
|
+
{ 'deploymentId': deploymentId,'tokenId': tokenId },
|
|
81764
|
+
{ },
|
|
81765
|
+
{ },
|
|
81766
|
+
{ },
|
|
81767
|
+
body,
|
|
81768
|
+
['PureCloud OAuth'],
|
|
81769
|
+
['application/json'],
|
|
81770
|
+
['application/json']
|
|
81771
|
+
);
|
|
81772
|
+
}
|
|
81773
|
+
|
|
81505
81774
|
}
|
|
81506
81775
|
|
|
81507
81776
|
class WidgetsApi {
|
|
81508
81777
|
/**
|
|
81509
81778
|
* Widgets service.
|
|
81510
81779
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
81511
|
-
* @version
|
|
81780
|
+
* @version 230.0.0
|
|
81512
81781
|
*/
|
|
81513
81782
|
|
|
81514
81783
|
/**
|
|
@@ -81659,7 +81928,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81659
81928
|
/**
|
|
81660
81929
|
* WorkforceManagement service.
|
|
81661
81930
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
81662
|
-
* @version
|
|
81931
|
+
* @version 230.0.0
|
|
81663
81932
|
*/
|
|
81664
81933
|
|
|
81665
81934
|
/**
|
|
@@ -89629,7 +89898,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
89629
89898
|
* </pre>
|
|
89630
89899
|
* </p>
|
|
89631
89900
|
* @module purecloud-platform-client-v2/index
|
|
89632
|
-
* @version
|
|
89901
|
+
* @version 230.0.0
|
|
89633
89902
|
*/
|
|
89634
89903
|
class platformClient {
|
|
89635
89904
|
constructor() {
|