purecloud-platform-client-v2 233.0.0 → 235.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 +503 -1079
- package/dist/web-amd/purecloud-platform-client-v2.js +503 -1079
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +233 -409
- package/dist/web-cjs/purecloud-platform-client-v2.js +233 -409
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +475 -382
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +45 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +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 -30
- 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 +51 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +42 -8
- 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 +46 -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 +61 -880
- 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 +51 -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 +26 -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 -107
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +156 -1
- 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 -31
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +7 -3
- 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 +2 -2
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +3 -2
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/package.json
CHANGED
|
@@ -6,7 +6,7 @@ import { default as qs } from 'qs';
|
|
|
6
6
|
|
|
7
7
|
/**
|
|
8
8
|
* @module purecloud-platform-client-v2/ApiClient
|
|
9
|
-
* @version
|
|
9
|
+
* @version 235.0.0
|
|
10
10
|
*/
|
|
11
11
|
class ApiClient {
|
|
12
12
|
/**
|
|
@@ -209,6 +209,50 @@ class ApiClient {
|
|
|
209
209
|
this.config.setEnvironment(environment);
|
|
210
210
|
}
|
|
211
211
|
|
|
212
|
+
/**
|
|
213
|
+
* @description Sets the optional http headers used by the client
|
|
214
|
+
* @param {object} newHeaders - default headers to be used
|
|
215
|
+
*/
|
|
216
|
+
setDefaultHeaders(newHeaders) {
|
|
217
|
+
if (!newHeaders || !(typeof newHeaders === 'object')) {
|
|
218
|
+
throw new Error("default headers must be a map");
|
|
219
|
+
}
|
|
220
|
+
this.defaultHeaders = newHeaders;
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
/**
|
|
224
|
+
* @description Gets the default http headers used by the client
|
|
225
|
+
*/
|
|
226
|
+
getDefaultHeaders() {
|
|
227
|
+
return this.defaultHeaders;
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
/**
|
|
231
|
+
* @description Sets the optional Genesys-App http header used by the client
|
|
232
|
+
* @param {string} headerValue - value for the Genesys-App header
|
|
233
|
+
*/
|
|
234
|
+
setGenesysAppHeader(headerValue) {
|
|
235
|
+
if (!headerValue || !(typeof headerValue === 'string')) throw new Error("headerValue must be a non empty string");
|
|
236
|
+
if (!this.defaultHeaders) {
|
|
237
|
+
this.defaultHeaders = {
|
|
238
|
+
"Genesys-App": headerValue
|
|
239
|
+
};
|
|
240
|
+
} else {
|
|
241
|
+
this.defaultHeaders["Genesys-App"] = headerValue;
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
/**
|
|
246
|
+
* @description Gets the Genesys-App http header used by the client
|
|
247
|
+
*/
|
|
248
|
+
getGenesysAppHeader() {
|
|
249
|
+
if (this.defaultHeaders && this.defaultHeaders["Genesys-App"]) {
|
|
250
|
+
return this.defaultHeaders["Genesys-App"];
|
|
251
|
+
} else {
|
|
252
|
+
return null;
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
|
|
212
256
|
/**
|
|
213
257
|
* @description Sets the dynamic HttpClient used by the client
|
|
214
258
|
* @param {object} httpClient - HttpClient to be injected
|
|
@@ -5,7 +5,7 @@ class BusinessRulesApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* BusinessRules service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 235.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -26,7 +26,6 @@ class BusinessRulesApi {
|
|
|
26
26
|
* @param {String} tableId Table ID
|
|
27
27
|
* @param {Object} opts Optional parameters
|
|
28
28
|
* @param {Boolean} opts.forceDelete Force delete decision table (under certain conditions) (default to false)
|
|
29
|
-
* deleteBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30
29
|
*/
|
|
31
30
|
deleteBusinessrulesDecisiontable(tableId, opts) {
|
|
32
31
|
opts = opts || {};
|
|
@@ -55,7 +54,6 @@ class BusinessRulesApi {
|
|
|
55
54
|
*
|
|
56
55
|
* @param {String} tableId Table ID
|
|
57
56
|
* @param {Number} tableVersion Table Version
|
|
58
|
-
* deleteBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59
57
|
*/
|
|
60
58
|
deleteBusinessrulesDecisiontableVersion(tableId, tableVersion) {
|
|
61
59
|
// verify the required parameter 'tableId' is set
|
|
@@ -87,7 +85,6 @@ class BusinessRulesApi {
|
|
|
87
85
|
* @param {String} tableId Table ID
|
|
88
86
|
* @param {Number} tableVersion Table Version
|
|
89
87
|
* @param {String} rowId Row ID
|
|
90
|
-
* deleteBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
91
88
|
*/
|
|
92
89
|
deleteBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId) {
|
|
93
90
|
// verify the required parameter 'tableId' is set
|
|
@@ -121,7 +118,6 @@ class BusinessRulesApi {
|
|
|
121
118
|
* Delete a schema
|
|
122
119
|
*
|
|
123
120
|
* @param {String} schemaId Schema ID
|
|
124
|
-
* deleteBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
125
121
|
*/
|
|
126
122
|
deleteBusinessrulesSchema(schemaId) {
|
|
127
123
|
// verify the required parameter 'schemaId' is set
|
|
@@ -147,7 +143,6 @@ class BusinessRulesApi {
|
|
|
147
143
|
* Get a decision table
|
|
148
144
|
*
|
|
149
145
|
* @param {String} tableId Table ID
|
|
150
|
-
* getBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
151
146
|
*/
|
|
152
147
|
getBusinessrulesDecisiontable(tableId) {
|
|
153
148
|
// verify the required parameter 'tableId' is set
|
|
@@ -174,7 +169,6 @@ class BusinessRulesApi {
|
|
|
174
169
|
*
|
|
175
170
|
* @param {String} tableId Table ID
|
|
176
171
|
* @param {Number} tableVersion Table Version
|
|
177
|
-
* getBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
178
172
|
*/
|
|
179
173
|
getBusinessrulesDecisiontableVersion(tableId, tableVersion) {
|
|
180
174
|
// verify the required parameter 'tableId' is set
|
|
@@ -206,7 +200,6 @@ class BusinessRulesApi {
|
|
|
206
200
|
* @param {String} tableId Table ID
|
|
207
201
|
* @param {Number} tableVersion Table Version
|
|
208
202
|
* @param {String} rowId Row ID
|
|
209
|
-
* getBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
210
203
|
*/
|
|
211
204
|
getBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId) {
|
|
212
205
|
// verify the required parameter 'tableId' is set
|
|
@@ -244,7 +237,6 @@ class BusinessRulesApi {
|
|
|
244
237
|
* @param {Object} opts Optional parameters
|
|
245
238
|
* @param {String} opts.pageNumber Page number of the entities to return. Defaults to 1.
|
|
246
239
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. Defaults to 25.
|
|
247
|
-
* getBusinessrulesDecisiontableVersionRows is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
248
240
|
*/
|
|
249
241
|
getBusinessrulesDecisiontableVersionRows(tableId, tableVersion, opts) {
|
|
250
242
|
opts = opts || {};
|
|
@@ -279,7 +271,6 @@ class BusinessRulesApi {
|
|
|
279
271
|
* @param {Object} opts Optional parameters
|
|
280
272
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
281
273
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
282
|
-
* getBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
283
274
|
*/
|
|
284
275
|
getBusinessrulesDecisiontableVersions(tableId, opts) {
|
|
285
276
|
opts = opts || {};
|
|
@@ -311,7 +302,6 @@ class BusinessRulesApi {
|
|
|
311
302
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
312
303
|
* @param {Array.<String>} opts.divisionIds One or more comma separated divisions to filters decision tables by. If nothing is provided, the decision tables associated with the list of divisions that the user has access to will be returned.
|
|
313
304
|
* @param {String} opts.name Search for decision tables with a name that contains the given search string. Search is case insensitive and will match any table that contains this string in any part of the name.
|
|
314
|
-
* getBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
315
305
|
*/
|
|
316
306
|
getBusinessrulesDecisiontables(opts) {
|
|
317
307
|
opts = opts || {};
|
|
@@ -342,7 +332,6 @@ class BusinessRulesApi {
|
|
|
342
332
|
* @param {Boolean} opts.withPublishedVersion Filters results to only decision tables that have at least one version in Published status
|
|
343
333
|
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
344
334
|
* @param {Array.<String>} opts.ids Decision table IDs to search for
|
|
345
|
-
* getBusinessrulesDecisiontablesSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
346
335
|
*/
|
|
347
336
|
getBusinessrulesDecisiontablesSearch(opts) {
|
|
348
337
|
opts = opts || {};
|
|
@@ -366,7 +355,6 @@ class BusinessRulesApi {
|
|
|
366
355
|
* Get a schema
|
|
367
356
|
*
|
|
368
357
|
* @param {String} schemaId Schema ID
|
|
369
|
-
* getBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
370
358
|
*/
|
|
371
359
|
getBusinessrulesSchema(schemaId) {
|
|
372
360
|
// verify the required parameter 'schemaId' is set
|
|
@@ -391,7 +379,6 @@ class BusinessRulesApi {
|
|
|
391
379
|
/**
|
|
392
380
|
* Get a list of schemas.
|
|
393
381
|
*
|
|
394
|
-
* getBusinessrulesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
395
382
|
*/
|
|
396
383
|
getBusinessrulesSchemas() {
|
|
397
384
|
|
|
@@ -413,7 +400,6 @@ class BusinessRulesApi {
|
|
|
413
400
|
* Get a specific named core type.
|
|
414
401
|
*
|
|
415
402
|
* @param {String} coreTypeName The core type's name
|
|
416
|
-
* getBusinessrulesSchemasCoretype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
417
403
|
*/
|
|
418
404
|
getBusinessrulesSchemasCoretype(coreTypeName) {
|
|
419
405
|
// verify the required parameter 'coreTypeName' is set
|
|
@@ -438,7 +424,6 @@ class BusinessRulesApi {
|
|
|
438
424
|
/**
|
|
439
425
|
* Get the core types from which all schemas are built.
|
|
440
426
|
*
|
|
441
|
-
* getBusinessrulesSchemasCoretypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
442
427
|
*/
|
|
443
428
|
getBusinessrulesSchemasCoretypes() {
|
|
444
429
|
|
|
@@ -461,7 +446,6 @@ class BusinessRulesApi {
|
|
|
461
446
|
*
|
|
462
447
|
* @param {String} tableId Table ID
|
|
463
448
|
* @param {Object} body Decision Table
|
|
464
|
-
* patchBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
465
449
|
*/
|
|
466
450
|
patchBusinessrulesDecisiontable(tableId, body) {
|
|
467
451
|
// verify the required parameter 'tableId' is set
|
|
@@ -493,7 +477,6 @@ class BusinessRulesApi {
|
|
|
493
477
|
* @param {String} tableId Table ID
|
|
494
478
|
* @param {Number} tableVersion Table Version
|
|
495
479
|
* @param {Object} body Decision Table
|
|
496
|
-
* patchBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
497
480
|
*/
|
|
498
481
|
patchBusinessrulesDecisiontableVersion(tableId, tableVersion, body) {
|
|
499
482
|
// verify the required parameter 'tableId' is set
|
|
@@ -528,7 +511,6 @@ class BusinessRulesApi {
|
|
|
528
511
|
*
|
|
529
512
|
* @param {String} tableId Table ID
|
|
530
513
|
* @param {Object} body Decision Table
|
|
531
|
-
* postBusinessrulesDecisiontableExecute is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
532
514
|
*/
|
|
533
515
|
postBusinessrulesDecisiontableExecute(tableId, body) {
|
|
534
516
|
// verify the required parameter 'tableId' is set
|
|
@@ -560,7 +542,6 @@ class BusinessRulesApi {
|
|
|
560
542
|
* @param {String} tableId Table ID
|
|
561
543
|
* @param {Number} tableVersion Table Version
|
|
562
544
|
* @param {Object} body Decision Table
|
|
563
|
-
* postBusinessrulesDecisiontableVersionCopy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
564
545
|
*/
|
|
565
546
|
postBusinessrulesDecisiontableVersionCopy(tableId, tableVersion, body) {
|
|
566
547
|
// verify the required parameter 'tableId' is set
|
|
@@ -596,7 +577,6 @@ class BusinessRulesApi {
|
|
|
596
577
|
* @param {String} tableId Table ID
|
|
597
578
|
* @param {Number} tableVersion Table Version
|
|
598
579
|
* @param {Object} body Decision Table
|
|
599
|
-
* postBusinessrulesDecisiontableVersionExecute is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
600
580
|
*/
|
|
601
581
|
postBusinessrulesDecisiontableVersionExecute(tableId, tableVersion, body) {
|
|
602
582
|
// verify the required parameter 'tableId' is set
|
|
@@ -632,7 +612,6 @@ class BusinessRulesApi {
|
|
|
632
612
|
* @param {String} tableId Table ID
|
|
633
613
|
* @param {Number} tableVersion Table Version
|
|
634
614
|
* @param {Object} body Create decision table row request
|
|
635
|
-
* postBusinessrulesDecisiontableVersionRows is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
636
615
|
*/
|
|
637
616
|
postBusinessrulesDecisiontableVersionRows(tableId, tableVersion, body) {
|
|
638
617
|
// verify the required parameter 'tableId' is set
|
|
@@ -671,7 +650,6 @@ class BusinessRulesApi {
|
|
|
671
650
|
* @param {Object} opts Optional parameters
|
|
672
651
|
* @param {String} opts.pageNumber Page number of the entities to return. Defaults to 1.
|
|
673
652
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. Defaults to 25.
|
|
674
|
-
* postBusinessrulesDecisiontableVersionRowsSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
675
653
|
*/
|
|
676
654
|
postBusinessrulesDecisiontableVersionRowsSearch(tableId, tableVersion, body, opts) {
|
|
677
655
|
opts = opts || {};
|
|
@@ -708,7 +686,6 @@ class BusinessRulesApi {
|
|
|
708
686
|
*
|
|
709
687
|
* @param {String} tableId Table ID
|
|
710
688
|
* @param {Number} tableVersion Table Version
|
|
711
|
-
* postBusinessrulesDecisiontableVersionSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
712
689
|
*/
|
|
713
690
|
postBusinessrulesDecisiontableVersionSync(tableId, tableVersion) {
|
|
714
691
|
// verify the required parameter 'tableId' is set
|
|
@@ -738,7 +715,6 @@ class BusinessRulesApi {
|
|
|
738
715
|
* Create a new decision table version
|
|
739
716
|
*
|
|
740
717
|
* @param {String} tableId Table ID
|
|
741
|
-
* postBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
742
718
|
*/
|
|
743
719
|
postBusinessrulesDecisiontableVersions(tableId) {
|
|
744
720
|
// verify the required parameter 'tableId' is set
|
|
@@ -764,7 +740,6 @@ class BusinessRulesApi {
|
|
|
764
740
|
* Create a decision table
|
|
765
741
|
*
|
|
766
742
|
* @param {Object} body Decision Table
|
|
767
|
-
* postBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
768
743
|
*/
|
|
769
744
|
postBusinessrulesDecisiontables(body) {
|
|
770
745
|
// verify the required parameter 'body' is set
|
|
@@ -790,7 +765,6 @@ class BusinessRulesApi {
|
|
|
790
765
|
* Create a schema
|
|
791
766
|
*
|
|
792
767
|
* @param {Object} body Business Rules Schema Create Request
|
|
793
|
-
* postBusinessrulesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
794
768
|
*/
|
|
795
769
|
postBusinessrulesSchemas(body) {
|
|
796
770
|
// verify the required parameter 'body' is set
|
|
@@ -817,7 +791,6 @@ class BusinessRulesApi {
|
|
|
817
791
|
*
|
|
818
792
|
* @param {String} tableId Table ID
|
|
819
793
|
* @param {Number} tableVersion Table Version
|
|
820
|
-
* putBusinessrulesDecisiontableVersionPublish is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
821
794
|
*/
|
|
822
795
|
putBusinessrulesDecisiontableVersionPublish(tableId, tableVersion) {
|
|
823
796
|
// verify the required parameter 'tableId' is set
|
|
@@ -850,7 +823,6 @@ class BusinessRulesApi {
|
|
|
850
823
|
* @param {Number} tableVersion Table Version
|
|
851
824
|
* @param {String} rowId Row ID
|
|
852
825
|
* @param {Object} body Full update decision table row request
|
|
853
|
-
* putBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
854
826
|
*/
|
|
855
827
|
putBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId, body) {
|
|
856
828
|
// verify the required parameter 'tableId' is set
|
|
@@ -889,7 +861,6 @@ class BusinessRulesApi {
|
|
|
889
861
|
*
|
|
890
862
|
* @param {String} schemaId Schema ID
|
|
891
863
|
* @param {Object} body Business Rules Schema Update Request
|
|
892
|
-
* putBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
893
864
|
*/
|
|
894
865
|
putBusinessrulesSchema(schemaId, body) {
|
|
895
866
|
// verify the required parameter 'schemaId' is set
|
|
@@ -5,7 +5,7 @@ class CoachingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Coaching service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 235.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -316,6 +316,31 @@ class CoachingApi {
|
|
|
316
316
|
);
|
|
317
317
|
}
|
|
318
318
|
|
|
319
|
+
/**
|
|
320
|
+
* Retrieve the status of the job for the slots where a coaching appointment can be scheduled.
|
|
321
|
+
*
|
|
322
|
+
* @param {String} jobId The ID of job
|
|
323
|
+
*/
|
|
324
|
+
getCoachingScheduleslotsJob(jobId) {
|
|
325
|
+
// verify the required parameter 'jobId' is set
|
|
326
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
327
|
+
throw 'Missing the required parameter "jobId" when calling getCoachingScheduleslotsJob';
|
|
328
|
+
}
|
|
329
|
+
|
|
330
|
+
return this.apiClient.callApi(
|
|
331
|
+
'/api/v2/coaching/scheduleslots/jobs/{jobId}',
|
|
332
|
+
'GET',
|
|
333
|
+
{ 'jobId': jobId },
|
|
334
|
+
{ },
|
|
335
|
+
{ },
|
|
336
|
+
{ },
|
|
337
|
+
null,
|
|
338
|
+
['PureCloud OAuth'],
|
|
339
|
+
['application/json'],
|
|
340
|
+
['application/json']
|
|
341
|
+
);
|
|
342
|
+
}
|
|
343
|
+
|
|
319
344
|
/**
|
|
320
345
|
* Update an existing appointment
|
|
321
346
|
* Permission not required if you are the creator or facilitator of the appointment
|
|
@@ -551,6 +576,31 @@ class CoachingApi {
|
|
|
551
576
|
);
|
|
552
577
|
}
|
|
553
578
|
|
|
579
|
+
/**
|
|
580
|
+
* Start job to retrieve the slots where a coaching appointment can be scheduled.
|
|
581
|
+
*
|
|
582
|
+
* @param {Object} body The slots search request
|
|
583
|
+
*/
|
|
584
|
+
postCoachingScheduleslotsJobs(body) {
|
|
585
|
+
// verify the required parameter 'body' is set
|
|
586
|
+
if (body === undefined || body === null) {
|
|
587
|
+
throw 'Missing the required parameter "body" when calling postCoachingScheduleslotsJobs';
|
|
588
|
+
}
|
|
589
|
+
|
|
590
|
+
return this.apiClient.callApi(
|
|
591
|
+
'/api/v2/coaching/scheduleslots/jobs',
|
|
592
|
+
'POST',
|
|
593
|
+
{ },
|
|
594
|
+
{ },
|
|
595
|
+
{ },
|
|
596
|
+
{ },
|
|
597
|
+
body,
|
|
598
|
+
['PureCloud OAuth'],
|
|
599
|
+
['application/json'],
|
|
600
|
+
['application/json']
|
|
601
|
+
);
|
|
602
|
+
}
|
|
603
|
+
|
|
554
604
|
/**
|
|
555
605
|
* Get list of possible slots where a coaching appointment can be scheduled.
|
|
556
606
|
*
|
|
@@ -5,7 +5,7 @@ class ConversationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Conversations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 235.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -677,7 +677,6 @@ class ConversationsApi {
|
|
|
677
677
|
* @param {String} conversationId conversationId
|
|
678
678
|
* @param {String} communicationId communicationId
|
|
679
679
|
* @param {String} messageId messageId
|
|
680
|
-
* getConversationCommunicationInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
681
680
|
*/
|
|
682
681
|
getConversationCommunicationInternalmessage(conversationId, communicationId, messageId) {
|
|
683
682
|
// verify the required parameter 'conversationId' is set
|
|
@@ -715,7 +714,6 @@ class ConversationsApi {
|
|
|
715
714
|
* @param {Object} opts Optional parameters
|
|
716
715
|
* @param {Number} opts.pageSize Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 200. (default to 25)
|
|
717
716
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
718
|
-
* getConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
719
717
|
*/
|
|
720
718
|
getConversationCommunicationInternalmessages(conversationId, communicationId, opts) {
|
|
721
719
|
opts = opts || {};
|
|
@@ -1977,7 +1975,6 @@ class ConversationsApi {
|
|
|
1977
1975
|
* Get internal message conversation
|
|
1978
1976
|
*
|
|
1979
1977
|
* @param {String} conversationId conversationId
|
|
1980
|
-
* getConversationsInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1981
1978
|
*/
|
|
1982
1979
|
getConversationsInternalmessage(conversationId) {
|
|
1983
1980
|
// verify the required parameter 'conversationId' is set
|
|
@@ -2002,7 +1999,6 @@ class ConversationsApi {
|
|
|
2002
1999
|
/**
|
|
2003
2000
|
* Get active internal message conversations for the logged in user
|
|
2004
2001
|
*
|
|
2005
|
-
* getConversationsInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2006
2002
|
*/
|
|
2007
2003
|
getConversationsInternalmessages() {
|
|
2008
2004
|
|
|
@@ -3824,6 +3820,46 @@ class ConversationsApi {
|
|
|
3824
3820
|
);
|
|
3825
3821
|
}
|
|
3826
3822
|
|
|
3823
|
+
/**
|
|
3824
|
+
* Update conversation participant on behalf of a user
|
|
3825
|
+
*
|
|
3826
|
+
* @param {String} conversationId conversationId
|
|
3827
|
+
* @param {String} participantId participantId
|
|
3828
|
+
* @param {String} userId userId
|
|
3829
|
+
* @param {Object} body Participant request
|
|
3830
|
+
*/
|
|
3831
|
+
patchConversationsCallParticipantUserUserId(conversationId, participantId, userId, body) {
|
|
3832
|
+
// verify the required parameter 'conversationId' is set
|
|
3833
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
3834
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationsCallParticipantUserUserId';
|
|
3835
|
+
}
|
|
3836
|
+
// verify the required parameter 'participantId' is set
|
|
3837
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
3838
|
+
throw 'Missing the required parameter "participantId" when calling patchConversationsCallParticipantUserUserId';
|
|
3839
|
+
}
|
|
3840
|
+
// verify the required parameter 'userId' is set
|
|
3841
|
+
if (userId === undefined || userId === null || userId === '') {
|
|
3842
|
+
throw 'Missing the required parameter "userId" when calling patchConversationsCallParticipantUserUserId';
|
|
3843
|
+
}
|
|
3844
|
+
// verify the required parameter 'body' is set
|
|
3845
|
+
if (body === undefined || body === null) {
|
|
3846
|
+
throw 'Missing the required parameter "body" when calling patchConversationsCallParticipantUserUserId';
|
|
3847
|
+
}
|
|
3848
|
+
|
|
3849
|
+
return this.apiClient.callApi(
|
|
3850
|
+
'/api/v2/conversations/calls/{conversationId}/participants/{participantId}/user/{userId}',
|
|
3851
|
+
'PATCH',
|
|
3852
|
+
{ 'conversationId': conversationId,'participantId': participantId,'userId': userId },
|
|
3853
|
+
{ },
|
|
3854
|
+
{ },
|
|
3855
|
+
{ },
|
|
3856
|
+
body,
|
|
3857
|
+
['PureCloud OAuth'],
|
|
3858
|
+
['application/json'],
|
|
3859
|
+
['application/json']
|
|
3860
|
+
);
|
|
3861
|
+
}
|
|
3862
|
+
|
|
3827
3863
|
/**
|
|
3828
3864
|
* Update a conversation by disconnecting all of the participants
|
|
3829
3865
|
*
|
|
@@ -5161,7 +5197,6 @@ class ConversationsApi {
|
|
|
5161
5197
|
* @param {String} conversationId conversationId
|
|
5162
5198
|
* @param {String} communicationId communicationId
|
|
5163
5199
|
* @param {Object} body Message
|
|
5164
|
-
* postConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5165
5200
|
*/
|
|
5166
5201
|
postConversationCommunicationInternalmessages(conversationId, communicationId, body) {
|
|
5167
5202
|
// verify the required parameter 'conversationId' is set
|
|
@@ -5290,7 +5325,6 @@ class ConversationsApi {
|
|
|
5290
5325
|
* @param {String} conversationId conversation ID
|
|
5291
5326
|
* @param {String} participantId participant ID
|
|
5292
5327
|
* @param {Object} body Confer request
|
|
5293
|
-
* postConversationParticipantInternalmessagesUsersCommunications is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5294
5328
|
*/
|
|
5295
5329
|
postConversationParticipantInternalmessagesUsersCommunications(conversationId, participantId, body) {
|
|
5296
5330
|
// verify the required parameter 'conversationId' is set
|
|
@@ -7200,7 +7234,7 @@ class ConversationsApi {
|
|
|
7200
7234
|
|
|
7201
7235
|
/**
|
|
7202
7236
|
* Get messages in batch
|
|
7203
|
-
* The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]
|
|
7237
|
+
* The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]. The max messages you can request in the body is 1,000. Best practice is to limit to only the messages you need in each request, rather than request large batches by default.
|
|
7204
7238
|
* @param {String} conversationId
|
|
7205
7239
|
* @param {Object} opts Optional parameters
|
|
7206
7240
|
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|