purecloud-platform-client-v2 223.0.0 → 224.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 +3 -3
- package/dist/node/purecloud-platform-client-v2.js +1046 -116
- package/dist/web-amd/purecloud-platform-client-v2.js +1046 -116
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +378 -120
- package/dist/web-cjs/purecloud-platform-client-v2.js +378 -120
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +730 -249
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +387 -0
- 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 +2 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +4 -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/BusinessRulesApi.js +49 -4
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +292 -16
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -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 +89 -2
- 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 +27 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +31 -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/SocialMediaApi.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 +2 -2
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +43 -2
- 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 +31 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +2 -2
- 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 +16 -10
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -5,7 +5,7 @@ class GreetingsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Greetings service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 224.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -71,12 +71,70 @@ class GreetingsApi {
|
|
|
71
71
|
}
|
|
72
72
|
|
|
73
73
|
/**
|
|
74
|
-
*
|
|
74
|
+
* Download a organization greeting recording
|
|
75
|
+
*
|
|
76
|
+
* @param {String} greetingId Greeting ID
|
|
77
|
+
* @param {Object} opts Optional parameters
|
|
78
|
+
* @param {Object} opts.formatId The desired media format. (default to WAV)
|
|
79
|
+
*/
|
|
80
|
+
getGreetingDownloads(greetingId, opts) {
|
|
81
|
+
opts = opts || {};
|
|
82
|
+
|
|
83
|
+
// verify the required parameter 'greetingId' is set
|
|
84
|
+
if (greetingId === undefined || greetingId === null) {
|
|
85
|
+
throw 'Missing the required parameter "greetingId" when calling getGreetingDownloads';
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
return this.apiClient.callApi(
|
|
89
|
+
'/api/v2/greetings/{greetingId}/downloads',
|
|
90
|
+
'GET',
|
|
91
|
+
{ 'greetingId': greetingId },
|
|
92
|
+
{ 'formatId': opts['formatId'] },
|
|
93
|
+
{ },
|
|
94
|
+
{ },
|
|
95
|
+
null,
|
|
96
|
+
['PureCloud OAuth'],
|
|
97
|
+
['application/json'],
|
|
98
|
+
['application/json']
|
|
99
|
+
);
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* Download a group greeting recording
|
|
75
104
|
*
|
|
76
105
|
* @param {String} greetingId Greeting ID
|
|
77
106
|
* @param {Object} opts Optional parameters
|
|
78
107
|
* @param {Object} opts.formatId The desired media format. (default to WAV)
|
|
79
108
|
*/
|
|
109
|
+
getGreetingGroupsDownloads(greetingId, opts) {
|
|
110
|
+
opts = opts || {};
|
|
111
|
+
|
|
112
|
+
// verify the required parameter 'greetingId' is set
|
|
113
|
+
if (greetingId === undefined || greetingId === null) {
|
|
114
|
+
throw 'Missing the required parameter "greetingId" when calling getGreetingGroupsDownloads';
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
return this.apiClient.callApi(
|
|
118
|
+
'/api/v2/greetings/{greetingId}/groups/downloads',
|
|
119
|
+
'GET',
|
|
120
|
+
{ 'greetingId': greetingId },
|
|
121
|
+
{ 'formatId': opts['formatId'] },
|
|
122
|
+
{ },
|
|
123
|
+
{ },
|
|
124
|
+
null,
|
|
125
|
+
['PureCloud OAuth'],
|
|
126
|
+
['application/json'],
|
|
127
|
+
['application/json']
|
|
128
|
+
);
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* Get media playback URI for this greeting
|
|
133
|
+
* API should migrate to use GET api/v2/greetings/{greetingId}/downloads
|
|
134
|
+
* @param {String} greetingId Greeting ID
|
|
135
|
+
* @param {Object} opts Optional parameters
|
|
136
|
+
* @param {Object} opts.formatId The desired media format. (default to WAV)
|
|
137
|
+
*/
|
|
80
138
|
getGreetingMedia(greetingId, opts) {
|
|
81
139
|
opts = opts || {};
|
|
82
140
|
|
|
@@ -99,6 +157,35 @@ class GreetingsApi {
|
|
|
99
157
|
);
|
|
100
158
|
}
|
|
101
159
|
|
|
160
|
+
/**
|
|
161
|
+
* Download a user greeting recording
|
|
162
|
+
*
|
|
163
|
+
* @param {String} greetingId Greeting ID
|
|
164
|
+
* @param {Object} opts Optional parameters
|
|
165
|
+
* @param {Object} opts.formatId The desired media format. (default to WAV)
|
|
166
|
+
*/
|
|
167
|
+
getGreetingUsersDownloads(greetingId, opts) {
|
|
168
|
+
opts = opts || {};
|
|
169
|
+
|
|
170
|
+
// verify the required parameter 'greetingId' is set
|
|
171
|
+
if (greetingId === undefined || greetingId === null) {
|
|
172
|
+
throw 'Missing the required parameter "greetingId" when calling getGreetingUsersDownloads';
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
return this.apiClient.callApi(
|
|
176
|
+
'/api/v2/greetings/{greetingId}/users/downloads',
|
|
177
|
+
'GET',
|
|
178
|
+
{ 'greetingId': greetingId },
|
|
179
|
+
{ 'formatId': opts['formatId'] },
|
|
180
|
+
{ },
|
|
181
|
+
{ },
|
|
182
|
+
null,
|
|
183
|
+
['PureCloud OAuth'],
|
|
184
|
+
['application/json'],
|
|
185
|
+
['application/json']
|
|
186
|
+
);
|
|
187
|
+
}
|
|
188
|
+
|
|
102
189
|
/**
|
|
103
190
|
* Gets an Organization's Greetings
|
|
104
191
|
*
|
|
@@ -5,7 +5,7 @@ class IntegrationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Integrations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 224.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -966,6 +966,32 @@ class IntegrationsApi {
|
|
|
966
966
|
);
|
|
967
967
|
}
|
|
968
968
|
|
|
969
|
+
/**
|
|
970
|
+
* List multiple sets of credentials using cursor-based paging
|
|
971
|
+
*
|
|
972
|
+
* @param {Object} opts Optional parameters
|
|
973
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
974
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
975
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
976
|
+
*/
|
|
977
|
+
getIntegrationsCredentialsListing(opts) {
|
|
978
|
+
opts = opts || {};
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
return this.apiClient.callApi(
|
|
982
|
+
'/api/v2/integrations/credentials/listing',
|
|
983
|
+
'GET',
|
|
984
|
+
{ },
|
|
985
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
986
|
+
{ },
|
|
987
|
+
{ },
|
|
988
|
+
null,
|
|
989
|
+
['PureCloud OAuth'],
|
|
990
|
+
['application/json'],
|
|
991
|
+
['application/json']
|
|
992
|
+
);
|
|
993
|
+
}
|
|
994
|
+
|
|
969
995
|
/**
|
|
970
996
|
* List all credential types
|
|
971
997
|
*
|
|
@@ -5,7 +5,7 @@ class RoutingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Routing service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 224.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -2919,6 +2919,36 @@ class RoutingApi {
|
|
|
2919
2919
|
);
|
|
2920
2920
|
}
|
|
2921
2921
|
|
|
2922
|
+
/**
|
|
2923
|
+
* Update a phone number provisioned for SMS.
|
|
2924
|
+
*
|
|
2925
|
+
* @param {String} phoneNumberId phone number
|
|
2926
|
+
* @param {Object} body SmsPhoneNumberPatchRequest
|
|
2927
|
+
*/
|
|
2928
|
+
patchRoutingSmsPhonenumber(phoneNumberId, body) {
|
|
2929
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
2930
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
2931
|
+
throw 'Missing the required parameter "phoneNumberId" when calling patchRoutingSmsPhonenumber';
|
|
2932
|
+
}
|
|
2933
|
+
// verify the required parameter 'body' is set
|
|
2934
|
+
if (body === undefined || body === null) {
|
|
2935
|
+
throw 'Missing the required parameter "body" when calling patchRoutingSmsPhonenumber';
|
|
2936
|
+
}
|
|
2937
|
+
|
|
2938
|
+
return this.apiClient.callApi(
|
|
2939
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
2940
|
+
'PATCH',
|
|
2941
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
2942
|
+
{ },
|
|
2943
|
+
{ },
|
|
2944
|
+
{ },
|
|
2945
|
+
body,
|
|
2946
|
+
['PureCloud OAuth'],
|
|
2947
|
+
['application/json'],
|
|
2948
|
+
['application/json']
|
|
2949
|
+
);
|
|
2950
|
+
}
|
|
2951
|
+
|
|
2922
2952
|
/**
|
|
2923
2953
|
* Join or unjoin a queue for a user
|
|
2924
2954
|
*
|
|
@@ -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 224.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -144,7 +144,7 @@ class TeamsApi {
|
|
|
144
144
|
* @param {String} opts.name Return only teams whose names start with this value (case-insensitive matching)
|
|
145
145
|
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
146
146
|
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
147
|
-
* @param {Object} opts.expand Expand the
|
|
147
|
+
* @param {Object} opts.expand Expand the division on each team
|
|
148
148
|
*/
|
|
149
149
|
getTeams(opts) {
|
|
150
150
|
opts = opts || {};
|
|
@@ -5,7 +5,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* TelephonyProvidersEdge service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 224.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1209,7 +1209,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
1209
1209
|
|
|
1210
1210
|
/**
|
|
1211
1211
|
* Get a pageable list of basic extension pool objects filterable by query parameters.
|
|
1212
|
-
* This returns extension pools consisting of name and division. If one or more IDs are specified, the search will fetch
|
|
1212
|
+
* This returns extension pools consisting of name and division. If one or more IDs are specified, the search will fetch extension pools that match the given ID(s) and not use any additional supplied query parameters in the search.
|
|
1213
1213
|
* @param {Object} opts Optional parameters
|
|
1214
1214
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1215
1215
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
@@ -2786,6 +2786,47 @@ class TelephonyProvidersEdgeApi {
|
|
|
2786
2786
|
);
|
|
2787
2787
|
}
|
|
2788
2788
|
|
|
2789
|
+
/**
|
|
2790
|
+
* Post media endpoint statistics event.
|
|
2791
|
+
*
|
|
2792
|
+
* @param {String} conversationId Identifier of the conversation
|
|
2793
|
+
* @param {String} communicationId Identifier of the media session
|
|
2794
|
+
* @param {String} mediaResourceId Identifier of the media resource of the endpoint
|
|
2795
|
+
* @param {Object} body MediaStatisticsPostRequest
|
|
2796
|
+
* postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2797
|
+
*/
|
|
2798
|
+
postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource(conversationId, communicationId, mediaResourceId, body) {
|
|
2799
|
+
// verify the required parameter 'conversationId' is set
|
|
2800
|
+
if (conversationId === undefined || conversationId === null) {
|
|
2801
|
+
throw 'Missing the required parameter "conversationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
2802
|
+
}
|
|
2803
|
+
// verify the required parameter 'communicationId' is set
|
|
2804
|
+
if (communicationId === undefined || communicationId === null) {
|
|
2805
|
+
throw 'Missing the required parameter "communicationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
2806
|
+
}
|
|
2807
|
+
// verify the required parameter 'mediaResourceId' is set
|
|
2808
|
+
if (mediaResourceId === undefined || mediaResourceId === null) {
|
|
2809
|
+
throw 'Missing the required parameter "mediaResourceId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
2810
|
+
}
|
|
2811
|
+
// verify the required parameter 'body' is set
|
|
2812
|
+
if (body === undefined || body === null) {
|
|
2813
|
+
throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
2814
|
+
}
|
|
2815
|
+
|
|
2816
|
+
return this.apiClient.callApi(
|
|
2817
|
+
'/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}/communications/{communicationId}/mediaresources/{mediaResourceId}',
|
|
2818
|
+
'POST',
|
|
2819
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'mediaResourceId': mediaResourceId },
|
|
2820
|
+
{ },
|
|
2821
|
+
{ },
|
|
2822
|
+
{ },
|
|
2823
|
+
body,
|
|
2824
|
+
['PureCloud OAuth'],
|
|
2825
|
+
['application/json'],
|
|
2826
|
+
['application/json']
|
|
2827
|
+
);
|
|
2828
|
+
}
|
|
2829
|
+
|
|
2789
2830
|
/**
|
|
2790
2831
|
* Reboot a Phone
|
|
2791
2832
|
*
|