purecloud-platform-client-v2 206.0.0 → 207.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +100 -3
- package/dist/node/purecloud-platform-client-v2.js +675 -129
- package/dist/web-amd/purecloud-platform-client-v2.js +675 -129
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +236 -132
- package/dist/web-cjs/purecloud-platform-client-v2.js +236 -132
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +775 -270
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +40 -18
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +7 -6
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +2 -3
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +232 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -4
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -19
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +48 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +101 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +27 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +56 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/configuration.js +81 -0
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class OrganizationAuthorizationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* OrganizationAuthorization service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 207.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -642,6 +642,26 @@ class OrganizationAuthorizationApi {
|
|
|
642
642
|
);
|
|
643
643
|
}
|
|
644
644
|
|
|
645
|
+
/**
|
|
646
|
+
* Get Customer Care organization ids.
|
|
647
|
+
*
|
|
648
|
+
*/
|
|
649
|
+
getOrgauthorizationTrusteesCare() {
|
|
650
|
+
|
|
651
|
+
return this.apiClient.callApi(
|
|
652
|
+
'/api/v2/orgauthorization/trustees/care',
|
|
653
|
+
'GET',
|
|
654
|
+
{ },
|
|
655
|
+
{ },
|
|
656
|
+
{ },
|
|
657
|
+
{ },
|
|
658
|
+
null,
|
|
659
|
+
['PureCloud OAuth'],
|
|
660
|
+
['application/json'],
|
|
661
|
+
['application/json']
|
|
662
|
+
);
|
|
663
|
+
}
|
|
664
|
+
|
|
645
665
|
/**
|
|
646
666
|
* Get organization authorization trust with Customer Care, if one exists.
|
|
647
667
|
*
|
|
@@ -1029,6 +1049,33 @@ class OrganizationAuthorizationApi {
|
|
|
1029
1049
|
);
|
|
1030
1050
|
}
|
|
1031
1051
|
|
|
1052
|
+
/**
|
|
1053
|
+
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
1054
|
+
*
|
|
1055
|
+
* @param {Object} opts Optional parameters
|
|
1056
|
+
* @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
|
|
1057
|
+
* @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
|
|
1058
|
+
* @param {Boolean} opts.assignFullAccess Grant Customer Care full access to the organization
|
|
1059
|
+
* @param {Boolean} opts.allowTrustedUserAccess Make Customer Care a Trusted User
|
|
1060
|
+
*/
|
|
1061
|
+
postOrgauthorizationTrusteesCare(opts) {
|
|
1062
|
+
opts = opts || {};
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
return this.apiClient.callApi(
|
|
1066
|
+
'/api/v2/orgauthorization/trustees/care',
|
|
1067
|
+
'POST',
|
|
1068
|
+
{ },
|
|
1069
|
+
{ 'assignDefaultRole': opts['assignDefaultRole'],'autoExpire': opts['autoExpire'],'assignFullAccess': opts['assignFullAccess'],'allowTrustedUserAccess': opts['allowTrustedUserAccess'] },
|
|
1070
|
+
{ },
|
|
1071
|
+
{ },
|
|
1072
|
+
null,
|
|
1073
|
+
['PureCloud OAuth'],
|
|
1074
|
+
['application/json'],
|
|
1075
|
+
['application/json']
|
|
1076
|
+
);
|
|
1077
|
+
}
|
|
1078
|
+
|
|
1032
1079
|
/**
|
|
1033
1080
|
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
1034
1081
|
*
|
|
@@ -5,7 +5,7 @@ class OutboundApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Outbound service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 207.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -2982,6 +2982,56 @@ class OutboundApi {
|
|
|
2982
2982
|
);
|
|
2983
2983
|
}
|
|
2984
2984
|
|
|
2985
|
+
/**
|
|
2986
|
+
* Start the campaign
|
|
2987
|
+
*
|
|
2988
|
+
* @param {String} campaignId Campaign ID
|
|
2989
|
+
*/
|
|
2990
|
+
postOutboundCampaignStart(campaignId) {
|
|
2991
|
+
// verify the required parameter 'campaignId' is set
|
|
2992
|
+
if (campaignId === undefined || campaignId === null) {
|
|
2993
|
+
throw 'Missing the required parameter "campaignId" when calling postOutboundCampaignStart';
|
|
2994
|
+
}
|
|
2995
|
+
|
|
2996
|
+
return this.apiClient.callApi(
|
|
2997
|
+
'/api/v2/outbound/campaigns/{campaignId}/start',
|
|
2998
|
+
'POST',
|
|
2999
|
+
{ 'campaignId': campaignId },
|
|
3000
|
+
{ },
|
|
3001
|
+
{ },
|
|
3002
|
+
{ },
|
|
3003
|
+
null,
|
|
3004
|
+
['PureCloud OAuth'],
|
|
3005
|
+
['application/json'],
|
|
3006
|
+
['application/json']
|
|
3007
|
+
);
|
|
3008
|
+
}
|
|
3009
|
+
|
|
3010
|
+
/**
|
|
3011
|
+
* Stop the campaign
|
|
3012
|
+
*
|
|
3013
|
+
* @param {String} campaignId Campaign ID
|
|
3014
|
+
*/
|
|
3015
|
+
postOutboundCampaignStop(campaignId) {
|
|
3016
|
+
// verify the required parameter 'campaignId' is set
|
|
3017
|
+
if (campaignId === undefined || campaignId === null) {
|
|
3018
|
+
throw 'Missing the required parameter "campaignId" when calling postOutboundCampaignStop';
|
|
3019
|
+
}
|
|
3020
|
+
|
|
3021
|
+
return this.apiClient.callApi(
|
|
3022
|
+
'/api/v2/outbound/campaigns/{campaignId}/stop',
|
|
3023
|
+
'POST',
|
|
3024
|
+
{ 'campaignId': campaignId },
|
|
3025
|
+
{ },
|
|
3026
|
+
{ },
|
|
3027
|
+
{ },
|
|
3028
|
+
null,
|
|
3029
|
+
['PureCloud OAuth'],
|
|
3030
|
+
['application/json'],
|
|
3031
|
+
['application/json']
|
|
3032
|
+
);
|
|
3033
|
+
}
|
|
3034
|
+
|
|
2985
3035
|
/**
|
|
2986
3036
|
* Create Campaign Rule
|
|
2987
3037
|
*
|
|
@@ -3681,6 +3731,56 @@ class OutboundApi {
|
|
|
3681
3731
|
);
|
|
3682
3732
|
}
|
|
3683
3733
|
|
|
3734
|
+
/**
|
|
3735
|
+
* Start the campaign
|
|
3736
|
+
* Documented permissions are applicable based on campaign type.
|
|
3737
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
3738
|
+
*/
|
|
3739
|
+
postOutboundMessagingcampaignStart(messagingCampaignId) {
|
|
3740
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
3741
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
3742
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStart';
|
|
3743
|
+
}
|
|
3744
|
+
|
|
3745
|
+
return this.apiClient.callApi(
|
|
3746
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/start',
|
|
3747
|
+
'POST',
|
|
3748
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
3749
|
+
{ },
|
|
3750
|
+
{ },
|
|
3751
|
+
{ },
|
|
3752
|
+
null,
|
|
3753
|
+
['PureCloud OAuth'],
|
|
3754
|
+
['application/json'],
|
|
3755
|
+
['application/json']
|
|
3756
|
+
);
|
|
3757
|
+
}
|
|
3758
|
+
|
|
3759
|
+
/**
|
|
3760
|
+
* Stop the campaign
|
|
3761
|
+
* Documented permissions are applicable based on campaign type.
|
|
3762
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
3763
|
+
*/
|
|
3764
|
+
postOutboundMessagingcampaignStop(messagingCampaignId) {
|
|
3765
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
3766
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
3767
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStop';
|
|
3768
|
+
}
|
|
3769
|
+
|
|
3770
|
+
return this.apiClient.callApi(
|
|
3771
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/stop',
|
|
3772
|
+
'POST',
|
|
3773
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
3774
|
+
{ },
|
|
3775
|
+
{ },
|
|
3776
|
+
{ },
|
|
3777
|
+
null,
|
|
3778
|
+
['PureCloud OAuth'],
|
|
3779
|
+
['application/json'],
|
|
3780
|
+
['application/json']
|
|
3781
|
+
);
|
|
3782
|
+
}
|
|
3783
|
+
|
|
3684
3784
|
/**
|
|
3685
3785
|
* Create a Messaging Campaign
|
|
3686
3786
|
*
|
|
@@ -5,7 +5,7 @@ class TeamsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Teams service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 207.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -79,8 +79,12 @@ class TeamsApi {
|
|
|
79
79
|
* Get team
|
|
80
80
|
*
|
|
81
81
|
* @param {String} teamId Team ID
|
|
82
|
+
* @param {Object} opts Optional parameters
|
|
83
|
+
* @param {Object} opts.expand Expand the division name
|
|
82
84
|
*/
|
|
83
|
-
getTeam(teamId) {
|
|
85
|
+
getTeam(teamId, opts) {
|
|
86
|
+
opts = opts || {};
|
|
87
|
+
|
|
84
88
|
// verify the required parameter 'teamId' is set
|
|
85
89
|
if (teamId === undefined || teamId === null) {
|
|
86
90
|
throw 'Missing the required parameter "teamId" when calling getTeam';
|
|
@@ -90,7 +94,7 @@ class TeamsApi {
|
|
|
90
94
|
'/api/v2/teams/{teamId}',
|
|
91
95
|
'GET',
|
|
92
96
|
{ 'teamId': teamId },
|
|
93
|
-
{
|
|
97
|
+
{ 'expand': opts['expand'] },
|
|
94
98
|
{ },
|
|
95
99
|
{ },
|
|
96
100
|
null,
|
|
@@ -5,7 +5,7 @@ class UsersApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Users service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 207.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1320,6 +1320,32 @@ class UsersApi {
|
|
|
1320
1320
|
);
|
|
1321
1321
|
}
|
|
1322
1322
|
|
|
1323
|
+
/**
|
|
1324
|
+
* Get chats for a user
|
|
1325
|
+
*
|
|
1326
|
+
* @param {Object} opts Optional parameters
|
|
1327
|
+
* @param {Boolean} opts.excludeClosed Whether or not to exclude closed chats
|
|
1328
|
+
* @param {Boolean} opts.includePresence Whether or not to include user presence
|
|
1329
|
+
* @param {String} opts.after The key to start after
|
|
1330
|
+
*/
|
|
1331
|
+
getUsersChatsMe(opts) {
|
|
1332
|
+
opts = opts || {};
|
|
1333
|
+
|
|
1334
|
+
|
|
1335
|
+
return this.apiClient.callApi(
|
|
1336
|
+
'/api/v2/users/chats/me',
|
|
1337
|
+
'GET',
|
|
1338
|
+
{ },
|
|
1339
|
+
{ 'excludeClosed': opts['excludeClosed'],'includePresence': opts['includePresence'],'after': opts['after'] },
|
|
1340
|
+
{ },
|
|
1341
|
+
{ },
|
|
1342
|
+
null,
|
|
1343
|
+
['PureCloud OAuth'],
|
|
1344
|
+
['application/json'],
|
|
1345
|
+
['application/json']
|
|
1346
|
+
);
|
|
1347
|
+
}
|
|
1348
|
+
|
|
1323
1349
|
/**
|
|
1324
1350
|
* Get list of Development Activities
|
|
1325
1351
|
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
@@ -5,7 +5,7 @@ class VoicemailApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Voicemail service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 207.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -392,6 +392,61 @@ class VoicemailApi {
|
|
|
392
392
|
);
|
|
393
393
|
}
|
|
394
394
|
|
|
395
|
+
/**
|
|
396
|
+
* Get a user's mailbox information
|
|
397
|
+
*
|
|
398
|
+
* @param {String} userId userId
|
|
399
|
+
*/
|
|
400
|
+
getVoicemailUserMailbox(userId) {
|
|
401
|
+
// verify the required parameter 'userId' is set
|
|
402
|
+
if (userId === undefined || userId === null) {
|
|
403
|
+
throw 'Missing the required parameter "userId" when calling getVoicemailUserMailbox';
|
|
404
|
+
}
|
|
405
|
+
|
|
406
|
+
return this.apiClient.callApi(
|
|
407
|
+
'/api/v2/voicemail/users/{userId}/mailbox',
|
|
408
|
+
'GET',
|
|
409
|
+
{ 'userId': userId },
|
|
410
|
+
{ },
|
|
411
|
+
{ },
|
|
412
|
+
{ },
|
|
413
|
+
null,
|
|
414
|
+
['PureCloud OAuth'],
|
|
415
|
+
['application/json'],
|
|
416
|
+
['application/json']
|
|
417
|
+
);
|
|
418
|
+
}
|
|
419
|
+
|
|
420
|
+
/**
|
|
421
|
+
* List voicemail messages
|
|
422
|
+
*
|
|
423
|
+
* @param {String} userId User ID
|
|
424
|
+
* @param {Object} opts Optional parameters
|
|
425
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
426
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
427
|
+
*/
|
|
428
|
+
getVoicemailUserMessages(userId, opts) {
|
|
429
|
+
opts = opts || {};
|
|
430
|
+
|
|
431
|
+
// verify the required parameter 'userId' is set
|
|
432
|
+
if (userId === undefined || userId === null) {
|
|
433
|
+
throw 'Missing the required parameter "userId" when calling getVoicemailUserMessages';
|
|
434
|
+
}
|
|
435
|
+
|
|
436
|
+
return this.apiClient.callApi(
|
|
437
|
+
'/api/v2/voicemail/users/{userId}/messages',
|
|
438
|
+
'GET',
|
|
439
|
+
{ 'userId': userId },
|
|
440
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
441
|
+
{ },
|
|
442
|
+
{ },
|
|
443
|
+
null,
|
|
444
|
+
['PureCloud OAuth'],
|
|
445
|
+
['application/json'],
|
|
446
|
+
['application/json']
|
|
447
|
+
);
|
|
448
|
+
}
|
|
449
|
+
|
|
395
450
|
/**
|
|
396
451
|
* Get a user's voicemail policy
|
|
397
452
|
*
|