purecloud-platform-client-v2 249.0.0 → 250.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 +34 -3
- package/dist/node/purecloud-platform-client-v2.js +20042 -5569
- package/dist/web-amd/purecloud-platform-client-v2.js +20042 -5569
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +11159 -5369
- package/dist/web-cjs/purecloud-platform-client-v2.js +11159 -5369
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +10600 -2242
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +26 -2
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +136 -40
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +130 -39
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +18 -6
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +29 -9
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +86 -26
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +917 -224
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +754 -226
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +36 -11
- package/src/purecloud-platform-client-v2/api/AuditApi.js +38 -12
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +302 -91
- package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/BillingApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +180 -53
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +11 -4
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +187 -56
- package/src/purecloud-platform-client-v2/api/ChatApi.js +223 -65
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +124 -37
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +165 -51
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1992 -578
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +22 -7
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +39 -12
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +28 -9
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +35 -11
- package/src/purecloud-platform-client-v2/api/EventsApi.js +22 -7
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +700 -206
- package/src/purecloud-platform-client-v2/api/FaxApi.js +49 -15
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +42 -13
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +419 -125
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +21 -7
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +29 -9
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +106 -32
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +103 -31
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +267 -77
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +20 -7
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +461 -139
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +93 -28
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +872 -120
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +618 -185
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +221 -66
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +53 -16
- package/src/purecloud-platform-client-v2/api/LearningApi.js +199 -60
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +51 -16
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +45 -14
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +34 -11
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +84 -25
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +28 -9
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +72 -22
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +58 -18
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +21 -7
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +122 -36
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +297 -87
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1066 -312
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +162 -48
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/QualityApi.js +409 -121
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +351 -108
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +113 -34
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +964 -284
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +123 -39
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +50 -17
- package/src/purecloud-platform-client-v2/api/SearchApi.js +147 -44
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +87 -26
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +208 -67
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +389 -114
- package/src/purecloud-platform-client-v2/api/StationsApi.js +18 -6
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +13 -5
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +473 -138
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +55 -17
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +80 -24
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +751 -220
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/TokensApi.js +35 -11
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +78 -23
- package/src/purecloud-platform-client-v2/api/UsageApi.js +62 -19
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +27 -9
- package/src/purecloud-platform-client-v2/api/UsersApi.js +717 -228
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +52 -16
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +154 -46
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +126 -37
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +120 -36
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +36 -11
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +2475 -577
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class WebDeploymentsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* WebDeployments service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 250.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,8 +24,12 @@ class WebDeploymentsApi {
|
|
|
24
24
|
* Delete all versions of a configuration
|
|
25
25
|
*
|
|
26
26
|
* @param {String} configurationId The configuration version ID
|
|
27
|
+
* @param {Object} opts Optional parameters
|
|
28
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27
29
|
*/
|
|
28
|
-
deleteWebdeploymentsConfiguration(configurationId) {
|
|
30
|
+
deleteWebdeploymentsConfiguration(configurationId, opts) {
|
|
31
|
+
opts = opts || {};
|
|
32
|
+
|
|
29
33
|
// verify the required parameter 'configurationId' is set
|
|
30
34
|
if (configurationId === undefined || configurationId === null || configurationId === '') {
|
|
31
35
|
throw 'Missing the required parameter "configurationId" when calling deleteWebdeploymentsConfiguration';
|
|
@@ -41,7 +45,8 @@ class WebDeploymentsApi {
|
|
|
41
45
|
null,
|
|
42
46
|
['PureCloud OAuth'],
|
|
43
47
|
['application/json'],
|
|
44
|
-
['application/json']
|
|
48
|
+
['application/json'],
|
|
49
|
+
opts['customHeaders']
|
|
45
50
|
);
|
|
46
51
|
}
|
|
47
52
|
|
|
@@ -49,8 +54,12 @@ class WebDeploymentsApi {
|
|
|
49
54
|
* Delete a deployment
|
|
50
55
|
*
|
|
51
56
|
* @param {String} deploymentId The deployment ID
|
|
57
|
+
* @param {Object} opts Optional parameters
|
|
58
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
52
59
|
*/
|
|
53
|
-
deleteWebdeploymentsDeployment(deploymentId) {
|
|
60
|
+
deleteWebdeploymentsDeployment(deploymentId, opts) {
|
|
61
|
+
opts = opts || {};
|
|
62
|
+
|
|
54
63
|
// verify the required parameter 'deploymentId' is set
|
|
55
64
|
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
56
65
|
throw 'Missing the required parameter "deploymentId" when calling deleteWebdeploymentsDeployment';
|
|
@@ -66,7 +75,8 @@ class WebDeploymentsApi {
|
|
|
66
75
|
null,
|
|
67
76
|
['PureCloud OAuth'],
|
|
68
77
|
['application/json'],
|
|
69
|
-
['application/json']
|
|
78
|
+
['application/json'],
|
|
79
|
+
opts['customHeaders']
|
|
70
80
|
);
|
|
71
81
|
}
|
|
72
82
|
|
|
@@ -75,8 +85,12 @@ class WebDeploymentsApi {
|
|
|
75
85
|
*
|
|
76
86
|
* @param {String} deploymentId WebMessaging deployment ID
|
|
77
87
|
* @param {String} sessionId Cobrowse session id or join code
|
|
88
|
+
* @param {Object} opts Optional parameters
|
|
89
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
78
90
|
*/
|
|
79
|
-
deleteWebdeploymentsDeploymentCobrowseSessionId(deploymentId, sessionId) {
|
|
91
|
+
deleteWebdeploymentsDeploymentCobrowseSessionId(deploymentId, sessionId, opts) {
|
|
92
|
+
opts = opts || {};
|
|
93
|
+
|
|
80
94
|
// verify the required parameter 'deploymentId' is set
|
|
81
95
|
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
82
96
|
throw 'Missing the required parameter "deploymentId" when calling deleteWebdeploymentsDeploymentCobrowseSessionId';
|
|
@@ -96,7 +110,8 @@ class WebDeploymentsApi {
|
|
|
96
110
|
null,
|
|
97
111
|
['PureCloud OAuth'],
|
|
98
112
|
['application/json'],
|
|
99
|
-
['application/json']
|
|
113
|
+
['application/json'],
|
|
114
|
+
opts['customHeaders']
|
|
100
115
|
);
|
|
101
116
|
}
|
|
102
117
|
|
|
@@ -106,6 +121,7 @@ class WebDeploymentsApi {
|
|
|
106
121
|
* @param {Object} opts Optional parameters
|
|
107
122
|
* @param {String} opts.xJourneySessionId The Customer's journey sessionId.
|
|
108
123
|
* @param {String} opts.xJourneySessionType The Customer's journey session type.
|
|
124
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109
125
|
*/
|
|
110
126
|
deleteWebdeploymentsTokenRevoke(opts) {
|
|
111
127
|
opts = opts || {};
|
|
@@ -121,7 +137,8 @@ class WebDeploymentsApi {
|
|
|
121
137
|
null,
|
|
122
138
|
['PureCloud OAuth'],
|
|
123
139
|
['application/json'],
|
|
124
|
-
['application/json']
|
|
140
|
+
['application/json'],
|
|
141
|
+
opts['customHeaders']
|
|
125
142
|
);
|
|
126
143
|
}
|
|
127
144
|
|
|
@@ -130,8 +147,12 @@ class WebDeploymentsApi {
|
|
|
130
147
|
*
|
|
131
148
|
* @param {String} configurationId The configuration version ID
|
|
132
149
|
* @param {String} versionId The version of the configuration to get
|
|
150
|
+
* @param {Object} opts Optional parameters
|
|
151
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
133
152
|
*/
|
|
134
|
-
getWebdeploymentsConfigurationVersion(configurationId, versionId) {
|
|
153
|
+
getWebdeploymentsConfigurationVersion(configurationId, versionId, opts) {
|
|
154
|
+
opts = opts || {};
|
|
155
|
+
|
|
135
156
|
// verify the required parameter 'configurationId' is set
|
|
136
157
|
if (configurationId === undefined || configurationId === null || configurationId === '') {
|
|
137
158
|
throw 'Missing the required parameter "configurationId" when calling getWebdeploymentsConfigurationVersion';
|
|
@@ -151,7 +172,8 @@ class WebDeploymentsApi {
|
|
|
151
172
|
null,
|
|
152
173
|
['PureCloud OAuth'],
|
|
153
174
|
['application/json'],
|
|
154
|
-
['application/json']
|
|
175
|
+
['application/json'],
|
|
176
|
+
opts['customHeaders']
|
|
155
177
|
);
|
|
156
178
|
}
|
|
157
179
|
|
|
@@ -163,6 +185,7 @@ class WebDeploymentsApi {
|
|
|
163
185
|
* @param {String} opts.pageSize Number of entities to return. Defaults to 300.
|
|
164
186
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
165
187
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
188
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
166
189
|
*/
|
|
167
190
|
getWebdeploymentsConfigurationVersions(configurationId, opts) {
|
|
168
191
|
opts = opts || {};
|
|
@@ -182,7 +205,8 @@ class WebDeploymentsApi {
|
|
|
182
205
|
null,
|
|
183
206
|
['PureCloud OAuth'],
|
|
184
207
|
['application/json'],
|
|
185
|
-
['application/json']
|
|
208
|
+
['application/json'],
|
|
209
|
+
opts['customHeaders']
|
|
186
210
|
);
|
|
187
211
|
}
|
|
188
212
|
|
|
@@ -190,8 +214,12 @@ class WebDeploymentsApi {
|
|
|
190
214
|
* Get the configuration draft
|
|
191
215
|
*
|
|
192
216
|
* @param {String} configurationId The configuration version ID
|
|
217
|
+
* @param {Object} opts Optional parameters
|
|
218
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
193
219
|
*/
|
|
194
|
-
getWebdeploymentsConfigurationVersionsDraft(configurationId) {
|
|
220
|
+
getWebdeploymentsConfigurationVersionsDraft(configurationId, opts) {
|
|
221
|
+
opts = opts || {};
|
|
222
|
+
|
|
195
223
|
// verify the required parameter 'configurationId' is set
|
|
196
224
|
if (configurationId === undefined || configurationId === null || configurationId === '') {
|
|
197
225
|
throw 'Missing the required parameter "configurationId" when calling getWebdeploymentsConfigurationVersionsDraft';
|
|
@@ -207,7 +235,8 @@ class WebDeploymentsApi {
|
|
|
207
235
|
null,
|
|
208
236
|
['PureCloud OAuth'],
|
|
209
237
|
['application/json'],
|
|
210
|
-
['application/json']
|
|
238
|
+
['application/json'],
|
|
239
|
+
opts['customHeaders']
|
|
211
240
|
);
|
|
212
241
|
}
|
|
213
242
|
|
|
@@ -219,6 +248,7 @@ class WebDeploymentsApi {
|
|
|
219
248
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
220
249
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
221
250
|
* @param {Boolean} opts.showOnlyPublished Filter by published status.
|
|
251
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
222
252
|
*/
|
|
223
253
|
getWebdeploymentsConfigurations(opts) {
|
|
224
254
|
opts = opts || {};
|
|
@@ -234,7 +264,8 @@ class WebDeploymentsApi {
|
|
|
234
264
|
null,
|
|
235
265
|
['PureCloud OAuth'],
|
|
236
266
|
['application/json'],
|
|
237
|
-
['application/json']
|
|
267
|
+
['application/json'],
|
|
268
|
+
opts['customHeaders']
|
|
238
269
|
);
|
|
239
270
|
}
|
|
240
271
|
|
|
@@ -244,6 +275,7 @@ class WebDeploymentsApi {
|
|
|
244
275
|
* @param {String} deploymentId The deployment ID
|
|
245
276
|
* @param {Object} opts Optional parameters
|
|
246
277
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
278
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
247
279
|
*/
|
|
248
280
|
getWebdeploymentsDeployment(deploymentId, opts) {
|
|
249
281
|
opts = opts || {};
|
|
@@ -263,7 +295,8 @@ class WebDeploymentsApi {
|
|
|
263
295
|
null,
|
|
264
296
|
['PureCloud OAuth'],
|
|
265
297
|
['application/json'],
|
|
266
|
-
['application/json']
|
|
298
|
+
['application/json'],
|
|
299
|
+
opts['customHeaders']
|
|
267
300
|
);
|
|
268
301
|
}
|
|
269
302
|
|
|
@@ -272,8 +305,12 @@ class WebDeploymentsApi {
|
|
|
272
305
|
*
|
|
273
306
|
* @param {String} deploymentId WebMessaging deployment ID
|
|
274
307
|
* @param {String} sessionId Cobrowse session id or join code
|
|
308
|
+
* @param {Object} opts Optional parameters
|
|
309
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
275
310
|
*/
|
|
276
|
-
getWebdeploymentsDeploymentCobrowseSessionId(deploymentId, sessionId) {
|
|
311
|
+
getWebdeploymentsDeploymentCobrowseSessionId(deploymentId, sessionId, opts) {
|
|
312
|
+
opts = opts || {};
|
|
313
|
+
|
|
277
314
|
// verify the required parameter 'deploymentId' is set
|
|
278
315
|
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
279
316
|
throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentCobrowseSessionId';
|
|
@@ -293,7 +330,8 @@ class WebDeploymentsApi {
|
|
|
293
330
|
null,
|
|
294
331
|
['PureCloud OAuth'],
|
|
295
332
|
['application/json'],
|
|
296
|
-
['application/json']
|
|
333
|
+
['application/json'],
|
|
334
|
+
opts['customHeaders']
|
|
297
335
|
);
|
|
298
336
|
}
|
|
299
337
|
|
|
@@ -304,6 +342,7 @@ class WebDeploymentsApi {
|
|
|
304
342
|
* @param {Object} opts Optional parameters
|
|
305
343
|
* @param {String} opts.type Get active configuration on a deployment
|
|
306
344
|
* @param {Array.<String>} opts.expand Expand instructions for the return value
|
|
345
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
307
346
|
*/
|
|
308
347
|
getWebdeploymentsDeploymentConfigurations(deploymentId, opts) {
|
|
309
348
|
opts = opts || {};
|
|
@@ -323,7 +362,8 @@ class WebDeploymentsApi {
|
|
|
323
362
|
null,
|
|
324
363
|
['PureCloud OAuth'],
|
|
325
364
|
['application/json'],
|
|
326
|
-
['application/json']
|
|
365
|
+
['application/json'],
|
|
366
|
+
opts['customHeaders']
|
|
327
367
|
);
|
|
328
368
|
}
|
|
329
369
|
|
|
@@ -331,8 +371,12 @@ class WebDeploymentsApi {
|
|
|
331
371
|
* Get a deployment identity resolution setting.
|
|
332
372
|
*
|
|
333
373
|
* @param {String} deploymentId The deployment ID
|
|
374
|
+
* @param {Object} opts Optional parameters
|
|
375
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
334
376
|
*/
|
|
335
|
-
getWebdeploymentsDeploymentIdentityresolution(deploymentId) {
|
|
377
|
+
getWebdeploymentsDeploymentIdentityresolution(deploymentId, opts) {
|
|
378
|
+
opts = opts || {};
|
|
379
|
+
|
|
336
380
|
// verify the required parameter 'deploymentId' is set
|
|
337
381
|
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
338
382
|
throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentIdentityresolution';
|
|
@@ -348,7 +392,8 @@ class WebDeploymentsApi {
|
|
|
348
392
|
null,
|
|
349
393
|
['PureCloud OAuth'],
|
|
350
394
|
['application/json'],
|
|
351
|
-
['application/json']
|
|
395
|
+
['application/json'],
|
|
396
|
+
opts['customHeaders']
|
|
352
397
|
);
|
|
353
398
|
}
|
|
354
399
|
|
|
@@ -360,6 +405,7 @@ class WebDeploymentsApi {
|
|
|
360
405
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
361
406
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
362
407
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
408
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
363
409
|
*/
|
|
364
410
|
getWebdeploymentsDeployments(opts) {
|
|
365
411
|
opts = opts || {};
|
|
@@ -375,7 +421,8 @@ class WebDeploymentsApi {
|
|
|
375
421
|
null,
|
|
376
422
|
['PureCloud OAuth'],
|
|
377
423
|
['application/json'],
|
|
378
|
-
['application/json']
|
|
424
|
+
['application/json'],
|
|
425
|
+
opts['customHeaders']
|
|
379
426
|
);
|
|
380
427
|
}
|
|
381
428
|
|
|
@@ -383,8 +430,12 @@ class WebDeploymentsApi {
|
|
|
383
430
|
* Publish the configuration draft and create a new version
|
|
384
431
|
*
|
|
385
432
|
* @param {String} configurationId The configuration version ID
|
|
433
|
+
* @param {Object} opts Optional parameters
|
|
434
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
386
435
|
*/
|
|
387
|
-
postWebdeploymentsConfigurationVersionsDraftPublish(configurationId) {
|
|
436
|
+
postWebdeploymentsConfigurationVersionsDraftPublish(configurationId, opts) {
|
|
437
|
+
opts = opts || {};
|
|
438
|
+
|
|
388
439
|
// verify the required parameter 'configurationId' is set
|
|
389
440
|
if (configurationId === undefined || configurationId === null || configurationId === '') {
|
|
390
441
|
throw 'Missing the required parameter "configurationId" when calling postWebdeploymentsConfigurationVersionsDraftPublish';
|
|
@@ -400,7 +451,8 @@ class WebDeploymentsApi {
|
|
|
400
451
|
null,
|
|
401
452
|
['PureCloud OAuth'],
|
|
402
453
|
['application/json'],
|
|
403
|
-
['application/json']
|
|
454
|
+
['application/json'],
|
|
455
|
+
opts['customHeaders']
|
|
404
456
|
);
|
|
405
457
|
}
|
|
406
458
|
|
|
@@ -408,8 +460,12 @@ class WebDeploymentsApi {
|
|
|
408
460
|
* Create a configuration draft
|
|
409
461
|
*
|
|
410
462
|
* @param {Object} configurationVersion
|
|
463
|
+
* @param {Object} opts Optional parameters
|
|
464
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
411
465
|
*/
|
|
412
|
-
postWebdeploymentsConfigurations(configurationVersion) {
|
|
466
|
+
postWebdeploymentsConfigurations(configurationVersion, opts) {
|
|
467
|
+
opts = opts || {};
|
|
468
|
+
|
|
413
469
|
// verify the required parameter 'configurationVersion' is set
|
|
414
470
|
if (configurationVersion === undefined || configurationVersion === null) {
|
|
415
471
|
throw 'Missing the required parameter "configurationVersion" when calling postWebdeploymentsConfigurations';
|
|
@@ -425,7 +481,8 @@ class WebDeploymentsApi {
|
|
|
425
481
|
configurationVersion,
|
|
426
482
|
['PureCloud OAuth'],
|
|
427
483
|
['application/json'],
|
|
428
|
-
['application/json']
|
|
484
|
+
['application/json'],
|
|
485
|
+
opts['customHeaders']
|
|
429
486
|
);
|
|
430
487
|
}
|
|
431
488
|
|
|
@@ -433,8 +490,12 @@ class WebDeploymentsApi {
|
|
|
433
490
|
* Create a deployment
|
|
434
491
|
*
|
|
435
492
|
* @param {Object} deployment
|
|
493
|
+
* @param {Object} opts Optional parameters
|
|
494
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
436
495
|
*/
|
|
437
|
-
postWebdeploymentsDeployments(deployment) {
|
|
496
|
+
postWebdeploymentsDeployments(deployment, opts) {
|
|
497
|
+
opts = opts || {};
|
|
498
|
+
|
|
438
499
|
// verify the required parameter 'deployment' is set
|
|
439
500
|
if (deployment === undefined || deployment === null) {
|
|
440
501
|
throw 'Missing the required parameter "deployment" when calling postWebdeploymentsDeployments';
|
|
@@ -450,7 +511,8 @@ class WebDeploymentsApi {
|
|
|
450
511
|
deployment,
|
|
451
512
|
['PureCloud OAuth'],
|
|
452
513
|
['application/json'],
|
|
453
|
-
['application/json']
|
|
514
|
+
['application/json'],
|
|
515
|
+
opts['customHeaders']
|
|
454
516
|
);
|
|
455
517
|
}
|
|
456
518
|
|
|
@@ -458,8 +520,12 @@ class WebDeploymentsApi {
|
|
|
458
520
|
* Exchange an oAuth code (obtained using the Authorization Code Flow or Implicit flow) for a JWT that can be used by webdeployments.
|
|
459
521
|
*
|
|
460
522
|
* @param {Object} body webDeploymentsOAuthExchangeRequest
|
|
523
|
+
* @param {Object} opts Optional parameters
|
|
524
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
461
525
|
*/
|
|
462
|
-
postWebdeploymentsTokenOauthcodegrantjwtexchange(body) {
|
|
526
|
+
postWebdeploymentsTokenOauthcodegrantjwtexchange(body, opts) {
|
|
527
|
+
opts = opts || {};
|
|
528
|
+
|
|
463
529
|
// verify the required parameter 'body' is set
|
|
464
530
|
if (body === undefined || body === null) {
|
|
465
531
|
throw 'Missing the required parameter "body" when calling postWebdeploymentsTokenOauthcodegrantjwtexchange';
|
|
@@ -475,7 +541,8 @@ class WebDeploymentsApi {
|
|
|
475
541
|
body,
|
|
476
542
|
['PureCloud OAuth'],
|
|
477
543
|
['application/json'],
|
|
478
|
-
['application/json']
|
|
544
|
+
['application/json'],
|
|
545
|
+
opts['customHeaders']
|
|
479
546
|
);
|
|
480
547
|
}
|
|
481
548
|
|
|
@@ -484,6 +551,7 @@ class WebDeploymentsApi {
|
|
|
484
551
|
*
|
|
485
552
|
* @param {Object} opts Optional parameters
|
|
486
553
|
* @param {Object} opts.body
|
|
554
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
487
555
|
*/
|
|
488
556
|
postWebdeploymentsTokenRefresh(opts) {
|
|
489
557
|
opts = opts || {};
|
|
@@ -499,7 +567,8 @@ class WebDeploymentsApi {
|
|
|
499
567
|
opts['body'],
|
|
500
568
|
['PureCloud OAuth'],
|
|
501
569
|
['application/json'],
|
|
502
|
-
['application/json']
|
|
570
|
+
['application/json'],
|
|
571
|
+
opts['customHeaders']
|
|
503
572
|
);
|
|
504
573
|
}
|
|
505
574
|
|
|
@@ -508,8 +577,12 @@ class WebDeploymentsApi {
|
|
|
508
577
|
*
|
|
509
578
|
* @param {String} configurationId The configuration version ID
|
|
510
579
|
* @param {Object} configurationVersion
|
|
580
|
+
* @param {Object} opts Optional parameters
|
|
581
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
511
582
|
*/
|
|
512
|
-
putWebdeploymentsConfigurationVersionsDraft(configurationId, configurationVersion) {
|
|
583
|
+
putWebdeploymentsConfigurationVersionsDraft(configurationId, configurationVersion, opts) {
|
|
584
|
+
opts = opts || {};
|
|
585
|
+
|
|
513
586
|
// verify the required parameter 'configurationId' is set
|
|
514
587
|
if (configurationId === undefined || configurationId === null || configurationId === '') {
|
|
515
588
|
throw 'Missing the required parameter "configurationId" when calling putWebdeploymentsConfigurationVersionsDraft';
|
|
@@ -529,7 +602,8 @@ class WebDeploymentsApi {
|
|
|
529
602
|
configurationVersion,
|
|
530
603
|
['PureCloud OAuth'],
|
|
531
604
|
['application/json'],
|
|
532
|
-
['application/json']
|
|
605
|
+
['application/json'],
|
|
606
|
+
opts['customHeaders']
|
|
533
607
|
);
|
|
534
608
|
}
|
|
535
609
|
|
|
@@ -538,8 +612,12 @@ class WebDeploymentsApi {
|
|
|
538
612
|
*
|
|
539
613
|
* @param {String} deploymentId The deployment ID
|
|
540
614
|
* @param {Object} deployment
|
|
615
|
+
* @param {Object} opts Optional parameters
|
|
616
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
541
617
|
*/
|
|
542
|
-
putWebdeploymentsDeployment(deploymentId, deployment) {
|
|
618
|
+
putWebdeploymentsDeployment(deploymentId, deployment, opts) {
|
|
619
|
+
opts = opts || {};
|
|
620
|
+
|
|
543
621
|
// verify the required parameter 'deploymentId' is set
|
|
544
622
|
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
545
623
|
throw 'Missing the required parameter "deploymentId" when calling putWebdeploymentsDeployment';
|
|
@@ -559,7 +637,8 @@ class WebDeploymentsApi {
|
|
|
559
637
|
deployment,
|
|
560
638
|
['PureCloud OAuth'],
|
|
561
639
|
['application/json'],
|
|
562
|
-
['application/json']
|
|
640
|
+
['application/json'],
|
|
641
|
+
opts['customHeaders']
|
|
563
642
|
);
|
|
564
643
|
}
|
|
565
644
|
|
|
@@ -568,8 +647,12 @@ class WebDeploymentsApi {
|
|
|
568
647
|
*
|
|
569
648
|
* @param {String} deploymentId The deployment ID
|
|
570
649
|
* @param {Object} body
|
|
650
|
+
* @param {Object} opts Optional parameters
|
|
651
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
571
652
|
*/
|
|
572
|
-
putWebdeploymentsDeploymentIdentityresolution(deploymentId, body) {
|
|
653
|
+
putWebdeploymentsDeploymentIdentityresolution(deploymentId, body, opts) {
|
|
654
|
+
opts = opts || {};
|
|
655
|
+
|
|
573
656
|
// verify the required parameter 'deploymentId' is set
|
|
574
657
|
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
575
658
|
throw 'Missing the required parameter "deploymentId" when calling putWebdeploymentsDeploymentIdentityresolution';
|
|
@@ -589,7 +672,8 @@ class WebDeploymentsApi {
|
|
|
589
672
|
body,
|
|
590
673
|
['PureCloud OAuth'],
|
|
591
674
|
['application/json'],
|
|
592
|
-
['application/json']
|
|
675
|
+
['application/json'],
|
|
676
|
+
opts['customHeaders']
|
|
593
677
|
);
|
|
594
678
|
}
|
|
595
679
|
|
|
@@ -5,7 +5,7 @@ class WebMessagingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* WebMessaging service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 250.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -25,8 +25,12 @@ class WebMessagingApi {
|
|
|
25
25
|
*
|
|
26
26
|
* @param {String} deploymentId WebMessaging deployment id
|
|
27
27
|
* @param {String} tokenId Device token id or cookie id
|
|
28
|
+
* @param {Object} opts Optional parameters
|
|
29
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
28
30
|
*/
|
|
29
|
-
deleteWebmessagingDeploymentPushdevice(deploymentId, tokenId) {
|
|
31
|
+
deleteWebmessagingDeploymentPushdevice(deploymentId, tokenId, opts) {
|
|
32
|
+
opts = opts || {};
|
|
33
|
+
|
|
30
34
|
// verify the required parameter 'deploymentId' is set
|
|
31
35
|
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
32
36
|
throw 'Missing the required parameter "deploymentId" when calling deleteWebmessagingDeploymentPushdevice';
|
|
@@ -46,7 +50,8 @@ class WebMessagingApi {
|
|
|
46
50
|
null,
|
|
47
51
|
['PureCloud OAuth'],
|
|
48
52
|
['application/json'],
|
|
49
|
-
['application/json']
|
|
53
|
+
['application/json'],
|
|
54
|
+
opts['customHeaders']
|
|
50
55
|
);
|
|
51
56
|
}
|
|
52
57
|
|
|
@@ -56,6 +61,7 @@ class WebMessagingApi {
|
|
|
56
61
|
* @param {Object} opts Optional parameters
|
|
57
62
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
58
63
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
64
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
59
65
|
*/
|
|
60
66
|
getWebmessagingMessages(opts) {
|
|
61
67
|
opts = opts || {};
|
|
@@ -71,7 +77,8 @@ class WebMessagingApi {
|
|
|
71
77
|
null,
|
|
72
78
|
['PureCloud OAuth'],
|
|
73
79
|
['application/json'],
|
|
74
|
-
['application/json']
|
|
80
|
+
['application/json'],
|
|
81
|
+
opts['customHeaders']
|
|
75
82
|
);
|
|
76
83
|
}
|
|
77
84
|
|
|
@@ -81,8 +88,12 @@ class WebMessagingApi {
|
|
|
81
88
|
* @param {String} deploymentId WebMessaging deployment id
|
|
82
89
|
* @param {String} tokenId Device token id or cookie id
|
|
83
90
|
* @param {Object} body Request body
|
|
91
|
+
* @param {Object} opts Optional parameters
|
|
92
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
84
93
|
*/
|
|
85
|
-
patchWebmessagingDeploymentPushdevice(deploymentId, tokenId, body) {
|
|
94
|
+
patchWebmessagingDeploymentPushdevice(deploymentId, tokenId, body, opts) {
|
|
95
|
+
opts = opts || {};
|
|
96
|
+
|
|
86
97
|
// verify the required parameter 'deploymentId' is set
|
|
87
98
|
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
88
99
|
throw 'Missing the required parameter "deploymentId" when calling patchWebmessagingDeploymentPushdevice';
|
|
@@ -106,7 +117,8 @@ class WebMessagingApi {
|
|
|
106
117
|
body,
|
|
107
118
|
['PureCloud OAuth'],
|
|
108
119
|
['application/json'],
|
|
109
|
-
['application/json']
|
|
120
|
+
['application/json'],
|
|
121
|
+
opts['customHeaders']
|
|
110
122
|
);
|
|
111
123
|
}
|
|
112
124
|
|
|
@@ -116,8 +128,12 @@ class WebMessagingApi {
|
|
|
116
128
|
* @param {String} deploymentId WebMessaging deployment id
|
|
117
129
|
* @param {String} tokenId Device token id or cookie id
|
|
118
130
|
* @param {Object} body Request body
|
|
131
|
+
* @param {Object} opts Optional parameters
|
|
132
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
119
133
|
*/
|
|
120
|
-
postWebmessagingDeploymentPushdevice(deploymentId, tokenId, body) {
|
|
134
|
+
postWebmessagingDeploymentPushdevice(deploymentId, tokenId, body, opts) {
|
|
135
|
+
opts = opts || {};
|
|
136
|
+
|
|
121
137
|
// verify the required parameter 'deploymentId' is set
|
|
122
138
|
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
123
139
|
throw 'Missing the required parameter "deploymentId" when calling postWebmessagingDeploymentPushdevice';
|
|
@@ -141,7 +157,8 @@ class WebMessagingApi {
|
|
|
141
157
|
body,
|
|
142
158
|
['PureCloud OAuth'],
|
|
143
159
|
['application/json'],
|
|
144
|
-
['application/json']
|
|
160
|
+
['application/json'],
|
|
161
|
+
opts['customHeaders']
|
|
145
162
|
);
|
|
146
163
|
}
|
|
147
164
|
|
|
@@ -5,7 +5,7 @@ class WidgetsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Widgets service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 250.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,9 +24,13 @@ class WidgetsApi {
|
|
|
24
24
|
* Delete a Widget deployment
|
|
25
25
|
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
26
26
|
* @param {String} deploymentId Widget Config Id
|
|
27
|
+
* @param {Object} opts Optional parameters
|
|
28
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27
29
|
* @deprecated
|
|
28
30
|
*/
|
|
29
|
-
deleteWidgetsDeployment(deploymentId) {
|
|
31
|
+
deleteWidgetsDeployment(deploymentId, opts) {
|
|
32
|
+
opts = opts || {};
|
|
33
|
+
|
|
30
34
|
// verify the required parameter 'deploymentId' is set
|
|
31
35
|
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
32
36
|
throw 'Missing the required parameter "deploymentId" when calling deleteWidgetsDeployment';
|
|
@@ -42,7 +46,8 @@ class WidgetsApi {
|
|
|
42
46
|
null,
|
|
43
47
|
['PureCloud OAuth'],
|
|
44
48
|
['application/json'],
|
|
45
|
-
['application/json']
|
|
49
|
+
['application/json'],
|
|
50
|
+
opts['customHeaders']
|
|
46
51
|
);
|
|
47
52
|
}
|
|
48
53
|
|
|
@@ -50,9 +55,13 @@ class WidgetsApi {
|
|
|
50
55
|
* Get a Widget deployment
|
|
51
56
|
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
52
57
|
* @param {String} deploymentId Widget Config Id
|
|
58
|
+
* @param {Object} opts Optional parameters
|
|
59
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
53
60
|
* @deprecated
|
|
54
61
|
*/
|
|
55
|
-
getWidgetsDeployment(deploymentId) {
|
|
62
|
+
getWidgetsDeployment(deploymentId, opts) {
|
|
63
|
+
opts = opts || {};
|
|
64
|
+
|
|
56
65
|
// verify the required parameter 'deploymentId' is set
|
|
57
66
|
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
58
67
|
throw 'Missing the required parameter "deploymentId" when calling getWidgetsDeployment';
|
|
@@ -68,16 +77,21 @@ class WidgetsApi {
|
|
|
68
77
|
null,
|
|
69
78
|
['PureCloud OAuth'],
|
|
70
79
|
['application/json'],
|
|
71
|
-
['application/json']
|
|
80
|
+
['application/json'],
|
|
81
|
+
opts['customHeaders']
|
|
72
82
|
);
|
|
73
83
|
}
|
|
74
84
|
|
|
75
85
|
/**
|
|
76
86
|
* List Widget deployments
|
|
77
87
|
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
88
|
+
* @param {Object} opts Optional parameters
|
|
89
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
78
90
|
* @deprecated
|
|
79
91
|
*/
|
|
80
|
-
getWidgetsDeployments() {
|
|
92
|
+
getWidgetsDeployments(opts) {
|
|
93
|
+
opts = opts || {};
|
|
94
|
+
|
|
81
95
|
|
|
82
96
|
return this.apiClient.callApi(
|
|
83
97
|
'/api/v2/widgets/deployments',
|
|
@@ -89,7 +103,8 @@ class WidgetsApi {
|
|
|
89
103
|
null,
|
|
90
104
|
['PureCloud OAuth'],
|
|
91
105
|
['application/json'],
|
|
92
|
-
['application/json']
|
|
106
|
+
['application/json'],
|
|
107
|
+
opts['customHeaders']
|
|
93
108
|
);
|
|
94
109
|
}
|
|
95
110
|
|
|
@@ -97,9 +112,13 @@ class WidgetsApi {
|
|
|
97
112
|
* Create Widget deployment
|
|
98
113
|
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
99
114
|
* @param {Object} body Deployment
|
|
115
|
+
* @param {Object} opts Optional parameters
|
|
116
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
100
117
|
* @deprecated
|
|
101
118
|
*/
|
|
102
|
-
postWidgetsDeployments(body) {
|
|
119
|
+
postWidgetsDeployments(body, opts) {
|
|
120
|
+
opts = opts || {};
|
|
121
|
+
|
|
103
122
|
// verify the required parameter 'body' is set
|
|
104
123
|
if (body === undefined || body === null) {
|
|
105
124
|
throw 'Missing the required parameter "body" when calling postWidgetsDeployments';
|
|
@@ -115,7 +134,8 @@ class WidgetsApi {
|
|
|
115
134
|
body,
|
|
116
135
|
['PureCloud OAuth'],
|
|
117
136
|
['application/json'],
|
|
118
|
-
['application/json']
|
|
137
|
+
['application/json'],
|
|
138
|
+
opts['customHeaders']
|
|
119
139
|
);
|
|
120
140
|
}
|
|
121
141
|
|
|
@@ -124,9 +144,13 @@ class WidgetsApi {
|
|
|
124
144
|
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
125
145
|
* @param {String} deploymentId Widget Config Id
|
|
126
146
|
* @param {Object} body Deployment
|
|
147
|
+
* @param {Object} opts Optional parameters
|
|
148
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
127
149
|
* @deprecated
|
|
128
150
|
*/
|
|
129
|
-
putWidgetsDeployment(deploymentId, body) {
|
|
151
|
+
putWidgetsDeployment(deploymentId, body, opts) {
|
|
152
|
+
opts = opts || {};
|
|
153
|
+
|
|
130
154
|
// verify the required parameter 'deploymentId' is set
|
|
131
155
|
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
132
156
|
throw 'Missing the required parameter "deploymentId" when calling putWidgetsDeployment';
|
|
@@ -146,7 +170,8 @@ class WidgetsApi {
|
|
|
146
170
|
body,
|
|
147
171
|
['PureCloud OAuth'],
|
|
148
172
|
['application/json'],
|
|
149
|
-
['application/json']
|
|
173
|
+
['application/json'],
|
|
174
|
+
opts['customHeaders']
|
|
150
175
|
);
|
|
151
176
|
}
|
|
152
177
|
|