purecloud-platform-client-v2 96.0.0 → 97.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +381 -62
- package/dist/web-amd/purecloud-platform-client-v2.js +381 -62
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +381 -62
- package/dist/web-cjs/purecloud-platform-client-v2.js +382 -62
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +378 -209
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- 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 +4 -2
- package/src/purecloud-platform-client-v2/api/BillingApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.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/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/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +131 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +4 -3
- 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/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.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/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/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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/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/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +187 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -1936,6 +1936,7 @@ function numberIsNaN (obj) {
|
|
|
1936
1936
|
|
|
1937
1937
|
}).call(this)}).call(this,require("buffer").Buffer)
|
|
1938
1938
|
},{"base64-js":2,"buffer":3,"ieee754":4}],4:[function(require,module,exports){
|
|
1939
|
+
/*! ieee754. BSD-3-Clause License. Feross Aboukhadijeh <https://feross.org/opensource> */
|
|
1939
1940
|
exports.read = function (buffer, offset, isLE, mLen, nBytes) {
|
|
1940
1941
|
var e, m
|
|
1941
1942
|
var eLen = (nBytes * 8) - mLen - 1
|
|
@@ -6053,7 +6054,7 @@ function isSlowBuffer (obj) {
|
|
|
6053
6054
|
|
|
6054
6055
|
/**
|
|
6055
6056
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6056
|
-
* @version
|
|
6057
|
+
* @version 97.0.0
|
|
6057
6058
|
*/
|
|
6058
6059
|
class ApiClient {
|
|
6059
6060
|
/**
|
|
@@ -6809,7 +6810,7 @@ class ApiClient {
|
|
|
6809
6810
|
|
|
6810
6811
|
// set header parameters
|
|
6811
6812
|
request.set(this.defaultHeaders).set(this.normalizeParams(headerParams));
|
|
6812
|
-
//request.set({ 'purecloud-sdk': '
|
|
6813
|
+
//request.set({ 'purecloud-sdk': '97.0.0' });
|
|
6813
6814
|
|
|
6814
6815
|
// set request timeout
|
|
6815
6816
|
request.timeout(this.timeout);
|
|
@@ -6934,7 +6935,7 @@ class AlertingApi {
|
|
|
6934
6935
|
/**
|
|
6935
6936
|
* Alerting service.
|
|
6936
6937
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6937
|
-
* @version
|
|
6938
|
+
* @version 97.0.0
|
|
6938
6939
|
*/
|
|
6939
6940
|
|
|
6940
6941
|
/**
|
|
@@ -7248,7 +7249,7 @@ class AnalyticsApi {
|
|
|
7248
7249
|
/**
|
|
7249
7250
|
* Analytics service.
|
|
7250
7251
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
7251
|
-
* @version
|
|
7252
|
+
* @version 97.0.0
|
|
7252
7253
|
*/
|
|
7253
7254
|
|
|
7254
7255
|
/**
|
|
@@ -8328,7 +8329,7 @@ class ArchitectApi {
|
|
|
8328
8329
|
/**
|
|
8329
8330
|
* Architect service.
|
|
8330
8331
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8331
|
-
* @version
|
|
8332
|
+
* @version 97.0.0
|
|
8332
8333
|
*/
|
|
8333
8334
|
|
|
8334
8335
|
/**
|
|
@@ -11166,7 +11167,7 @@ class AuditApi {
|
|
|
11166
11167
|
/**
|
|
11167
11168
|
* Audit service.
|
|
11168
11169
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
11169
|
-
* @version
|
|
11170
|
+
* @version 97.0.0
|
|
11170
11171
|
*/
|
|
11171
11172
|
|
|
11172
11173
|
/**
|
|
@@ -11337,7 +11338,7 @@ class AuthorizationApi {
|
|
|
11337
11338
|
/**
|
|
11338
11339
|
* Authorization service.
|
|
11339
11340
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
11340
|
-
* @version
|
|
11341
|
+
* @version 97.0.0
|
|
11341
11342
|
*/
|
|
11342
11343
|
|
|
11343
11344
|
/**
|
|
@@ -11672,6 +11673,8 @@ class AuthorizationApi {
|
|
|
11672
11673
|
* @param {Object} opts Optional parameters
|
|
11673
11674
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11674
11675
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11676
|
+
* @param {Object} opts.queryType Query filter type
|
|
11677
|
+
* @param {String} opts.query Comma-separated list of permissions or domains to query
|
|
11675
11678
|
*/
|
|
11676
11679
|
getAuthorizationPermissions(opts) {
|
|
11677
11680
|
opts = opts || {};
|
|
@@ -11681,7 +11684,7 @@ class AuthorizationApi {
|
|
|
11681
11684
|
'/api/v2/authorization/permissions',
|
|
11682
11685
|
'GET',
|
|
11683
11686
|
{ },
|
|
11684
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
11687
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'queryType': opts['queryType'],'query': opts['query'] },
|
|
11685
11688
|
{ },
|
|
11686
11689
|
{ },
|
|
11687
11690
|
null,
|
|
@@ -12454,7 +12457,7 @@ class BillingApi {
|
|
|
12454
12457
|
/**
|
|
12455
12458
|
* Billing service.
|
|
12456
12459
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12457
|
-
* @version
|
|
12460
|
+
* @version 97.0.0
|
|
12458
12461
|
*/
|
|
12459
12462
|
|
|
12460
12463
|
/**
|
|
@@ -12534,7 +12537,7 @@ class CoachingApi {
|
|
|
12534
12537
|
/**
|
|
12535
12538
|
* Coaching service.
|
|
12536
12539
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
12537
|
-
* @version
|
|
12540
|
+
* @version 97.0.0
|
|
12538
12541
|
*/
|
|
12539
12542
|
|
|
12540
12543
|
/**
|
|
@@ -13054,7 +13057,7 @@ class ContentManagementApi {
|
|
|
13054
13057
|
/**
|
|
13055
13058
|
* ContentManagement service.
|
|
13056
13059
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13057
|
-
* @version
|
|
13060
|
+
* @version 97.0.0
|
|
13058
13061
|
*/
|
|
13059
13062
|
|
|
13060
13063
|
/**
|
|
@@ -14194,7 +14197,7 @@ class ConversationsApi {
|
|
|
14194
14197
|
/**
|
|
14195
14198
|
* Conversations service.
|
|
14196
14199
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14197
|
-
* @version
|
|
14200
|
+
* @version 97.0.0
|
|
14198
14201
|
*/
|
|
14199
14202
|
|
|
14200
14203
|
/**
|
|
@@ -18252,7 +18255,7 @@ class DataExtensionsApi {
|
|
|
18252
18255
|
/**
|
|
18253
18256
|
* DataExtensions service.
|
|
18254
18257
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
18255
|
-
* @version
|
|
18258
|
+
* @version 97.0.0
|
|
18256
18259
|
*/
|
|
18257
18260
|
|
|
18258
18261
|
/**
|
|
@@ -18338,7 +18341,7 @@ class ExternalContactsApi {
|
|
|
18338
18341
|
/**
|
|
18339
18342
|
* ExternalContacts service.
|
|
18340
18343
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
18341
|
-
* @version
|
|
18344
|
+
* @version 97.0.0
|
|
18342
18345
|
*/
|
|
18343
18346
|
|
|
18344
18347
|
/**
|
|
@@ -19681,7 +19684,7 @@ class FaxApi {
|
|
|
19681
19684
|
/**
|
|
19682
19685
|
* Fax service.
|
|
19683
19686
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
19684
|
-
* @version
|
|
19687
|
+
* @version 97.0.0
|
|
19685
19688
|
*/
|
|
19686
19689
|
|
|
19687
19690
|
/**
|
|
@@ -19852,7 +19855,7 @@ class FlowsApi {
|
|
|
19852
19855
|
/**
|
|
19853
19856
|
* Flows service.
|
|
19854
19857
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
19855
|
-
* @version
|
|
19858
|
+
* @version 97.0.0
|
|
19856
19859
|
*/
|
|
19857
19860
|
|
|
19858
19861
|
/**
|
|
@@ -19923,7 +19926,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
19923
19926
|
/**
|
|
19924
19927
|
* GeneralDataProtectionRegulation service.
|
|
19925
19928
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
19926
|
-
* @version
|
|
19929
|
+
* @version 97.0.0
|
|
19927
19930
|
*/
|
|
19928
19931
|
|
|
19929
19932
|
/**
|
|
@@ -20053,7 +20056,7 @@ class GeolocationApi {
|
|
|
20053
20056
|
/**
|
|
20054
20057
|
* Geolocation service.
|
|
20055
20058
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
20056
|
-
* @version
|
|
20059
|
+
* @version 97.0.0
|
|
20057
20060
|
*/
|
|
20058
20061
|
|
|
20059
20062
|
/**
|
|
@@ -20184,7 +20187,7 @@ class GreetingsApi {
|
|
|
20184
20187
|
/**
|
|
20185
20188
|
* Greetings service.
|
|
20186
20189
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
20187
|
-
* @version
|
|
20190
|
+
* @version 97.0.0
|
|
20188
20191
|
*/
|
|
20189
20192
|
|
|
20190
20193
|
/**
|
|
@@ -20639,7 +20642,7 @@ class GroupsApi {
|
|
|
20639
20642
|
/**
|
|
20640
20643
|
* Groups service.
|
|
20641
20644
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
20642
|
-
* @version
|
|
20645
|
+
* @version 97.0.0
|
|
20643
20646
|
*/
|
|
20644
20647
|
|
|
20645
20648
|
/**
|
|
@@ -21044,7 +21047,7 @@ class IdentityProviderApi {
|
|
|
21044
21047
|
/**
|
|
21045
21048
|
* IdentityProvider service.
|
|
21046
21049
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
21047
|
-
* @version
|
|
21050
|
+
* @version 97.0.0
|
|
21048
21051
|
*/
|
|
21049
21052
|
|
|
21050
21053
|
/**
|
|
@@ -21800,7 +21803,7 @@ class IntegrationsApi {
|
|
|
21800
21803
|
/**
|
|
21801
21804
|
* Integrations service.
|
|
21802
21805
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
21803
|
-
* @version
|
|
21806
|
+
* @version 97.0.0
|
|
21804
21807
|
*/
|
|
21805
21808
|
|
|
21806
21809
|
/**
|
|
@@ -23292,7 +23295,7 @@ class JourneyApi {
|
|
|
23292
23295
|
/**
|
|
23293
23296
|
* Journey service.
|
|
23294
23297
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
23295
|
-
* @version
|
|
23298
|
+
* @version 97.0.0
|
|
23296
23299
|
*/
|
|
23297
23300
|
|
|
23298
23301
|
/**
|
|
@@ -23357,6 +23360,107 @@ class JourneyApi {
|
|
|
23357
23360
|
);
|
|
23358
23361
|
}
|
|
23359
23362
|
|
|
23363
|
+
/**
|
|
23364
|
+
* Retrieve segment assignments by customer ID.
|
|
23365
|
+
*
|
|
23366
|
+
* @param {String} customerIdType Type of ID used to identify customer (e.g. email, cookie, and phone).
|
|
23367
|
+
* @param {String} customerId Primary identifier of the customer to query for segment assignments.
|
|
23368
|
+
* @param {Object} opts Optional parameters
|
|
23369
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23370
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23371
|
+
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
23372
|
+
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
23373
|
+
*/
|
|
23374
|
+
getJourneyCustomerCustomerIdSegments(customerIdType, customerId, opts) {
|
|
23375
|
+
opts = opts || {};
|
|
23376
|
+
|
|
23377
|
+
// verify the required parameter 'customerIdType' is set
|
|
23378
|
+
if (customerIdType === undefined || customerIdType === null) {
|
|
23379
|
+
throw 'Missing the required parameter "customerIdType" when calling getJourneyCustomerCustomerIdSegments';
|
|
23380
|
+
}
|
|
23381
|
+
// verify the required parameter 'customerId' is set
|
|
23382
|
+
if (customerId === undefined || customerId === null) {
|
|
23383
|
+
throw 'Missing the required parameter "customerId" when calling getJourneyCustomerCustomerIdSegments';
|
|
23384
|
+
}
|
|
23385
|
+
|
|
23386
|
+
return this.apiClient.callApi(
|
|
23387
|
+
'/api/v2/journey/customers/{customerIdType}/{customerId}/segments',
|
|
23388
|
+
'GET',
|
|
23389
|
+
{ 'customerIdType': customerIdType,'customerId': customerId },
|
|
23390
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
23391
|
+
{ },
|
|
23392
|
+
{ },
|
|
23393
|
+
null,
|
|
23394
|
+
['PureCloud OAuth'],
|
|
23395
|
+
['application/json'],
|
|
23396
|
+
['application/json']
|
|
23397
|
+
);
|
|
23398
|
+
}
|
|
23399
|
+
|
|
23400
|
+
/**
|
|
23401
|
+
* Retrieve segment assignments by external contact ID.
|
|
23402
|
+
*
|
|
23403
|
+
* @param {String} externalContactId ID of the external contact to query for segment assignments.
|
|
23404
|
+
* @param {Object} opts Optional parameters
|
|
23405
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23406
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23407
|
+
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
23408
|
+
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
23409
|
+
*/
|
|
23410
|
+
getJourneyExternalcontactSegments(externalContactId, opts) {
|
|
23411
|
+
opts = opts || {};
|
|
23412
|
+
|
|
23413
|
+
// verify the required parameter 'externalContactId' is set
|
|
23414
|
+
if (externalContactId === undefined || externalContactId === null) {
|
|
23415
|
+
throw 'Missing the required parameter "externalContactId" when calling getJourneyExternalcontactSegments';
|
|
23416
|
+
}
|
|
23417
|
+
|
|
23418
|
+
return this.apiClient.callApi(
|
|
23419
|
+
'/api/v2/journey/externalcontacts/{externalContactId}/segments',
|
|
23420
|
+
'GET',
|
|
23421
|
+
{ 'externalContactId': externalContactId },
|
|
23422
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
23423
|
+
{ },
|
|
23424
|
+
{ },
|
|
23425
|
+
null,
|
|
23426
|
+
['PureCloud OAuth'],
|
|
23427
|
+
['application/json'],
|
|
23428
|
+
['application/json']
|
|
23429
|
+
);
|
|
23430
|
+
}
|
|
23431
|
+
|
|
23432
|
+
/**
|
|
23433
|
+
* Retrieve segment assignments by session ID.
|
|
23434
|
+
*
|
|
23435
|
+
* @param {String} sessionId ID of the session to query for segment assignments.
|
|
23436
|
+
* @param {Object} opts Optional parameters
|
|
23437
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23438
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23439
|
+
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
23440
|
+
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
23441
|
+
*/
|
|
23442
|
+
getJourneySessionSegments(sessionId, opts) {
|
|
23443
|
+
opts = opts || {};
|
|
23444
|
+
|
|
23445
|
+
// verify the required parameter 'sessionId' is set
|
|
23446
|
+
if (sessionId === undefined || sessionId === null) {
|
|
23447
|
+
throw 'Missing the required parameter "sessionId" when calling getJourneySessionSegments';
|
|
23448
|
+
}
|
|
23449
|
+
|
|
23450
|
+
return this.apiClient.callApi(
|
|
23451
|
+
'/api/v2/journey/sessions/{sessionId}/segments',
|
|
23452
|
+
'GET',
|
|
23453
|
+
{ 'sessionId': sessionId },
|
|
23454
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
23455
|
+
{ },
|
|
23456
|
+
{ },
|
|
23457
|
+
null,
|
|
23458
|
+
['PureCloud OAuth'],
|
|
23459
|
+
['application/json'],
|
|
23460
|
+
['application/json']
|
|
23461
|
+
);
|
|
23462
|
+
}
|
|
23463
|
+
|
|
23360
23464
|
/**
|
|
23361
23465
|
* Update a single action target.
|
|
23362
23466
|
*
|
|
@@ -23411,13 +23515,42 @@ class JourneyApi {
|
|
|
23411
23515
|
);
|
|
23412
23516
|
}
|
|
23413
23517
|
|
|
23518
|
+
/**
|
|
23519
|
+
* Assign/Unassign a segment to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment.
|
|
23520
|
+
*
|
|
23521
|
+
* @param {String} externalContactId ID of the external contact to query for segment assignments.
|
|
23522
|
+
* @param {Object} opts Optional parameters
|
|
23523
|
+
* @param {Array.<Object>} opts.body
|
|
23524
|
+
*/
|
|
23525
|
+
postJourneyExternalcontactSegments(externalContactId, opts) {
|
|
23526
|
+
opts = opts || {};
|
|
23527
|
+
|
|
23528
|
+
// verify the required parameter 'externalContactId' is set
|
|
23529
|
+
if (externalContactId === undefined || externalContactId === null) {
|
|
23530
|
+
throw 'Missing the required parameter "externalContactId" when calling postJourneyExternalcontactSegments';
|
|
23531
|
+
}
|
|
23532
|
+
|
|
23533
|
+
return this.apiClient.callApi(
|
|
23534
|
+
'/api/v2/journey/externalcontacts/{externalContactId}/segments',
|
|
23535
|
+
'POST',
|
|
23536
|
+
{ 'externalContactId': externalContactId },
|
|
23537
|
+
{ },
|
|
23538
|
+
{ },
|
|
23539
|
+
{ },
|
|
23540
|
+
opts['body'],
|
|
23541
|
+
['PureCloud OAuth'],
|
|
23542
|
+
['application/json'],
|
|
23543
|
+
['application/json']
|
|
23544
|
+
);
|
|
23545
|
+
}
|
|
23546
|
+
|
|
23414
23547
|
}
|
|
23415
23548
|
|
|
23416
23549
|
class KnowledgeApi {
|
|
23417
23550
|
/**
|
|
23418
23551
|
* Knowledge service.
|
|
23419
23552
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
23420
|
-
* @version
|
|
23553
|
+
* @version 97.0.0
|
|
23421
23554
|
*/
|
|
23422
23555
|
|
|
23423
23556
|
/**
|
|
@@ -23733,7 +23866,7 @@ class KnowledgeApi {
|
|
|
23733
23866
|
}
|
|
23734
23867
|
|
|
23735
23868
|
/**
|
|
23736
|
-
* Get
|
|
23869
|
+
* Get all trainings information for a knowledgebase
|
|
23737
23870
|
*
|
|
23738
23871
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23739
23872
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
@@ -23742,6 +23875,7 @@ class KnowledgeApi {
|
|
|
23742
23875
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23743
23876
|
* @param {String} opts.limit Number of entities to return. Maximum of 200.
|
|
23744
23877
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23878
|
+
* @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
|
|
23745
23879
|
*/
|
|
23746
23880
|
getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
|
|
23747
23881
|
opts = opts || {};
|
|
@@ -23759,7 +23893,7 @@ class KnowledgeApi {
|
|
|
23759
23893
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings',
|
|
23760
23894
|
'GET',
|
|
23761
23895
|
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
23762
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'] },
|
|
23896
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'knowledgeDocumentsState': opts['knowledgeDocumentsState'] },
|
|
23763
23897
|
{ },
|
|
23764
23898
|
{ },
|
|
23765
23899
|
null,
|
|
@@ -24137,7 +24271,7 @@ class LanguageUnderstandingApi {
|
|
|
24137
24271
|
/**
|
|
24138
24272
|
* LanguageUnderstanding service.
|
|
24139
24273
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
24140
|
-
* @version
|
|
24274
|
+
* @version 97.0.0
|
|
24141
24275
|
*/
|
|
24142
24276
|
|
|
24143
24277
|
/**
|
|
@@ -24703,7 +24837,7 @@ class LanguagesApi {
|
|
|
24703
24837
|
/**
|
|
24704
24838
|
* Languages service.
|
|
24705
24839
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
24706
|
-
* @version
|
|
24840
|
+
* @version 97.0.0
|
|
24707
24841
|
*/
|
|
24708
24842
|
|
|
24709
24843
|
/**
|
|
@@ -24971,7 +25105,7 @@ class LicenseApi {
|
|
|
24971
25105
|
/**
|
|
24972
25106
|
* License service.
|
|
24973
25107
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
24974
|
-
* @version
|
|
25108
|
+
* @version 97.0.0
|
|
24975
25109
|
*/
|
|
24976
25110
|
|
|
24977
25111
|
/**
|
|
@@ -25209,7 +25343,7 @@ class LocationsApi {
|
|
|
25209
25343
|
/**
|
|
25210
25344
|
* Locations service.
|
|
25211
25345
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
25212
|
-
* @version
|
|
25346
|
+
* @version 97.0.0
|
|
25213
25347
|
*/
|
|
25214
25348
|
|
|
25215
25349
|
/**
|
|
@@ -25445,7 +25579,7 @@ class MobileDevicesApi {
|
|
|
25445
25579
|
/**
|
|
25446
25580
|
* MobileDevices service.
|
|
25447
25581
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
25448
|
-
* @version
|
|
25582
|
+
* @version 97.0.0
|
|
25449
25583
|
*/
|
|
25450
25584
|
|
|
25451
25585
|
/**
|
|
@@ -25596,7 +25730,7 @@ class NotificationsApi {
|
|
|
25596
25730
|
/**
|
|
25597
25731
|
* Notifications service.
|
|
25598
25732
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
25599
|
-
* @version
|
|
25733
|
+
* @version 97.0.0
|
|
25600
25734
|
*/
|
|
25601
25735
|
|
|
25602
25736
|
/**
|
|
@@ -25795,7 +25929,7 @@ class OAuthApi {
|
|
|
25795
25929
|
/**
|
|
25796
25930
|
* OAuth service.
|
|
25797
25931
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
25798
|
-
* @version
|
|
25932
|
+
* @version 97.0.0
|
|
25799
25933
|
*/
|
|
25800
25934
|
|
|
25801
25935
|
/**
|
|
@@ -26153,7 +26287,7 @@ class ObjectsApi {
|
|
|
26153
26287
|
/**
|
|
26154
26288
|
* Objects service.
|
|
26155
26289
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
26156
|
-
* @version
|
|
26290
|
+
* @version 97.0.0
|
|
26157
26291
|
*/
|
|
26158
26292
|
|
|
26159
26293
|
/**
|
|
@@ -26394,7 +26528,7 @@ class OrganizationApi {
|
|
|
26394
26528
|
/**
|
|
26395
26529
|
* Organization service.
|
|
26396
26530
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
26397
|
-
* @version
|
|
26531
|
+
* @version 97.0.0
|
|
26398
26532
|
*/
|
|
26399
26533
|
|
|
26400
26534
|
/**
|
|
@@ -26649,7 +26783,7 @@ class OrganizationAuthorizationApi {
|
|
|
26649
26783
|
/**
|
|
26650
26784
|
* OrganizationAuthorization service.
|
|
26651
26785
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
26652
|
-
* @version
|
|
26786
|
+
* @version 97.0.0
|
|
26653
26787
|
*/
|
|
26654
26788
|
|
|
26655
26789
|
/**
|
|
@@ -27359,7 +27493,7 @@ class OutboundApi {
|
|
|
27359
27493
|
/**
|
|
27360
27494
|
* Outbound service.
|
|
27361
27495
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
27362
|
-
* @version
|
|
27496
|
+
* @version 97.0.0
|
|
27363
27497
|
*/
|
|
27364
27498
|
|
|
27365
27499
|
/**
|
|
@@ -30333,7 +30467,7 @@ class PresenceApi {
|
|
|
30333
30467
|
/**
|
|
30334
30468
|
* Presence service.
|
|
30335
30469
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
30336
|
-
* @version
|
|
30470
|
+
* @version 97.0.0
|
|
30337
30471
|
*/
|
|
30338
30472
|
|
|
30339
30473
|
/**
|
|
@@ -30680,7 +30814,7 @@ class QualityApi {
|
|
|
30680
30814
|
/**
|
|
30681
30815
|
* Quality service.
|
|
30682
30816
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
30683
|
-
* @version
|
|
30817
|
+
* @version 97.0.0
|
|
30684
30818
|
*/
|
|
30685
30819
|
|
|
30686
30820
|
/**
|
|
@@ -32377,7 +32511,7 @@ class RecordingApi {
|
|
|
32377
32511
|
/**
|
|
32378
32512
|
* Recording service.
|
|
32379
32513
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
32380
|
-
* @version
|
|
32514
|
+
* @version 97.0.0
|
|
32381
32515
|
*/
|
|
32382
32516
|
|
|
32383
32517
|
/**
|
|
@@ -33623,7 +33757,7 @@ class ResponseManagementApi {
|
|
|
33623
33757
|
/**
|
|
33624
33758
|
* ResponseManagement service.
|
|
33625
33759
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
33626
|
-
* @version
|
|
33760
|
+
* @version 97.0.0
|
|
33627
33761
|
*/
|
|
33628
33762
|
|
|
33629
33763
|
/**
|
|
@@ -33948,7 +34082,7 @@ class RoutingApi {
|
|
|
33948
34082
|
/**
|
|
33949
34083
|
* Routing service.
|
|
33950
34084
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
33951
|
-
* @version
|
|
34085
|
+
* @version 97.0.0
|
|
33952
34086
|
*/
|
|
33953
34087
|
|
|
33954
34088
|
/**
|
|
@@ -36246,7 +36380,7 @@ class SCIMApi {
|
|
|
36246
36380
|
/**
|
|
36247
36381
|
* SCIM service.
|
|
36248
36382
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
36249
|
-
* @version
|
|
36383
|
+
* @version 97.0.0
|
|
36250
36384
|
*/
|
|
36251
36385
|
|
|
36252
36386
|
/**
|
|
@@ -37231,7 +37365,7 @@ class ScriptsApi {
|
|
|
37231
37365
|
/**
|
|
37232
37366
|
* Scripts service.
|
|
37233
37367
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
37234
|
-
* @version
|
|
37368
|
+
* @version 97.0.0
|
|
37235
37369
|
*/
|
|
37236
37370
|
|
|
37237
37371
|
/**
|
|
@@ -37584,7 +37718,7 @@ class SearchApi {
|
|
|
37584
37718
|
/**
|
|
37585
37719
|
* Search service.
|
|
37586
37720
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
37587
|
-
* @version
|
|
37721
|
+
* @version 97.0.0
|
|
37588
37722
|
*/
|
|
37589
37723
|
|
|
37590
37724
|
/**
|
|
@@ -38094,7 +38228,7 @@ class SpeechTextAnalyticsApi {
|
|
|
38094
38228
|
/**
|
|
38095
38229
|
* SpeechTextAnalytics service.
|
|
38096
38230
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
38097
|
-
* @version
|
|
38231
|
+
* @version 97.0.0
|
|
38098
38232
|
*/
|
|
38099
38233
|
|
|
38100
38234
|
/**
|
|
@@ -38170,7 +38304,7 @@ class StationsApi {
|
|
|
38170
38304
|
/**
|
|
38171
38305
|
* Stations service.
|
|
38172
38306
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
38173
|
-
* @version
|
|
38307
|
+
* @version 97.0.0
|
|
38174
38308
|
*/
|
|
38175
38309
|
|
|
38176
38310
|
/**
|
|
@@ -38317,7 +38451,7 @@ class SuggestApi {
|
|
|
38317
38451
|
/**
|
|
38318
38452
|
* Suggest service.
|
|
38319
38453
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
38320
|
-
* @version
|
|
38454
|
+
* @version 97.0.0
|
|
38321
38455
|
*/
|
|
38322
38456
|
|
|
38323
38457
|
/**
|
|
@@ -38456,7 +38590,7 @@ class TelephonyApi {
|
|
|
38456
38590
|
/**
|
|
38457
38591
|
* Telephony service.
|
|
38458
38592
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
38459
|
-
* @version
|
|
38593
|
+
* @version 97.0.0
|
|
38460
38594
|
*/
|
|
38461
38595
|
|
|
38462
38596
|
/**
|
|
@@ -38564,7 +38698,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
38564
38698
|
/**
|
|
38565
38699
|
* TelephonyProvidersEdge service.
|
|
38566
38700
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
38567
|
-
* @version
|
|
38701
|
+
* @version 97.0.0
|
|
38568
38702
|
*/
|
|
38569
38703
|
|
|
38570
38704
|
/**
|
|
@@ -42141,7 +42275,7 @@ class TextbotsApi {
|
|
|
42141
42275
|
/**
|
|
42142
42276
|
* Textbots service.
|
|
42143
42277
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
42144
|
-
* @version
|
|
42278
|
+
* @version 97.0.0
|
|
42145
42279
|
*/
|
|
42146
42280
|
|
|
42147
42281
|
/**
|
|
@@ -42187,7 +42321,7 @@ class TokensApi {
|
|
|
42187
42321
|
/**
|
|
42188
42322
|
* Tokens service.
|
|
42189
42323
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
42190
|
-
* @version
|
|
42324
|
+
* @version 97.0.0
|
|
42191
42325
|
*/
|
|
42192
42326
|
|
|
42193
42327
|
/**
|
|
@@ -42273,7 +42407,7 @@ class UploadsApi {
|
|
|
42273
42407
|
/**
|
|
42274
42408
|
* Uploads service.
|
|
42275
42409
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
42276
|
-
* @version
|
|
42410
|
+
* @version 97.0.0
|
|
42277
42411
|
*/
|
|
42278
42412
|
|
|
42279
42413
|
/**
|
|
@@ -42319,7 +42453,7 @@ class UsageApi {
|
|
|
42319
42453
|
/**
|
|
42320
42454
|
* Usage service.
|
|
42321
42455
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
42322
|
-
* @version
|
|
42456
|
+
* @version 97.0.0
|
|
42323
42457
|
*/
|
|
42324
42458
|
|
|
42325
42459
|
/**
|
|
@@ -42390,7 +42524,7 @@ class UserRecordingsApi {
|
|
|
42390
42524
|
/**
|
|
42391
42525
|
* UserRecordings service.
|
|
42392
42526
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
42393
|
-
* @version
|
|
42527
|
+
* @version 97.0.0
|
|
42394
42528
|
*/
|
|
42395
42529
|
|
|
42396
42530
|
/**
|
|
@@ -42574,7 +42708,7 @@ class UsersApi {
|
|
|
42574
42708
|
/**
|
|
42575
42709
|
* Users service.
|
|
42576
42710
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
42577
|
-
* @version
|
|
42711
|
+
* @version 97.0.0
|
|
42578
42712
|
*/
|
|
42579
42713
|
|
|
42580
42714
|
/**
|
|
@@ -44787,7 +44921,7 @@ class UtilitiesApi {
|
|
|
44787
44921
|
/**
|
|
44788
44922
|
* Utilities service.
|
|
44789
44923
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
44790
|
-
* @version
|
|
44924
|
+
* @version 97.0.0
|
|
44791
44925
|
*/
|
|
44792
44926
|
|
|
44793
44927
|
/**
|
|
@@ -44898,7 +45032,7 @@ class VoicemailApi {
|
|
|
44898
45032
|
/**
|
|
44899
45033
|
* Voicemail service.
|
|
44900
45034
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
44901
|
-
* @version
|
|
45035
|
+
* @version 97.0.0
|
|
44902
45036
|
*/
|
|
44903
45037
|
|
|
44904
45038
|
/**
|
|
@@ -45535,7 +45669,7 @@ class WebChatApi {
|
|
|
45535
45669
|
/**
|
|
45536
45670
|
* WebChat service.
|
|
45537
45671
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
45538
|
-
* @version
|
|
45672
|
+
* @version 97.0.0
|
|
45539
45673
|
*/
|
|
45540
45674
|
|
|
45541
45675
|
/**
|
|
@@ -46079,7 +46213,7 @@ class WidgetsApi {
|
|
|
46079
46213
|
/**
|
|
46080
46214
|
* Widgets service.
|
|
46081
46215
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
46082
|
-
* @version
|
|
46216
|
+
* @version 97.0.0
|
|
46083
46217
|
*/
|
|
46084
46218
|
|
|
46085
46219
|
/**
|
|
@@ -46225,7 +46359,7 @@ class WorkforceManagementApi {
|
|
|
46225
46359
|
/**
|
|
46226
46360
|
* WorkforceManagement service.
|
|
46227
46361
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
46228
|
-
* @version
|
|
46362
|
+
* @version 97.0.0
|
|
46229
46363
|
*/
|
|
46230
46364
|
|
|
46231
46365
|
/**
|
|
@@ -46510,6 +46644,36 @@ class WorkforceManagementApi {
|
|
|
46510
46644
|
);
|
|
46511
46645
|
}
|
|
46512
46646
|
|
|
46647
|
+
/**
|
|
46648
|
+
* Delete a work plan rotation
|
|
46649
|
+
*
|
|
46650
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
46651
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to be deleted
|
|
46652
|
+
*/
|
|
46653
|
+
deleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
|
|
46654
|
+
// verify the required parameter 'managementUnitId' is set
|
|
46655
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
46656
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
|
|
46657
|
+
}
|
|
46658
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
46659
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
46660
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
|
|
46661
|
+
}
|
|
46662
|
+
|
|
46663
|
+
return this.apiClient.callApi(
|
|
46664
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
46665
|
+
'DELETE',
|
|
46666
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
46667
|
+
{ },
|
|
46668
|
+
{ },
|
|
46669
|
+
{ },
|
|
46670
|
+
null,
|
|
46671
|
+
['PureCloud OAuth'],
|
|
46672
|
+
['application/json'],
|
|
46673
|
+
['application/json']
|
|
46674
|
+
);
|
|
46675
|
+
}
|
|
46676
|
+
|
|
46513
46677
|
/**
|
|
46514
46678
|
* Get a list of UserScheduleAdherence records for the requested users
|
|
46515
46679
|
*
|
|
@@ -47716,6 +47880,65 @@ class WorkforceManagementApi {
|
|
|
47716
47880
|
);
|
|
47717
47881
|
}
|
|
47718
47882
|
|
|
47883
|
+
/**
|
|
47884
|
+
* Get a work plan rotation
|
|
47885
|
+
*
|
|
47886
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
47887
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to fetch
|
|
47888
|
+
*/
|
|
47889
|
+
getWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
|
|
47890
|
+
// verify the required parameter 'managementUnitId' is set
|
|
47891
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
47892
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
|
|
47893
|
+
}
|
|
47894
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
47895
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
47896
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
|
|
47897
|
+
}
|
|
47898
|
+
|
|
47899
|
+
return this.apiClient.callApi(
|
|
47900
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
47901
|
+
'GET',
|
|
47902
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
47903
|
+
{ },
|
|
47904
|
+
{ },
|
|
47905
|
+
{ },
|
|
47906
|
+
null,
|
|
47907
|
+
['PureCloud OAuth'],
|
|
47908
|
+
['application/json'],
|
|
47909
|
+
['application/json']
|
|
47910
|
+
);
|
|
47911
|
+
}
|
|
47912
|
+
|
|
47913
|
+
/**
|
|
47914
|
+
* Get work plan rotations
|
|
47915
|
+
*
|
|
47916
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
47917
|
+
* @param {Object} opts Optional parameters
|
|
47918
|
+
* @param {Array.<String>} opts.expand
|
|
47919
|
+
*/
|
|
47920
|
+
getWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
|
|
47921
|
+
opts = opts || {};
|
|
47922
|
+
|
|
47923
|
+
// verify the required parameter 'managementUnitId' is set
|
|
47924
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
47925
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotations';
|
|
47926
|
+
}
|
|
47927
|
+
|
|
47928
|
+
return this.apiClient.callApi(
|
|
47929
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
47930
|
+
'GET',
|
|
47931
|
+
{ 'managementUnitId': managementUnitId },
|
|
47932
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
47933
|
+
{ },
|
|
47934
|
+
{ },
|
|
47935
|
+
null,
|
|
47936
|
+
['PureCloud OAuth'],
|
|
47937
|
+
['application/json'],
|
|
47938
|
+
['application/json']
|
|
47939
|
+
);
|
|
47940
|
+
}
|
|
47941
|
+
|
|
47719
47942
|
/**
|
|
47720
47943
|
* Get work plans
|
|
47721
47944
|
*
|
|
@@ -48218,6 +48441,40 @@ class WorkforceManagementApi {
|
|
|
48218
48441
|
);
|
|
48219
48442
|
}
|
|
48220
48443
|
|
|
48444
|
+
/**
|
|
48445
|
+
* Update a work plan rotation
|
|
48446
|
+
*
|
|
48447
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
48448
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to update
|
|
48449
|
+
* @param {Object} opts Optional parameters
|
|
48450
|
+
* @param {Object} opts.body body
|
|
48451
|
+
*/
|
|
48452
|
+
patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId, opts) {
|
|
48453
|
+
opts = opts || {};
|
|
48454
|
+
|
|
48455
|
+
// verify the required parameter 'managementUnitId' is set
|
|
48456
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48457
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
48458
|
+
}
|
|
48459
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
48460
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
48461
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
48462
|
+
}
|
|
48463
|
+
|
|
48464
|
+
return this.apiClient.callApi(
|
|
48465
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
48466
|
+
'PATCH',
|
|
48467
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
48468
|
+
{ },
|
|
48469
|
+
{ },
|
|
48470
|
+
{ },
|
|
48471
|
+
opts['body'],
|
|
48472
|
+
['PureCloud OAuth'],
|
|
48473
|
+
['application/json'],
|
|
48474
|
+
['application/json']
|
|
48475
|
+
);
|
|
48476
|
+
}
|
|
48477
|
+
|
|
48221
48478
|
/**
|
|
48222
48479
|
* Update a time off request for the current user
|
|
48223
48480
|
*
|
|
@@ -49139,6 +49396,69 @@ class WorkforceManagementApi {
|
|
|
49139
49396
|
);
|
|
49140
49397
|
}
|
|
49141
49398
|
|
|
49399
|
+
/**
|
|
49400
|
+
* Create a copy of work plan rotation
|
|
49401
|
+
*
|
|
49402
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
49403
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to create a copy
|
|
49404
|
+
* @param {Object} opts Optional parameters
|
|
49405
|
+
* @param {Object} opts.body body
|
|
49406
|
+
*/
|
|
49407
|
+
postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, opts) {
|
|
49408
|
+
opts = opts || {};
|
|
49409
|
+
|
|
49410
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49411
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49412
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
49413
|
+
}
|
|
49414
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
49415
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
49416
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
49417
|
+
}
|
|
49418
|
+
|
|
49419
|
+
return this.apiClient.callApi(
|
|
49420
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy',
|
|
49421
|
+
'POST',
|
|
49422
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
49423
|
+
{ },
|
|
49424
|
+
{ },
|
|
49425
|
+
{ },
|
|
49426
|
+
opts['body'],
|
|
49427
|
+
['PureCloud OAuth'],
|
|
49428
|
+
['application/json'],
|
|
49429
|
+
['application/json']
|
|
49430
|
+
);
|
|
49431
|
+
}
|
|
49432
|
+
|
|
49433
|
+
/**
|
|
49434
|
+
* Create a new work plan rotation
|
|
49435
|
+
*
|
|
49436
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
49437
|
+
* @param {Object} opts Optional parameters
|
|
49438
|
+
* @param {Object} opts.body body
|
|
49439
|
+
*/
|
|
49440
|
+
postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
|
|
49441
|
+
opts = opts || {};
|
|
49442
|
+
|
|
49443
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49444
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49445
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';
|
|
49446
|
+
}
|
|
49447
|
+
|
|
49448
|
+
return this.apiClient.callApi(
|
|
49449
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
49450
|
+
'POST',
|
|
49451
|
+
{ 'managementUnitId': managementUnitId },
|
|
49452
|
+
{ },
|
|
49453
|
+
{ },
|
|
49454
|
+
{ },
|
|
49455
|
+
opts['body'],
|
|
49456
|
+
['PureCloud OAuth'],
|
|
49457
|
+
['application/json'],
|
|
49458
|
+
['application/json']
|
|
49459
|
+
);
|
|
49460
|
+
}
|
|
49461
|
+
|
|
49142
49462
|
/**
|
|
49143
49463
|
* Create a new work plan
|
|
49144
49464
|
*
|
|
@@ -49295,7 +49615,7 @@ class WorkforceManagementApi {
|
|
|
49295
49615
|
* </pre>
|
|
49296
49616
|
* </p>
|
|
49297
49617
|
* @module purecloud-platform-client-v2/index
|
|
49298
|
-
* @version
|
|
49618
|
+
* @version 97.0.0
|
|
49299
49619
|
*/
|
|
49300
49620
|
class platformClient {
|
|
49301
49621
|
constructor() {
|