purecloud-platform-client-v2 151.0.0 → 153.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 +712 -150
- package/dist/web-amd/purecloud-platform-client-v2.js +712 -150
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +712 -150
- package/dist/web-cjs/purecloud-platform-client-v2.js +712 -150
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +579 -212
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +30 -4
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +5 -4
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +46 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +16 -10
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -65
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +3 -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/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +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/ProcessAutomationApi.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 +226 -2
- 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/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +325 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -2279,7 +2279,7 @@ class Configuration {
|
|
|
2279
2279
|
|
|
2280
2280
|
/**
|
|
2281
2281
|
* @module purecloud-platform-client-v2/ApiClient
|
|
2282
|
-
* @version
|
|
2282
|
+
* @version 153.0.0
|
|
2283
2283
|
*/
|
|
2284
2284
|
class ApiClient {
|
|
2285
2285
|
/**
|
|
@@ -3351,7 +3351,7 @@ class AlertingApi {
|
|
|
3351
3351
|
/**
|
|
3352
3352
|
* Alerting service.
|
|
3353
3353
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3354
|
-
* @version
|
|
3354
|
+
* @version 153.0.0
|
|
3355
3355
|
*/
|
|
3356
3356
|
|
|
3357
3357
|
/**
|
|
@@ -3665,7 +3665,7 @@ class AnalyticsApi {
|
|
|
3665
3665
|
/**
|
|
3666
3666
|
* Analytics service.
|
|
3667
3667
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3668
|
-
* @version
|
|
3668
|
+
* @version 153.0.0
|
|
3669
3669
|
*/
|
|
3670
3670
|
|
|
3671
3671
|
/**
|
|
@@ -3681,7 +3681,7 @@ class AnalyticsApi {
|
|
|
3681
3681
|
|
|
3682
3682
|
|
|
3683
3683
|
/**
|
|
3684
|
-
* Delete/cancel an async
|
|
3684
|
+
* Delete/cancel an async details job
|
|
3685
3685
|
*
|
|
3686
3686
|
* @param {String} jobId jobId
|
|
3687
3687
|
*/
|
|
@@ -3764,6 +3764,7 @@ class AnalyticsApi {
|
|
|
3764
3764
|
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
3765
3765
|
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
3766
3766
|
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
|
|
3767
|
+
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
3767
3768
|
*/
|
|
3768
3769
|
getAnalyticsBotflowReportingturns(botFlowId, opts) {
|
|
3769
3770
|
opts = opts || {};
|
|
@@ -3777,7 +3778,7 @@ class AnalyticsApi {
|
|
|
3777
3778
|
'/api/v2/analytics/botflows/{botFlowId}/reportingturns',
|
|
3778
3779
|
'GET',
|
|
3779
3780
|
{ 'botFlowId': botFlowId },
|
|
3780
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'] },
|
|
3781
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'] },
|
|
3781
3782
|
{ },
|
|
3782
3783
|
{ },
|
|
3783
3784
|
null,
|
|
@@ -3862,7 +3863,7 @@ class AnalyticsApi {
|
|
|
3862
3863
|
}
|
|
3863
3864
|
|
|
3864
3865
|
/**
|
|
3865
|
-
* Fetch a page of results for an async
|
|
3866
|
+
* Fetch a page of results for an async details job
|
|
3866
3867
|
*
|
|
3867
3868
|
* @param {String} jobId jobId
|
|
3868
3869
|
* @param {Object} opts Optional parameters
|
|
@@ -4326,6 +4327,31 @@ class AnalyticsApi {
|
|
|
4326
4327
|
);
|
|
4327
4328
|
}
|
|
4328
4329
|
|
|
4330
|
+
/**
|
|
4331
|
+
* Query for action aggregates
|
|
4332
|
+
*
|
|
4333
|
+
* @param {Object} body query
|
|
4334
|
+
*/
|
|
4335
|
+
postAnalyticsActionsAggregatesQuery(body) {
|
|
4336
|
+
// verify the required parameter 'body' is set
|
|
4337
|
+
if (body === undefined || body === null) {
|
|
4338
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesQuery';
|
|
4339
|
+
}
|
|
4340
|
+
|
|
4341
|
+
return this.apiClient.callApi(
|
|
4342
|
+
'/api/v2/analytics/actions/aggregates/query',
|
|
4343
|
+
'POST',
|
|
4344
|
+
{ },
|
|
4345
|
+
{ },
|
|
4346
|
+
{ },
|
|
4347
|
+
{ },
|
|
4348
|
+
body,
|
|
4349
|
+
['PureCloud OAuth'],
|
|
4350
|
+
['application/json'],
|
|
4351
|
+
['application/json']
|
|
4352
|
+
);
|
|
4353
|
+
}
|
|
4354
|
+
|
|
4329
4355
|
/**
|
|
4330
4356
|
* Query for bot aggregates
|
|
4331
4357
|
*
|
|
@@ -4892,7 +4918,7 @@ class ArchitectApi {
|
|
|
4892
4918
|
/**
|
|
4893
4919
|
* Architect service.
|
|
4894
4920
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4895
|
-
* @version
|
|
4921
|
+
* @version 153.0.0
|
|
4896
4922
|
*/
|
|
4897
4923
|
|
|
4898
4924
|
/**
|
|
@@ -6485,6 +6511,7 @@ class ArchitectApi {
|
|
|
6485
6511
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
6486
6512
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
6487
6513
|
* @param {Boolean} opts.showbrief If true returns just the key value of the row (default to true)
|
|
6514
|
+
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
6488
6515
|
*/
|
|
6489
6516
|
getFlowsDatatableRows(datatableId, opts) {
|
|
6490
6517
|
opts = opts || {};
|
|
@@ -6498,7 +6525,7 @@ class ArchitectApi {
|
|
|
6498
6525
|
'/api/v2/flows/datatables/{datatableId}/rows',
|
|
6499
6526
|
'GET',
|
|
6500
6527
|
{ 'datatableId': datatableId },
|
|
6501
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'showbrief': opts['showbrief'] },
|
|
6528
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'showbrief': opts['showbrief'],'sortOrder': opts['sortOrder'] },
|
|
6502
6529
|
{ },
|
|
6503
6530
|
{ },
|
|
6504
6531
|
null,
|
|
@@ -6518,7 +6545,7 @@ class ArchitectApi {
|
|
|
6518
6545
|
* @param {Object} opts.sortBy Sort by (default to id)
|
|
6519
6546
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
6520
6547
|
* @param {Array.<String>} opts.divisionId division ID(s)
|
|
6521
|
-
* @param {String} opts.name Name
|
|
6548
|
+
* @param {String} opts.name Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.
|
|
6522
6549
|
*/
|
|
6523
6550
|
getFlowsDatatables(opts) {
|
|
6524
6551
|
opts = opts || {};
|
|
@@ -6577,7 +6604,7 @@ class ArchitectApi {
|
|
|
6577
6604
|
* @param {Object} opts.sortBy Sort by (default to id)
|
|
6578
6605
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
6579
6606
|
* @param {Array.<String>} opts.divisionId division ID(s)
|
|
6580
|
-
* @param {String} opts.name Name
|
|
6607
|
+
* @param {String} opts.name Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.
|
|
6581
6608
|
*/
|
|
6582
6609
|
getFlowsDatatablesDivisionviews(opts) {
|
|
6583
6610
|
opts = opts || {};
|
|
@@ -7938,7 +7965,7 @@ class AuditApi {
|
|
|
7938
7965
|
/**
|
|
7939
7966
|
* Audit service.
|
|
7940
7967
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7941
|
-
* @version
|
|
7968
|
+
* @version 153.0.0
|
|
7942
7969
|
*/
|
|
7943
7970
|
|
|
7944
7971
|
/**
|
|
@@ -8109,7 +8136,7 @@ class AuthorizationApi {
|
|
|
8109
8136
|
/**
|
|
8110
8137
|
* Authorization service.
|
|
8111
8138
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8112
|
-
* @version
|
|
8139
|
+
* @version 153.0.0
|
|
8113
8140
|
*/
|
|
8114
8141
|
|
|
8115
8142
|
/**
|
|
@@ -8642,6 +8669,26 @@ class AuthorizationApi {
|
|
|
8642
8669
|
);
|
|
8643
8670
|
}
|
|
8644
8671
|
|
|
8672
|
+
/**
|
|
8673
|
+
* Get authorization settings
|
|
8674
|
+
*
|
|
8675
|
+
*/
|
|
8676
|
+
getAuthorizationSettings() {
|
|
8677
|
+
|
|
8678
|
+
return this.apiClient.callApi(
|
|
8679
|
+
'/api/v2/authorization/settings',
|
|
8680
|
+
'GET',
|
|
8681
|
+
{ },
|
|
8682
|
+
{ },
|
|
8683
|
+
{ },
|
|
8684
|
+
{ },
|
|
8685
|
+
null,
|
|
8686
|
+
['PureCloud OAuth'],
|
|
8687
|
+
['application/json'],
|
|
8688
|
+
['application/json']
|
|
8689
|
+
);
|
|
8690
|
+
}
|
|
8691
|
+
|
|
8645
8692
|
/**
|
|
8646
8693
|
* Returns a listing of roles and permissions for a user.
|
|
8647
8694
|
*
|
|
@@ -8766,6 +8813,31 @@ class AuthorizationApi {
|
|
|
8766
8813
|
);
|
|
8767
8814
|
}
|
|
8768
8815
|
|
|
8816
|
+
/**
|
|
8817
|
+
* Change authorization settings
|
|
8818
|
+
* Change authorization settings
|
|
8819
|
+
* @param {Object} body Authorization Settings
|
|
8820
|
+
*/
|
|
8821
|
+
patchAuthorizationSettings(body) {
|
|
8822
|
+
// verify the required parameter 'body' is set
|
|
8823
|
+
if (body === undefined || body === null) {
|
|
8824
|
+
throw 'Missing the required parameter "body" when calling patchAuthorizationSettings';
|
|
8825
|
+
}
|
|
8826
|
+
|
|
8827
|
+
return this.apiClient.callApi(
|
|
8828
|
+
'/api/v2/authorization/settings',
|
|
8829
|
+
'PATCH',
|
|
8830
|
+
{ },
|
|
8831
|
+
{ },
|
|
8832
|
+
{ },
|
|
8833
|
+
{ },
|
|
8834
|
+
body,
|
|
8835
|
+
['PureCloud OAuth'],
|
|
8836
|
+
['application/json'],
|
|
8837
|
+
['application/json']
|
|
8838
|
+
);
|
|
8839
|
+
}
|
|
8840
|
+
|
|
8769
8841
|
/**
|
|
8770
8842
|
* Assign a list of objects to a division
|
|
8771
8843
|
* Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. ["206ce31f-61ec-40ed-a8b1-be6f06303998","250a754e-f5e4-4f51-800f-a92f09d3bf8c"]
|
|
@@ -9292,7 +9364,7 @@ class BillingApi {
|
|
|
9292
9364
|
/**
|
|
9293
9365
|
* Billing service.
|
|
9294
9366
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9295
|
-
* @version
|
|
9367
|
+
* @version 153.0.0
|
|
9296
9368
|
*/
|
|
9297
9369
|
|
|
9298
9370
|
/**
|
|
@@ -9372,7 +9444,7 @@ class ChatApi {
|
|
|
9372
9444
|
/**
|
|
9373
9445
|
* Chat service.
|
|
9374
9446
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9375
|
-
* @version
|
|
9447
|
+
* @version 153.0.0
|
|
9376
9448
|
*/
|
|
9377
9449
|
|
|
9378
9450
|
/**
|
|
@@ -9463,7 +9535,7 @@ class CoachingApi {
|
|
|
9463
9535
|
/**
|
|
9464
9536
|
* Coaching service.
|
|
9465
9537
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9466
|
-
* @version
|
|
9538
|
+
* @version 153.0.0
|
|
9467
9539
|
*/
|
|
9468
9540
|
|
|
9469
9541
|
/**
|
|
@@ -10040,7 +10112,7 @@ class ContentManagementApi {
|
|
|
10040
10112
|
/**
|
|
10041
10113
|
* ContentManagement service.
|
|
10042
10114
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
10043
|
-
* @version
|
|
10115
|
+
* @version 153.0.0
|
|
10044
10116
|
*/
|
|
10045
10117
|
|
|
10046
10118
|
/**
|
|
@@ -11180,7 +11252,7 @@ class ConversationsApi {
|
|
|
11180
11252
|
/**
|
|
11181
11253
|
* Conversations service.
|
|
11182
11254
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11183
|
-
* @version
|
|
11255
|
+
* @version 153.0.0
|
|
11184
11256
|
*/
|
|
11185
11257
|
|
|
11186
11258
|
/**
|
|
@@ -11196,7 +11268,7 @@ class ConversationsApi {
|
|
|
11196
11268
|
|
|
11197
11269
|
|
|
11198
11270
|
/**
|
|
11199
|
-
* Delete/cancel an async
|
|
11271
|
+
* Delete/cancel an async details job
|
|
11200
11272
|
*
|
|
11201
11273
|
* @param {String} jobId jobId
|
|
11202
11274
|
*/
|
|
@@ -11570,7 +11642,7 @@ class ConversationsApi {
|
|
|
11570
11642
|
}
|
|
11571
11643
|
|
|
11572
11644
|
/**
|
|
11573
|
-
* Fetch a page of results for an async
|
|
11645
|
+
* Fetch a page of results for an async details job
|
|
11574
11646
|
*
|
|
11575
11647
|
* @param {String} jobId jobId
|
|
11576
11648
|
* @param {Object} opts Optional parameters
|
|
@@ -12859,8 +12931,9 @@ class ConversationsApi {
|
|
|
12859
12931
|
* @param {Object} opts Optional parameters
|
|
12860
12932
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
12861
12933
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
12862
|
-
* @param {
|
|
12934
|
+
* @param {Array.<String>} opts.expand Expand instructions for the return value.
|
|
12863
12935
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
12936
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
12864
12937
|
*/
|
|
12865
12938
|
getConversationsMessagingIntegrations(opts) {
|
|
12866
12939
|
opts = opts || {};
|
|
@@ -12870,7 +12943,7 @@ class ConversationsApi {
|
|
|
12870
12943
|
'/api/v2/conversations/messaging/integrations',
|
|
12871
12944
|
'GET',
|
|
12872
12945
|
{ },
|
|
12873
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
12946
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
12874
12947
|
{ },
|
|
12875
12948
|
{ },
|
|
12876
12949
|
null,
|
|
@@ -12888,6 +12961,7 @@ class ConversationsApi {
|
|
|
12888
12961
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
12889
12962
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
12890
12963
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
12964
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
12891
12965
|
*/
|
|
12892
12966
|
getConversationsMessagingIntegrationsFacebook(opts) {
|
|
12893
12967
|
opts = opts || {};
|
|
@@ -12897,7 +12971,7 @@ class ConversationsApi {
|
|
|
12897
12971
|
'/api/v2/conversations/messaging/integrations/facebook',
|
|
12898
12972
|
'GET',
|
|
12899
12973
|
{ },
|
|
12900
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
12974
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
12901
12975
|
{ },
|
|
12902
12976
|
{ },
|
|
12903
12977
|
null,
|
|
@@ -12944,6 +13018,7 @@ class ConversationsApi {
|
|
|
12944
13018
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
12945
13019
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
12946
13020
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
13021
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
12947
13022
|
*/
|
|
12948
13023
|
getConversationsMessagingIntegrationsLine(opts) {
|
|
12949
13024
|
opts = opts || {};
|
|
@@ -12953,7 +13028,7 @@ class ConversationsApi {
|
|
|
12953
13028
|
'/api/v2/conversations/messaging/integrations/line',
|
|
12954
13029
|
'GET',
|
|
12955
13030
|
{ },
|
|
12956
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
13031
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
12957
13032
|
{ },
|
|
12958
13033
|
{ },
|
|
12959
13034
|
null,
|
|
@@ -13000,6 +13075,7 @@ class ConversationsApi {
|
|
|
13000
13075
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13001
13076
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
13002
13077
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
13078
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
13003
13079
|
*/
|
|
13004
13080
|
getConversationsMessagingIntegrationsOpen(opts) {
|
|
13005
13081
|
opts = opts || {};
|
|
@@ -13009,7 +13085,7 @@ class ConversationsApi {
|
|
|
13009
13085
|
'/api/v2/conversations/messaging/integrations/open',
|
|
13010
13086
|
'GET',
|
|
13011
13087
|
{ },
|
|
13012
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
13088
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
13013
13089
|
{ },
|
|
13014
13090
|
{ },
|
|
13015
13091
|
null,
|
|
@@ -13056,6 +13132,7 @@ class ConversationsApi {
|
|
|
13056
13132
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13057
13133
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
13058
13134
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
13135
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
13059
13136
|
*/
|
|
13060
13137
|
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
13061
13138
|
opts = opts || {};
|
|
@@ -13065,7 +13142,7 @@ class ConversationsApi {
|
|
|
13065
13142
|
'/api/v2/conversations/messaging/integrations/twitter',
|
|
13066
13143
|
'GET',
|
|
13067
13144
|
{ },
|
|
13068
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
13145
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
13069
13146
|
{ },
|
|
13070
13147
|
{ },
|
|
13071
13148
|
null,
|
|
@@ -13112,6 +13189,7 @@ class ConversationsApi {
|
|
|
13112
13189
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13113
13190
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
13114
13191
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
13192
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
13115
13193
|
*/
|
|
13116
13194
|
getConversationsMessagingIntegrationsWhatsapp(opts) {
|
|
13117
13195
|
opts = opts || {};
|
|
@@ -13121,7 +13199,7 @@ class ConversationsApi {
|
|
|
13121
13199
|
'/api/v2/conversations/messaging/integrations/whatsapp',
|
|
13122
13200
|
'GET',
|
|
13123
13201
|
{ },
|
|
13124
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
13202
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
13125
13203
|
{ },
|
|
13126
13204
|
{ },
|
|
13127
13205
|
null,
|
|
@@ -16397,7 +16475,7 @@ class DataExtensionsApi {
|
|
|
16397
16475
|
/**
|
|
16398
16476
|
* DataExtensions service.
|
|
16399
16477
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
16400
|
-
* @version
|
|
16478
|
+
* @version 153.0.0
|
|
16401
16479
|
*/
|
|
16402
16480
|
|
|
16403
16481
|
/**
|
|
@@ -16483,7 +16561,7 @@ class DownloadsApi {
|
|
|
16483
16561
|
/**
|
|
16484
16562
|
* Downloads service.
|
|
16485
16563
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
16486
|
-
* @version
|
|
16564
|
+
* @version 153.0.0
|
|
16487
16565
|
*/
|
|
16488
16566
|
|
|
16489
16567
|
/**
|
|
@@ -16535,7 +16613,7 @@ class EventsApi {
|
|
|
16535
16613
|
/**
|
|
16536
16614
|
* Events service.
|
|
16537
16615
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
16538
|
-
* @version
|
|
16616
|
+
* @version 153.0.0
|
|
16539
16617
|
*/
|
|
16540
16618
|
|
|
16541
16619
|
/**
|
|
@@ -16631,7 +16709,7 @@ class ExternalContactsApi {
|
|
|
16631
16709
|
/**
|
|
16632
16710
|
* ExternalContacts service.
|
|
16633
16711
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
16634
|
-
* @version
|
|
16712
|
+
* @version 153.0.0
|
|
16635
16713
|
*/
|
|
16636
16714
|
|
|
16637
16715
|
/**
|
|
@@ -18589,7 +18667,7 @@ class FaxApi {
|
|
|
18589
18667
|
/**
|
|
18590
18668
|
* Fax service.
|
|
18591
18669
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
18592
|
-
* @version
|
|
18670
|
+
* @version 153.0.0
|
|
18593
18671
|
*/
|
|
18594
18672
|
|
|
18595
18673
|
/**
|
|
@@ -18760,7 +18838,7 @@ class FlowsApi {
|
|
|
18760
18838
|
/**
|
|
18761
18839
|
* Flows service.
|
|
18762
18840
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
18763
|
-
* @version
|
|
18841
|
+
* @version 153.0.0
|
|
18764
18842
|
*/
|
|
18765
18843
|
|
|
18766
18844
|
/**
|
|
@@ -18831,7 +18909,7 @@ class GamificationApi {
|
|
|
18831
18909
|
/**
|
|
18832
18910
|
* Gamification service.
|
|
18833
18911
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
18834
|
-
* @version
|
|
18912
|
+
* @version 153.0.0
|
|
18835
18913
|
*/
|
|
18836
18914
|
|
|
18837
18915
|
/**
|
|
@@ -19049,36 +19127,6 @@ class GamificationApi {
|
|
|
19049
19127
|
);
|
|
19050
19128
|
}
|
|
19051
19129
|
|
|
19052
|
-
/**
|
|
19053
|
-
* Gamified metric by id
|
|
19054
|
-
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
19055
|
-
* @param {String} metricId metric Id
|
|
19056
|
-
* @param {Object} opts Optional parameters
|
|
19057
|
-
* @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
19058
|
-
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
19059
|
-
*/
|
|
19060
|
-
getGamificationMetric(metricId, opts) {
|
|
19061
|
-
opts = opts || {};
|
|
19062
|
-
|
|
19063
|
-
// verify the required parameter 'metricId' is set
|
|
19064
|
-
if (metricId === undefined || metricId === null) {
|
|
19065
|
-
throw 'Missing the required parameter "metricId" when calling getGamificationMetric';
|
|
19066
|
-
}
|
|
19067
|
-
|
|
19068
|
-
return this.apiClient.callApi(
|
|
19069
|
-
'/api/v2/gamification/metrics/{metricId}',
|
|
19070
|
-
'GET',
|
|
19071
|
-
{ 'metricId': metricId },
|
|
19072
|
-
{ 'workday': opts['workday'],'performanceProfileId': opts['performanceProfileId'] },
|
|
19073
|
-
{ },
|
|
19074
|
-
{ },
|
|
19075
|
-
null,
|
|
19076
|
-
['PureCloud OAuth'],
|
|
19077
|
-
['application/json'],
|
|
19078
|
-
['application/json']
|
|
19079
|
-
);
|
|
19080
|
-
}
|
|
19081
|
-
|
|
19082
19130
|
/**
|
|
19083
19131
|
* Metric definition by id
|
|
19084
19132
|
*
|
|
@@ -20383,40 +20431,6 @@ class GamificationApi {
|
|
|
20383
20431
|
);
|
|
20384
20432
|
}
|
|
20385
20433
|
|
|
20386
|
-
/**
|
|
20387
|
-
* Updates a metric
|
|
20388
|
-
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
20389
|
-
* @param {String} metricId metric Id
|
|
20390
|
-
* @param {Object} body Metric
|
|
20391
|
-
* @param {Object} opts Optional parameters
|
|
20392
|
-
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
20393
|
-
*/
|
|
20394
|
-
putGamificationMetric(metricId, body, opts) {
|
|
20395
|
-
opts = opts || {};
|
|
20396
|
-
|
|
20397
|
-
// verify the required parameter 'metricId' is set
|
|
20398
|
-
if (metricId === undefined || metricId === null) {
|
|
20399
|
-
throw 'Missing the required parameter "metricId" when calling putGamificationMetric';
|
|
20400
|
-
}
|
|
20401
|
-
// verify the required parameter 'body' is set
|
|
20402
|
-
if (body === undefined || body === null) {
|
|
20403
|
-
throw 'Missing the required parameter "body" when calling putGamificationMetric';
|
|
20404
|
-
}
|
|
20405
|
-
|
|
20406
|
-
return this.apiClient.callApi(
|
|
20407
|
-
'/api/v2/gamification/metrics/{metricId}',
|
|
20408
|
-
'PUT',
|
|
20409
|
-
{ 'metricId': metricId },
|
|
20410
|
-
{ 'performanceProfileId': opts['performanceProfileId'] },
|
|
20411
|
-
{ },
|
|
20412
|
-
{ },
|
|
20413
|
-
body,
|
|
20414
|
-
['PureCloud OAuth'],
|
|
20415
|
-
['application/json'],
|
|
20416
|
-
['application/json']
|
|
20417
|
-
);
|
|
20418
|
-
}
|
|
20419
|
-
|
|
20420
20434
|
/**
|
|
20421
20435
|
* Updates a performance profile
|
|
20422
20436
|
*
|
|
@@ -20512,7 +20526,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
20512
20526
|
/**
|
|
20513
20527
|
* GeneralDataProtectionRegulation service.
|
|
20514
20528
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
20515
|
-
* @version
|
|
20529
|
+
* @version 153.0.0
|
|
20516
20530
|
*/
|
|
20517
20531
|
|
|
20518
20532
|
/**
|
|
@@ -20642,7 +20656,7 @@ class GeolocationApi {
|
|
|
20642
20656
|
/**
|
|
20643
20657
|
* Geolocation service.
|
|
20644
20658
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
20645
|
-
* @version
|
|
20659
|
+
* @version 153.0.0
|
|
20646
20660
|
*/
|
|
20647
20661
|
|
|
20648
20662
|
/**
|
|
@@ -20773,7 +20787,7 @@ class GreetingsApi {
|
|
|
20773
20787
|
/**
|
|
20774
20788
|
* Greetings service.
|
|
20775
20789
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
20776
|
-
* @version
|
|
20790
|
+
* @version 153.0.0
|
|
20777
20791
|
*/
|
|
20778
20792
|
|
|
20779
20793
|
/**
|
|
@@ -21228,7 +21242,7 @@ class GroupsApi {
|
|
|
21228
21242
|
/**
|
|
21229
21243
|
* Groups service.
|
|
21230
21244
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
21231
|
-
* @version
|
|
21245
|
+
* @version 153.0.0
|
|
21232
21246
|
*/
|
|
21233
21247
|
|
|
21234
21248
|
/**
|
|
@@ -21634,7 +21648,7 @@ class IdentityProviderApi {
|
|
|
21634
21648
|
/**
|
|
21635
21649
|
* IdentityProvider service.
|
|
21636
21650
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
21637
|
-
* @version
|
|
21651
|
+
* @version 153.0.0
|
|
21638
21652
|
*/
|
|
21639
21653
|
|
|
21640
21654
|
/**
|
|
@@ -22390,7 +22404,7 @@ class IntegrationsApi {
|
|
|
22390
22404
|
/**
|
|
22391
22405
|
* Integrations service.
|
|
22392
22406
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
22393
|
-
* @version
|
|
22407
|
+
* @version 153.0.0
|
|
22394
22408
|
*/
|
|
22395
22409
|
|
|
22396
22410
|
/**
|
|
@@ -23990,7 +24004,7 @@ class JourneyApi {
|
|
|
23990
24004
|
/**
|
|
23991
24005
|
* Journey service.
|
|
23992
24006
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
23993
|
-
* @version
|
|
24007
|
+
* @version 153.0.0
|
|
23994
24008
|
*/
|
|
23995
24009
|
|
|
23996
24010
|
/**
|
|
@@ -24776,7 +24790,7 @@ class KnowledgeApi {
|
|
|
24776
24790
|
/**
|
|
24777
24791
|
* Knowledge service.
|
|
24778
24792
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
24779
|
-
* @version
|
|
24793
|
+
* @version 153.0.0
|
|
24780
24794
|
*/
|
|
24781
24795
|
|
|
24782
24796
|
/**
|
|
@@ -25179,8 +25193,8 @@ class KnowledgeApi {
|
|
|
25179
25193
|
* @param {String} sessionId Knowledge guest session ID.
|
|
25180
25194
|
* @param {Object} opts Optional parameters
|
|
25181
25195
|
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
25182
|
-
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
25183
|
-
* @param {
|
|
25196
|
+
* @param {Boolean} opts.includeSubcategories Deprecated - Do Not Use. Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
25197
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 10)
|
|
25184
25198
|
*/
|
|
25185
25199
|
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
25186
25200
|
opts = opts || {};
|
|
@@ -27209,7 +27223,7 @@ class LanguageUnderstandingApi {
|
|
|
27209
27223
|
/**
|
|
27210
27224
|
* LanguageUnderstanding service.
|
|
27211
27225
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
27212
|
-
* @version
|
|
27226
|
+
* @version 153.0.0
|
|
27213
27227
|
*/
|
|
27214
27228
|
|
|
27215
27229
|
/**
|
|
@@ -28113,7 +28127,7 @@ class LanguagesApi {
|
|
|
28113
28127
|
/**
|
|
28114
28128
|
* Languages service.
|
|
28115
28129
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
28116
|
-
* @version
|
|
28130
|
+
* @version 153.0.0
|
|
28117
28131
|
*/
|
|
28118
28132
|
|
|
28119
28133
|
/**
|
|
@@ -28381,7 +28395,7 @@ class LearningApi {
|
|
|
28381
28395
|
/**
|
|
28382
28396
|
* Learning service.
|
|
28383
28397
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
28384
|
-
* @version
|
|
28398
|
+
* @version 153.0.0
|
|
28385
28399
|
*/
|
|
28386
28400
|
|
|
28387
28401
|
/**
|
|
@@ -29141,7 +29155,7 @@ class LicenseApi {
|
|
|
29141
29155
|
/**
|
|
29142
29156
|
* License service.
|
|
29143
29157
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
29144
|
-
* @version
|
|
29158
|
+
* @version 153.0.0
|
|
29145
29159
|
*/
|
|
29146
29160
|
|
|
29147
29161
|
/**
|
|
@@ -29379,7 +29393,7 @@ class LocationsApi {
|
|
|
29379
29393
|
/**
|
|
29380
29394
|
* Locations service.
|
|
29381
29395
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
29382
|
-
* @version
|
|
29396
|
+
* @version 153.0.0
|
|
29383
29397
|
*/
|
|
29384
29398
|
|
|
29385
29399
|
/**
|
|
@@ -29615,7 +29629,7 @@ class MessagingApi {
|
|
|
29615
29629
|
/**
|
|
29616
29630
|
* Messaging service.
|
|
29617
29631
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
29618
|
-
* @version
|
|
29632
|
+
* @version 153.0.0
|
|
29619
29633
|
*/
|
|
29620
29634
|
|
|
29621
29635
|
/**
|
|
@@ -29766,7 +29780,7 @@ class MobileDevicesApi {
|
|
|
29766
29780
|
/**
|
|
29767
29781
|
* MobileDevices service.
|
|
29768
29782
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
29769
|
-
* @version
|
|
29783
|
+
* @version 153.0.0
|
|
29770
29784
|
*/
|
|
29771
29785
|
|
|
29772
29786
|
/**
|
|
@@ -29917,7 +29931,7 @@ class NotificationsApi {
|
|
|
29917
29931
|
/**
|
|
29918
29932
|
* Notifications service.
|
|
29919
29933
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
29920
|
-
* @version
|
|
29934
|
+
* @version 153.0.0
|
|
29921
29935
|
*/
|
|
29922
29936
|
|
|
29923
29937
|
/**
|
|
@@ -30142,7 +30156,7 @@ class OAuthApi {
|
|
|
30142
30156
|
/**
|
|
30143
30157
|
* OAuth service.
|
|
30144
30158
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
30145
|
-
* @version
|
|
30159
|
+
* @version 153.0.0
|
|
30146
30160
|
*/
|
|
30147
30161
|
|
|
30148
30162
|
/**
|
|
@@ -30508,7 +30522,7 @@ class ObjectsApi {
|
|
|
30508
30522
|
/**
|
|
30509
30523
|
* Objects service.
|
|
30510
30524
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
30511
|
-
* @version
|
|
30525
|
+
* @version 153.0.0
|
|
30512
30526
|
*/
|
|
30513
30527
|
|
|
30514
30528
|
/**
|
|
@@ -30779,7 +30793,7 @@ class OrganizationApi {
|
|
|
30779
30793
|
/**
|
|
30780
30794
|
* Organization service.
|
|
30781
30795
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
30782
|
-
* @version
|
|
30796
|
+
* @version 153.0.0
|
|
30783
30797
|
*/
|
|
30784
30798
|
|
|
30785
30799
|
/**
|
|
@@ -31182,7 +31196,7 @@ class OrganizationAuthorizationApi {
|
|
|
31182
31196
|
/**
|
|
31183
31197
|
* OrganizationAuthorization service.
|
|
31184
31198
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
31185
|
-
* @version
|
|
31199
|
+
* @version 153.0.0
|
|
31186
31200
|
*/
|
|
31187
31201
|
|
|
31188
31202
|
/**
|
|
@@ -32107,7 +32121,7 @@ class OutboundApi {
|
|
|
32107
32121
|
/**
|
|
32108
32122
|
* Outbound service.
|
|
32109
32123
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
32110
|
-
* @version
|
|
32124
|
+
* @version 153.0.0
|
|
32111
32125
|
*/
|
|
32112
32126
|
|
|
32113
32127
|
/**
|
|
@@ -35496,7 +35510,7 @@ class PresenceApi {
|
|
|
35496
35510
|
/**
|
|
35497
35511
|
* Presence service.
|
|
35498
35512
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
35499
|
-
* @version
|
|
35513
|
+
* @version 153.0.0
|
|
35500
35514
|
*/
|
|
35501
35515
|
|
|
35502
35516
|
/**
|
|
@@ -36002,7 +36016,7 @@ class ProcessAutomationApi {
|
|
|
36002
36016
|
/**
|
|
36003
36017
|
* ProcessAutomation service.
|
|
36004
36018
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
36005
|
-
* @version
|
|
36019
|
+
* @version 153.0.0
|
|
36006
36020
|
*/
|
|
36007
36021
|
|
|
36008
36022
|
/**
|
|
@@ -36240,7 +36254,7 @@ class QualityApi {
|
|
|
36240
36254
|
/**
|
|
36241
36255
|
* Quality service.
|
|
36242
36256
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
36243
|
-
* @version
|
|
36257
|
+
* @version 153.0.0
|
|
36244
36258
|
*/
|
|
36245
36259
|
|
|
36246
36260
|
/**
|
|
@@ -37818,7 +37832,7 @@ class RecordingApi {
|
|
|
37818
37832
|
/**
|
|
37819
37833
|
* Recording service.
|
|
37820
37834
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
37821
|
-
* @version
|
|
37835
|
+
* @version 153.0.0
|
|
37822
37836
|
*/
|
|
37823
37837
|
|
|
37824
37838
|
/**
|
|
@@ -39505,7 +39519,7 @@ class ResponseManagementApi {
|
|
|
39505
39519
|
/**
|
|
39506
39520
|
* ResponseManagement service.
|
|
39507
39521
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
39508
|
-
* @version
|
|
39522
|
+
* @version 153.0.0
|
|
39509
39523
|
*/
|
|
39510
39524
|
|
|
39511
39525
|
/**
|
|
@@ -39989,7 +40003,7 @@ class RoutingApi {
|
|
|
39989
40003
|
/**
|
|
39990
40004
|
* Routing service.
|
|
39991
40005
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
39992
|
-
* @version
|
|
40006
|
+
* @version 153.0.0
|
|
39993
40007
|
*/
|
|
39994
40008
|
|
|
39995
40009
|
/**
|
|
@@ -40298,6 +40312,31 @@ class RoutingApi {
|
|
|
40298
40312
|
);
|
|
40299
40313
|
}
|
|
40300
40314
|
|
|
40315
|
+
/**
|
|
40316
|
+
* Remove skill group definition
|
|
40317
|
+
*
|
|
40318
|
+
* @param {String} skillGroupId Skill Group ID
|
|
40319
|
+
*/
|
|
40320
|
+
deleteRoutingSkillgroup(skillGroupId) {
|
|
40321
|
+
// verify the required parameter 'skillGroupId' is set
|
|
40322
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
40323
|
+
throw 'Missing the required parameter "skillGroupId" when calling deleteRoutingSkillgroup';
|
|
40324
|
+
}
|
|
40325
|
+
|
|
40326
|
+
return this.apiClient.callApi(
|
|
40327
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
40328
|
+
'DELETE',
|
|
40329
|
+
{ 'skillGroupId': skillGroupId },
|
|
40330
|
+
{ },
|
|
40331
|
+
{ },
|
|
40332
|
+
{ },
|
|
40333
|
+
null,
|
|
40334
|
+
['PureCloud OAuth'],
|
|
40335
|
+
['application/json'],
|
|
40336
|
+
['application/json']
|
|
40337
|
+
);
|
|
40338
|
+
}
|
|
40339
|
+
|
|
40301
40340
|
/**
|
|
40302
40341
|
* Delete an Address by Id for SMS
|
|
40303
40342
|
*
|
|
@@ -40690,6 +40729,8 @@ class RoutingApi {
|
|
|
40690
40729
|
* Get domains
|
|
40691
40730
|
*
|
|
40692
40731
|
* @param {Object} opts Optional parameters
|
|
40732
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
40733
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
40693
40734
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
40694
40735
|
*/
|
|
40695
40736
|
getRoutingEmailDomains(opts) {
|
|
@@ -40700,7 +40741,7 @@ class RoutingApi {
|
|
|
40700
40741
|
'/api/v2/routing/email/domains',
|
|
40701
40742
|
'GET',
|
|
40702
40743
|
{ },
|
|
40703
|
-
{ 'excludeStatus': opts['excludeStatus'] },
|
|
40744
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'] },
|
|
40704
40745
|
{ },
|
|
40705
40746
|
{ },
|
|
40706
40747
|
null,
|
|
@@ -41483,6 +41524,119 @@ class RoutingApi {
|
|
|
41483
41524
|
);
|
|
41484
41525
|
}
|
|
41485
41526
|
|
|
41527
|
+
/**
|
|
41528
|
+
* Get skill group
|
|
41529
|
+
*
|
|
41530
|
+
* @param {String} skillGroupId Skill Group ID
|
|
41531
|
+
*/
|
|
41532
|
+
getRoutingSkillgroup(skillGroupId) {
|
|
41533
|
+
// verify the required parameter 'skillGroupId' is set
|
|
41534
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
41535
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroup';
|
|
41536
|
+
}
|
|
41537
|
+
|
|
41538
|
+
return this.apiClient.callApi(
|
|
41539
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
41540
|
+
'GET',
|
|
41541
|
+
{ 'skillGroupId': skillGroupId },
|
|
41542
|
+
{ },
|
|
41543
|
+
{ },
|
|
41544
|
+
{ },
|
|
41545
|
+
null,
|
|
41546
|
+
['PureCloud OAuth'],
|
|
41547
|
+
['application/json'],
|
|
41548
|
+
['application/json']
|
|
41549
|
+
);
|
|
41550
|
+
}
|
|
41551
|
+
|
|
41552
|
+
/**
|
|
41553
|
+
* Get skill group members
|
|
41554
|
+
*
|
|
41555
|
+
* @param {String} skillGroupId Skill Group ID
|
|
41556
|
+
* @param {Object} opts Optional parameters
|
|
41557
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
41558
|
+
* @param {String} opts.after The cursor that points to the next item
|
|
41559
|
+
* @param {String} opts.before The cursor that points to the previous item
|
|
41560
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
41561
|
+
*/
|
|
41562
|
+
getRoutingSkillgroupMembers(skillGroupId, opts) {
|
|
41563
|
+
opts = opts || {};
|
|
41564
|
+
|
|
41565
|
+
// verify the required parameter 'skillGroupId' is set
|
|
41566
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
41567
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembers';
|
|
41568
|
+
}
|
|
41569
|
+
|
|
41570
|
+
return this.apiClient.callApi(
|
|
41571
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members',
|
|
41572
|
+
'GET',
|
|
41573
|
+
{ 'skillGroupId': skillGroupId },
|
|
41574
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'before': opts['before'],'expand': opts['expand'] },
|
|
41575
|
+
{ },
|
|
41576
|
+
{ },
|
|
41577
|
+
null,
|
|
41578
|
+
['PureCloud OAuth'],
|
|
41579
|
+
['application/json'],
|
|
41580
|
+
['application/json']
|
|
41581
|
+
);
|
|
41582
|
+
}
|
|
41583
|
+
|
|
41584
|
+
/**
|
|
41585
|
+
* Get list of member divisions for this skill group.
|
|
41586
|
+
*
|
|
41587
|
+
* @param {String} skillGroupId Skill Group ID
|
|
41588
|
+
* @param {Object} opts Optional parameters
|
|
41589
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
41590
|
+
*/
|
|
41591
|
+
getRoutingSkillgroupMembersDivisions(skillGroupId, opts) {
|
|
41592
|
+
opts = opts || {};
|
|
41593
|
+
|
|
41594
|
+
// verify the required parameter 'skillGroupId' is set
|
|
41595
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
41596
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembersDivisions';
|
|
41597
|
+
}
|
|
41598
|
+
|
|
41599
|
+
return this.apiClient.callApi(
|
|
41600
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members/divisions',
|
|
41601
|
+
'GET',
|
|
41602
|
+
{ 'skillGroupId': skillGroupId },
|
|
41603
|
+
{ 'expand': opts['expand'] },
|
|
41604
|
+
{ },
|
|
41605
|
+
{ },
|
|
41606
|
+
null,
|
|
41607
|
+
['PureCloud OAuth'],
|
|
41608
|
+
['application/json'],
|
|
41609
|
+
['application/json']
|
|
41610
|
+
);
|
|
41611
|
+
}
|
|
41612
|
+
|
|
41613
|
+
/**
|
|
41614
|
+
* Get skill group listing
|
|
41615
|
+
*
|
|
41616
|
+
* @param {Object} opts Optional parameters
|
|
41617
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
41618
|
+
* @param {String} opts.name Return only skill group names whose names start with this value (case-insensitive matching)
|
|
41619
|
+
* @param {String} opts.after The cursor that points to the next item
|
|
41620
|
+
* @param {String} opts.before The cursor that points to the previous item
|
|
41621
|
+
*/
|
|
41622
|
+
getRoutingSkillgroups(opts) {
|
|
41623
|
+
opts = opts || {};
|
|
41624
|
+
|
|
41625
|
+
|
|
41626
|
+
return this.apiClient.callApi(
|
|
41627
|
+
'/api/v2/routing/skillgroups',
|
|
41628
|
+
'GET',
|
|
41629
|
+
{ },
|
|
41630
|
+
{ 'pageSize': opts['pageSize'],'name': opts['name'],'after': opts['after'],'before': opts['before'] },
|
|
41631
|
+
{ },
|
|
41632
|
+
{ },
|
|
41633
|
+
null,
|
|
41634
|
+
['PureCloud OAuth'],
|
|
41635
|
+
['application/json'],
|
|
41636
|
+
['application/json']
|
|
41637
|
+
);
|
|
41638
|
+
}
|
|
41639
|
+
|
|
41486
41640
|
/**
|
|
41487
41641
|
* Get the list of routing skills.
|
|
41488
41642
|
*
|
|
@@ -42121,6 +42275,36 @@ class RoutingApi {
|
|
|
42121
42275
|
);
|
|
42122
42276
|
}
|
|
42123
42277
|
|
|
42278
|
+
/**
|
|
42279
|
+
* Update skill group definition
|
|
42280
|
+
*
|
|
42281
|
+
* @param {String} skillGroupId Skill Group ID
|
|
42282
|
+
* @param {Object} body Update skill groups
|
|
42283
|
+
*/
|
|
42284
|
+
patchRoutingSkillgroup(skillGroupId, body) {
|
|
42285
|
+
// verify the required parameter 'skillGroupId' is set
|
|
42286
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
42287
|
+
throw 'Missing the required parameter "skillGroupId" when calling patchRoutingSkillgroup';
|
|
42288
|
+
}
|
|
42289
|
+
// verify the required parameter 'body' is set
|
|
42290
|
+
if (body === undefined || body === null) {
|
|
42291
|
+
throw 'Missing the required parameter "body" when calling patchRoutingSkillgroup';
|
|
42292
|
+
}
|
|
42293
|
+
|
|
42294
|
+
return this.apiClient.callApi(
|
|
42295
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
42296
|
+
'PATCH',
|
|
42297
|
+
{ 'skillGroupId': skillGroupId },
|
|
42298
|
+
{ },
|
|
42299
|
+
{ },
|
|
42300
|
+
{ },
|
|
42301
|
+
body,
|
|
42302
|
+
['PureCloud OAuth'],
|
|
42303
|
+
['application/json'],
|
|
42304
|
+
['application/json']
|
|
42305
|
+
);
|
|
42306
|
+
}
|
|
42307
|
+
|
|
42124
42308
|
/**
|
|
42125
42309
|
* Join or unjoin a queue for a user
|
|
42126
42310
|
*
|
|
@@ -42664,6 +42848,60 @@ class RoutingApi {
|
|
|
42664
42848
|
);
|
|
42665
42849
|
}
|
|
42666
42850
|
|
|
42851
|
+
/**
|
|
42852
|
+
* Add or remove member divisions for this skill group.
|
|
42853
|
+
*
|
|
42854
|
+
* @param {String} skillGroupId Skill Group ID
|
|
42855
|
+
* @param {Object} opts Optional parameters
|
|
42856
|
+
* @param {Object} opts.body
|
|
42857
|
+
*/
|
|
42858
|
+
postRoutingSkillgroupMembersDivisions(skillGroupId, opts) {
|
|
42859
|
+
opts = opts || {};
|
|
42860
|
+
|
|
42861
|
+
// verify the required parameter 'skillGroupId' is set
|
|
42862
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
42863
|
+
throw 'Missing the required parameter "skillGroupId" when calling postRoutingSkillgroupMembersDivisions';
|
|
42864
|
+
}
|
|
42865
|
+
|
|
42866
|
+
return this.apiClient.callApi(
|
|
42867
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members/divisions',
|
|
42868
|
+
'POST',
|
|
42869
|
+
{ 'skillGroupId': skillGroupId },
|
|
42870
|
+
{ },
|
|
42871
|
+
{ },
|
|
42872
|
+
{ },
|
|
42873
|
+
opts['body'],
|
|
42874
|
+
['PureCloud OAuth'],
|
|
42875
|
+
['application/json'],
|
|
42876
|
+
['application/json']
|
|
42877
|
+
);
|
|
42878
|
+
}
|
|
42879
|
+
|
|
42880
|
+
/**
|
|
42881
|
+
* Create a skill group
|
|
42882
|
+
*
|
|
42883
|
+
* @param {Object} body Create skill group
|
|
42884
|
+
*/
|
|
42885
|
+
postRoutingSkillgroups(body) {
|
|
42886
|
+
// verify the required parameter 'body' is set
|
|
42887
|
+
if (body === undefined || body === null) {
|
|
42888
|
+
throw 'Missing the required parameter "body" when calling postRoutingSkillgroups';
|
|
42889
|
+
}
|
|
42890
|
+
|
|
42891
|
+
return this.apiClient.callApi(
|
|
42892
|
+
'/api/v2/routing/skillgroups',
|
|
42893
|
+
'POST',
|
|
42894
|
+
{ },
|
|
42895
|
+
{ },
|
|
42896
|
+
{ },
|
|
42897
|
+
{ },
|
|
42898
|
+
body,
|
|
42899
|
+
['PureCloud OAuth'],
|
|
42900
|
+
['application/json'],
|
|
42901
|
+
['application/json']
|
|
42902
|
+
);
|
|
42903
|
+
}
|
|
42904
|
+
|
|
42667
42905
|
/**
|
|
42668
42906
|
* Create Skill
|
|
42669
42907
|
*
|
|
@@ -43180,7 +43418,7 @@ class SCIMApi {
|
|
|
43180
43418
|
/**
|
|
43181
43419
|
* SCIM service.
|
|
43182
43420
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
43183
|
-
* @version
|
|
43421
|
+
* @version 153.0.0
|
|
43184
43422
|
*/
|
|
43185
43423
|
|
|
43186
43424
|
/**
|
|
@@ -44057,7 +44295,7 @@ class ScriptsApi {
|
|
|
44057
44295
|
/**
|
|
44058
44296
|
* Scripts service.
|
|
44059
44297
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
44060
|
-
* @version
|
|
44298
|
+
* @version 153.0.0
|
|
44061
44299
|
*/
|
|
44062
44300
|
|
|
44063
44301
|
/**
|
|
@@ -44476,7 +44714,7 @@ class SearchApi {
|
|
|
44476
44714
|
/**
|
|
44477
44715
|
* Search service.
|
|
44478
44716
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
44479
|
-
* @version
|
|
44717
|
+
* @version 153.0.0
|
|
44480
44718
|
*/
|
|
44481
44719
|
|
|
44482
44720
|
/**
|
|
@@ -45061,7 +45299,7 @@ class SpeechTextAnalyticsApi {
|
|
|
45061
45299
|
/**
|
|
45062
45300
|
* SpeechTextAnalytics service.
|
|
45063
45301
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
45064
|
-
* @version
|
|
45302
|
+
* @version 153.0.0
|
|
45065
45303
|
*/
|
|
45066
45304
|
|
|
45067
45305
|
/**
|
|
@@ -45915,7 +46153,7 @@ class StationsApi {
|
|
|
45915
46153
|
/**
|
|
45916
46154
|
* Stations service.
|
|
45917
46155
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
45918
|
-
* @version
|
|
46156
|
+
* @version 153.0.0
|
|
45919
46157
|
*/
|
|
45920
46158
|
|
|
45921
46159
|
/**
|
|
@@ -46062,7 +46300,7 @@ class SuggestApi {
|
|
|
46062
46300
|
/**
|
|
46063
46301
|
* Suggest service.
|
|
46064
46302
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
46065
|
-
* @version
|
|
46303
|
+
* @version 153.0.0
|
|
46066
46304
|
*/
|
|
46067
46305
|
|
|
46068
46306
|
/**
|
|
@@ -46201,7 +46439,7 @@ class TeamsApi {
|
|
|
46201
46439
|
/**
|
|
46202
46440
|
* Teams service.
|
|
46203
46441
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
46204
|
-
* @version
|
|
46442
|
+
* @version 153.0.0
|
|
46205
46443
|
*/
|
|
46206
46444
|
|
|
46207
46445
|
/**
|
|
@@ -46472,7 +46710,7 @@ class TelephonyApi {
|
|
|
46472
46710
|
/**
|
|
46473
46711
|
* Telephony service.
|
|
46474
46712
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
46475
|
-
* @version
|
|
46713
|
+
* @version 153.0.0
|
|
46476
46714
|
*/
|
|
46477
46715
|
|
|
46478
46716
|
/**
|
|
@@ -46580,7 +46818,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
46580
46818
|
/**
|
|
46581
46819
|
* TelephonyProvidersEdge service.
|
|
46582
46820
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
46583
|
-
* @version
|
|
46821
|
+
* @version 153.0.0
|
|
46584
46822
|
*/
|
|
46585
46823
|
|
|
46586
46824
|
/**
|
|
@@ -50213,7 +50451,7 @@ class TextbotsApi {
|
|
|
50213
50451
|
/**
|
|
50214
50452
|
* Textbots service.
|
|
50215
50453
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
50216
|
-
* @version
|
|
50454
|
+
* @version 153.0.0
|
|
50217
50455
|
*/
|
|
50218
50456
|
|
|
50219
50457
|
/**
|
|
@@ -50341,7 +50579,7 @@ class TokensApi {
|
|
|
50341
50579
|
/**
|
|
50342
50580
|
* Tokens service.
|
|
50343
50581
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
50344
|
-
* @version
|
|
50582
|
+
* @version 153.0.0
|
|
50345
50583
|
*/
|
|
50346
50584
|
|
|
50347
50585
|
/**
|
|
@@ -50447,7 +50685,7 @@ class UploadsApi {
|
|
|
50447
50685
|
/**
|
|
50448
50686
|
* Uploads service.
|
|
50449
50687
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
50450
|
-
* @version
|
|
50688
|
+
* @version 153.0.0
|
|
50451
50689
|
*/
|
|
50452
50690
|
|
|
50453
50691
|
/**
|
|
@@ -50623,7 +50861,7 @@ class UsageApi {
|
|
|
50623
50861
|
/**
|
|
50624
50862
|
* Usage service.
|
|
50625
50863
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
50626
|
-
* @version
|
|
50864
|
+
* @version 153.0.0
|
|
50627
50865
|
*/
|
|
50628
50866
|
|
|
50629
50867
|
/**
|
|
@@ -50694,7 +50932,7 @@ class UserRecordingsApi {
|
|
|
50694
50932
|
/**
|
|
50695
50933
|
* UserRecordings service.
|
|
50696
50934
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
50697
|
-
* @version
|
|
50935
|
+
* @version 153.0.0
|
|
50698
50936
|
*/
|
|
50699
50937
|
|
|
50700
50938
|
/**
|
|
@@ -50879,7 +51117,7 @@ class UsersApi {
|
|
|
50879
51117
|
/**
|
|
50880
51118
|
* Users service.
|
|
50881
51119
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
50882
|
-
* @version
|
|
51120
|
+
* @version 153.0.0
|
|
50883
51121
|
*/
|
|
50884
51122
|
|
|
50885
51123
|
/**
|
|
@@ -53236,7 +53474,7 @@ class UtilitiesApi {
|
|
|
53236
53474
|
/**
|
|
53237
53475
|
* Utilities service.
|
|
53238
53476
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
53239
|
-
* @version
|
|
53477
|
+
* @version 153.0.0
|
|
53240
53478
|
*/
|
|
53241
53479
|
|
|
53242
53480
|
/**
|
|
@@ -53347,7 +53585,7 @@ class VoicemailApi {
|
|
|
53347
53585
|
/**
|
|
53348
53586
|
* Voicemail service.
|
|
53349
53587
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
53350
|
-
* @version
|
|
53588
|
+
* @version 153.0.0
|
|
53351
53589
|
*/
|
|
53352
53590
|
|
|
53353
53591
|
/**
|
|
@@ -54014,7 +54252,7 @@ class WebChatApi {
|
|
|
54014
54252
|
/**
|
|
54015
54253
|
* WebChat service.
|
|
54016
54254
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
54017
|
-
* @version
|
|
54255
|
+
* @version 153.0.0
|
|
54018
54256
|
*/
|
|
54019
54257
|
|
|
54020
54258
|
/**
|
|
@@ -54558,7 +54796,7 @@ class WebDeploymentsApi {
|
|
|
54558
54796
|
/**
|
|
54559
54797
|
* WebDeployments service.
|
|
54560
54798
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
54561
|
-
* @version
|
|
54799
|
+
* @version 153.0.0
|
|
54562
54800
|
*/
|
|
54563
54801
|
|
|
54564
54802
|
/**
|
|
@@ -54946,7 +55184,7 @@ class WebMessagingApi {
|
|
|
54946
55184
|
/**
|
|
54947
55185
|
* WebMessaging service.
|
|
54948
55186
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
54949
|
-
* @version
|
|
55187
|
+
* @version 153.0.0
|
|
54950
55188
|
*/
|
|
54951
55189
|
|
|
54952
55190
|
/**
|
|
@@ -54992,7 +55230,7 @@ class WidgetsApi {
|
|
|
54992
55230
|
/**
|
|
54993
55231
|
* Widgets service.
|
|
54994
55232
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
54995
|
-
* @version
|
|
55233
|
+
* @version 153.0.0
|
|
54996
55234
|
*/
|
|
54997
55235
|
|
|
54998
55236
|
/**
|
|
@@ -55138,7 +55376,7 @@ class WorkforceManagementApi {
|
|
|
55138
55376
|
/**
|
|
55139
55377
|
* WorkforceManagement service.
|
|
55140
55378
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
55141
|
-
* @version
|
|
55379
|
+
* @version 153.0.0
|
|
55142
55380
|
*/
|
|
55143
55381
|
|
|
55144
55382
|
/**
|
|
@@ -55558,6 +55796,56 @@ class WorkforceManagementApi {
|
|
|
55558
55796
|
);
|
|
55559
55797
|
}
|
|
55560
55798
|
|
|
55799
|
+
/**
|
|
55800
|
+
* Get an adherence explanation for the current user
|
|
55801
|
+
*
|
|
55802
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
55803
|
+
*/
|
|
55804
|
+
getWorkforcemanagementAdherenceExplanation(explanationId) {
|
|
55805
|
+
// verify the required parameter 'explanationId' is set
|
|
55806
|
+
if (explanationId === undefined || explanationId === null) {
|
|
55807
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAdherenceExplanation';
|
|
55808
|
+
}
|
|
55809
|
+
|
|
55810
|
+
return this.apiClient.callApi(
|
|
55811
|
+
'/api/v2/workforcemanagement/adherence/explanations/{explanationId}',
|
|
55812
|
+
'GET',
|
|
55813
|
+
{ 'explanationId': explanationId },
|
|
55814
|
+
{ },
|
|
55815
|
+
{ },
|
|
55816
|
+
{ },
|
|
55817
|
+
null,
|
|
55818
|
+
['PureCloud OAuth'],
|
|
55819
|
+
['application/json'],
|
|
55820
|
+
['application/json']
|
|
55821
|
+
);
|
|
55822
|
+
}
|
|
55823
|
+
|
|
55824
|
+
/**
|
|
55825
|
+
* Query the status of an adherence explanation operation. Only the user who started the operation can query the status
|
|
55826
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
55827
|
+
* @param {String} jobId The ID of the job
|
|
55828
|
+
*/
|
|
55829
|
+
getWorkforcemanagementAdherenceExplanationsJob(jobId) {
|
|
55830
|
+
// verify the required parameter 'jobId' is set
|
|
55831
|
+
if (jobId === undefined || jobId === null) {
|
|
55832
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceExplanationsJob';
|
|
55833
|
+
}
|
|
55834
|
+
|
|
55835
|
+
return this.apiClient.callApi(
|
|
55836
|
+
'/api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}',
|
|
55837
|
+
'GET',
|
|
55838
|
+
{ 'jobId': jobId },
|
|
55839
|
+
{ },
|
|
55840
|
+
{ },
|
|
55841
|
+
{ },
|
|
55842
|
+
null,
|
|
55843
|
+
['PureCloud OAuth'],
|
|
55844
|
+
['application/json'],
|
|
55845
|
+
['application/json']
|
|
55846
|
+
);
|
|
55847
|
+
}
|
|
55848
|
+
|
|
55561
55849
|
/**
|
|
55562
55850
|
* Query the status of a historical adherence request operation. Only the user who started the operation can query the status
|
|
55563
55851
|
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
@@ -55608,6 +55896,36 @@ class WorkforceManagementApi {
|
|
|
55608
55896
|
);
|
|
55609
55897
|
}
|
|
55610
55898
|
|
|
55899
|
+
/**
|
|
55900
|
+
* Get an adherence explanation
|
|
55901
|
+
*
|
|
55902
|
+
* @param {String} agentId The ID of the agent to query
|
|
55903
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
55904
|
+
*/
|
|
55905
|
+
getWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId) {
|
|
55906
|
+
// verify the required parameter 'agentId' is set
|
|
55907
|
+
if (agentId === undefined || agentId === null) {
|
|
55908
|
+
throw 'Missing the required parameter "agentId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
55909
|
+
}
|
|
55910
|
+
// verify the required parameter 'explanationId' is set
|
|
55911
|
+
if (explanationId === undefined || explanationId === null) {
|
|
55912
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
55913
|
+
}
|
|
55914
|
+
|
|
55915
|
+
return this.apiClient.callApi(
|
|
55916
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
55917
|
+
'GET',
|
|
55918
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
55919
|
+
{ },
|
|
55920
|
+
{ },
|
|
55921
|
+
{ },
|
|
55922
|
+
null,
|
|
55923
|
+
['PureCloud OAuth'],
|
|
55924
|
+
['application/json'],
|
|
55925
|
+
['application/json']
|
|
55926
|
+
);
|
|
55927
|
+
}
|
|
55928
|
+
|
|
55611
55929
|
/**
|
|
55612
55930
|
* Get the management unit to which the agent belongs
|
|
55613
55931
|
*
|
|
@@ -57327,6 +57645,31 @@ class WorkforceManagementApi {
|
|
|
57327
57645
|
);
|
|
57328
57646
|
}
|
|
57329
57647
|
|
|
57648
|
+
/**
|
|
57649
|
+
* Request to fetch the status of the historical shrinkage query
|
|
57650
|
+
*
|
|
57651
|
+
* @param {String} jobId jobId
|
|
57652
|
+
*/
|
|
57653
|
+
getWorkforcemanagementShrinkageJob(jobId) {
|
|
57654
|
+
// verify the required parameter 'jobId' is set
|
|
57655
|
+
if (jobId === undefined || jobId === null) {
|
|
57656
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShrinkageJob';
|
|
57657
|
+
}
|
|
57658
|
+
|
|
57659
|
+
return this.apiClient.callApi(
|
|
57660
|
+
'/api/v2/workforcemanagement/shrinkage/jobs/{jobId}',
|
|
57661
|
+
'GET',
|
|
57662
|
+
{ 'jobId': jobId },
|
|
57663
|
+
{ },
|
|
57664
|
+
{ },
|
|
57665
|
+
{ },
|
|
57666
|
+
null,
|
|
57667
|
+
['PureCloud OAuth'],
|
|
57668
|
+
['application/json'],
|
|
57669
|
+
['application/json']
|
|
57670
|
+
);
|
|
57671
|
+
}
|
|
57672
|
+
|
|
57330
57673
|
/**
|
|
57331
57674
|
* Get a time off request for the current user
|
|
57332
57675
|
*
|
|
@@ -57401,6 +57744,41 @@ class WorkforceManagementApi {
|
|
|
57401
57744
|
);
|
|
57402
57745
|
}
|
|
57403
57746
|
|
|
57747
|
+
/**
|
|
57748
|
+
* Update an adherence explanation
|
|
57749
|
+
*
|
|
57750
|
+
* @param {String} agentId The ID of the agent to query
|
|
57751
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
57752
|
+
* @param {Object} body The request body
|
|
57753
|
+
*/
|
|
57754
|
+
patchWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId, body) {
|
|
57755
|
+
// verify the required parameter 'agentId' is set
|
|
57756
|
+
if (agentId === undefined || agentId === null) {
|
|
57757
|
+
throw 'Missing the required parameter "agentId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
57758
|
+
}
|
|
57759
|
+
// verify the required parameter 'explanationId' is set
|
|
57760
|
+
if (explanationId === undefined || explanationId === null) {
|
|
57761
|
+
throw 'Missing the required parameter "explanationId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
57762
|
+
}
|
|
57763
|
+
// verify the required parameter 'body' is set
|
|
57764
|
+
if (body === undefined || body === null) {
|
|
57765
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
57766
|
+
}
|
|
57767
|
+
|
|
57768
|
+
return this.apiClient.callApi(
|
|
57769
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
57770
|
+
'PATCH',
|
|
57771
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
57772
|
+
{ },
|
|
57773
|
+
{ },
|
|
57774
|
+
{ },
|
|
57775
|
+
body,
|
|
57776
|
+
['PureCloud OAuth'],
|
|
57777
|
+
['application/json'],
|
|
57778
|
+
['application/json']
|
|
57779
|
+
);
|
|
57780
|
+
}
|
|
57781
|
+
|
|
57404
57782
|
/**
|
|
57405
57783
|
* Update business unit
|
|
57406
57784
|
*
|
|
@@ -57840,6 +58218,61 @@ class WorkforceManagementApi {
|
|
|
57840
58218
|
);
|
|
57841
58219
|
}
|
|
57842
58220
|
|
|
58221
|
+
/**
|
|
58222
|
+
* Submit an adherence explanation for the current user
|
|
58223
|
+
*
|
|
58224
|
+
* @param {Object} body The request body
|
|
58225
|
+
*/
|
|
58226
|
+
postWorkforcemanagementAdherenceExplanations(body) {
|
|
58227
|
+
// verify the required parameter 'body' is set
|
|
58228
|
+
if (body === undefined || body === null) {
|
|
58229
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanations';
|
|
58230
|
+
}
|
|
58231
|
+
|
|
58232
|
+
return this.apiClient.callApi(
|
|
58233
|
+
'/api/v2/workforcemanagement/adherence/explanations',
|
|
58234
|
+
'POST',
|
|
58235
|
+
{ },
|
|
58236
|
+
{ },
|
|
58237
|
+
{ },
|
|
58238
|
+
{ },
|
|
58239
|
+
body,
|
|
58240
|
+
['PureCloud OAuth'],
|
|
58241
|
+
['application/json'],
|
|
58242
|
+
['application/json']
|
|
58243
|
+
);
|
|
58244
|
+
}
|
|
58245
|
+
|
|
58246
|
+
/**
|
|
58247
|
+
* Query adherence explanations for the current user
|
|
58248
|
+
*
|
|
58249
|
+
* @param {Object} body The request body
|
|
58250
|
+
* @param {Object} opts Optional parameters
|
|
58251
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
58252
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
58253
|
+
*/
|
|
58254
|
+
postWorkforcemanagementAdherenceExplanationsQuery(body, opts) {
|
|
58255
|
+
opts = opts || {};
|
|
58256
|
+
|
|
58257
|
+
// verify the required parameter 'body' is set
|
|
58258
|
+
if (body === undefined || body === null) {
|
|
58259
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanationsQuery';
|
|
58260
|
+
}
|
|
58261
|
+
|
|
58262
|
+
return this.apiClient.callApi(
|
|
58263
|
+
'/api/v2/workforcemanagement/adherence/explanations/query',
|
|
58264
|
+
'POST',
|
|
58265
|
+
{ },
|
|
58266
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
58267
|
+
{ },
|
|
58268
|
+
{ },
|
|
58269
|
+
body,
|
|
58270
|
+
['PureCloud OAuth'],
|
|
58271
|
+
['application/json'],
|
|
58272
|
+
['application/json']
|
|
58273
|
+
);
|
|
58274
|
+
}
|
|
58275
|
+
|
|
57843
58276
|
/**
|
|
57844
58277
|
* Request a historical adherence report for users across management units
|
|
57845
58278
|
*
|
|
@@ -57864,6 +58297,71 @@ class WorkforceManagementApi {
|
|
|
57864
58297
|
);
|
|
57865
58298
|
}
|
|
57866
58299
|
|
|
58300
|
+
/**
|
|
58301
|
+
* Add an adherence explanation for the requested user
|
|
58302
|
+
*
|
|
58303
|
+
* @param {String} agentId The ID of the agent to query
|
|
58304
|
+
* @param {Object} body The request body
|
|
58305
|
+
*/
|
|
58306
|
+
postWorkforcemanagementAgentAdherenceExplanations(agentId, body) {
|
|
58307
|
+
// verify the required parameter 'agentId' is set
|
|
58308
|
+
if (agentId === undefined || agentId === null) {
|
|
58309
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
58310
|
+
}
|
|
58311
|
+
// verify the required parameter 'body' is set
|
|
58312
|
+
if (body === undefined || body === null) {
|
|
58313
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
58314
|
+
}
|
|
58315
|
+
|
|
58316
|
+
return this.apiClient.callApi(
|
|
58317
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations',
|
|
58318
|
+
'POST',
|
|
58319
|
+
{ 'agentId': agentId },
|
|
58320
|
+
{ },
|
|
58321
|
+
{ },
|
|
58322
|
+
{ },
|
|
58323
|
+
body,
|
|
58324
|
+
['PureCloud OAuth'],
|
|
58325
|
+
['application/json'],
|
|
58326
|
+
['application/json']
|
|
58327
|
+
);
|
|
58328
|
+
}
|
|
58329
|
+
|
|
58330
|
+
/**
|
|
58331
|
+
* Query adherence explanations for the given agent across a specified range
|
|
58332
|
+
*
|
|
58333
|
+
* @param {String} agentId The ID of the agent to query
|
|
58334
|
+
* @param {Object} body The request body
|
|
58335
|
+
* @param {Object} opts Optional parameters
|
|
58336
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
58337
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
58338
|
+
*/
|
|
58339
|
+
postWorkforcemanagementAgentAdherenceExplanationsQuery(agentId, body, opts) {
|
|
58340
|
+
opts = opts || {};
|
|
58341
|
+
|
|
58342
|
+
// verify the required parameter 'agentId' is set
|
|
58343
|
+
if (agentId === undefined || agentId === null) {
|
|
58344
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
58345
|
+
}
|
|
58346
|
+
// verify the required parameter 'body' is set
|
|
58347
|
+
if (body === undefined || body === null) {
|
|
58348
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
58349
|
+
}
|
|
58350
|
+
|
|
58351
|
+
return this.apiClient.callApi(
|
|
58352
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query',
|
|
58353
|
+
'POST',
|
|
58354
|
+
{ 'agentId': agentId },
|
|
58355
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
58356
|
+
{ },
|
|
58357
|
+
{ },
|
|
58358
|
+
body,
|
|
58359
|
+
['PureCloud OAuth'],
|
|
58360
|
+
['application/json'],
|
|
58361
|
+
['application/json']
|
|
58362
|
+
);
|
|
58363
|
+
}
|
|
58364
|
+
|
|
57867
58365
|
/**
|
|
57868
58366
|
* Get published schedule for the current user
|
|
57869
58367
|
*
|
|
@@ -57917,6 +58415,41 @@ class WorkforceManagementApi {
|
|
|
57917
58415
|
);
|
|
57918
58416
|
}
|
|
57919
58417
|
|
|
58418
|
+
/**
|
|
58419
|
+
* Query adherence explanations across an entire business unit for the requested period
|
|
58420
|
+
*
|
|
58421
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
58422
|
+
* @param {Object} body The request body
|
|
58423
|
+
* @param {Object} opts Optional parameters
|
|
58424
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
58425
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
58426
|
+
*/
|
|
58427
|
+
postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(businessUnitId, body, opts) {
|
|
58428
|
+
opts = opts || {};
|
|
58429
|
+
|
|
58430
|
+
// verify the required parameter 'businessUnitId' is set
|
|
58431
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
58432
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
58433
|
+
}
|
|
58434
|
+
// verify the required parameter 'body' is set
|
|
58435
|
+
if (body === undefined || body === null) {
|
|
58436
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
58437
|
+
}
|
|
58438
|
+
|
|
58439
|
+
return this.apiClient.callApi(
|
|
58440
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query',
|
|
58441
|
+
'POST',
|
|
58442
|
+
{ 'businessUnitId': businessUnitId },
|
|
58443
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
58444
|
+
{ },
|
|
58445
|
+
{ },
|
|
58446
|
+
body,
|
|
58447
|
+
['PureCloud OAuth'],
|
|
58448
|
+
['application/json'],
|
|
58449
|
+
['application/json']
|
|
58450
|
+
);
|
|
58451
|
+
}
|
|
58452
|
+
|
|
57920
58453
|
/**
|
|
57921
58454
|
* Search published schedules
|
|
57922
58455
|
*
|
|
@@ -58744,6 +59277,35 @@ class WorkforceManagementApi {
|
|
|
58744
59277
|
);
|
|
58745
59278
|
}
|
|
58746
59279
|
|
|
59280
|
+
/**
|
|
59281
|
+
* Request a historical shrinkage report
|
|
59282
|
+
* The maximum supported range for historical shrinkage queries is up to 32 days. Historical Shrinkage for a given date range can be queried in two modes - granular and aggregated. To see granular shrinkage information, provide granularity in the request body.
|
|
59283
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
59284
|
+
* @param {Object} opts Optional parameters
|
|
59285
|
+
* @param {Object} opts.body body
|
|
59286
|
+
*/
|
|
59287
|
+
postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId, opts) {
|
|
59288
|
+
opts = opts || {};
|
|
59289
|
+
|
|
59290
|
+
// verify the required parameter 'managementUnitId' is set
|
|
59291
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
59292
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitShrinkageJobs';
|
|
59293
|
+
}
|
|
59294
|
+
|
|
59295
|
+
return this.apiClient.callApi(
|
|
59296
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs',
|
|
59297
|
+
'POST',
|
|
59298
|
+
{ 'managementUnitId': managementUnitId },
|
|
59299
|
+
{ },
|
|
59300
|
+
{ },
|
|
59301
|
+
{ },
|
|
59302
|
+
opts['body'],
|
|
59303
|
+
['PureCloud OAuth'],
|
|
59304
|
+
['application/json'],
|
|
59305
|
+
['application/json']
|
|
59306
|
+
);
|
|
59307
|
+
}
|
|
59308
|
+
|
|
58747
59309
|
/**
|
|
58748
59310
|
* Creates a new time off limit object under management unit.
|
|
58749
59311
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
@@ -59484,7 +60046,7 @@ class WorkforceManagementApi {
|
|
|
59484
60046
|
* </pre>
|
|
59485
60047
|
* </p>
|
|
59486
60048
|
* @module purecloud-platform-client-v2/index
|
|
59487
|
-
* @version
|
|
60049
|
+
* @version 153.0.0
|
|
59488
60050
|
*/
|
|
59489
60051
|
class platformClient {
|
|
59490
60052
|
constructor() {
|