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
|
@@ -402,7 +402,7 @@ class Configuration {
|
|
|
402
402
|
|
|
403
403
|
/**
|
|
404
404
|
* @module purecloud-platform-client-v2/ApiClient
|
|
405
|
-
* @version 168.
|
|
405
|
+
* @version 168.2.0
|
|
406
406
|
*/
|
|
407
407
|
class ApiClient {
|
|
408
408
|
/**
|
|
@@ -1488,7 +1488,7 @@ class AlertingApi {
|
|
|
1488
1488
|
/**
|
|
1489
1489
|
* Alerting service.
|
|
1490
1490
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1491
|
-
* @version 168.
|
|
1491
|
+
* @version 168.2.0
|
|
1492
1492
|
*/
|
|
1493
1493
|
|
|
1494
1494
|
/**
|
|
@@ -1802,7 +1802,7 @@ class AnalyticsApi {
|
|
|
1802
1802
|
/**
|
|
1803
1803
|
* Analytics service.
|
|
1804
1804
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1805
|
-
* @version 168.
|
|
1805
|
+
* @version 168.2.0
|
|
1806
1806
|
*/
|
|
1807
1807
|
|
|
1808
1808
|
/**
|
|
@@ -3056,7 +3056,7 @@ class ArchitectApi {
|
|
|
3056
3056
|
/**
|
|
3057
3057
|
* Architect service.
|
|
3058
3058
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
3059
|
-
* @version 168.
|
|
3059
|
+
* @version 168.2.0
|
|
3060
3060
|
*/
|
|
3061
3061
|
|
|
3062
3062
|
/**
|
|
@@ -6104,7 +6104,7 @@ class AuditApi {
|
|
|
6104
6104
|
/**
|
|
6105
6105
|
* Audit service.
|
|
6106
6106
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6107
|
-
* @version 168.
|
|
6107
|
+
* @version 168.2.0
|
|
6108
6108
|
*/
|
|
6109
6109
|
|
|
6110
6110
|
/**
|
|
@@ -6275,7 +6275,7 @@ class AuthorizationApi {
|
|
|
6275
6275
|
/**
|
|
6276
6276
|
* Authorization service.
|
|
6277
6277
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6278
|
-
* @version 168.
|
|
6278
|
+
* @version 168.2.0
|
|
6279
6279
|
*/
|
|
6280
6280
|
|
|
6281
6281
|
/**
|
|
@@ -6516,6 +6516,7 @@ class AuthorizationApi {
|
|
|
6516
6516
|
* @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
|
|
6517
6517
|
* @param {Object} opts Optional parameters
|
|
6518
6518
|
* @param {String} opts.name Search term to filter by division name
|
|
6519
|
+
* @deprecated
|
|
6519
6520
|
*/
|
|
6520
6521
|
getAuthorizationDivisionspermittedMe(permission, opts) {
|
|
6521
6522
|
opts = opts || {};
|
|
@@ -6577,6 +6578,7 @@ class AuthorizationApi {
|
|
|
6577
6578
|
* @param {Object} opts Optional parameters
|
|
6578
6579
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
6579
6580
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
6581
|
+
* @deprecated
|
|
6580
6582
|
*/
|
|
6581
6583
|
getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
|
|
6582
6584
|
opts = opts || {};
|
|
@@ -7504,7 +7506,7 @@ class BillingApi {
|
|
|
7504
7506
|
/**
|
|
7505
7507
|
* Billing service.
|
|
7506
7508
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7507
|
-
* @version 168.
|
|
7509
|
+
* @version 168.2.0
|
|
7508
7510
|
*/
|
|
7509
7511
|
|
|
7510
7512
|
/**
|
|
@@ -7584,7 +7586,7 @@ class CarrierServicesApi {
|
|
|
7584
7586
|
/**
|
|
7585
7587
|
* CarrierServices service.
|
|
7586
7588
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
7587
|
-
* @version 168.
|
|
7589
|
+
* @version 168.2.0
|
|
7588
7590
|
*/
|
|
7589
7591
|
|
|
7590
7592
|
/**
|
|
@@ -7654,7 +7656,7 @@ class ChatApi {
|
|
|
7654
7656
|
/**
|
|
7655
7657
|
* Chat service.
|
|
7656
7658
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7657
|
-
* @version 168.
|
|
7659
|
+
* @version 168.2.0
|
|
7658
7660
|
*/
|
|
7659
7661
|
|
|
7660
7662
|
/**
|
|
@@ -7672,6 +7674,7 @@ class ChatApi {
|
|
|
7672
7674
|
/**
|
|
7673
7675
|
* Get Chat Settings.
|
|
7674
7676
|
* This route is deprecated, please use /chats/settings instead
|
|
7677
|
+
* @deprecated
|
|
7675
7678
|
*/
|
|
7676
7679
|
getChatSettings() {
|
|
7677
7680
|
|
|
@@ -7713,6 +7716,7 @@ class ChatApi {
|
|
|
7713
7716
|
* Patch Chat Settings.
|
|
7714
7717
|
* This route is deprecated, please use /chats/settings instead
|
|
7715
7718
|
* @param {Object} body Chat
|
|
7719
|
+
* @deprecated
|
|
7716
7720
|
*/
|
|
7717
7721
|
patchChatSettings(body) {
|
|
7718
7722
|
// verify the required parameter 'body' is set
|
|
@@ -7763,6 +7767,7 @@ class ChatApi {
|
|
|
7763
7767
|
* Update Chat Settings.
|
|
7764
7768
|
* This route is deprecated, please use /chats/settings instead
|
|
7765
7769
|
* @param {Object} body Chat
|
|
7770
|
+
* @deprecated
|
|
7766
7771
|
*/
|
|
7767
7772
|
putChatSettings(body) {
|
|
7768
7773
|
// verify the required parameter 'body' is set
|
|
@@ -7815,7 +7820,7 @@ class CoachingApi {
|
|
|
7815
7820
|
/**
|
|
7816
7821
|
* Coaching service.
|
|
7817
7822
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7818
|
-
* @version 168.
|
|
7823
|
+
* @version 168.2.0
|
|
7819
7824
|
*/
|
|
7820
7825
|
|
|
7821
7826
|
/**
|
|
@@ -8392,7 +8397,7 @@ class ContentManagementApi {
|
|
|
8392
8397
|
/**
|
|
8393
8398
|
* ContentManagement service.
|
|
8394
8399
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8395
|
-
* @version 168.
|
|
8400
|
+
* @version 168.2.0
|
|
8396
8401
|
*/
|
|
8397
8402
|
|
|
8398
8403
|
/**
|
|
@@ -8679,6 +8684,7 @@ class ContentManagementApi {
|
|
|
8679
8684
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
8680
8685
|
* @param {String} opts.sortBy name or dateCreated
|
|
8681
8686
|
* @param {String} opts.sortOrder ascending or descending (default to ascending)
|
|
8687
|
+
* @deprecated
|
|
8682
8688
|
*/
|
|
8683
8689
|
getContentmanagementDocuments(workspaceId, opts) {
|
|
8684
8690
|
opts = opts || {};
|
|
@@ -9532,7 +9538,7 @@ class ConversationsApi {
|
|
|
9532
9538
|
/**
|
|
9533
9539
|
* Conversations service.
|
|
9534
9540
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9535
|
-
* @version 168.
|
|
9541
|
+
* @version 168.2.0
|
|
9536
9542
|
*/
|
|
9537
9543
|
|
|
9538
9544
|
/**
|
|
@@ -15623,7 +15629,7 @@ class DataExtensionsApi {
|
|
|
15623
15629
|
/**
|
|
15624
15630
|
* DataExtensions service.
|
|
15625
15631
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
15626
|
-
* @version 168.
|
|
15632
|
+
* @version 168.2.0
|
|
15627
15633
|
*/
|
|
15628
15634
|
|
|
15629
15635
|
/**
|
|
@@ -15709,7 +15715,7 @@ class DownloadsApi {
|
|
|
15709
15715
|
/**
|
|
15710
15716
|
* Downloads service.
|
|
15711
15717
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
15712
|
-
* @version 168.
|
|
15718
|
+
* @version 168.2.0
|
|
15713
15719
|
*/
|
|
15714
15720
|
|
|
15715
15721
|
/**
|
|
@@ -15761,7 +15767,7 @@ class EventsApi {
|
|
|
15761
15767
|
/**
|
|
15762
15768
|
* Events service.
|
|
15763
15769
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
15764
|
-
* @version 168.
|
|
15770
|
+
* @version 168.2.0
|
|
15765
15771
|
*/
|
|
15766
15772
|
|
|
15767
15773
|
/**
|
|
@@ -15857,7 +15863,7 @@ class ExternalContactsApi {
|
|
|
15857
15863
|
/**
|
|
15858
15864
|
* ExternalContacts service.
|
|
15859
15865
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
15860
|
-
* @version 168.
|
|
15866
|
+
* @version 168.2.0
|
|
15861
15867
|
*/
|
|
15862
15868
|
|
|
15863
15869
|
/**
|
|
@@ -17815,7 +17821,7 @@ class FaxApi {
|
|
|
17815
17821
|
/**
|
|
17816
17822
|
* Fax service.
|
|
17817
17823
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
17818
|
-
* @version 168.
|
|
17824
|
+
* @version 168.2.0
|
|
17819
17825
|
*/
|
|
17820
17826
|
|
|
17821
17827
|
/**
|
|
@@ -17986,7 +17992,7 @@ class FlowsApi {
|
|
|
17986
17992
|
/**
|
|
17987
17993
|
* Flows service.
|
|
17988
17994
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
17989
|
-
* @version 168.
|
|
17995
|
+
* @version 168.2.0
|
|
17990
17996
|
*/
|
|
17991
17997
|
|
|
17992
17998
|
/**
|
|
@@ -18057,7 +18063,7 @@ class GamificationApi {
|
|
|
18057
18063
|
/**
|
|
18058
18064
|
* Gamification service.
|
|
18059
18065
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
18060
|
-
* @version 168.
|
|
18066
|
+
* @version 168.2.0
|
|
18061
18067
|
*/
|
|
18062
18068
|
|
|
18063
18069
|
/**
|
|
@@ -20143,7 +20149,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
20143
20149
|
/**
|
|
20144
20150
|
* GeneralDataProtectionRegulation service.
|
|
20145
20151
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
20146
|
-
* @version 168.
|
|
20152
|
+
* @version 168.2.0
|
|
20147
20153
|
*/
|
|
20148
20154
|
|
|
20149
20155
|
/**
|
|
@@ -20273,7 +20279,7 @@ class GeolocationApi {
|
|
|
20273
20279
|
/**
|
|
20274
20280
|
* Geolocation service.
|
|
20275
20281
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
20276
|
-
* @version 168.
|
|
20282
|
+
* @version 168.2.0
|
|
20277
20283
|
*/
|
|
20278
20284
|
|
|
20279
20285
|
/**
|
|
@@ -20404,7 +20410,7 @@ class GreetingsApi {
|
|
|
20404
20410
|
/**
|
|
20405
20411
|
* Greetings service.
|
|
20406
20412
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
20407
|
-
* @version 168.
|
|
20413
|
+
* @version 168.2.0
|
|
20408
20414
|
*/
|
|
20409
20415
|
|
|
20410
20416
|
/**
|
|
@@ -20859,7 +20865,7 @@ class GroupsApi {
|
|
|
20859
20865
|
/**
|
|
20860
20866
|
* Groups service.
|
|
20861
20867
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
20862
|
-
* @version 168.
|
|
20868
|
+
* @version 168.2.0
|
|
20863
20869
|
*/
|
|
20864
20870
|
|
|
20865
20871
|
/**
|
|
@@ -20933,6 +20939,7 @@ class GroupsApi {
|
|
|
20933
20939
|
* Fetch field config for an entity type
|
|
20934
20940
|
*
|
|
20935
20941
|
* @param {Object} type Field type
|
|
20942
|
+
* @deprecated
|
|
20936
20943
|
*/
|
|
20937
20944
|
getFieldconfig(type) {
|
|
20938
20945
|
// verify the required parameter 'type' is set
|
|
@@ -21042,6 +21049,7 @@ class GroupsApi {
|
|
|
21042
21049
|
* @param {String} groupId groupId
|
|
21043
21050
|
* @param {Object} opts Optional parameters
|
|
21044
21051
|
* @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
|
|
21052
|
+
* @deprecated
|
|
21045
21053
|
*/
|
|
21046
21054
|
getGroupProfile(groupId, opts) {
|
|
21047
21055
|
opts = opts || {};
|
|
@@ -21131,6 +21139,7 @@ class GroupsApi {
|
|
|
21131
21139
|
* @param {Array.<String>} opts.id id
|
|
21132
21140
|
* @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
|
|
21133
21141
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
21142
|
+
* @deprecated
|
|
21134
21143
|
*/
|
|
21135
21144
|
getProfilesGroups(opts) {
|
|
21136
21145
|
opts = opts || {};
|
|
@@ -21265,7 +21274,7 @@ class IdentityProviderApi {
|
|
|
21265
21274
|
/**
|
|
21266
21275
|
* IdentityProvider service.
|
|
21267
21276
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
21268
|
-
* @version 168.
|
|
21277
|
+
* @version 168.2.0
|
|
21269
21278
|
*/
|
|
21270
21279
|
|
|
21271
21280
|
/**
|
|
@@ -22021,7 +22030,7 @@ class InfrastructureAsCodeApi {
|
|
|
22021
22030
|
/**
|
|
22022
22031
|
* InfrastructureAsCode service.
|
|
22023
22032
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
22024
|
-
* @version 168.
|
|
22033
|
+
* @version 168.2.0
|
|
22025
22034
|
*/
|
|
22026
22035
|
|
|
22027
22036
|
/**
|
|
@@ -22188,7 +22197,7 @@ class IntegrationsApi {
|
|
|
22188
22197
|
/**
|
|
22189
22198
|
* Integrations service.
|
|
22190
22199
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
22191
|
-
* @version 168.
|
|
22200
|
+
* @version 168.2.0
|
|
22192
22201
|
*/
|
|
22193
22202
|
|
|
22194
22203
|
/**
|
|
@@ -23788,7 +23797,7 @@ class JourneyApi {
|
|
|
23788
23797
|
/**
|
|
23789
23798
|
* Journey service.
|
|
23790
23799
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
23791
|
-
* @version 168.
|
|
23800
|
+
* @version 168.2.0
|
|
23792
23801
|
*/
|
|
23793
23802
|
|
|
23794
23803
|
/**
|
|
@@ -24668,7 +24677,7 @@ class KnowledgeApi {
|
|
|
24668
24677
|
/**
|
|
24669
24678
|
* Knowledge service.
|
|
24670
24679
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
24671
|
-
* @version 168.
|
|
24680
|
+
* @version 168.2.0
|
|
24672
24681
|
*/
|
|
24673
24682
|
|
|
24674
24683
|
/**
|
|
@@ -27100,7 +27109,7 @@ class LanguageUnderstandingApi {
|
|
|
27100
27109
|
/**
|
|
27101
27110
|
* LanguageUnderstanding service.
|
|
27102
27111
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
27103
|
-
* @version 168.
|
|
27112
|
+
* @version 168.2.0
|
|
27104
27113
|
*/
|
|
27105
27114
|
|
|
27106
27115
|
/**
|
|
@@ -28113,7 +28122,7 @@ class LanguagesApi {
|
|
|
28113
28122
|
/**
|
|
28114
28123
|
* Languages service.
|
|
28115
28124
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
28116
|
-
* @version 168.
|
|
28125
|
+
* @version 168.2.0
|
|
28117
28126
|
*/
|
|
28118
28127
|
|
|
28119
28128
|
/**
|
|
@@ -28132,6 +28141,7 @@ class LanguagesApi {
|
|
|
28132
28141
|
* Delete Language (Deprecated)
|
|
28133
28142
|
* This endpoint is deprecated. Please see the Routing API (DELETE /api/v2/routing/languages/{languageId})
|
|
28134
28143
|
* @param {String} languageId Language ID
|
|
28144
|
+
* @deprecated
|
|
28135
28145
|
*/
|
|
28136
28146
|
deleteLanguage(languageId) {
|
|
28137
28147
|
// verify the required parameter 'languageId' is set
|
|
@@ -28157,6 +28167,7 @@ class LanguagesApi {
|
|
|
28157
28167
|
* Get Language (Deprecated)
|
|
28158
28168
|
* This endpoint is deprecated. Please see the Routing API (GET /api/v2/routing/languages/{languageId})
|
|
28159
28169
|
* @param {String} languageId Language ID
|
|
28170
|
+
* @deprecated
|
|
28160
28171
|
*/
|
|
28161
28172
|
getLanguage(languageId) {
|
|
28162
28173
|
// verify the required parameter 'languageId' is set
|
|
@@ -28186,6 +28197,7 @@ class LanguagesApi {
|
|
|
28186
28197
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
28187
28198
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
28188
28199
|
* @param {String} opts.name Name
|
|
28200
|
+
* @deprecated
|
|
28189
28201
|
*/
|
|
28190
28202
|
getLanguages(opts) {
|
|
28191
28203
|
opts = opts || {};
|
|
@@ -28304,6 +28316,7 @@ class LanguagesApi {
|
|
|
28304
28316
|
* Create Language (Deprecated)
|
|
28305
28317
|
* This endpoint is deprecated. Please see the Routing API. (POST /api/v2/routing/languages
|
|
28306
28318
|
* @param {Object} body Language
|
|
28319
|
+
* @deprecated
|
|
28307
28320
|
*/
|
|
28308
28321
|
postLanguages(body) {
|
|
28309
28322
|
// verify the required parameter 'body' is set
|
|
@@ -28331,7 +28344,7 @@ class LearningApi {
|
|
|
28331
28344
|
/**
|
|
28332
28345
|
* Learning service.
|
|
28333
28346
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
28334
|
-
* @version 168.
|
|
28347
|
+
* @version 168.2.0
|
|
28335
28348
|
*/
|
|
28336
28349
|
|
|
28337
28350
|
/**
|
|
@@ -29146,7 +29159,7 @@ class LicenseApi {
|
|
|
29146
29159
|
/**
|
|
29147
29160
|
* License service.
|
|
29148
29161
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
29149
|
-
* @version 168.
|
|
29162
|
+
* @version 168.2.0
|
|
29150
29163
|
*/
|
|
29151
29164
|
|
|
29152
29165
|
/**
|
|
@@ -29384,7 +29397,7 @@ class LocationsApi {
|
|
|
29384
29397
|
/**
|
|
29385
29398
|
* Locations service.
|
|
29386
29399
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
29387
|
-
* @version 168.
|
|
29400
|
+
* @version 168.2.0
|
|
29388
29401
|
*/
|
|
29389
29402
|
|
|
29390
29403
|
/**
|
|
@@ -29620,7 +29633,7 @@ class MessagingApi {
|
|
|
29620
29633
|
/**
|
|
29621
29634
|
* Messaging service.
|
|
29622
29635
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
29623
|
-
* @version 168.
|
|
29636
|
+
* @version 168.2.0
|
|
29624
29637
|
*/
|
|
29625
29638
|
|
|
29626
29639
|
/**
|
|
@@ -29771,7 +29784,7 @@ class MobileDevicesApi {
|
|
|
29771
29784
|
/**
|
|
29772
29785
|
* MobileDevices service.
|
|
29773
29786
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
29774
|
-
* @version 168.
|
|
29787
|
+
* @version 168.2.0
|
|
29775
29788
|
*/
|
|
29776
29789
|
|
|
29777
29790
|
/**
|
|
@@ -29922,7 +29935,7 @@ class NotificationsApi {
|
|
|
29922
29935
|
/**
|
|
29923
29936
|
* Notifications service.
|
|
29924
29937
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
29925
|
-
* @version 168.
|
|
29938
|
+
* @version 168.2.0
|
|
29926
29939
|
*/
|
|
29927
29940
|
|
|
29928
29941
|
/**
|
|
@@ -30155,7 +30168,7 @@ class OAuthApi {
|
|
|
30155
30168
|
/**
|
|
30156
30169
|
* OAuth service.
|
|
30157
30170
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
30158
|
-
* @version 168.
|
|
30171
|
+
* @version 168.2.0
|
|
30159
30172
|
*/
|
|
30160
30173
|
|
|
30161
30174
|
/**
|
|
@@ -30521,7 +30534,7 @@ class ObjectsApi {
|
|
|
30521
30534
|
/**
|
|
30522
30535
|
* Objects service.
|
|
30523
30536
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
30524
|
-
* @version 168.
|
|
30537
|
+
* @version 168.2.0
|
|
30525
30538
|
*/
|
|
30526
30539
|
|
|
30527
30540
|
/**
|
|
@@ -30792,7 +30805,7 @@ class OrganizationApi {
|
|
|
30792
30805
|
/**
|
|
30793
30806
|
* Organization service.
|
|
30794
30807
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
30795
|
-
* @version 168.
|
|
30808
|
+
* @version 168.2.0
|
|
30796
30809
|
*/
|
|
30797
30810
|
|
|
30798
30811
|
/**
|
|
@@ -30811,6 +30824,7 @@ class OrganizationApi {
|
|
|
30811
30824
|
* Fetch field config for an entity type
|
|
30812
30825
|
*
|
|
30813
30826
|
* @param {Object} type Field type
|
|
30827
|
+
* @deprecated
|
|
30814
30828
|
*/
|
|
30815
30829
|
getFieldconfig(type) {
|
|
30816
30830
|
// verify the required parameter 'type' is set
|
|
@@ -31043,6 +31057,7 @@ class OrganizationApi {
|
|
|
31043
31057
|
/**
|
|
31044
31058
|
* Use PUT /api/v2/organizations/embeddedintegration instead
|
|
31045
31059
|
*
|
|
31060
|
+
* @deprecated
|
|
31046
31061
|
*/
|
|
31047
31062
|
getOrganizationsWhitelist() {
|
|
31048
31063
|
|
|
@@ -31168,6 +31183,7 @@ class OrganizationApi {
|
|
|
31168
31183
|
* Use PUT /api/v2/organizations/embeddedintegration instead
|
|
31169
31184
|
*
|
|
31170
31185
|
* @param {Object} body Whitelist settings
|
|
31186
|
+
* @deprecated
|
|
31171
31187
|
*/
|
|
31172
31188
|
putOrganizationsWhitelist(body) {
|
|
31173
31189
|
// verify the required parameter 'body' is set
|
|
@@ -31195,7 +31211,7 @@ class OrganizationAuthorizationApi {
|
|
|
31195
31211
|
/**
|
|
31196
31212
|
* OrganizationAuthorization service.
|
|
31197
31213
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
31198
|
-
* @version 168.
|
|
31214
|
+
* @version 168.2.0
|
|
31199
31215
|
*/
|
|
31200
31216
|
|
|
31201
31217
|
/**
|
|
@@ -32490,7 +32506,7 @@ class OutboundApi {
|
|
|
32490
32506
|
/**
|
|
32491
32507
|
* Outbound service.
|
|
32492
32508
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
32493
|
-
* @version 168.
|
|
32509
|
+
* @version 168.2.0
|
|
32494
32510
|
*/
|
|
32495
32511
|
|
|
32496
32512
|
/**
|
|
@@ -34975,6 +34991,7 @@ class OutboundApi {
|
|
|
34975
34991
|
* This endpoint is deprecated and may have unexpected results. Please use "/conversations/{conversationId}/participants/{participantId}/callbacks instead."
|
|
34976
34992
|
* @param {String} campaignId Campaign ID
|
|
34977
34993
|
* @param {Object} body ContactCallbackRequest
|
|
34994
|
+
* @deprecated
|
|
34978
34995
|
*/
|
|
34979
34996
|
postOutboundCampaignCallbackSchedule(campaignId, body) {
|
|
34980
34997
|
// verify the required parameter 'campaignId' is set
|
|
@@ -36111,7 +36128,7 @@ class PresenceApi {
|
|
|
36111
36128
|
/**
|
|
36112
36129
|
* Presence service.
|
|
36113
36130
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
36114
|
-
* @version 168.
|
|
36131
|
+
* @version 168.2.0
|
|
36115
36132
|
*/
|
|
36116
36133
|
|
|
36117
36134
|
/**
|
|
@@ -36662,7 +36679,7 @@ class ProcessAutomationApi {
|
|
|
36662
36679
|
/**
|
|
36663
36680
|
* ProcessAutomation service.
|
|
36664
36681
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
36665
|
-
* @version 168.
|
|
36682
|
+
* @version 168.2.0
|
|
36666
36683
|
*/
|
|
36667
36684
|
|
|
36668
36685
|
/**
|
|
@@ -36901,7 +36918,7 @@ class QualityApi {
|
|
|
36901
36918
|
/**
|
|
36902
36919
|
* Quality service.
|
|
36903
36920
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
36904
|
-
* @version 168.
|
|
36921
|
+
* @version 168.2.0
|
|
36905
36922
|
*/
|
|
36906
36923
|
|
|
36907
36924
|
/**
|
|
@@ -36984,6 +37001,7 @@ class QualityApi {
|
|
|
36984
37001
|
* Delete an evaluation form.
|
|
36985
37002
|
*
|
|
36986
37003
|
* @param {String} formId Form ID
|
|
37004
|
+
* @deprecated
|
|
36987
37005
|
*/
|
|
36988
37006
|
deleteQualityForm(formId) {
|
|
36989
37007
|
// verify the required parameter 'formId' is set
|
|
@@ -37352,6 +37370,7 @@ class QualityApi {
|
|
|
37352
37370
|
* Get an evaluation form
|
|
37353
37371
|
*
|
|
37354
37372
|
* @param {String} formId Form ID
|
|
37373
|
+
* @deprecated
|
|
37355
37374
|
*/
|
|
37356
37375
|
getQualityForm(formId) {
|
|
37357
37376
|
// verify the required parameter 'formId' is set
|
|
@@ -37380,6 +37399,7 @@ class QualityApi {
|
|
|
37380
37399
|
* @param {Object} opts Optional parameters
|
|
37381
37400
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
37382
37401
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
37402
|
+
* @deprecated
|
|
37383
37403
|
*/
|
|
37384
37404
|
getQualityFormVersions(formId, opts) {
|
|
37385
37405
|
opts = opts || {};
|
|
@@ -37415,6 +37435,7 @@ class QualityApi {
|
|
|
37415
37435
|
* @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
|
|
37416
37436
|
* @param {String} opts.name Name
|
|
37417
37437
|
* @param {String} opts.sortOrder Order to sort results, either asc or desc
|
|
37438
|
+
* @deprecated
|
|
37418
37439
|
*/
|
|
37419
37440
|
getQualityForms(opts) {
|
|
37420
37441
|
opts = opts || {};
|
|
@@ -37690,6 +37711,7 @@ class QualityApi {
|
|
|
37690
37711
|
* Get the published evaluation forms.
|
|
37691
37712
|
*
|
|
37692
37713
|
* @param {String} formId Form ID
|
|
37714
|
+
* @deprecated
|
|
37693
37715
|
*/
|
|
37694
37716
|
getQualityPublishedform(formId) {
|
|
37695
37717
|
// verify the required parameter 'formId' is set
|
|
@@ -37719,6 +37741,7 @@ class QualityApi {
|
|
|
37719
37741
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
37720
37742
|
* @param {String} opts.name Name
|
|
37721
37743
|
* @param {Boolean} opts.onlyLatestPerContext onlyLatestPerContext (default to false)
|
|
37744
|
+
* @deprecated
|
|
37722
37745
|
*/
|
|
37723
37746
|
getQualityPublishedforms(opts) {
|
|
37724
37747
|
opts = opts || {};
|
|
@@ -38114,6 +38137,7 @@ class QualityApi {
|
|
|
38114
38137
|
* Create an evaluation form.
|
|
38115
38138
|
*
|
|
38116
38139
|
* @param {Object} body Evaluation form
|
|
38140
|
+
* @deprecated
|
|
38117
38141
|
*/
|
|
38118
38142
|
postQualityForms(body) {
|
|
38119
38143
|
// verify the required parameter 'body' is set
|
|
@@ -38189,6 +38213,7 @@ class QualityApi {
|
|
|
38189
38213
|
* Publish an evaluation form.
|
|
38190
38214
|
*
|
|
38191
38215
|
* @param {Object} body Publish request containing id of form to publish
|
|
38216
|
+
* @deprecated
|
|
38192
38217
|
*/
|
|
38193
38218
|
postQualityPublishedforms(body) {
|
|
38194
38219
|
// verify the required parameter 'body' is set
|
|
@@ -38359,6 +38384,7 @@ class QualityApi {
|
|
|
38359
38384
|
*
|
|
38360
38385
|
* @param {String} formId Form ID
|
|
38361
38386
|
* @param {Object} body Evaluation form
|
|
38387
|
+
* @deprecated
|
|
38362
38388
|
*/
|
|
38363
38389
|
putQualityForm(formId, body) {
|
|
38364
38390
|
// verify the required parameter 'formId' is set
|
|
@@ -38480,7 +38506,7 @@ class RecordingApi {
|
|
|
38480
38506
|
/**
|
|
38481
38507
|
* Recording service.
|
|
38482
38508
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
38483
|
-
* @version 168.
|
|
38509
|
+
* @version 168.2.0
|
|
38484
38510
|
*/
|
|
38485
38511
|
|
|
38486
38512
|
/**
|
|
@@ -40117,7 +40143,7 @@ class ResponseManagementApi {
|
|
|
40117
40143
|
/**
|
|
40118
40144
|
* ResponseManagement service.
|
|
40119
40145
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
40120
|
-
* @version 168.
|
|
40146
|
+
* @version 168.2.0
|
|
40121
40147
|
*/
|
|
40122
40148
|
|
|
40123
40149
|
/**
|
|
@@ -40602,7 +40628,7 @@ class RoutingApi {
|
|
|
40602
40628
|
/**
|
|
40603
40629
|
* Routing service.
|
|
40604
40630
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
40605
|
-
* @version 168.
|
|
40631
|
+
* @version 168.2.0
|
|
40606
40632
|
*/
|
|
40607
40633
|
|
|
40608
40634
|
/**
|
|
@@ -40836,6 +40862,7 @@ class RoutingApi {
|
|
|
40836
40862
|
*
|
|
40837
40863
|
* @param {String} queueId Queue ID
|
|
40838
40864
|
* @param {String} memberId Member ID
|
|
40865
|
+
* @deprecated
|
|
40839
40866
|
*/
|
|
40840
40867
|
deleteRoutingQueueUser(queueId, memberId) {
|
|
40841
40868
|
// verify the required parameter 'queueId' is set
|
|
@@ -41927,6 +41954,7 @@ class RoutingApi {
|
|
|
41927
41954
|
* @param {Array.<String>} opts.languages Filter by language
|
|
41928
41955
|
* @param {Array.<String>} opts.routingStatus Filter by routing status
|
|
41929
41956
|
* @param {Array.<String>} opts.presence Filter by presence
|
|
41957
|
+
* @deprecated
|
|
41930
41958
|
*/
|
|
41931
41959
|
getRoutingQueueUsers(queueId, opts) {
|
|
41932
41960
|
opts = opts || {};
|
|
@@ -42884,6 +42912,7 @@ class RoutingApi {
|
|
|
42884
42912
|
* @param {String} queueId Queue ID
|
|
42885
42913
|
* @param {String} memberId Member ID
|
|
42886
42914
|
* @param {Object} body Queue Member
|
|
42915
|
+
* @deprecated
|
|
42887
42916
|
*/
|
|
42888
42917
|
patchRoutingQueueUser(queueId, memberId, body) {
|
|
42889
42918
|
// verify the required parameter 'queueId' is set
|
|
@@ -42918,6 +42947,7 @@ class RoutingApi {
|
|
|
42918
42947
|
*
|
|
42919
42948
|
* @param {String} queueId Queue ID
|
|
42920
42949
|
* @param {Array.<Object>} body Queue Members
|
|
42950
|
+
* @deprecated
|
|
42921
42951
|
*/
|
|
42922
42952
|
patchRoutingQueueUsers(queueId, body) {
|
|
42923
42953
|
// verify the required parameter 'queueId' is set
|
|
@@ -43459,6 +43489,7 @@ class RoutingApi {
|
|
|
43459
43489
|
* @param {Array.<Object>} body Queue Members
|
|
43460
43490
|
* @param {Object} opts Optional parameters
|
|
43461
43491
|
* @param {Boolean} opts._delete True to delete queue members (default to false)
|
|
43492
|
+
* @deprecated
|
|
43462
43493
|
*/
|
|
43463
43494
|
postRoutingQueueUsers(queueId, body, opts) {
|
|
43464
43495
|
opts = opts || {};
|
|
@@ -44111,7 +44142,7 @@ class SCIMApi {
|
|
|
44111
44142
|
/**
|
|
44112
44143
|
* SCIM service.
|
|
44113
44144
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
44114
|
-
* @version 168.
|
|
44145
|
+
* @version 168.2.0
|
|
44115
44146
|
*/
|
|
44116
44147
|
|
|
44117
44148
|
/**
|
|
@@ -44988,7 +45019,7 @@ class ScriptsApi {
|
|
|
44988
45019
|
/**
|
|
44989
45020
|
* Scripts service.
|
|
44990
45021
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
44991
|
-
* @version 168.
|
|
45022
|
+
* @version 168.2.0
|
|
44992
45023
|
*/
|
|
44993
45024
|
|
|
44994
45025
|
/**
|
|
@@ -45407,7 +45438,7 @@ class SearchApi {
|
|
|
45407
45438
|
/**
|
|
45408
45439
|
* Search service.
|
|
45409
45440
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
45410
|
-
* @version 168.
|
|
45441
|
+
* @version 168.2.0
|
|
45411
45442
|
*/
|
|
45412
45443
|
|
|
45413
45444
|
/**
|
|
@@ -46017,7 +46048,7 @@ class SpeechTextAnalyticsApi {
|
|
|
46017
46048
|
/**
|
|
46018
46049
|
* SpeechTextAnalytics service.
|
|
46019
46050
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
46020
|
-
* @version 168.
|
|
46051
|
+
* @version 168.2.0
|
|
46021
46052
|
*/
|
|
46022
46053
|
|
|
46023
46054
|
/**
|
|
@@ -46946,7 +46977,7 @@ class StationsApi {
|
|
|
46946
46977
|
/**
|
|
46947
46978
|
* Stations service.
|
|
46948
46979
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
46949
|
-
* @version 168.
|
|
46980
|
+
* @version 168.2.0
|
|
46950
46981
|
*/
|
|
46951
46982
|
|
|
46952
46983
|
/**
|
|
@@ -47048,7 +47079,7 @@ class SuggestApi {
|
|
|
47048
47079
|
/**
|
|
47049
47080
|
* Suggest service.
|
|
47050
47081
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
47051
|
-
* @version 168.
|
|
47082
|
+
* @version 168.2.0
|
|
47052
47083
|
*/
|
|
47053
47084
|
|
|
47054
47085
|
/**
|
|
@@ -47187,7 +47218,7 @@ class TeamsApi {
|
|
|
47187
47218
|
/**
|
|
47188
47219
|
* Teams service.
|
|
47189
47220
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
47190
|
-
* @version 168.
|
|
47221
|
+
* @version 168.2.0
|
|
47191
47222
|
*/
|
|
47192
47223
|
|
|
47193
47224
|
/**
|
|
@@ -47458,7 +47489,7 @@ class TelephonyApi {
|
|
|
47458
47489
|
/**
|
|
47459
47490
|
* Telephony service.
|
|
47460
47491
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
47461
|
-
* @version 168.
|
|
47492
|
+
* @version 168.2.0
|
|
47462
47493
|
*/
|
|
47463
47494
|
|
|
47464
47495
|
/**
|
|
@@ -47586,7 +47617,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
47586
47617
|
/**
|
|
47587
47618
|
* TelephonyProvidersEdge service.
|
|
47588
47619
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
47589
|
-
* @version 168.
|
|
47620
|
+
* @version 168.2.0
|
|
47590
47621
|
*/
|
|
47591
47622
|
|
|
47592
47623
|
/**
|
|
@@ -48980,6 +49011,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
48980
49011
|
* Get outbound route
|
|
48981
49012
|
* This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
|
|
48982
49013
|
* @param {String} outboundRouteId Outbound route ID
|
|
49014
|
+
* @deprecated
|
|
48983
49015
|
*/
|
|
48984
49016
|
getTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
|
|
48985
49017
|
// verify the required parameter 'outboundRouteId' is set
|
|
@@ -50786,7 +50818,7 @@ class TextbotsApi {
|
|
|
50786
50818
|
/**
|
|
50787
50819
|
* Textbots service.
|
|
50788
50820
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
50789
|
-
* @version 168.
|
|
50821
|
+
* @version 168.2.0
|
|
50790
50822
|
*/
|
|
50791
50823
|
|
|
50792
50824
|
/**
|
|
@@ -50914,7 +50946,7 @@ class TokensApi {
|
|
|
50914
50946
|
/**
|
|
50915
50947
|
* Tokens service.
|
|
50916
50948
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
50917
|
-
* @version 168.
|
|
50949
|
+
* @version 168.2.0
|
|
50918
50950
|
*/
|
|
50919
50951
|
|
|
50920
50952
|
/**
|
|
@@ -51020,7 +51052,7 @@ class UploadsApi {
|
|
|
51020
51052
|
/**
|
|
51021
51053
|
* Uploads service.
|
|
51022
51054
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
51023
|
-
* @version 168.
|
|
51055
|
+
* @version 168.2.0
|
|
51024
51056
|
*/
|
|
51025
51057
|
|
|
51026
51058
|
/**
|
|
@@ -51196,7 +51228,7 @@ class UsageApi {
|
|
|
51196
51228
|
/**
|
|
51197
51229
|
* Usage service.
|
|
51198
51230
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
51199
|
-
* @version 168.
|
|
51231
|
+
* @version 168.2.0
|
|
51200
51232
|
*/
|
|
51201
51233
|
|
|
51202
51234
|
/**
|
|
@@ -51356,7 +51388,7 @@ class UserRecordingsApi {
|
|
|
51356
51388
|
/**
|
|
51357
51389
|
* UserRecordings service.
|
|
51358
51390
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
51359
|
-
* @version 168.
|
|
51391
|
+
* @version 168.2.0
|
|
51360
51392
|
*/
|
|
51361
51393
|
|
|
51362
51394
|
/**
|
|
@@ -51541,7 +51573,7 @@ class UsersApi {
|
|
|
51541
51573
|
/**
|
|
51542
51574
|
* Users service.
|
|
51543
51575
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
51544
|
-
* @version 168.
|
|
51576
|
+
* @version 168.2.0
|
|
51545
51577
|
*/
|
|
51546
51578
|
|
|
51547
51579
|
/**
|
|
@@ -51857,6 +51889,7 @@ class UsersApi {
|
|
|
51857
51889
|
* @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
|
|
51858
51890
|
* @param {Object} opts Optional parameters
|
|
51859
51891
|
* @param {String} opts.name Search term to filter by division name
|
|
51892
|
+
* @deprecated
|
|
51860
51893
|
*/
|
|
51861
51894
|
getAuthorizationDivisionspermittedMe(permission, opts) {
|
|
51862
51895
|
opts = opts || {};
|
|
@@ -51918,6 +51951,7 @@ class UsersApi {
|
|
|
51918
51951
|
* @param {Object} opts Optional parameters
|
|
51919
51952
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
51920
51953
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
51954
|
+
* @deprecated
|
|
51921
51955
|
*/
|
|
51922
51956
|
getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
|
|
51923
51957
|
opts = opts || {};
|
|
@@ -51994,6 +52028,7 @@ class UsersApi {
|
|
|
51994
52028
|
* Fetch field config for an entity type
|
|
51995
52029
|
*
|
|
51996
52030
|
* @param {Object} type Field type
|
|
52031
|
+
* @deprecated
|
|
51997
52032
|
*/
|
|
51998
52033
|
getFieldconfig(type) {
|
|
51999
52034
|
// verify the required parameter 'type' is set
|
|
@@ -52026,6 +52061,7 @@ class UsersApi {
|
|
|
52026
52061
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
52027
52062
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
52028
52063
|
* @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.
|
|
52064
|
+
* @deprecated
|
|
52029
52065
|
*/
|
|
52030
52066
|
getProfilesUsers(opts) {
|
|
52031
52067
|
opts = opts || {};
|
|
@@ -52193,6 +52229,7 @@ class UsersApi {
|
|
|
52193
52229
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
52194
52230
|
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
52195
52231
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
52232
|
+
* @deprecated
|
|
52196
52233
|
*/
|
|
52197
52234
|
getUserFavorites(userId, opts) {
|
|
52198
52235
|
opts = opts || {};
|
|
@@ -52278,6 +52315,7 @@ class UsersApi {
|
|
|
52278
52315
|
* @param {Object} opts Optional parameters
|
|
52279
52316
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
52280
52317
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
|
|
52318
|
+
* @deprecated
|
|
52281
52319
|
*/
|
|
52282
52320
|
getUserProfile(userId, opts) {
|
|
52283
52321
|
opts = opts || {};
|
|
@@ -53931,7 +53969,7 @@ class UtilitiesApi {
|
|
|
53931
53969
|
/**
|
|
53932
53970
|
* Utilities service.
|
|
53933
53971
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
53934
|
-
* @version 168.
|
|
53972
|
+
* @version 168.2.0
|
|
53935
53973
|
*/
|
|
53936
53974
|
|
|
53937
53975
|
/**
|
|
@@ -54042,7 +54080,7 @@ class VoicemailApi {
|
|
|
54042
54080
|
/**
|
|
54043
54081
|
* Voicemail service.
|
|
54044
54082
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
54045
|
-
* @version 168.
|
|
54083
|
+
* @version 168.2.0
|
|
54046
54084
|
*/
|
|
54047
54085
|
|
|
54048
54086
|
/**
|
|
@@ -54709,7 +54747,7 @@ class WebChatApi {
|
|
|
54709
54747
|
/**
|
|
54710
54748
|
* WebChat service.
|
|
54711
54749
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
54712
|
-
* @version 168.
|
|
54750
|
+
* @version 168.2.0
|
|
54713
54751
|
*/
|
|
54714
54752
|
|
|
54715
54753
|
/**
|
|
@@ -54728,6 +54766,7 @@ class WebChatApi {
|
|
|
54728
54766
|
* Delete a WebChat deployment
|
|
54729
54767
|
*
|
|
54730
54768
|
* @param {String} deploymentId Deployment Id
|
|
54769
|
+
* @deprecated
|
|
54731
54770
|
*/
|
|
54732
54771
|
deleteWebchatDeployment(deploymentId) {
|
|
54733
54772
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -54803,6 +54842,7 @@ class WebChatApi {
|
|
|
54803
54842
|
* Get a WebChat deployment
|
|
54804
54843
|
*
|
|
54805
54844
|
* @param {String} deploymentId Deployment Id
|
|
54845
|
+
* @deprecated
|
|
54806
54846
|
*/
|
|
54807
54847
|
getWebchatDeployment(deploymentId) {
|
|
54808
54848
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -54827,6 +54867,7 @@ class WebChatApi {
|
|
|
54827
54867
|
/**
|
|
54828
54868
|
* List WebChat deployments
|
|
54829
54869
|
*
|
|
54870
|
+
* @deprecated
|
|
54830
54871
|
*/
|
|
54831
54872
|
getWebchatDeployments() {
|
|
54832
54873
|
|
|
@@ -55081,6 +55122,7 @@ class WebChatApi {
|
|
|
55081
55122
|
* Create WebChat deployment
|
|
55082
55123
|
*
|
|
55083
55124
|
* @param {Object} body Deployment
|
|
55125
|
+
* @deprecated
|
|
55084
55126
|
*/
|
|
55085
55127
|
postWebchatDeployments(body) {
|
|
55086
55128
|
// verify the required parameter 'body' is set
|
|
@@ -55197,6 +55239,7 @@ class WebChatApi {
|
|
|
55197
55239
|
*
|
|
55198
55240
|
* @param {String} deploymentId Deployment Id
|
|
55199
55241
|
* @param {Object} body Deployment
|
|
55242
|
+
* @deprecated
|
|
55200
55243
|
*/
|
|
55201
55244
|
putWebchatDeployment(deploymentId, body) {
|
|
55202
55245
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -55253,7 +55296,7 @@ class WebDeploymentsApi {
|
|
|
55253
55296
|
/**
|
|
55254
55297
|
* WebDeployments service.
|
|
55255
55298
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
55256
|
-
* @version 168.
|
|
55299
|
+
* @version 168.2.0
|
|
55257
55300
|
*/
|
|
55258
55301
|
|
|
55259
55302
|
/**
|
|
@@ -55775,7 +55818,7 @@ class WebMessagingApi {
|
|
|
55775
55818
|
/**
|
|
55776
55819
|
* WebMessaging service.
|
|
55777
55820
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
55778
|
-
* @version 168.
|
|
55821
|
+
* @version 168.2.0
|
|
55779
55822
|
*/
|
|
55780
55823
|
|
|
55781
55824
|
/**
|
|
@@ -55821,7 +55864,7 @@ class WidgetsApi {
|
|
|
55821
55864
|
/**
|
|
55822
55865
|
* Widgets service.
|
|
55823
55866
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
55824
|
-
* @version 168.
|
|
55867
|
+
* @version 168.2.0
|
|
55825
55868
|
*/
|
|
55826
55869
|
|
|
55827
55870
|
/**
|
|
@@ -55967,7 +56010,7 @@ class WorkforceManagementApi {
|
|
|
55967
56010
|
/**
|
|
55968
56011
|
* WorkforceManagement service.
|
|
55969
56012
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
55970
|
-
* @version 168.
|
|
56013
|
+
* @version 168.2.0
|
|
55971
56014
|
*/
|
|
55972
56015
|
|
|
55973
56016
|
/**
|
|
@@ -56592,7 +56635,7 @@ class WorkforceManagementApi {
|
|
|
56592
56635
|
* Expanding "settings" will retrieve all settings. All other expands will retrieve only the requested settings field(s).
|
|
56593
56636
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
56594
56637
|
* @param {Object} opts Optional parameters
|
|
56595
|
-
* @param {Array.<String>} opts.expand
|
|
56638
|
+
* @param {Array.<String>} opts.expand Include to access additional data on the business unit
|
|
56596
56639
|
*/
|
|
56597
56640
|
getWorkforcemanagementBusinessunit(businessUnitId, opts) {
|
|
56598
56641
|
opts = opts || {};
|
|
@@ -57131,7 +57174,7 @@ class WorkforceManagementApi {
|
|
|
57131
57174
|
* @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
|
|
57132
57175
|
* @param {String} forecastId The ID of the forecast
|
|
57133
57176
|
* @param {Object} opts Optional parameters
|
|
57134
|
-
* @param {Array.<String>} opts.expand
|
|
57177
|
+
* @param {Array.<String>} opts.expand Include to access additional data on the forecast
|
|
57135
57178
|
*/
|
|
57136
57179
|
getWorkforcemanagementBusinessunitWeekShorttermforecast(businessUnitId, weekDateId, forecastId, opts) {
|
|
57137
57180
|
opts = opts || {};
|
|
@@ -57509,6 +57552,7 @@ class WorkforceManagementApi {
|
|
|
57509
57552
|
* Get activity codes
|
|
57510
57553
|
*
|
|
57511
57554
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
57555
|
+
* @deprecated
|
|
57512
57556
|
*/
|
|
57513
57557
|
getWorkforcemanagementManagementunitActivitycodes(managementUnitId) {
|
|
57514
57558
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -57921,6 +57965,7 @@ class WorkforceManagementApi {
|
|
|
57921
57965
|
* @param {Object} opts Optional parameters
|
|
57922
57966
|
* @param {Object} opts.expand Which fields, if any, to expand
|
|
57923
57967
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
57968
|
+
* @deprecated
|
|
57924
57969
|
*/
|
|
57925
57970
|
getWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId, opts) {
|
|
57926
57971
|
opts = opts || {};
|
|
@@ -57961,6 +58006,7 @@ class WorkforceManagementApi {
|
|
|
57961
58006
|
* @param {Boolean} opts.includeOnlyPublished Return only published schedules
|
|
57962
58007
|
* @param {String} opts.earliestWeekDate The start date of the earliest week to query in yyyy-MM-dd format
|
|
57963
58008
|
* @param {String} opts.latestWeekDate The start date of the latest week to query in yyyy-MM-dd format
|
|
58009
|
+
* @deprecated
|
|
57964
58010
|
*/
|
|
57965
58011
|
getWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId, opts) {
|
|
57966
58012
|
opts = opts || {};
|
|
@@ -58120,7 +58166,7 @@ class WorkforceManagementApi {
|
|
|
58120
58166
|
* "expand=details" is deprecated
|
|
58121
58167
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
58122
58168
|
* @param {Object} opts Optional parameters
|
|
58123
|
-
* @param {Array.<String>} opts.expand
|
|
58169
|
+
* @param {Array.<String>} opts.expand Include to access additional data on the work plans
|
|
58124
58170
|
*/
|
|
58125
58171
|
getWorkforcemanagementManagementunitWorkplans(managementUnitId, opts) {
|
|
58126
58172
|
opts = opts || {};
|
|
@@ -59628,7 +59674,7 @@ class WorkforceManagementApi {
|
|
|
59628
59674
|
*
|
|
59629
59675
|
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
59630
59676
|
* @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
|
|
59631
|
-
* @param {Object} body
|
|
59677
|
+
* @param {Object} body body
|
|
59632
59678
|
* @param {Object} opts Optional parameters
|
|
59633
59679
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
59634
59680
|
*/
|
|
@@ -59667,7 +59713,7 @@ class WorkforceManagementApi {
|
|
|
59667
59713
|
* Call after uploading the forecast data to the url supplied by the /import/uploadurl route
|
|
59668
59714
|
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
59669
59715
|
* @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
|
|
59670
|
-
* @param {Object} body
|
|
59716
|
+
* @param {Object} body body
|
|
59671
59717
|
*/
|
|
59672
59718
|
postWorkforcemanagementBusinessunitWeekShorttermforecastsImport(businessUnitId, weekDateId, body) {
|
|
59673
59719
|
// verify the required parameter 'businessUnitId' is set
|
|
@@ -59919,6 +59965,7 @@ class WorkforceManagementApi {
|
|
|
59919
59965
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59920
59966
|
* @param {Object} opts Optional parameters
|
|
59921
59967
|
* @param {Object} opts.body body
|
|
59968
|
+
* @deprecated
|
|
59922
59969
|
*/
|
|
59923
59970
|
postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId, opts) {
|
|
59924
59971
|
opts = opts || {};
|
|
@@ -60579,6 +60626,7 @@ class WorkforceManagementApi {
|
|
|
60579
60626
|
*
|
|
60580
60627
|
* @param {Object} opts Optional parameters
|
|
60581
60628
|
* @param {Object} opts.body body
|
|
60629
|
+
* @deprecated
|
|
60582
60630
|
*/
|
|
60583
60631
|
postWorkforcemanagementSchedules(opts) {
|
|
60584
60632
|
opts = opts || {};
|
|
@@ -60598,6 +60646,64 @@ class WorkforceManagementApi {
|
|
|
60598
60646
|
);
|
|
60599
60647
|
}
|
|
60600
60648
|
|
|
60649
|
+
/**
|
|
60650
|
+
* Request a teams historical adherence report
|
|
60651
|
+
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
60652
|
+
* @param {String} teamId The ID of the team
|
|
60653
|
+
* @param {Object} opts Optional parameters
|
|
60654
|
+
* @param {Object} opts.body body
|
|
60655
|
+
*/
|
|
60656
|
+
postWorkforcemanagementTeamAdherenceHistorical(teamId, opts) {
|
|
60657
|
+
opts = opts || {};
|
|
60658
|
+
|
|
60659
|
+
// verify the required parameter 'teamId' is set
|
|
60660
|
+
if (teamId === undefined || teamId === null) {
|
|
60661
|
+
throw 'Missing the required parameter "teamId" when calling postWorkforcemanagementTeamAdherenceHistorical';
|
|
60662
|
+
}
|
|
60663
|
+
|
|
60664
|
+
return this.apiClient.callApi(
|
|
60665
|
+
'/api/v2/workforcemanagement/teams/{teamId}/adherence/historical',
|
|
60666
|
+
'POST',
|
|
60667
|
+
{ 'teamId': teamId },
|
|
60668
|
+
{ },
|
|
60669
|
+
{ },
|
|
60670
|
+
{ },
|
|
60671
|
+
opts['body'],
|
|
60672
|
+
['PureCloud OAuth'],
|
|
60673
|
+
['application/json'],
|
|
60674
|
+
['application/json']
|
|
60675
|
+
);
|
|
60676
|
+
}
|
|
60677
|
+
|
|
60678
|
+
/**
|
|
60679
|
+
* Request a historical shrinkage report
|
|
60680
|
+
* The maximum supported range for historical shrinkage queries is up to 32 days
|
|
60681
|
+
* @param {String} teamId The ID of the team
|
|
60682
|
+
* @param {Object} opts Optional parameters
|
|
60683
|
+
* @param {Object} opts.body body
|
|
60684
|
+
*/
|
|
60685
|
+
postWorkforcemanagementTeamShrinkageJobs(teamId, opts) {
|
|
60686
|
+
opts = opts || {};
|
|
60687
|
+
|
|
60688
|
+
// verify the required parameter 'teamId' is set
|
|
60689
|
+
if (teamId === undefined || teamId === null) {
|
|
60690
|
+
throw 'Missing the required parameter "teamId" when calling postWorkforcemanagementTeamShrinkageJobs';
|
|
60691
|
+
}
|
|
60692
|
+
|
|
60693
|
+
return this.apiClient.callApi(
|
|
60694
|
+
'/api/v2/workforcemanagement/teams/{teamId}/shrinkage/jobs',
|
|
60695
|
+
'POST',
|
|
60696
|
+
{ 'teamId': teamId },
|
|
60697
|
+
{ },
|
|
60698
|
+
{ },
|
|
60699
|
+
{ },
|
|
60700
|
+
opts['body'],
|
|
60701
|
+
['PureCloud OAuth'],
|
|
60702
|
+
['application/json'],
|
|
60703
|
+
['application/json']
|
|
60704
|
+
);
|
|
60705
|
+
}
|
|
60706
|
+
|
|
60601
60707
|
/**
|
|
60602
60708
|
* Queries available time off for the current user
|
|
60603
60709
|
*
|
|
@@ -60711,7 +60817,7 @@ class WorkforceManagementApi {
|
|
|
60711
60817
|
* </pre>
|
|
60712
60818
|
* </p>
|
|
60713
60819
|
* @module purecloud-platform-client-v2/index
|
|
60714
|
-
* @version 168.
|
|
60820
|
+
* @version 168.2.0
|
|
60715
60821
|
*/
|
|
60716
60822
|
class platformClient {
|
|
60717
60823
|
constructor() {
|