purecloud-platform-client-v2 199.0.0 → 201.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 +1565 -120
- package/dist/web-amd/purecloud-platform-client-v2.js +1565 -120
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +476 -127
- package/dist/web-cjs/purecloud-platform-client-v2.js +592 -159
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +862 -244
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.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 +3 -3
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +3 -2
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- 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 +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 +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 +21 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +10 -3
- 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 +4 -4
- 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 +68 -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 +3 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +146 -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 +36 -31
- 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 -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 +149 -4
- 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 +1080 -26
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@ class AnalyticsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Analytics service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 201.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -2066,8 +2066,8 @@ class AnalyticsApi {
|
|
|
2066
2066
|
}
|
|
2067
2067
|
|
|
2068
2068
|
/**
|
|
2069
|
-
* Query for limits rate limit aggregates. Data populated when limits
|
|
2070
|
-
* The max property can be used to determine estimated rate limit value hit.
|
|
2069
|
+
* Query for limits rate limit aggregates. Data populated when limits reach 90% of the maximum. Not a source of truth for limits hit but a best effort estimate.
|
|
2070
|
+
* The max property can be used to determine estimated rate limit value hit. See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
|
|
2071
2071
|
* @param {Object} body query
|
|
2072
2072
|
*/
|
|
2073
2073
|
postAnalyticsRatelimitsAggregatesQuery(body) {
|
|
@@ -5,7 +5,7 @@ class AuditApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Audit service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 201.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -93,6 +93,7 @@ class AuditApi {
|
|
|
93
93
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
94
94
|
* @param {Number} opts.pageSize Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 500. (default to 25)
|
|
95
95
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
96
|
+
* @param {Boolean} opts.allowRedirect Result sets with large amounts of data will respond with a download url
|
|
96
97
|
*/
|
|
97
98
|
getAuditsQueryTransactionIdResults(transactionId, opts) {
|
|
98
99
|
opts = opts || {};
|
|
@@ -106,7 +107,7 @@ class AuditApi {
|
|
|
106
107
|
'/api/v2/audits/query/{transactionId}/results',
|
|
107
108
|
'GET',
|
|
108
109
|
{ 'transactionId': transactionId },
|
|
109
|
-
{ 'cursor': opts['cursor'],'pageSize': opts['pageSize'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
110
|
+
{ 'cursor': opts['cursor'],'pageSize': opts['pageSize'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'allowRedirect': opts['allowRedirect'] },
|
|
110
111
|
{ },
|
|
111
112
|
{ },
|
|
112
113
|
null,
|
|
@@ -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 201.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -554,6 +554,26 @@ class IntegrationsApi {
|
|
|
554
554
|
);
|
|
555
555
|
}
|
|
556
556
|
|
|
557
|
+
/**
|
|
558
|
+
* Retrieves basic info about trusted root CA certificates
|
|
559
|
+
*
|
|
560
|
+
*/
|
|
561
|
+
getIntegrationsActionsCertificatesTruststore() {
|
|
562
|
+
|
|
563
|
+
return this.apiClient.callApi(
|
|
564
|
+
'/api/v2/integrations/actions/certificates/truststore',
|
|
565
|
+
'GET',
|
|
566
|
+
{ },
|
|
567
|
+
{ },
|
|
568
|
+
{ },
|
|
569
|
+
{ },
|
|
570
|
+
null,
|
|
571
|
+
['PureCloud OAuth'],
|
|
572
|
+
['application/json'],
|
|
573
|
+
['application/json']
|
|
574
|
+
);
|
|
575
|
+
}
|
|
576
|
+
|
|
557
577
|
/**
|
|
558
578
|
* Retrieves all action drafts associated with the filters passed in via query param.
|
|
559
579
|
*
|
|
@@ -5,7 +5,7 @@ class JourneyApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Journey service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 201.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -961,15 +961,22 @@ class JourneyApi {
|
|
|
961
961
|
/**
|
|
962
962
|
* Get a list of Journey Views
|
|
963
963
|
*
|
|
964
|
+
* @param {Object} opts Optional parameters
|
|
965
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
966
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
967
|
+
* @param {String} opts.nameOrCreatedBy Journey View Name or Created By
|
|
968
|
+
* @param {Object} opts.expand Parameter to request additional data to return in Journey payload
|
|
964
969
|
* getJourneyViews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
965
970
|
*/
|
|
966
|
-
getJourneyViews() {
|
|
971
|
+
getJourneyViews(opts) {
|
|
972
|
+
opts = opts || {};
|
|
973
|
+
|
|
967
974
|
|
|
968
975
|
return this.apiClient.callApi(
|
|
969
976
|
'/api/v2/journey/views',
|
|
970
977
|
'GET',
|
|
971
978
|
{ },
|
|
972
|
-
{
|
|
979
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'nameOrCreatedBy': opts['nameOrCreatedBy'],'expand': opts['expand'] },
|
|
973
980
|
{ },
|
|
974
981
|
{ },
|
|
975
982
|
null,
|
|
@@ -5,7 +5,7 @@ class LearningApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Learning service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 201.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -151,7 +151,7 @@ class LearningApi {
|
|
|
151
151
|
* @param {Object} opts.sortOrder Specifies result set sort order; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
152
152
|
* @param {Object} opts.sortBy Specifies which field to sort the results by, default sort is by recommendedCompletionDate
|
|
153
153
|
* @param {Array.<String>} opts.userId Specifies the list of user IDs to be queried, up to 100 user IDs.
|
|
154
|
-
* @param {Array.<String>} opts.types Specifies the module types to filter by
|
|
154
|
+
* @param {Array.<String>} opts.types Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated
|
|
155
155
|
* @param {Array.<String>} opts.states Specifies the assignment states to filter by
|
|
156
156
|
* @param {Array.<String>} opts.expand Specifies the expand option for returning additional information
|
|
157
157
|
*/
|
|
@@ -188,7 +188,7 @@ class LearningApi {
|
|
|
188
188
|
* @param {Number} opts.maxPercentageScore The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)
|
|
189
189
|
* @param {Object} opts.sortOrder Specifies result set sort order; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
190
190
|
* @param {Object} opts.sortBy Specifies which field to sort the results by, default sort is by recommendedCompletionDate
|
|
191
|
-
* @param {Array.<String>} opts.types Specifies the module types to filter by
|
|
191
|
+
* @param {Array.<String>} opts.types Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated
|
|
192
192
|
* @param {Array.<String>} opts.states Specifies the assignment states to filter by
|
|
193
193
|
* @param {Array.<String>} opts.expand Specifies the expand option for returning additional information
|
|
194
194
|
*/
|
|
@@ -358,7 +358,7 @@ class LearningApi {
|
|
|
358
358
|
*
|
|
359
359
|
* @param {Object} opts Optional parameters
|
|
360
360
|
* @param {Boolean} opts.isArchived Archive status (default to false)
|
|
361
|
-
* @param {Array.<String>} opts.types Specifies the module types.
|
|
361
|
+
* @param {Array.<String>} opts.types Specifies the module types. Informational, AssessedContent and Assessment are deprecated
|
|
362
362
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
363
363
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
364
364
|
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
@@ -5,7 +5,7 @@ class OrganizationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Organization service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 201.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -226,6 +226,37 @@ class OrganizationApi {
|
|
|
226
226
|
);
|
|
227
227
|
}
|
|
228
228
|
|
|
229
|
+
/**
|
|
230
|
+
* Get estimated limit counts for a namespace. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking.
|
|
231
|
+
* See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
|
|
232
|
+
* @param {String} namespaceName The namespace to get
|
|
233
|
+
* @param {Object} opts Optional parameters
|
|
234
|
+
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
235
|
+
* @param {String} opts.entityId entity id of the count
|
|
236
|
+
* @param {String} opts.userId userid of the count
|
|
237
|
+
*/
|
|
238
|
+
getOrganizationsLimitsNamespaceCounts(namespaceName, opts) {
|
|
239
|
+
opts = opts || {};
|
|
240
|
+
|
|
241
|
+
// verify the required parameter 'namespaceName' is set
|
|
242
|
+
if (namespaceName === undefined || namespaceName === null) {
|
|
243
|
+
throw 'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceCounts';
|
|
244
|
+
}
|
|
245
|
+
|
|
246
|
+
return this.apiClient.callApi(
|
|
247
|
+
'/api/v2/organizations/limits/namespaces/{namespaceName}/counts',
|
|
248
|
+
'GET',
|
|
249
|
+
{ 'namespaceName': namespaceName },
|
|
250
|
+
{ 'cursor': opts['cursor'],'entityId': opts['entityId'],'userId': opts['userId'] },
|
|
251
|
+
{ },
|
|
252
|
+
{ },
|
|
253
|
+
null,
|
|
254
|
+
['PureCloud OAuth'],
|
|
255
|
+
['application/json'],
|
|
256
|
+
['application/json']
|
|
257
|
+
);
|
|
258
|
+
}
|
|
259
|
+
|
|
229
260
|
/**
|
|
230
261
|
* Get the default limits in a namespace for an organization
|
|
231
262
|
*
|
|
@@ -251,6 +282,42 @@ class OrganizationApi {
|
|
|
251
282
|
);
|
|
252
283
|
}
|
|
253
284
|
|
|
285
|
+
/**
|
|
286
|
+
* Get estimated limit counts for a namespace and limit name. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking.
|
|
287
|
+
* See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
|
|
288
|
+
* @param {String} namespaceName The namespace to get
|
|
289
|
+
* @param {String} limitName The limit to get
|
|
290
|
+
* @param {Object} opts Optional parameters
|
|
291
|
+
* @param {String} opts.entityId entity id of the count
|
|
292
|
+
* @param {String} opts.userId userid of the count
|
|
293
|
+
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
294
|
+
*/
|
|
295
|
+
getOrganizationsLimitsNamespaceLimitCounts(namespaceName, limitName, opts) {
|
|
296
|
+
opts = opts || {};
|
|
297
|
+
|
|
298
|
+
// verify the required parameter 'namespaceName' is set
|
|
299
|
+
if (namespaceName === undefined || namespaceName === null) {
|
|
300
|
+
throw 'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceLimitCounts';
|
|
301
|
+
}
|
|
302
|
+
// verify the required parameter 'limitName' is set
|
|
303
|
+
if (limitName === undefined || limitName === null) {
|
|
304
|
+
throw 'Missing the required parameter "limitName" when calling getOrganizationsLimitsNamespaceLimitCounts';
|
|
305
|
+
}
|
|
306
|
+
|
|
307
|
+
return this.apiClient.callApi(
|
|
308
|
+
'/api/v2/organizations/limits/namespaces/{namespaceName}/limits/{limitName}/counts',
|
|
309
|
+
'GET',
|
|
310
|
+
{ 'namespaceName': namespaceName,'limitName': limitName },
|
|
311
|
+
{ 'entityId': opts['entityId'],'userId': opts['userId'],'cursor': opts['cursor'] },
|
|
312
|
+
{ },
|
|
313
|
+
{ },
|
|
314
|
+
null,
|
|
315
|
+
['PureCloud OAuth'],
|
|
316
|
+
['application/json'],
|
|
317
|
+
['application/json']
|
|
318
|
+
);
|
|
319
|
+
}
|
|
320
|
+
|
|
254
321
|
/**
|
|
255
322
|
* Get the available limit namespaces
|
|
256
323
|
*
|