purecloud-platform-client-v2 140.0.1 → 141.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 +252 -65
- package/dist/web-amd/purecloud-platform-client-v2.js +252 -65
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +252 -65
- package/dist/web-cjs/purecloud-platform-client-v2.js +252 -65
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +322 -200
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.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/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 +152 -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/IntegrationsApi.js +1 -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 +35 -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/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/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/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 +4 -2
- 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/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/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 +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 +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@ class GamificationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Gamification service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 141.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -628,6 +628,157 @@ class GamificationApi {
|
|
|
628
628
|
);
|
|
629
629
|
}
|
|
630
630
|
|
|
631
|
+
/**
|
|
632
|
+
* Average performance values trends by metric of a user
|
|
633
|
+
*
|
|
634
|
+
* @param {String} profileId performanceProfileId
|
|
635
|
+
* @param {String} metricId metricId
|
|
636
|
+
* @param {String} userId
|
|
637
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
638
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
639
|
+
* @param {Object} opts Optional parameters
|
|
640
|
+
* @param {String} opts.referenceWorkday Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
641
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
642
|
+
*/
|
|
643
|
+
getGamificationScorecardsProfileMetricUserValuesTrends(profileId, metricId, userId, startWorkday, endWorkday, opts) {
|
|
644
|
+
opts = opts || {};
|
|
645
|
+
|
|
646
|
+
// verify the required parameter 'profileId' is set
|
|
647
|
+
if (profileId === undefined || profileId === null) {
|
|
648
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
649
|
+
}
|
|
650
|
+
// verify the required parameter 'metricId' is set
|
|
651
|
+
if (metricId === undefined || metricId === null) {
|
|
652
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
653
|
+
}
|
|
654
|
+
// verify the required parameter 'userId' is set
|
|
655
|
+
if (userId === undefined || userId === null) {
|
|
656
|
+
throw 'Missing the required parameter "userId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
657
|
+
}
|
|
658
|
+
// verify the required parameter 'startWorkday' is set
|
|
659
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
660
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
661
|
+
}
|
|
662
|
+
// verify the required parameter 'endWorkday' is set
|
|
663
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
664
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
665
|
+
}
|
|
666
|
+
|
|
667
|
+
return this.apiClient.callApi(
|
|
668
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends',
|
|
669
|
+
'GET',
|
|
670
|
+
{ 'profileId': profileId,'metricId': metricId,'userId': userId },
|
|
671
|
+
{ 'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
672
|
+
{ },
|
|
673
|
+
{ },
|
|
674
|
+
null,
|
|
675
|
+
['PureCloud OAuth'],
|
|
676
|
+
['application/json'],
|
|
677
|
+
['application/json']
|
|
678
|
+
);
|
|
679
|
+
}
|
|
680
|
+
|
|
681
|
+
/**
|
|
682
|
+
* Average performance values trends by metric of a division or a performance profile
|
|
683
|
+
*
|
|
684
|
+
* @param {String} profileId performanceProfileId
|
|
685
|
+
* @param {String} metricId metricId
|
|
686
|
+
* @param {Object} filterType Filter type for the query request.
|
|
687
|
+
* @param {String} filterId ID for the filter type. For example, division Id
|
|
688
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
689
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
690
|
+
* @param {Object} opts Optional parameters
|
|
691
|
+
* @param {String} opts.referenceWorkday Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
692
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
693
|
+
*/
|
|
694
|
+
getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, filterId, startWorkday, endWorkday, opts) {
|
|
695
|
+
opts = opts || {};
|
|
696
|
+
|
|
697
|
+
// verify the required parameter 'profileId' is set
|
|
698
|
+
if (profileId === undefined || profileId === null) {
|
|
699
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
700
|
+
}
|
|
701
|
+
// verify the required parameter 'metricId' is set
|
|
702
|
+
if (metricId === undefined || metricId === null) {
|
|
703
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
704
|
+
}
|
|
705
|
+
// verify the required parameter 'filterType' is set
|
|
706
|
+
if (filterType === undefined || filterType === null) {
|
|
707
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
708
|
+
}
|
|
709
|
+
// verify the required parameter 'filterId' is set
|
|
710
|
+
if (filterId === undefined || filterId === null) {
|
|
711
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
712
|
+
}
|
|
713
|
+
// verify the required parameter 'startWorkday' is set
|
|
714
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
715
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
716
|
+
}
|
|
717
|
+
// verify the required parameter 'endWorkday' is set
|
|
718
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
719
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
720
|
+
}
|
|
721
|
+
|
|
722
|
+
return this.apiClient.callApi(
|
|
723
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends',
|
|
724
|
+
'GET',
|
|
725
|
+
{ 'profileId': profileId,'metricId': metricId },
|
|
726
|
+
{ 'filterType': filterType,'filterId': filterId,'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
727
|
+
{ },
|
|
728
|
+
{ },
|
|
729
|
+
null,
|
|
730
|
+
['PureCloud OAuth'],
|
|
731
|
+
['application/json'],
|
|
732
|
+
['application/json']
|
|
733
|
+
);
|
|
734
|
+
}
|
|
735
|
+
|
|
736
|
+
/**
|
|
737
|
+
* Average performance values trends by metric of the requesting user
|
|
738
|
+
*
|
|
739
|
+
* @param {String} profileId performanceProfileId
|
|
740
|
+
* @param {String} metricId metricId
|
|
741
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
742
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
743
|
+
* @param {Object} opts Optional parameters
|
|
744
|
+
* @param {Object} opts.filterType Filter type for the query request. If not set, returns the values trends of the requesting user
|
|
745
|
+
* @param {String} opts.referenceWorkday Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
746
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
747
|
+
*/
|
|
748
|
+
getGamificationScorecardsProfileMetricValuesTrends(profileId, metricId, startWorkday, endWorkday, opts) {
|
|
749
|
+
opts = opts || {};
|
|
750
|
+
|
|
751
|
+
// verify the required parameter 'profileId' is set
|
|
752
|
+
if (profileId === undefined || profileId === null) {
|
|
753
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
754
|
+
}
|
|
755
|
+
// verify the required parameter 'metricId' is set
|
|
756
|
+
if (metricId === undefined || metricId === null) {
|
|
757
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
758
|
+
}
|
|
759
|
+
// verify the required parameter 'startWorkday' is set
|
|
760
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
761
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
762
|
+
}
|
|
763
|
+
// verify the required parameter 'endWorkday' is set
|
|
764
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
765
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
766
|
+
}
|
|
767
|
+
|
|
768
|
+
return this.apiClient.callApi(
|
|
769
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends',
|
|
770
|
+
'GET',
|
|
771
|
+
{ 'profileId': profileId,'metricId': metricId },
|
|
772
|
+
{ 'filterType': opts['filterType'],'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
773
|
+
{ },
|
|
774
|
+
{ },
|
|
775
|
+
null,
|
|
776
|
+
['PureCloud OAuth'],
|
|
777
|
+
['application/json'],
|
|
778
|
+
['application/json']
|
|
779
|
+
);
|
|
780
|
+
}
|
|
781
|
+
|
|
631
782
|
/**
|
|
632
783
|
* Workday performance metrics for a user
|
|
633
784
|
*
|
|
@@ -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 141.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -324,6 +324,40 @@ class LearningApi {
|
|
|
324
324
|
);
|
|
325
325
|
}
|
|
326
326
|
|
|
327
|
+
/**
|
|
328
|
+
* Get all learning modules of an organization including assignments for a specific user
|
|
329
|
+
*
|
|
330
|
+
* @param {Array.<String>} userIds The IDs of the users to include
|
|
331
|
+
* @param {Object} opts Optional parameters
|
|
332
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
333
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
334
|
+
* @param {String} opts.searchTerm Search Term (searches by name and description)
|
|
335
|
+
* @param {Object} opts.overdue Specifies if only modules with overdue/not overdue (overdue is True or False) assignments are returned. If overdue is Any or omitted, both are returned and can including modules that are unassigned. (default to Any)
|
|
336
|
+
* @param {Array.<String>} opts.assignmentStates Specifies the assignment states to return.
|
|
337
|
+
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
338
|
+
*/
|
|
339
|
+
getLearningModulesAssignments(userIds, opts) {
|
|
340
|
+
opts = opts || {};
|
|
341
|
+
|
|
342
|
+
// verify the required parameter 'userIds' is set
|
|
343
|
+
if (userIds === undefined || userIds === null) {
|
|
344
|
+
throw 'Missing the required parameter "userIds" when calling getLearningModulesAssignments';
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
return this.apiClient.callApi(
|
|
348
|
+
'/api/v2/learning/modules/assignments',
|
|
349
|
+
'GET',
|
|
350
|
+
{ },
|
|
351
|
+
{ 'userIds': this.apiClient.buildCollectionParam(userIds, 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'searchTerm': opts['searchTerm'],'overdue': opts['overdue'],'assignmentStates': this.apiClient.buildCollectionParam(opts['assignmentStates'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
352
|
+
{ },
|
|
353
|
+
{ },
|
|
354
|
+
null,
|
|
355
|
+
['PureCloud OAuth'],
|
|
356
|
+
['application/json'],
|
|
357
|
+
['application/json']
|
|
358
|
+
);
|
|
359
|
+
}
|
|
360
|
+
|
|
327
361
|
/**
|
|
328
362
|
* Update Learning Assignment
|
|
329
363
|
*
|
|
@@ -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 141.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1115,6 +1115,8 @@ class RoutingApi {
|
|
|
1115
1115
|
* @param {String} opts.name Filter by queue name
|
|
1116
1116
|
* @param {Array.<String>} opts.id Filter by queue ID(s)
|
|
1117
1117
|
* @param {Array.<String>} opts.divisionId Filter by queue division ID(s)
|
|
1118
|
+
* @param {Array.<String>} opts.peerId Filter by queue peer ID(s)
|
|
1119
|
+
* @param {Boolean} opts.hasPeer Filter by queues associated with peer
|
|
1118
1120
|
*/
|
|
1119
1121
|
getRoutingQueues(opts) {
|
|
1120
1122
|
opts = opts || {};
|
|
@@ -1124,7 +1126,7 @@ class RoutingApi {
|
|
|
1124
1126
|
'/api/v2/routing/queues',
|
|
1125
1127
|
'GET',
|
|
1126
1128
|
{ },
|
|
1127
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
1129
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'peerId': this.apiClient.buildCollectionParam(opts['peerId'], 'multi'),'hasPeer': opts['hasPeer'] },
|
|
1128
1130
|
{ },
|
|
1129
1131
|
{ },
|
|
1130
1132
|
null,
|