purecloud-platform-client-v2 168.0.0 → 168.2.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 +181 -75
- package/dist/web-amd/purecloud-platform-client-v2.js +181 -75
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +181 -75
- package/dist/web-cjs/purecloud-platform-client-v2.js +229 -102
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +315 -257
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/AuditApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/BillingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ChatApi.js +5 -2
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/EventsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/FaxApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +5 -2
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +6 -2
- package/src/purecloud-platform-client-v2/api/LearningApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +5 -2
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/QualityApi.js +11 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +7 -2
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/SearchApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/StationsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TokensApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/UsageApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/UsersApi.js +8 -2
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +7 -2
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +70 -7
- 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 168.
|
|
2282
|
+
* @version 168.2.0
|
|
2283
2283
|
*/
|
|
2284
2284
|
class ApiClient {
|
|
2285
2285
|
/**
|
|
@@ -3358,7 +3358,7 @@ class AlertingApi {
|
|
|
3358
3358
|
/**
|
|
3359
3359
|
* Alerting service.
|
|
3360
3360
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3361
|
-
* @version 168.
|
|
3361
|
+
* @version 168.2.0
|
|
3362
3362
|
*/
|
|
3363
3363
|
|
|
3364
3364
|
/**
|
|
@@ -3672,7 +3672,7 @@ class AnalyticsApi {
|
|
|
3672
3672
|
/**
|
|
3673
3673
|
* Analytics service.
|
|
3674
3674
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3675
|
-
* @version 168.
|
|
3675
|
+
* @version 168.2.0
|
|
3676
3676
|
*/
|
|
3677
3677
|
|
|
3678
3678
|
/**
|
|
@@ -4926,7 +4926,7 @@ class ArchitectApi {
|
|
|
4926
4926
|
/**
|
|
4927
4927
|
* Architect service.
|
|
4928
4928
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4929
|
-
* @version 168.
|
|
4929
|
+
* @version 168.2.0
|
|
4930
4930
|
*/
|
|
4931
4931
|
|
|
4932
4932
|
/**
|
|
@@ -7974,7 +7974,7 @@ class AuditApi {
|
|
|
7974
7974
|
/**
|
|
7975
7975
|
* Audit service.
|
|
7976
7976
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7977
|
-
* @version 168.
|
|
7977
|
+
* @version 168.2.0
|
|
7978
7978
|
*/
|
|
7979
7979
|
|
|
7980
7980
|
/**
|
|
@@ -8145,7 +8145,7 @@ class AuthorizationApi {
|
|
|
8145
8145
|
/**
|
|
8146
8146
|
* Authorization service.
|
|
8147
8147
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8148
|
-
* @version 168.
|
|
8148
|
+
* @version 168.2.0
|
|
8149
8149
|
*/
|
|
8150
8150
|
|
|
8151
8151
|
/**
|
|
@@ -8386,6 +8386,7 @@ class AuthorizationApi {
|
|
|
8386
8386
|
* @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
|
|
8387
8387
|
* @param {Object} opts Optional parameters
|
|
8388
8388
|
* @param {String} opts.name Search term to filter by division name
|
|
8389
|
+
* @deprecated
|
|
8389
8390
|
*/
|
|
8390
8391
|
getAuthorizationDivisionspermittedMe(permission, opts) {
|
|
8391
8392
|
opts = opts || {};
|
|
@@ -8447,6 +8448,7 @@ class AuthorizationApi {
|
|
|
8447
8448
|
* @param {Object} opts Optional parameters
|
|
8448
8449
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
8449
8450
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
8451
|
+
* @deprecated
|
|
8450
8452
|
*/
|
|
8451
8453
|
getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
|
|
8452
8454
|
opts = opts || {};
|
|
@@ -9374,7 +9376,7 @@ class BillingApi {
|
|
|
9374
9376
|
/**
|
|
9375
9377
|
* Billing service.
|
|
9376
9378
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9377
|
-
* @version 168.
|
|
9379
|
+
* @version 168.2.0
|
|
9378
9380
|
*/
|
|
9379
9381
|
|
|
9380
9382
|
/**
|
|
@@ -9454,7 +9456,7 @@ class CarrierServicesApi {
|
|
|
9454
9456
|
/**
|
|
9455
9457
|
* CarrierServices service.
|
|
9456
9458
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
9457
|
-
* @version 168.
|
|
9459
|
+
* @version 168.2.0
|
|
9458
9460
|
*/
|
|
9459
9461
|
|
|
9460
9462
|
/**
|
|
@@ -9524,7 +9526,7 @@ class ChatApi {
|
|
|
9524
9526
|
/**
|
|
9525
9527
|
* Chat service.
|
|
9526
9528
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9527
|
-
* @version 168.
|
|
9529
|
+
* @version 168.2.0
|
|
9528
9530
|
*/
|
|
9529
9531
|
|
|
9530
9532
|
/**
|
|
@@ -9542,6 +9544,7 @@ class ChatApi {
|
|
|
9542
9544
|
/**
|
|
9543
9545
|
* Get Chat Settings.
|
|
9544
9546
|
* This route is deprecated, please use /chats/settings instead
|
|
9547
|
+
* @deprecated
|
|
9545
9548
|
*/
|
|
9546
9549
|
getChatSettings() {
|
|
9547
9550
|
|
|
@@ -9583,6 +9586,7 @@ class ChatApi {
|
|
|
9583
9586
|
* Patch Chat Settings.
|
|
9584
9587
|
* This route is deprecated, please use /chats/settings instead
|
|
9585
9588
|
* @param {Object} body Chat
|
|
9589
|
+
* @deprecated
|
|
9586
9590
|
*/
|
|
9587
9591
|
patchChatSettings(body) {
|
|
9588
9592
|
// verify the required parameter 'body' is set
|
|
@@ -9633,6 +9637,7 @@ class ChatApi {
|
|
|
9633
9637
|
* Update Chat Settings.
|
|
9634
9638
|
* This route is deprecated, please use /chats/settings instead
|
|
9635
9639
|
* @param {Object} body Chat
|
|
9640
|
+
* @deprecated
|
|
9636
9641
|
*/
|
|
9637
9642
|
putChatSettings(body) {
|
|
9638
9643
|
// verify the required parameter 'body' is set
|
|
@@ -9685,7 +9690,7 @@ class CoachingApi {
|
|
|
9685
9690
|
/**
|
|
9686
9691
|
* Coaching service.
|
|
9687
9692
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9688
|
-
* @version 168.
|
|
9693
|
+
* @version 168.2.0
|
|
9689
9694
|
*/
|
|
9690
9695
|
|
|
9691
9696
|
/**
|
|
@@ -10262,7 +10267,7 @@ class ContentManagementApi {
|
|
|
10262
10267
|
/**
|
|
10263
10268
|
* ContentManagement service.
|
|
10264
10269
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
10265
|
-
* @version 168.
|
|
10270
|
+
* @version 168.2.0
|
|
10266
10271
|
*/
|
|
10267
10272
|
|
|
10268
10273
|
/**
|
|
@@ -10549,6 +10554,7 @@ class ContentManagementApi {
|
|
|
10549
10554
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
10550
10555
|
* @param {String} opts.sortBy name or dateCreated
|
|
10551
10556
|
* @param {String} opts.sortOrder ascending or descending (default to ascending)
|
|
10557
|
+
* @deprecated
|
|
10552
10558
|
*/
|
|
10553
10559
|
getContentmanagementDocuments(workspaceId, opts) {
|
|
10554
10560
|
opts = opts || {};
|
|
@@ -11402,7 +11408,7 @@ class ConversationsApi {
|
|
|
11402
11408
|
/**
|
|
11403
11409
|
* Conversations service.
|
|
11404
11410
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11405
|
-
* @version 168.
|
|
11411
|
+
* @version 168.2.0
|
|
11406
11412
|
*/
|
|
11407
11413
|
|
|
11408
11414
|
/**
|
|
@@ -17493,7 +17499,7 @@ class DataExtensionsApi {
|
|
|
17493
17499
|
/**
|
|
17494
17500
|
* DataExtensions service.
|
|
17495
17501
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
17496
|
-
* @version 168.
|
|
17502
|
+
* @version 168.2.0
|
|
17497
17503
|
*/
|
|
17498
17504
|
|
|
17499
17505
|
/**
|
|
@@ -17579,7 +17585,7 @@ class DownloadsApi {
|
|
|
17579
17585
|
/**
|
|
17580
17586
|
* Downloads service.
|
|
17581
17587
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
17582
|
-
* @version 168.
|
|
17588
|
+
* @version 168.2.0
|
|
17583
17589
|
*/
|
|
17584
17590
|
|
|
17585
17591
|
/**
|
|
@@ -17631,7 +17637,7 @@ class EventsApi {
|
|
|
17631
17637
|
/**
|
|
17632
17638
|
* Events service.
|
|
17633
17639
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
17634
|
-
* @version 168.
|
|
17640
|
+
* @version 168.2.0
|
|
17635
17641
|
*/
|
|
17636
17642
|
|
|
17637
17643
|
/**
|
|
@@ -17727,7 +17733,7 @@ class ExternalContactsApi {
|
|
|
17727
17733
|
/**
|
|
17728
17734
|
* ExternalContacts service.
|
|
17729
17735
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
17730
|
-
* @version 168.
|
|
17736
|
+
* @version 168.2.0
|
|
17731
17737
|
*/
|
|
17732
17738
|
|
|
17733
17739
|
/**
|
|
@@ -19685,7 +19691,7 @@ class FaxApi {
|
|
|
19685
19691
|
/**
|
|
19686
19692
|
* Fax service.
|
|
19687
19693
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
19688
|
-
* @version 168.
|
|
19694
|
+
* @version 168.2.0
|
|
19689
19695
|
*/
|
|
19690
19696
|
|
|
19691
19697
|
/**
|
|
@@ -19856,7 +19862,7 @@ class FlowsApi {
|
|
|
19856
19862
|
/**
|
|
19857
19863
|
* Flows service.
|
|
19858
19864
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
19859
|
-
* @version 168.
|
|
19865
|
+
* @version 168.2.0
|
|
19860
19866
|
*/
|
|
19861
19867
|
|
|
19862
19868
|
/**
|
|
@@ -19927,7 +19933,7 @@ class GamificationApi {
|
|
|
19927
19933
|
/**
|
|
19928
19934
|
* Gamification service.
|
|
19929
19935
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
19930
|
-
* @version 168.
|
|
19936
|
+
* @version 168.2.0
|
|
19931
19937
|
*/
|
|
19932
19938
|
|
|
19933
19939
|
/**
|
|
@@ -22013,7 +22019,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
22013
22019
|
/**
|
|
22014
22020
|
* GeneralDataProtectionRegulation service.
|
|
22015
22021
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
22016
|
-
* @version 168.
|
|
22022
|
+
* @version 168.2.0
|
|
22017
22023
|
*/
|
|
22018
22024
|
|
|
22019
22025
|
/**
|
|
@@ -22143,7 +22149,7 @@ class GeolocationApi {
|
|
|
22143
22149
|
/**
|
|
22144
22150
|
* Geolocation service.
|
|
22145
22151
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
22146
|
-
* @version 168.
|
|
22152
|
+
* @version 168.2.0
|
|
22147
22153
|
*/
|
|
22148
22154
|
|
|
22149
22155
|
/**
|
|
@@ -22274,7 +22280,7 @@ class GreetingsApi {
|
|
|
22274
22280
|
/**
|
|
22275
22281
|
* Greetings service.
|
|
22276
22282
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
22277
|
-
* @version 168.
|
|
22283
|
+
* @version 168.2.0
|
|
22278
22284
|
*/
|
|
22279
22285
|
|
|
22280
22286
|
/**
|
|
@@ -22729,7 +22735,7 @@ class GroupsApi {
|
|
|
22729
22735
|
/**
|
|
22730
22736
|
* Groups service.
|
|
22731
22737
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
22732
|
-
* @version 168.
|
|
22738
|
+
* @version 168.2.0
|
|
22733
22739
|
*/
|
|
22734
22740
|
|
|
22735
22741
|
/**
|
|
@@ -22803,6 +22809,7 @@ class GroupsApi {
|
|
|
22803
22809
|
* Fetch field config for an entity type
|
|
22804
22810
|
*
|
|
22805
22811
|
* @param {Object} type Field type
|
|
22812
|
+
* @deprecated
|
|
22806
22813
|
*/
|
|
22807
22814
|
getFieldconfig(type) {
|
|
22808
22815
|
// verify the required parameter 'type' is set
|
|
@@ -22912,6 +22919,7 @@ class GroupsApi {
|
|
|
22912
22919
|
* @param {String} groupId groupId
|
|
22913
22920
|
* @param {Object} opts Optional parameters
|
|
22914
22921
|
* @param {String} opts.fields Comma separated fields to return. Allowable values can be found by querying /api/v2/fieldconfig?type=group and using the key for the elements returned by the fieldList
|
|
22922
|
+
* @deprecated
|
|
22915
22923
|
*/
|
|
22916
22924
|
getGroupProfile(groupId, opts) {
|
|
22917
22925
|
opts = opts || {};
|
|
@@ -23001,6 +23009,7 @@ class GroupsApi {
|
|
|
23001
23009
|
* @param {Array.<String>} opts.id id
|
|
23002
23010
|
* @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
|
|
23003
23011
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
23012
|
+
* @deprecated
|
|
23004
23013
|
*/
|
|
23005
23014
|
getProfilesGroups(opts) {
|
|
23006
23015
|
opts = opts || {};
|
|
@@ -23135,7 +23144,7 @@ class IdentityProviderApi {
|
|
|
23135
23144
|
/**
|
|
23136
23145
|
* IdentityProvider service.
|
|
23137
23146
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
23138
|
-
* @version 168.
|
|
23147
|
+
* @version 168.2.0
|
|
23139
23148
|
*/
|
|
23140
23149
|
|
|
23141
23150
|
/**
|
|
@@ -23891,7 +23900,7 @@ class InfrastructureAsCodeApi {
|
|
|
23891
23900
|
/**
|
|
23892
23901
|
* InfrastructureAsCode service.
|
|
23893
23902
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
23894
|
-
* @version 168.
|
|
23903
|
+
* @version 168.2.0
|
|
23895
23904
|
*/
|
|
23896
23905
|
|
|
23897
23906
|
/**
|
|
@@ -24058,7 +24067,7 @@ class IntegrationsApi {
|
|
|
24058
24067
|
/**
|
|
24059
24068
|
* Integrations service.
|
|
24060
24069
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
24061
|
-
* @version 168.
|
|
24070
|
+
* @version 168.2.0
|
|
24062
24071
|
*/
|
|
24063
24072
|
|
|
24064
24073
|
/**
|
|
@@ -25658,7 +25667,7 @@ class JourneyApi {
|
|
|
25658
25667
|
/**
|
|
25659
25668
|
* Journey service.
|
|
25660
25669
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
25661
|
-
* @version 168.
|
|
25670
|
+
* @version 168.2.0
|
|
25662
25671
|
*/
|
|
25663
25672
|
|
|
25664
25673
|
/**
|
|
@@ -26538,7 +26547,7 @@ class KnowledgeApi {
|
|
|
26538
26547
|
/**
|
|
26539
26548
|
* Knowledge service.
|
|
26540
26549
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
26541
|
-
* @version 168.
|
|
26550
|
+
* @version 168.2.0
|
|
26542
26551
|
*/
|
|
26543
26552
|
|
|
26544
26553
|
/**
|
|
@@ -28970,7 +28979,7 @@ class LanguageUnderstandingApi {
|
|
|
28970
28979
|
/**
|
|
28971
28980
|
* LanguageUnderstanding service.
|
|
28972
28981
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
28973
|
-
* @version 168.
|
|
28982
|
+
* @version 168.2.0
|
|
28974
28983
|
*/
|
|
28975
28984
|
|
|
28976
28985
|
/**
|
|
@@ -29983,7 +29992,7 @@ class LanguagesApi {
|
|
|
29983
29992
|
/**
|
|
29984
29993
|
* Languages service.
|
|
29985
29994
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
29986
|
-
* @version 168.
|
|
29995
|
+
* @version 168.2.0
|
|
29987
29996
|
*/
|
|
29988
29997
|
|
|
29989
29998
|
/**
|
|
@@ -30002,6 +30011,7 @@ class LanguagesApi {
|
|
|
30002
30011
|
* Delete Language (Deprecated)
|
|
30003
30012
|
* This endpoint is deprecated. Please see the Routing API (DELETE /api/v2/routing/languages/{languageId})
|
|
30004
30013
|
* @param {String} languageId Language ID
|
|
30014
|
+
* @deprecated
|
|
30005
30015
|
*/
|
|
30006
30016
|
deleteLanguage(languageId) {
|
|
30007
30017
|
// verify the required parameter 'languageId' is set
|
|
@@ -30027,6 +30037,7 @@ class LanguagesApi {
|
|
|
30027
30037
|
* Get Language (Deprecated)
|
|
30028
30038
|
* This endpoint is deprecated. Please see the Routing API (GET /api/v2/routing/languages/{languageId})
|
|
30029
30039
|
* @param {String} languageId Language ID
|
|
30040
|
+
* @deprecated
|
|
30030
30041
|
*/
|
|
30031
30042
|
getLanguage(languageId) {
|
|
30032
30043
|
// verify the required parameter 'languageId' is set
|
|
@@ -30056,6 +30067,7 @@ class LanguagesApi {
|
|
|
30056
30067
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
30057
30068
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
30058
30069
|
* @param {String} opts.name Name
|
|
30070
|
+
* @deprecated
|
|
30059
30071
|
*/
|
|
30060
30072
|
getLanguages(opts) {
|
|
30061
30073
|
opts = opts || {};
|
|
@@ -30174,6 +30186,7 @@ class LanguagesApi {
|
|
|
30174
30186
|
* Create Language (Deprecated)
|
|
30175
30187
|
* This endpoint is deprecated. Please see the Routing API. (POST /api/v2/routing/languages
|
|
30176
30188
|
* @param {Object} body Language
|
|
30189
|
+
* @deprecated
|
|
30177
30190
|
*/
|
|
30178
30191
|
postLanguages(body) {
|
|
30179
30192
|
// verify the required parameter 'body' is set
|
|
@@ -30201,7 +30214,7 @@ class LearningApi {
|
|
|
30201
30214
|
/**
|
|
30202
30215
|
* Learning service.
|
|
30203
30216
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
30204
|
-
* @version 168.
|
|
30217
|
+
* @version 168.2.0
|
|
30205
30218
|
*/
|
|
30206
30219
|
|
|
30207
30220
|
/**
|
|
@@ -31016,7 +31029,7 @@ class LicenseApi {
|
|
|
31016
31029
|
/**
|
|
31017
31030
|
* License service.
|
|
31018
31031
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
31019
|
-
* @version 168.
|
|
31032
|
+
* @version 168.2.0
|
|
31020
31033
|
*/
|
|
31021
31034
|
|
|
31022
31035
|
/**
|
|
@@ -31254,7 +31267,7 @@ class LocationsApi {
|
|
|
31254
31267
|
/**
|
|
31255
31268
|
* Locations service.
|
|
31256
31269
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
31257
|
-
* @version 168.
|
|
31270
|
+
* @version 168.2.0
|
|
31258
31271
|
*/
|
|
31259
31272
|
|
|
31260
31273
|
/**
|
|
@@ -31490,7 +31503,7 @@ class MessagingApi {
|
|
|
31490
31503
|
/**
|
|
31491
31504
|
* Messaging service.
|
|
31492
31505
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
31493
|
-
* @version 168.
|
|
31506
|
+
* @version 168.2.0
|
|
31494
31507
|
*/
|
|
31495
31508
|
|
|
31496
31509
|
/**
|
|
@@ -31641,7 +31654,7 @@ class MobileDevicesApi {
|
|
|
31641
31654
|
/**
|
|
31642
31655
|
* MobileDevices service.
|
|
31643
31656
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
31644
|
-
* @version 168.
|
|
31657
|
+
* @version 168.2.0
|
|
31645
31658
|
*/
|
|
31646
31659
|
|
|
31647
31660
|
/**
|
|
@@ -31792,7 +31805,7 @@ class NotificationsApi {
|
|
|
31792
31805
|
/**
|
|
31793
31806
|
* Notifications service.
|
|
31794
31807
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
31795
|
-
* @version 168.
|
|
31808
|
+
* @version 168.2.0
|
|
31796
31809
|
*/
|
|
31797
31810
|
|
|
31798
31811
|
/**
|
|
@@ -32025,7 +32038,7 @@ class OAuthApi {
|
|
|
32025
32038
|
/**
|
|
32026
32039
|
* OAuth service.
|
|
32027
32040
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
32028
|
-
* @version 168.
|
|
32041
|
+
* @version 168.2.0
|
|
32029
32042
|
*/
|
|
32030
32043
|
|
|
32031
32044
|
/**
|
|
@@ -32391,7 +32404,7 @@ class ObjectsApi {
|
|
|
32391
32404
|
/**
|
|
32392
32405
|
* Objects service.
|
|
32393
32406
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
32394
|
-
* @version 168.
|
|
32407
|
+
* @version 168.2.0
|
|
32395
32408
|
*/
|
|
32396
32409
|
|
|
32397
32410
|
/**
|
|
@@ -32662,7 +32675,7 @@ class OrganizationApi {
|
|
|
32662
32675
|
/**
|
|
32663
32676
|
* Organization service.
|
|
32664
32677
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
32665
|
-
* @version 168.
|
|
32678
|
+
* @version 168.2.0
|
|
32666
32679
|
*/
|
|
32667
32680
|
|
|
32668
32681
|
/**
|
|
@@ -32681,6 +32694,7 @@ class OrganizationApi {
|
|
|
32681
32694
|
* Fetch field config for an entity type
|
|
32682
32695
|
*
|
|
32683
32696
|
* @param {Object} type Field type
|
|
32697
|
+
* @deprecated
|
|
32684
32698
|
*/
|
|
32685
32699
|
getFieldconfig(type) {
|
|
32686
32700
|
// verify the required parameter 'type' is set
|
|
@@ -32913,6 +32927,7 @@ class OrganizationApi {
|
|
|
32913
32927
|
/**
|
|
32914
32928
|
* Use PUT /api/v2/organizations/embeddedintegration instead
|
|
32915
32929
|
*
|
|
32930
|
+
* @deprecated
|
|
32916
32931
|
*/
|
|
32917
32932
|
getOrganizationsWhitelist() {
|
|
32918
32933
|
|
|
@@ -33038,6 +33053,7 @@ class OrganizationApi {
|
|
|
33038
33053
|
* Use PUT /api/v2/organizations/embeddedintegration instead
|
|
33039
33054
|
*
|
|
33040
33055
|
* @param {Object} body Whitelist settings
|
|
33056
|
+
* @deprecated
|
|
33041
33057
|
*/
|
|
33042
33058
|
putOrganizationsWhitelist(body) {
|
|
33043
33059
|
// verify the required parameter 'body' is set
|
|
@@ -33065,7 +33081,7 @@ class OrganizationAuthorizationApi {
|
|
|
33065
33081
|
/**
|
|
33066
33082
|
* OrganizationAuthorization service.
|
|
33067
33083
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
33068
|
-
* @version 168.
|
|
33084
|
+
* @version 168.2.0
|
|
33069
33085
|
*/
|
|
33070
33086
|
|
|
33071
33087
|
/**
|
|
@@ -34360,7 +34376,7 @@ class OutboundApi {
|
|
|
34360
34376
|
/**
|
|
34361
34377
|
* Outbound service.
|
|
34362
34378
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
34363
|
-
* @version 168.
|
|
34379
|
+
* @version 168.2.0
|
|
34364
34380
|
*/
|
|
34365
34381
|
|
|
34366
34382
|
/**
|
|
@@ -36845,6 +36861,7 @@ class OutboundApi {
|
|
|
36845
36861
|
* This endpoint is deprecated and may have unexpected results. Please use "/conversations/{conversationId}/participants/{participantId}/callbacks instead."
|
|
36846
36862
|
* @param {String} campaignId Campaign ID
|
|
36847
36863
|
* @param {Object} body ContactCallbackRequest
|
|
36864
|
+
* @deprecated
|
|
36848
36865
|
*/
|
|
36849
36866
|
postOutboundCampaignCallbackSchedule(campaignId, body) {
|
|
36850
36867
|
// verify the required parameter 'campaignId' is set
|
|
@@ -37981,7 +37998,7 @@ class PresenceApi {
|
|
|
37981
37998
|
/**
|
|
37982
37999
|
* Presence service.
|
|
37983
38000
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
37984
|
-
* @version 168.
|
|
38001
|
+
* @version 168.2.0
|
|
37985
38002
|
*/
|
|
37986
38003
|
|
|
37987
38004
|
/**
|
|
@@ -38532,7 +38549,7 @@ class ProcessAutomationApi {
|
|
|
38532
38549
|
/**
|
|
38533
38550
|
* ProcessAutomation service.
|
|
38534
38551
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
38535
|
-
* @version 168.
|
|
38552
|
+
* @version 168.2.0
|
|
38536
38553
|
*/
|
|
38537
38554
|
|
|
38538
38555
|
/**
|
|
@@ -38771,7 +38788,7 @@ class QualityApi {
|
|
|
38771
38788
|
/**
|
|
38772
38789
|
* Quality service.
|
|
38773
38790
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
38774
|
-
* @version 168.
|
|
38791
|
+
* @version 168.2.0
|
|
38775
38792
|
*/
|
|
38776
38793
|
|
|
38777
38794
|
/**
|
|
@@ -38854,6 +38871,7 @@ class QualityApi {
|
|
|
38854
38871
|
* Delete an evaluation form.
|
|
38855
38872
|
*
|
|
38856
38873
|
* @param {String} formId Form ID
|
|
38874
|
+
* @deprecated
|
|
38857
38875
|
*/
|
|
38858
38876
|
deleteQualityForm(formId) {
|
|
38859
38877
|
// verify the required parameter 'formId' is set
|
|
@@ -39222,6 +39240,7 @@ class QualityApi {
|
|
|
39222
39240
|
* Get an evaluation form
|
|
39223
39241
|
*
|
|
39224
39242
|
* @param {String} formId Form ID
|
|
39243
|
+
* @deprecated
|
|
39225
39244
|
*/
|
|
39226
39245
|
getQualityForm(formId) {
|
|
39227
39246
|
// verify the required parameter 'formId' is set
|
|
@@ -39250,6 +39269,7 @@ class QualityApi {
|
|
|
39250
39269
|
* @param {Object} opts Optional parameters
|
|
39251
39270
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
39252
39271
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
39272
|
+
* @deprecated
|
|
39253
39273
|
*/
|
|
39254
39274
|
getQualityFormVersions(formId, opts) {
|
|
39255
39275
|
opts = opts || {};
|
|
@@ -39285,6 +39305,7 @@ class QualityApi {
|
|
|
39285
39305
|
* @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
|
|
39286
39306
|
* @param {String} opts.name Name
|
|
39287
39307
|
* @param {String} opts.sortOrder Order to sort results, either asc or desc
|
|
39308
|
+
* @deprecated
|
|
39288
39309
|
*/
|
|
39289
39310
|
getQualityForms(opts) {
|
|
39290
39311
|
opts = opts || {};
|
|
@@ -39560,6 +39581,7 @@ class QualityApi {
|
|
|
39560
39581
|
* Get the published evaluation forms.
|
|
39561
39582
|
*
|
|
39562
39583
|
* @param {String} formId Form ID
|
|
39584
|
+
* @deprecated
|
|
39563
39585
|
*/
|
|
39564
39586
|
getQualityPublishedform(formId) {
|
|
39565
39587
|
// verify the required parameter 'formId' is set
|
|
@@ -39589,6 +39611,7 @@ class QualityApi {
|
|
|
39589
39611
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
39590
39612
|
* @param {String} opts.name Name
|
|
39591
39613
|
* @param {Boolean} opts.onlyLatestPerContext onlyLatestPerContext (default to false)
|
|
39614
|
+
* @deprecated
|
|
39592
39615
|
*/
|
|
39593
39616
|
getQualityPublishedforms(opts) {
|
|
39594
39617
|
opts = opts || {};
|
|
@@ -39984,6 +40007,7 @@ class QualityApi {
|
|
|
39984
40007
|
* Create an evaluation form.
|
|
39985
40008
|
*
|
|
39986
40009
|
* @param {Object} body Evaluation form
|
|
40010
|
+
* @deprecated
|
|
39987
40011
|
*/
|
|
39988
40012
|
postQualityForms(body) {
|
|
39989
40013
|
// verify the required parameter 'body' is set
|
|
@@ -40059,6 +40083,7 @@ class QualityApi {
|
|
|
40059
40083
|
* Publish an evaluation form.
|
|
40060
40084
|
*
|
|
40061
40085
|
* @param {Object} body Publish request containing id of form to publish
|
|
40086
|
+
* @deprecated
|
|
40062
40087
|
*/
|
|
40063
40088
|
postQualityPublishedforms(body) {
|
|
40064
40089
|
// verify the required parameter 'body' is set
|
|
@@ -40229,6 +40254,7 @@ class QualityApi {
|
|
|
40229
40254
|
*
|
|
40230
40255
|
* @param {String} formId Form ID
|
|
40231
40256
|
* @param {Object} body Evaluation form
|
|
40257
|
+
* @deprecated
|
|
40232
40258
|
*/
|
|
40233
40259
|
putQualityForm(formId, body) {
|
|
40234
40260
|
// verify the required parameter 'formId' is set
|
|
@@ -40350,7 +40376,7 @@ class RecordingApi {
|
|
|
40350
40376
|
/**
|
|
40351
40377
|
* Recording service.
|
|
40352
40378
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
40353
|
-
* @version 168.
|
|
40379
|
+
* @version 168.2.0
|
|
40354
40380
|
*/
|
|
40355
40381
|
|
|
40356
40382
|
/**
|
|
@@ -41987,7 +42013,7 @@ class ResponseManagementApi {
|
|
|
41987
42013
|
/**
|
|
41988
42014
|
* ResponseManagement service.
|
|
41989
42015
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
41990
|
-
* @version 168.
|
|
42016
|
+
* @version 168.2.0
|
|
41991
42017
|
*/
|
|
41992
42018
|
|
|
41993
42019
|
/**
|
|
@@ -42472,7 +42498,7 @@ class RoutingApi {
|
|
|
42472
42498
|
/**
|
|
42473
42499
|
* Routing service.
|
|
42474
42500
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
42475
|
-
* @version 168.
|
|
42501
|
+
* @version 168.2.0
|
|
42476
42502
|
*/
|
|
42477
42503
|
|
|
42478
42504
|
/**
|
|
@@ -42706,6 +42732,7 @@ class RoutingApi {
|
|
|
42706
42732
|
*
|
|
42707
42733
|
* @param {String} queueId Queue ID
|
|
42708
42734
|
* @param {String} memberId Member ID
|
|
42735
|
+
* @deprecated
|
|
42709
42736
|
*/
|
|
42710
42737
|
deleteRoutingQueueUser(queueId, memberId) {
|
|
42711
42738
|
// verify the required parameter 'queueId' is set
|
|
@@ -43797,6 +43824,7 @@ class RoutingApi {
|
|
|
43797
43824
|
* @param {Array.<String>} opts.languages Filter by language
|
|
43798
43825
|
* @param {Array.<String>} opts.routingStatus Filter by routing status
|
|
43799
43826
|
* @param {Array.<String>} opts.presence Filter by presence
|
|
43827
|
+
* @deprecated
|
|
43800
43828
|
*/
|
|
43801
43829
|
getRoutingQueueUsers(queueId, opts) {
|
|
43802
43830
|
opts = opts || {};
|
|
@@ -44754,6 +44782,7 @@ class RoutingApi {
|
|
|
44754
44782
|
* @param {String} queueId Queue ID
|
|
44755
44783
|
* @param {String} memberId Member ID
|
|
44756
44784
|
* @param {Object} body Queue Member
|
|
44785
|
+
* @deprecated
|
|
44757
44786
|
*/
|
|
44758
44787
|
patchRoutingQueueUser(queueId, memberId, body) {
|
|
44759
44788
|
// verify the required parameter 'queueId' is set
|
|
@@ -44788,6 +44817,7 @@ class RoutingApi {
|
|
|
44788
44817
|
*
|
|
44789
44818
|
* @param {String} queueId Queue ID
|
|
44790
44819
|
* @param {Array.<Object>} body Queue Members
|
|
44820
|
+
* @deprecated
|
|
44791
44821
|
*/
|
|
44792
44822
|
patchRoutingQueueUsers(queueId, body) {
|
|
44793
44823
|
// verify the required parameter 'queueId' is set
|
|
@@ -45329,6 +45359,7 @@ class RoutingApi {
|
|
|
45329
45359
|
* @param {Array.<Object>} body Queue Members
|
|
45330
45360
|
* @param {Object} opts Optional parameters
|
|
45331
45361
|
* @param {Boolean} opts._delete True to delete queue members (default to false)
|
|
45362
|
+
* @deprecated
|
|
45332
45363
|
*/
|
|
45333
45364
|
postRoutingQueueUsers(queueId, body, opts) {
|
|
45334
45365
|
opts = opts || {};
|
|
@@ -45981,7 +46012,7 @@ class SCIMApi {
|
|
|
45981
46012
|
/**
|
|
45982
46013
|
* SCIM service.
|
|
45983
46014
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
45984
|
-
* @version 168.
|
|
46015
|
+
* @version 168.2.0
|
|
45985
46016
|
*/
|
|
45986
46017
|
|
|
45987
46018
|
/**
|
|
@@ -46858,7 +46889,7 @@ class ScriptsApi {
|
|
|
46858
46889
|
/**
|
|
46859
46890
|
* Scripts service.
|
|
46860
46891
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
46861
|
-
* @version 168.
|
|
46892
|
+
* @version 168.2.0
|
|
46862
46893
|
*/
|
|
46863
46894
|
|
|
46864
46895
|
/**
|
|
@@ -47277,7 +47308,7 @@ class SearchApi {
|
|
|
47277
47308
|
/**
|
|
47278
47309
|
* Search service.
|
|
47279
47310
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
47280
|
-
* @version 168.
|
|
47311
|
+
* @version 168.2.0
|
|
47281
47312
|
*/
|
|
47282
47313
|
|
|
47283
47314
|
/**
|
|
@@ -47887,7 +47918,7 @@ class SpeechTextAnalyticsApi {
|
|
|
47887
47918
|
/**
|
|
47888
47919
|
* SpeechTextAnalytics service.
|
|
47889
47920
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
47890
|
-
* @version 168.
|
|
47921
|
+
* @version 168.2.0
|
|
47891
47922
|
*/
|
|
47892
47923
|
|
|
47893
47924
|
/**
|
|
@@ -48816,7 +48847,7 @@ class StationsApi {
|
|
|
48816
48847
|
/**
|
|
48817
48848
|
* Stations service.
|
|
48818
48849
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
48819
|
-
* @version 168.
|
|
48850
|
+
* @version 168.2.0
|
|
48820
48851
|
*/
|
|
48821
48852
|
|
|
48822
48853
|
/**
|
|
@@ -48918,7 +48949,7 @@ class SuggestApi {
|
|
|
48918
48949
|
/**
|
|
48919
48950
|
* Suggest service.
|
|
48920
48951
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
48921
|
-
* @version 168.
|
|
48952
|
+
* @version 168.2.0
|
|
48922
48953
|
*/
|
|
48923
48954
|
|
|
48924
48955
|
/**
|
|
@@ -49057,7 +49088,7 @@ class TeamsApi {
|
|
|
49057
49088
|
/**
|
|
49058
49089
|
* Teams service.
|
|
49059
49090
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
49060
|
-
* @version 168.
|
|
49091
|
+
* @version 168.2.0
|
|
49061
49092
|
*/
|
|
49062
49093
|
|
|
49063
49094
|
/**
|
|
@@ -49328,7 +49359,7 @@ class TelephonyApi {
|
|
|
49328
49359
|
/**
|
|
49329
49360
|
* Telephony service.
|
|
49330
49361
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
49331
|
-
* @version 168.
|
|
49362
|
+
* @version 168.2.0
|
|
49332
49363
|
*/
|
|
49333
49364
|
|
|
49334
49365
|
/**
|
|
@@ -49456,7 +49487,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
49456
49487
|
/**
|
|
49457
49488
|
* TelephonyProvidersEdge service.
|
|
49458
49489
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
49459
|
-
* @version 168.
|
|
49490
|
+
* @version 168.2.0
|
|
49460
49491
|
*/
|
|
49461
49492
|
|
|
49462
49493
|
/**
|
|
@@ -50850,6 +50881,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
50850
50881
|
* Get outbound route
|
|
50851
50882
|
* This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
|
|
50852
50883
|
* @param {String} outboundRouteId Outbound route ID
|
|
50884
|
+
* @deprecated
|
|
50853
50885
|
*/
|
|
50854
50886
|
getTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
|
|
50855
50887
|
// verify the required parameter 'outboundRouteId' is set
|
|
@@ -52656,7 +52688,7 @@ class TextbotsApi {
|
|
|
52656
52688
|
/**
|
|
52657
52689
|
* Textbots service.
|
|
52658
52690
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
52659
|
-
* @version 168.
|
|
52691
|
+
* @version 168.2.0
|
|
52660
52692
|
*/
|
|
52661
52693
|
|
|
52662
52694
|
/**
|
|
@@ -52784,7 +52816,7 @@ class TokensApi {
|
|
|
52784
52816
|
/**
|
|
52785
52817
|
* Tokens service.
|
|
52786
52818
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
52787
|
-
* @version 168.
|
|
52819
|
+
* @version 168.2.0
|
|
52788
52820
|
*/
|
|
52789
52821
|
|
|
52790
52822
|
/**
|
|
@@ -52890,7 +52922,7 @@ class UploadsApi {
|
|
|
52890
52922
|
/**
|
|
52891
52923
|
* Uploads service.
|
|
52892
52924
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
52893
|
-
* @version 168.
|
|
52925
|
+
* @version 168.2.0
|
|
52894
52926
|
*/
|
|
52895
52927
|
|
|
52896
52928
|
/**
|
|
@@ -53066,7 +53098,7 @@ class UsageApi {
|
|
|
53066
53098
|
/**
|
|
53067
53099
|
* Usage service.
|
|
53068
53100
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
53069
|
-
* @version 168.
|
|
53101
|
+
* @version 168.2.0
|
|
53070
53102
|
*/
|
|
53071
53103
|
|
|
53072
53104
|
/**
|
|
@@ -53226,7 +53258,7 @@ class UserRecordingsApi {
|
|
|
53226
53258
|
/**
|
|
53227
53259
|
* UserRecordings service.
|
|
53228
53260
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
53229
|
-
* @version 168.
|
|
53261
|
+
* @version 168.2.0
|
|
53230
53262
|
*/
|
|
53231
53263
|
|
|
53232
53264
|
/**
|
|
@@ -53411,7 +53443,7 @@ class UsersApi {
|
|
|
53411
53443
|
/**
|
|
53412
53444
|
* Users service.
|
|
53413
53445
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
53414
|
-
* @version 168.
|
|
53446
|
+
* @version 168.2.0
|
|
53415
53447
|
*/
|
|
53416
53448
|
|
|
53417
53449
|
/**
|
|
@@ -53727,6 +53759,7 @@ class UsersApi {
|
|
|
53727
53759
|
* @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
|
|
53728
53760
|
* @param {Object} opts Optional parameters
|
|
53729
53761
|
* @param {String} opts.name Search term to filter by division name
|
|
53762
|
+
* @deprecated
|
|
53730
53763
|
*/
|
|
53731
53764
|
getAuthorizationDivisionspermittedMe(permission, opts) {
|
|
53732
53765
|
opts = opts || {};
|
|
@@ -53788,6 +53821,7 @@ class UsersApi {
|
|
|
53788
53821
|
* @param {Object} opts Optional parameters
|
|
53789
53822
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
53790
53823
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
53824
|
+
* @deprecated
|
|
53791
53825
|
*/
|
|
53792
53826
|
getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
|
|
53793
53827
|
opts = opts || {};
|
|
@@ -53864,6 +53898,7 @@ class UsersApi {
|
|
|
53864
53898
|
* Fetch field config for an entity type
|
|
53865
53899
|
*
|
|
53866
53900
|
* @param {Object} type Field type
|
|
53901
|
+
* @deprecated
|
|
53867
53902
|
*/
|
|
53868
53903
|
getFieldconfig(type) {
|
|
53869
53904
|
// verify the required parameter 'type' is set
|
|
@@ -53896,6 +53931,7 @@ class UsersApi {
|
|
|
53896
53931
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
53897
53932
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
53898
53933
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an expand.
|
|
53934
|
+
* @deprecated
|
|
53899
53935
|
*/
|
|
53900
53936
|
getProfilesUsers(opts) {
|
|
53901
53937
|
opts = opts || {};
|
|
@@ -54063,6 +54099,7 @@ class UsersApi {
|
|
|
54063
54099
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
54064
54100
|
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
54065
54101
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
54102
|
+
* @deprecated
|
|
54066
54103
|
*/
|
|
54067
54104
|
getUserFavorites(userId, opts) {
|
|
54068
54105
|
opts = opts || {};
|
|
@@ -54148,6 +54185,7 @@ class UsersApi {
|
|
|
54148
54185
|
* @param {Object} opts Optional parameters
|
|
54149
54186
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
54150
54187
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
|
|
54188
|
+
* @deprecated
|
|
54151
54189
|
*/
|
|
54152
54190
|
getUserProfile(userId, opts) {
|
|
54153
54191
|
opts = opts || {};
|
|
@@ -55801,7 +55839,7 @@ class UtilitiesApi {
|
|
|
55801
55839
|
/**
|
|
55802
55840
|
* Utilities service.
|
|
55803
55841
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
55804
|
-
* @version 168.
|
|
55842
|
+
* @version 168.2.0
|
|
55805
55843
|
*/
|
|
55806
55844
|
|
|
55807
55845
|
/**
|
|
@@ -55912,7 +55950,7 @@ class VoicemailApi {
|
|
|
55912
55950
|
/**
|
|
55913
55951
|
* Voicemail service.
|
|
55914
55952
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
55915
|
-
* @version 168.
|
|
55953
|
+
* @version 168.2.0
|
|
55916
55954
|
*/
|
|
55917
55955
|
|
|
55918
55956
|
/**
|
|
@@ -56579,7 +56617,7 @@ class WebChatApi {
|
|
|
56579
56617
|
/**
|
|
56580
56618
|
* WebChat service.
|
|
56581
56619
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
56582
|
-
* @version 168.
|
|
56620
|
+
* @version 168.2.0
|
|
56583
56621
|
*/
|
|
56584
56622
|
|
|
56585
56623
|
/**
|
|
@@ -56598,6 +56636,7 @@ class WebChatApi {
|
|
|
56598
56636
|
* Delete a WebChat deployment
|
|
56599
56637
|
*
|
|
56600
56638
|
* @param {String} deploymentId Deployment Id
|
|
56639
|
+
* @deprecated
|
|
56601
56640
|
*/
|
|
56602
56641
|
deleteWebchatDeployment(deploymentId) {
|
|
56603
56642
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -56673,6 +56712,7 @@ class WebChatApi {
|
|
|
56673
56712
|
* Get a WebChat deployment
|
|
56674
56713
|
*
|
|
56675
56714
|
* @param {String} deploymentId Deployment Id
|
|
56715
|
+
* @deprecated
|
|
56676
56716
|
*/
|
|
56677
56717
|
getWebchatDeployment(deploymentId) {
|
|
56678
56718
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -56697,6 +56737,7 @@ class WebChatApi {
|
|
|
56697
56737
|
/**
|
|
56698
56738
|
* List WebChat deployments
|
|
56699
56739
|
*
|
|
56740
|
+
* @deprecated
|
|
56700
56741
|
*/
|
|
56701
56742
|
getWebchatDeployments() {
|
|
56702
56743
|
|
|
@@ -56951,6 +56992,7 @@ class WebChatApi {
|
|
|
56951
56992
|
* Create WebChat deployment
|
|
56952
56993
|
*
|
|
56953
56994
|
* @param {Object} body Deployment
|
|
56995
|
+
* @deprecated
|
|
56954
56996
|
*/
|
|
56955
56997
|
postWebchatDeployments(body) {
|
|
56956
56998
|
// verify the required parameter 'body' is set
|
|
@@ -57067,6 +57109,7 @@ class WebChatApi {
|
|
|
57067
57109
|
*
|
|
57068
57110
|
* @param {String} deploymentId Deployment Id
|
|
57069
57111
|
* @param {Object} body Deployment
|
|
57112
|
+
* @deprecated
|
|
57070
57113
|
*/
|
|
57071
57114
|
putWebchatDeployment(deploymentId, body) {
|
|
57072
57115
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -57123,7 +57166,7 @@ class WebDeploymentsApi {
|
|
|
57123
57166
|
/**
|
|
57124
57167
|
* WebDeployments service.
|
|
57125
57168
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
57126
|
-
* @version 168.
|
|
57169
|
+
* @version 168.2.0
|
|
57127
57170
|
*/
|
|
57128
57171
|
|
|
57129
57172
|
/**
|
|
@@ -57645,7 +57688,7 @@ class WebMessagingApi {
|
|
|
57645
57688
|
/**
|
|
57646
57689
|
* WebMessaging service.
|
|
57647
57690
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
57648
|
-
* @version 168.
|
|
57691
|
+
* @version 168.2.0
|
|
57649
57692
|
*/
|
|
57650
57693
|
|
|
57651
57694
|
/**
|
|
@@ -57691,7 +57734,7 @@ class WidgetsApi {
|
|
|
57691
57734
|
/**
|
|
57692
57735
|
* Widgets service.
|
|
57693
57736
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
57694
|
-
* @version 168.
|
|
57737
|
+
* @version 168.2.0
|
|
57695
57738
|
*/
|
|
57696
57739
|
|
|
57697
57740
|
/**
|
|
@@ -57837,7 +57880,7 @@ class WorkforceManagementApi {
|
|
|
57837
57880
|
/**
|
|
57838
57881
|
* WorkforceManagement service.
|
|
57839
57882
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
57840
|
-
* @version 168.
|
|
57883
|
+
* @version 168.2.0
|
|
57841
57884
|
*/
|
|
57842
57885
|
|
|
57843
57886
|
/**
|
|
@@ -58462,7 +58505,7 @@ class WorkforceManagementApi {
|
|
|
58462
58505
|
* Expanding "settings" will retrieve all settings. All other expands will retrieve only the requested settings field(s).
|
|
58463
58506
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
58464
58507
|
* @param {Object} opts Optional parameters
|
|
58465
|
-
* @param {Array.<String>} opts.expand
|
|
58508
|
+
* @param {Array.<String>} opts.expand Include to access additional data on the business unit
|
|
58466
58509
|
*/
|
|
58467
58510
|
getWorkforcemanagementBusinessunit(businessUnitId, opts) {
|
|
58468
58511
|
opts = opts || {};
|
|
@@ -59001,7 +59044,7 @@ class WorkforceManagementApi {
|
|
|
59001
59044
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
59002
59045
|
* @param {String} forecastId The ID of the forecast
|
|
59003
59046
|
* @param {Object} opts Optional parameters
|
|
59004
|
-
* @param {Array.<String>} opts.expand
|
|
59047
|
+
* @param {Array.<String>} opts.expand Include to access additional data on the forecast
|
|
59005
59048
|
*/
|
|
59006
59049
|
getWorkforcemanagementBusinessunitWeekShorttermforecast(businessUnitId, weekDateId, forecastId, opts) {
|
|
59007
59050
|
opts = opts || {};
|
|
@@ -59379,6 +59422,7 @@ class WorkforceManagementApi {
|
|
|
59379
59422
|
* Get activity codes
|
|
59380
59423
|
*
|
|
59381
59424
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59425
|
+
* @deprecated
|
|
59382
59426
|
*/
|
|
59383
59427
|
getWorkforcemanagementManagementunitActivitycodes(managementUnitId) {
|
|
59384
59428
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -59791,6 +59835,7 @@ class WorkforceManagementApi {
|
|
|
59791
59835
|
* @param {Object} opts Optional parameters
|
|
59792
59836
|
* @param {Object} opts.expand Which fields, if any, to expand
|
|
59793
59837
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
59838
|
+
* @deprecated
|
|
59794
59839
|
*/
|
|
59795
59840
|
getWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId, opts) {
|
|
59796
59841
|
opts = opts || {};
|
|
@@ -59831,6 +59876,7 @@ class WorkforceManagementApi {
|
|
|
59831
59876
|
* @param {Boolean} opts.includeOnlyPublished Return only published schedules
|
|
59832
59877
|
* @param {String} opts.earliestWeekDate The start date of the earliest week to query in yyyy-MM-dd format
|
|
59833
59878
|
* @param {String} opts.latestWeekDate The start date of the latest week to query in yyyy-MM-dd format
|
|
59879
|
+
* @deprecated
|
|
59834
59880
|
*/
|
|
59835
59881
|
getWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId, opts) {
|
|
59836
59882
|
opts = opts || {};
|
|
@@ -59990,7 +60036,7 @@ class WorkforceManagementApi {
|
|
|
59990
60036
|
* "expand=details" is deprecated
|
|
59991
60037
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59992
60038
|
* @param {Object} opts Optional parameters
|
|
59993
|
-
* @param {Array.<String>} opts.expand
|
|
60039
|
+
* @param {Array.<String>} opts.expand Include to access additional data on the work plans
|
|
59994
60040
|
*/
|
|
59995
60041
|
getWorkforcemanagementManagementunitWorkplans(managementUnitId, opts) {
|
|
59996
60042
|
opts = opts || {};
|
|
@@ -61498,7 +61544,7 @@ class WorkforceManagementApi {
|
|
|
61498
61544
|
*
|
|
61499
61545
|
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
61500
61546
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
61501
|
-
* @param {Object} body
|
|
61547
|
+
* @param {Object} body body
|
|
61502
61548
|
* @param {Object} opts Optional parameters
|
|
61503
61549
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
61504
61550
|
*/
|
|
@@ -61537,7 +61583,7 @@ class WorkforceManagementApi {
|
|
|
61537
61583
|
* Call after uploading the forecast data to the url supplied by the /import/uploadurl route
|
|
61538
61584
|
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
61539
61585
|
* @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
61540
|
-
* @param {Object} body
|
|
61586
|
+
* @param {Object} body body
|
|
61541
61587
|
*/
|
|
61542
61588
|
postWorkforcemanagementBusinessunitWeekShorttermforecastsImport(businessUnitId, weekDateId, body) {
|
|
61543
61589
|
// verify the required parameter 'businessUnitId' is set
|
|
@@ -61789,6 +61835,7 @@ class WorkforceManagementApi {
|
|
|
61789
61835
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61790
61836
|
* @param {Object} opts Optional parameters
|
|
61791
61837
|
* @param {Object} opts.body body
|
|
61838
|
+
* @deprecated
|
|
61792
61839
|
*/
|
|
61793
61840
|
postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId, opts) {
|
|
61794
61841
|
opts = opts || {};
|
|
@@ -62449,6 +62496,7 @@ class WorkforceManagementApi {
|
|
|
62449
62496
|
*
|
|
62450
62497
|
* @param {Object} opts Optional parameters
|
|
62451
62498
|
* @param {Object} opts.body body
|
|
62499
|
+
* @deprecated
|
|
62452
62500
|
*/
|
|
62453
62501
|
postWorkforcemanagementSchedules(opts) {
|
|
62454
62502
|
opts = opts || {};
|
|
@@ -62468,6 +62516,64 @@ class WorkforceManagementApi {
|
|
|
62468
62516
|
);
|
|
62469
62517
|
}
|
|
62470
62518
|
|
|
62519
|
+
/**
|
|
62520
|
+
* Request a teams historical adherence report
|
|
62521
|
+
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
62522
|
+
* @param {String} teamId The ID of the team
|
|
62523
|
+
* @param {Object} opts Optional parameters
|
|
62524
|
+
* @param {Object} opts.body body
|
|
62525
|
+
*/
|
|
62526
|
+
postWorkforcemanagementTeamAdherenceHistorical(teamId, opts) {
|
|
62527
|
+
opts = opts || {};
|
|
62528
|
+
|
|
62529
|
+
// verify the required parameter 'teamId' is set
|
|
62530
|
+
if (teamId === undefined || teamId === null) {
|
|
62531
|
+
throw 'Missing the required parameter "teamId" when calling postWorkforcemanagementTeamAdherenceHistorical';
|
|
62532
|
+
}
|
|
62533
|
+
|
|
62534
|
+
return this.apiClient.callApi(
|
|
62535
|
+
'/api/v2/workforcemanagement/teams/{teamId}/adherence/historical',
|
|
62536
|
+
'POST',
|
|
62537
|
+
{ 'teamId': teamId },
|
|
62538
|
+
{ },
|
|
62539
|
+
{ },
|
|
62540
|
+
{ },
|
|
62541
|
+
opts['body'],
|
|
62542
|
+
['PureCloud OAuth'],
|
|
62543
|
+
['application/json'],
|
|
62544
|
+
['application/json']
|
|
62545
|
+
);
|
|
62546
|
+
}
|
|
62547
|
+
|
|
62548
|
+
/**
|
|
62549
|
+
* Request a historical shrinkage report
|
|
62550
|
+
* The maximum supported range for historical shrinkage queries is up to 32 days
|
|
62551
|
+
* @param {String} teamId The ID of the team
|
|
62552
|
+
* @param {Object} opts Optional parameters
|
|
62553
|
+
* @param {Object} opts.body body
|
|
62554
|
+
*/
|
|
62555
|
+
postWorkforcemanagementTeamShrinkageJobs(teamId, opts) {
|
|
62556
|
+
opts = opts || {};
|
|
62557
|
+
|
|
62558
|
+
// verify the required parameter 'teamId' is set
|
|
62559
|
+
if (teamId === undefined || teamId === null) {
|
|
62560
|
+
throw 'Missing the required parameter "teamId" when calling postWorkforcemanagementTeamShrinkageJobs';
|
|
62561
|
+
}
|
|
62562
|
+
|
|
62563
|
+
return this.apiClient.callApi(
|
|
62564
|
+
'/api/v2/workforcemanagement/teams/{teamId}/shrinkage/jobs',
|
|
62565
|
+
'POST',
|
|
62566
|
+
{ 'teamId': teamId },
|
|
62567
|
+
{ },
|
|
62568
|
+
{ },
|
|
62569
|
+
{ },
|
|
62570
|
+
opts['body'],
|
|
62571
|
+
['PureCloud OAuth'],
|
|
62572
|
+
['application/json'],
|
|
62573
|
+
['application/json']
|
|
62574
|
+
);
|
|
62575
|
+
}
|
|
62576
|
+
|
|
62471
62577
|
/**
|
|
62472
62578
|
* Queries available time off for the current user
|
|
62473
62579
|
*
|
|
@@ -62581,7 +62687,7 @@ class WorkforceManagementApi {
|
|
|
62581
62687
|
* </pre>
|
|
62582
62688
|
* </p>
|
|
62583
62689
|
* @module purecloud-platform-client-v2/index
|
|
62584
|
-
* @version 168.
|
|
62690
|
+
* @version 168.2.0
|
|
62585
62691
|
*/
|
|
62586
62692
|
class platformClient {
|
|
62587
62693
|
constructor() {
|