purecloud-platform-client-v2 247.1.0 → 249.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 +2057 -116
- package/dist/web-amd/purecloud-platform-client-v2.js +2057 -116
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +626 -121
- package/dist/web-cjs/purecloud-platform-client-v2.js +626 -121
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1404 -337
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +1 -1
- 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/BackgroundAssistantApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +1100 -0
- 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 +18 -14
- 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 +31 -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/IntentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +501 -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 +26 -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 +37 -2
- 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 +57 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +5 -5
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +2 -3
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +46 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +152 -5
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -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 249.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -226,7 +226,7 @@ class OutboundApi {
|
|
|
226
226
|
}
|
|
227
227
|
|
|
228
228
|
/**
|
|
229
|
-
* Delete contacts from a contact list.
|
|
229
|
+
* Delete contacts from a contact list. Only contacts that are not in use by any campaign will be deleted
|
|
230
230
|
*
|
|
231
231
|
* @param {String} contactListId Contact List ID
|
|
232
232
|
* @param {Array.<String>} contactIds ContactIds to delete.
|
|
@@ -1832,6 +1832,41 @@ class OutboundApi {
|
|
|
1832
1832
|
);
|
|
1833
1833
|
}
|
|
1834
1834
|
|
|
1835
|
+
/**
|
|
1836
|
+
* Get diagnostic summary for a single campaign
|
|
1837
|
+
*
|
|
1838
|
+
* @param {String} campaignId Campaign ID
|
|
1839
|
+
* @param {String} start Start datetime (ISO 8601 or Unix epoch)
|
|
1840
|
+
* @param {String} end End datetime (ISO 8601 or Unix epoch)
|
|
1841
|
+
*/
|
|
1842
|
+
getOutboundDiagnosticsCampaignSummary(campaignId, start, end) {
|
|
1843
|
+
// verify the required parameter 'campaignId' is set
|
|
1844
|
+
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
1845
|
+
throw 'Missing the required parameter "campaignId" when calling getOutboundDiagnosticsCampaignSummary';
|
|
1846
|
+
}
|
|
1847
|
+
// verify the required parameter 'start' is set
|
|
1848
|
+
if (start === undefined || start === null) {
|
|
1849
|
+
throw 'Missing the required parameter "start" when calling getOutboundDiagnosticsCampaignSummary';
|
|
1850
|
+
}
|
|
1851
|
+
// verify the required parameter 'end' is set
|
|
1852
|
+
if (end === undefined || end === null) {
|
|
1853
|
+
throw 'Missing the required parameter "end" when calling getOutboundDiagnosticsCampaignSummary';
|
|
1854
|
+
}
|
|
1855
|
+
|
|
1856
|
+
return this.apiClient.callApi(
|
|
1857
|
+
'/api/v2/outbound/diagnostics/campaigns/{campaignId}/summary',
|
|
1858
|
+
'GET',
|
|
1859
|
+
{ 'campaignId': campaignId },
|
|
1860
|
+
{ 'start': start,'end': end },
|
|
1861
|
+
{ },
|
|
1862
|
+
{ },
|
|
1863
|
+
null,
|
|
1864
|
+
['PureCloud OAuth'],
|
|
1865
|
+
['application/json'],
|
|
1866
|
+
['application/json']
|
|
1867
|
+
);
|
|
1868
|
+
}
|
|
1869
|
+
|
|
1835
1870
|
/**
|
|
1836
1871
|
* Get an Outbound Digital Rule Set
|
|
1837
1872
|
*
|
|
@@ -5,7 +5,7 @@ class ResponseManagementApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* ResponseManagement service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 249.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -307,6 +307,62 @@ class ResponseManagementApi {
|
|
|
307
307
|
);
|
|
308
308
|
}
|
|
309
309
|
|
|
310
|
+
/**
|
|
311
|
+
* Query libraries using criteria. Users can set DivisionId parameter as '*' to fetch libraries that aren't associated with any divisions.
|
|
312
|
+
*
|
|
313
|
+
* @param {Object} body Query criteria
|
|
314
|
+
* @param {Object} opts Optional parameters
|
|
315
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
316
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
317
|
+
* postResponsemanagementLibrariesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
318
|
+
*/
|
|
319
|
+
postResponsemanagementLibrariesQuery(body, opts) {
|
|
320
|
+
opts = opts || {};
|
|
321
|
+
|
|
322
|
+
// verify the required parameter 'body' is set
|
|
323
|
+
if (body === undefined || body === null) {
|
|
324
|
+
throw 'Missing the required parameter "body" when calling postResponsemanagementLibrariesQuery';
|
|
325
|
+
}
|
|
326
|
+
|
|
327
|
+
return this.apiClient.callApi(
|
|
328
|
+
'/api/v2/responsemanagement/libraries/query',
|
|
329
|
+
'POST',
|
|
330
|
+
{ },
|
|
331
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
332
|
+
{ },
|
|
333
|
+
{ },
|
|
334
|
+
body,
|
|
335
|
+
['PureCloud OAuth'],
|
|
336
|
+
['application/json'],
|
|
337
|
+
['application/json']
|
|
338
|
+
);
|
|
339
|
+
}
|
|
340
|
+
|
|
341
|
+
/**
|
|
342
|
+
* Get response assets.
|
|
343
|
+
*
|
|
344
|
+
* @param {Object} body Asset IDs (max allowed 50)
|
|
345
|
+
*/
|
|
346
|
+
postResponsemanagementResponseassetsBulk(body) {
|
|
347
|
+
// verify the required parameter 'body' is set
|
|
348
|
+
if (body === undefined || body === null) {
|
|
349
|
+
throw 'Missing the required parameter "body" when calling postResponsemanagementResponseassetsBulk';
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
return this.apiClient.callApi(
|
|
353
|
+
'/api/v2/responsemanagement/responseassets/bulk',
|
|
354
|
+
'POST',
|
|
355
|
+
{ },
|
|
356
|
+
{ },
|
|
357
|
+
{ },
|
|
358
|
+
{ },
|
|
359
|
+
body,
|
|
360
|
+
['PureCloud OAuth'],
|
|
361
|
+
['application/json'],
|
|
362
|
+
['application/json']
|
|
363
|
+
);
|
|
364
|
+
}
|
|
365
|
+
|
|
310
366
|
/**
|
|
311
367
|
* Search response assets
|
|
312
368
|
*
|
|
@@ -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 249.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -2207,7 +2207,7 @@ class RoutingApi {
|
|
|
2207
2207
|
|
|
2208
2208
|
/**
|
|
2209
2209
|
* Get a phone number provisioned for SMS.
|
|
2210
|
-
*
|
|
2210
|
+
* When no supported content profile is explicitly set on an MMS-capable phone number, the system uses the "SMS Default" profile. This default profile allows all media types (\*\/\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The "SMS Default" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile using the PATCH endpoint.
|
|
2211
2211
|
* @param {String} phoneNumberId phone number
|
|
2212
2212
|
* @param {Object} opts Optional parameters
|
|
2213
2213
|
* @param {Object} opts.expand Expand response with additional information
|
|
@@ -2236,7 +2236,7 @@ class RoutingApi {
|
|
|
2236
2236
|
|
|
2237
2237
|
/**
|
|
2238
2238
|
* Get a list of provisioned phone numbers.
|
|
2239
|
-
*
|
|
2239
|
+
* When no supported content profile is explicitly set, the system uses the "SMS Default" profile. This default profile allows all media types (\*\/\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The "SMS Default" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile.
|
|
2240
2240
|
* @param {Object} opts Optional parameters
|
|
2241
2241
|
* @param {String} opts.phoneNumber Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used.
|
|
2242
2242
|
* @param {Array.<String>} opts.phoneNumberType Filter on phone number type
|
|
@@ -3153,7 +3153,7 @@ class RoutingApi {
|
|
|
3153
3153
|
|
|
3154
3154
|
/**
|
|
3155
3155
|
* Update a phone number provisioned for SMS.
|
|
3156
|
-
*
|
|
3156
|
+
* Use this endpoint to assign a custom supported content profile to an MMS-capable phone number. If no supported content profile is set, the phone number uses the "SMS Default" profile, which allows all media types (\*\/\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To customize media filtering, provide a supported content profile ID in the request body.
|
|
3157
3157
|
* @param {String} phoneNumberId phone number
|
|
3158
3158
|
* @param {Object} body SmsPhoneNumberPatchRequest
|
|
3159
3159
|
*/
|
|
@@ -3996,7 +3996,7 @@ class RoutingApi {
|
|
|
3996
3996
|
|
|
3997
3997
|
/**
|
|
3998
3998
|
* Provision a phone number for SMS
|
|
3999
|
-
*
|
|
3999
|
+
* When provisioning an MMS-capable phone number, if no supported content profile is specified in the request, the system automatically assigns the "SMS Default" profile. This default profile allows all media types (\*\/\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To use custom media filtering, specify a supported content profile ID in the request body.
|
|
4000
4000
|
* @param {Object} body SmsPhoneNumber
|
|
4001
4001
|
*/
|
|
4002
4002
|
postRoutingSmsPhonenumbers(body) {
|
|
@@ -5,7 +5,7 @@ class TaskManagementApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* TaskManagement service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 249.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1887,9 +1887,8 @@ class TaskManagementApi {
|
|
|
1887
1887
|
|
|
1888
1888
|
/**
|
|
1889
1889
|
* Query for workitems
|
|
1890
|
-
* This query requires at least one EQ filter on the workbinId, assigneeId or typeId attributes.
|
|
1890
|
+
* This query requires at least one EQ filter on the workbinId, assigneeId, queueId or typeId attributes. A maximum of three filters are allowed.
|
|
1891
1891
|
* @param {Object} body WorkitemQueryPostRequest
|
|
1892
|
-
* postTaskmanagementWorkitemsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1893
1892
|
*/
|
|
1894
1893
|
postTaskmanagementWorkitemsQuery(body) {
|
|
1895
1894
|
// verify the required parameter 'body' is set
|
|
@@ -5,7 +5,7 @@ class TelephonyApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Telephony service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 249.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -109,6 +109,26 @@ class TelephonyApi {
|
|
|
109
109
|
);
|
|
110
110
|
}
|
|
111
111
|
|
|
112
|
+
/**
|
|
113
|
+
* Get the global telephony configuration.
|
|
114
|
+
*
|
|
115
|
+
*/
|
|
116
|
+
getTelephonySettings() {
|
|
117
|
+
|
|
118
|
+
return this.apiClient.callApi(
|
|
119
|
+
'/api/v2/telephony/settings',
|
|
120
|
+
'GET',
|
|
121
|
+
{ },
|
|
122
|
+
{ },
|
|
123
|
+
{ },
|
|
124
|
+
{ },
|
|
125
|
+
null,
|
|
126
|
+
['PureCloud OAuth'],
|
|
127
|
+
['application/json'],
|
|
128
|
+
['application/json']
|
|
129
|
+
);
|
|
130
|
+
}
|
|
131
|
+
|
|
112
132
|
/**
|
|
113
133
|
* Get a SIP message.
|
|
114
134
|
* Get the raw form of the SIP message
|
|
@@ -305,6 +325,31 @@ class TelephonyApi {
|
|
|
305
325
|
);
|
|
306
326
|
}
|
|
307
327
|
|
|
328
|
+
/**
|
|
329
|
+
* Update the global telephony configuration.
|
|
330
|
+
*
|
|
331
|
+
* @param {Object} body Telephony
|
|
332
|
+
*/
|
|
333
|
+
putTelephonySettings(body) {
|
|
334
|
+
// verify the required parameter 'body' is set
|
|
335
|
+
if (body === undefined || body === null) {
|
|
336
|
+
throw 'Missing the required parameter "body" when calling putTelephonySettings';
|
|
337
|
+
}
|
|
338
|
+
|
|
339
|
+
return this.apiClient.callApi(
|
|
340
|
+
'/api/v2/telephony/settings',
|
|
341
|
+
'PUT',
|
|
342
|
+
{ },
|
|
343
|
+
{ },
|
|
344
|
+
{ },
|
|
345
|
+
{ },
|
|
346
|
+
body,
|
|
347
|
+
['PureCloud OAuth'],
|
|
348
|
+
['application/json'],
|
|
349
|
+
['application/json']
|
|
350
|
+
);
|
|
351
|
+
}
|
|
352
|
+
|
|
308
353
|
}
|
|
309
354
|
|
|
310
355
|
|