purecloud-platform-client-v2 191.0.0 → 192.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +417 -168
- package/dist/web-amd/purecloud-platform-client-v2.js +417 -168
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +203 -126
- package/dist/web-cjs/purecloud-platform-client-v2.js +251 -161
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +438 -247
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.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/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +13 -5
- 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 +127 -39
- 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 +30 -16
- 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/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +45 -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 +3 -2
- 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 +22 -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 +4 -3
- 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 +3 -3
- 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 +2 -2
- 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 +79 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -22
- 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 +8 -3
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +13 -5
- 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 +5 -3
- 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/index.js +1 -1
|
@@ -5,7 +5,7 @@ class FaxApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Fax service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 192.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -120,6 +120,26 @@ class FaxApi {
|
|
|
120
120
|
);
|
|
121
121
|
}
|
|
122
122
|
|
|
123
|
+
/**
|
|
124
|
+
* Get organization config for given organization
|
|
125
|
+
*
|
|
126
|
+
*/
|
|
127
|
+
getFaxSettings() {
|
|
128
|
+
|
|
129
|
+
return this.apiClient.callApi(
|
|
130
|
+
'/api/v2/fax/settings',
|
|
131
|
+
'GET',
|
|
132
|
+
{ },
|
|
133
|
+
{ },
|
|
134
|
+
{ },
|
|
135
|
+
{ },
|
|
136
|
+
null,
|
|
137
|
+
['PureCloud OAuth'],
|
|
138
|
+
['application/json'],
|
|
139
|
+
['application/json']
|
|
140
|
+
);
|
|
141
|
+
}
|
|
142
|
+
|
|
123
143
|
/**
|
|
124
144
|
* Get fax summary
|
|
125
145
|
*
|
|
@@ -170,6 +190,30 @@ class FaxApi {
|
|
|
170
190
|
);
|
|
171
191
|
}
|
|
172
192
|
|
|
193
|
+
/**
|
|
194
|
+
* Update/write organization config for given organization
|
|
195
|
+
*
|
|
196
|
+
* @param {Object} opts Optional parameters
|
|
197
|
+
* @param {Object} opts.body
|
|
198
|
+
*/
|
|
199
|
+
putFaxSettings(opts) {
|
|
200
|
+
opts = opts || {};
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
return this.apiClient.callApi(
|
|
204
|
+
'/api/v2/fax/settings',
|
|
205
|
+
'PUT',
|
|
206
|
+
{ },
|
|
207
|
+
{ },
|
|
208
|
+
{ },
|
|
209
|
+
{ },
|
|
210
|
+
opts['body'],
|
|
211
|
+
['PureCloud OAuth'],
|
|
212
|
+
['application/json'],
|
|
213
|
+
['application/json']
|
|
214
|
+
);
|
|
215
|
+
}
|
|
216
|
+
|
|
173
217
|
}
|
|
174
218
|
|
|
175
219
|
|
|
@@ -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 192.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -764,7 +764,7 @@ class IntegrationsApi {
|
|
|
764
764
|
|
|
765
765
|
/**
|
|
766
766
|
* UC integration client application configuration.
|
|
767
|
-
* This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.
|
|
767
|
+
* Deprecated: Please use GET /integrations/unifiedcommunications/clientapps instead. This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.
|
|
768
768
|
* @param {Object} opts Optional parameters
|
|
769
769
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
770
770
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -772,6 +772,7 @@ class IntegrationsApi {
|
|
|
772
772
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
773
773
|
* @param {String} opts.nextPage next page token
|
|
774
774
|
* @param {String} opts.previousPage Previous page token
|
|
775
|
+
* @deprecated
|
|
775
776
|
*/
|
|
776
777
|
getIntegrationsClientappsUnifiedcommunications(opts) {
|
|
777
778
|
opts = opts || {};
|
|
@@ -5,7 +5,7 @@ class LanguageUnderstandingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* LanguageUnderstanding service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 192.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -645,6 +645,27 @@ class LanguageUnderstandingApi {
|
|
|
645
645
|
);
|
|
646
646
|
}
|
|
647
647
|
|
|
648
|
+
/**
|
|
649
|
+
* Get Organization Configuration
|
|
650
|
+
*
|
|
651
|
+
* getLanguageunderstandingSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
652
|
+
*/
|
|
653
|
+
getLanguageunderstandingSettings() {
|
|
654
|
+
|
|
655
|
+
return this.apiClient.callApi(
|
|
656
|
+
'/api/v2/languageunderstanding/settings',
|
|
657
|
+
'GET',
|
|
658
|
+
{ },
|
|
659
|
+
{ },
|
|
660
|
+
{ },
|
|
661
|
+
{ },
|
|
662
|
+
null,
|
|
663
|
+
['PureCloud OAuth'],
|
|
664
|
+
['application/json'],
|
|
665
|
+
['application/json']
|
|
666
|
+
);
|
|
667
|
+
}
|
|
668
|
+
|
|
648
669
|
/**
|
|
649
670
|
* Update an NLU Domain.
|
|
650
671
|
*
|
|
@@ -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 192.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -2728,8 +2728,8 @@ class OutboundApi {
|
|
|
2728
2728
|
}
|
|
2729
2729
|
|
|
2730
2730
|
/**
|
|
2731
|
-
* Retrieves audits for dialer.
|
|
2732
|
-
*
|
|
2731
|
+
* Retrieves audits for dialer. (Deprecated)
|
|
2732
|
+
* This endpoint is deprecated as a result of this functionality being moved to the Audit Service. Please use "/api/v2/audits/query" instead.
|
|
2733
2733
|
* @param {Object} body AuditSearch
|
|
2734
2734
|
* @param {Object} opts Optional parameters
|
|
2735
2735
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
@@ -2737,6 +2737,7 @@ class OutboundApi {
|
|
|
2737
2737
|
* @param {String} opts.sortBy Sort by (default to entity.name)
|
|
2738
2738
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
2739
2739
|
* @param {Boolean} opts.facetsOnly Facets only (default to false)
|
|
2740
|
+
* @deprecated
|
|
2740
2741
|
*/
|
|
2741
2742
|
postOutboundAudits(body, opts) {
|
|
2742
2743
|
opts = opts || {};
|
|
@@ -5,7 +5,7 @@ class QualityApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Quality service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 192.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -341,7 +341,7 @@ class QualityApi {
|
|
|
341
341
|
|
|
342
342
|
/**
|
|
343
343
|
* Get the list of calibrations
|
|
344
|
-
*
|
|
344
|
+
* NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch.
|
|
345
345
|
* @param {String} calibratorId user id of calibrator
|
|
346
346
|
* @param {Object} opts Optional parameters
|
|
347
347
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
@@ -493,7 +493,7 @@ class QualityApi {
|
|
|
493
493
|
|
|
494
494
|
/**
|
|
495
495
|
* Queries Evaluations and returns a paged list
|
|
496
|
-
* Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to Never Release are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date.
|
|
496
|
+
* Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to Never Release are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date. NOTE: The count for total and pageCount might not be accurate when querying for a large number of evaluations. nextUri, if present, will indicate that there are more evaluations to fetch.
|
|
497
497
|
* @param {Object} opts Optional parameters
|
|
498
498
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
499
499
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* SpeechTextAnalytics service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 192.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -595,7 +595,7 @@ class SpeechTextAnalyticsApi {
|
|
|
595
595
|
*
|
|
596
596
|
* @param {Object} opts Optional parameters
|
|
597
597
|
* @param {String} opts.nextPage The key for listing the next page
|
|
598
|
-
* @param {Number} opts.pageSize The page size for the listing (default to 20)
|
|
598
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 500. (default to 20)
|
|
599
599
|
* @param {Object} opts.state Topic state. Defaults to latest
|
|
600
600
|
* @param {String} opts.name Case insensitive partial name to filter by
|
|
601
601
|
* @param {Array.<String>} opts.ids Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.
|
|
@@ -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 192.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -472,6 +472,58 @@ class TaskManagementApi {
|
|
|
472
472
|
);
|
|
473
473
|
}
|
|
474
474
|
|
|
475
|
+
/**
|
|
476
|
+
* Get the workitem query job associated with the job id.
|
|
477
|
+
*
|
|
478
|
+
* @param {String} jobId jobId
|
|
479
|
+
* getTaskmanagementWorkitemsQueryJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
480
|
+
*/
|
|
481
|
+
getTaskmanagementWorkitemsQueryJob(jobId) {
|
|
482
|
+
// verify the required parameter 'jobId' is set
|
|
483
|
+
if (jobId === undefined || jobId === null) {
|
|
484
|
+
throw 'Missing the required parameter "jobId" when calling getTaskmanagementWorkitemsQueryJob';
|
|
485
|
+
}
|
|
486
|
+
|
|
487
|
+
return this.apiClient.callApi(
|
|
488
|
+
'/api/v2/taskmanagement/workitems/query/jobs/{jobId}',
|
|
489
|
+
'GET',
|
|
490
|
+
{ 'jobId': jobId },
|
|
491
|
+
{ },
|
|
492
|
+
{ },
|
|
493
|
+
{ },
|
|
494
|
+
null,
|
|
495
|
+
['PureCloud OAuth'],
|
|
496
|
+
['application/json'],
|
|
497
|
+
['application/json']
|
|
498
|
+
);
|
|
499
|
+
}
|
|
500
|
+
|
|
501
|
+
/**
|
|
502
|
+
* Get results from for workitem query job
|
|
503
|
+
*
|
|
504
|
+
* @param {String} jobId jobId
|
|
505
|
+
* getTaskmanagementWorkitemsQueryJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
506
|
+
*/
|
|
507
|
+
getTaskmanagementWorkitemsQueryJobResults(jobId) {
|
|
508
|
+
// verify the required parameter 'jobId' is set
|
|
509
|
+
if (jobId === undefined || jobId === null) {
|
|
510
|
+
throw 'Missing the required parameter "jobId" when calling getTaskmanagementWorkitemsQueryJobResults';
|
|
511
|
+
}
|
|
512
|
+
|
|
513
|
+
return this.apiClient.callApi(
|
|
514
|
+
'/api/v2/taskmanagement/workitems/query/jobs/{jobId}/results',
|
|
515
|
+
'GET',
|
|
516
|
+
{ 'jobId': jobId },
|
|
517
|
+
{ },
|
|
518
|
+
{ },
|
|
519
|
+
{ },
|
|
520
|
+
null,
|
|
521
|
+
['PureCloud OAuth'],
|
|
522
|
+
['application/json'],
|
|
523
|
+
['application/json']
|
|
524
|
+
);
|
|
525
|
+
}
|
|
526
|
+
|
|
475
527
|
/**
|
|
476
528
|
* Get a schema
|
|
477
529
|
*
|
|
@@ -1168,6 +1220,32 @@ class TaskManagementApi {
|
|
|
1168
1220
|
);
|
|
1169
1221
|
}
|
|
1170
1222
|
|
|
1223
|
+
/**
|
|
1224
|
+
* Create a workitem query job
|
|
1225
|
+
*
|
|
1226
|
+
* @param {Object} body WorkitemQueryJobCreate
|
|
1227
|
+
* postTaskmanagementWorkitemsQueryJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1228
|
+
*/
|
|
1229
|
+
postTaskmanagementWorkitemsQueryJobs(body) {
|
|
1230
|
+
// verify the required parameter 'body' is set
|
|
1231
|
+
if (body === undefined || body === null) {
|
|
1232
|
+
throw 'Missing the required parameter "body" when calling postTaskmanagementWorkitemsQueryJobs';
|
|
1233
|
+
}
|
|
1234
|
+
|
|
1235
|
+
return this.apiClient.callApi(
|
|
1236
|
+
'/api/v2/taskmanagement/workitems/query/jobs',
|
|
1237
|
+
'POST',
|
|
1238
|
+
{ },
|
|
1239
|
+
{ },
|
|
1240
|
+
{ },
|
|
1241
|
+
{ },
|
|
1242
|
+
body,
|
|
1243
|
+
['PureCloud OAuth'],
|
|
1244
|
+
['application/json'],
|
|
1245
|
+
['application/json']
|
|
1246
|
+
);
|
|
1247
|
+
}
|
|
1248
|
+
|
|
1171
1249
|
/**
|
|
1172
1250
|
* Create a schema
|
|
1173
1251
|
*
|