purecloud-platform-client-v2 140.0.1 → 142.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 +488 -66
- package/dist/web-amd/purecloud-platform-client-v2.js +488 -66
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +488 -66
- package/dist/web-cjs/purecloud-platform-client-v2.js +488 -66
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +458 -199
- 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 +26 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +3 -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/TeamsApi.js +184 -0
- 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 +26 -1
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -401,7 +401,7 @@ class Configuration {
|
|
|
401
401
|
|
|
402
402
|
/**
|
|
403
403
|
* @module purecloud-platform-client-v2/ApiClient
|
|
404
|
-
* @version
|
|
404
|
+
* @version 142.0.0
|
|
405
405
|
*/
|
|
406
406
|
class ApiClient {
|
|
407
407
|
/**
|
|
@@ -1480,7 +1480,7 @@ class AlertingApi {
|
|
|
1480
1480
|
/**
|
|
1481
1481
|
* Alerting service.
|
|
1482
1482
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1483
|
-
* @version
|
|
1483
|
+
* @version 142.0.0
|
|
1484
1484
|
*/
|
|
1485
1485
|
|
|
1486
1486
|
/**
|
|
@@ -1794,7 +1794,7 @@ class AnalyticsApi {
|
|
|
1794
1794
|
/**
|
|
1795
1795
|
* Analytics service.
|
|
1796
1796
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1797
|
-
* @version
|
|
1797
|
+
* @version 142.0.0
|
|
1798
1798
|
*/
|
|
1799
1799
|
|
|
1800
1800
|
/**
|
|
@@ -2976,7 +2976,7 @@ class ArchitectApi {
|
|
|
2976
2976
|
/**
|
|
2977
2977
|
* Architect service.
|
|
2978
2978
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2979
|
-
* @version
|
|
2979
|
+
* @version 142.0.0
|
|
2980
2980
|
*/
|
|
2981
2981
|
|
|
2982
2982
|
/**
|
|
@@ -6021,7 +6021,7 @@ class AuditApi {
|
|
|
6021
6021
|
/**
|
|
6022
6022
|
* Audit service.
|
|
6023
6023
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6024
|
-
* @version
|
|
6024
|
+
* @version 142.0.0
|
|
6025
6025
|
*/
|
|
6026
6026
|
|
|
6027
6027
|
/**
|
|
@@ -6192,7 +6192,7 @@ class AuthorizationApi {
|
|
|
6192
6192
|
/**
|
|
6193
6193
|
* Authorization service.
|
|
6194
6194
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6195
|
-
* @version
|
|
6195
|
+
* @version 142.0.0
|
|
6196
6196
|
*/
|
|
6197
6197
|
|
|
6198
6198
|
/**
|
|
@@ -7375,7 +7375,7 @@ class BillingApi {
|
|
|
7375
7375
|
/**
|
|
7376
7376
|
* Billing service.
|
|
7377
7377
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7378
|
-
* @version
|
|
7378
|
+
* @version 142.0.0
|
|
7379
7379
|
*/
|
|
7380
7380
|
|
|
7381
7381
|
/**
|
|
@@ -7455,7 +7455,7 @@ class ChatApi {
|
|
|
7455
7455
|
/**
|
|
7456
7456
|
* Chat service.
|
|
7457
7457
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7458
|
-
* @version
|
|
7458
|
+
* @version 142.0.0
|
|
7459
7459
|
*/
|
|
7460
7460
|
|
|
7461
7461
|
/**
|
|
@@ -7546,7 +7546,7 @@ class CoachingApi {
|
|
|
7546
7546
|
/**
|
|
7547
7547
|
* Coaching service.
|
|
7548
7548
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7549
|
-
* @version
|
|
7549
|
+
* @version 142.0.0
|
|
7550
7550
|
*/
|
|
7551
7551
|
|
|
7552
7552
|
/**
|
|
@@ -8123,7 +8123,7 @@ class ContentManagementApi {
|
|
|
8123
8123
|
/**
|
|
8124
8124
|
* ContentManagement service.
|
|
8125
8125
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8126
|
-
* @version
|
|
8126
|
+
* @version 142.0.0
|
|
8127
8127
|
*/
|
|
8128
8128
|
|
|
8129
8129
|
/**
|
|
@@ -9263,7 +9263,7 @@ class ConversationsApi {
|
|
|
9263
9263
|
/**
|
|
9264
9264
|
* Conversations service.
|
|
9265
9265
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9266
|
-
* @version
|
|
9266
|
+
* @version 142.0.0
|
|
9267
9267
|
*/
|
|
9268
9268
|
|
|
9269
9269
|
/**
|
|
@@ -14197,7 +14197,7 @@ class DataExtensionsApi {
|
|
|
14197
14197
|
/**
|
|
14198
14198
|
* DataExtensions service.
|
|
14199
14199
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14200
|
-
* @version
|
|
14200
|
+
* @version 142.0.0
|
|
14201
14201
|
*/
|
|
14202
14202
|
|
|
14203
14203
|
/**
|
|
@@ -14283,7 +14283,7 @@ class ExternalContactsApi {
|
|
|
14283
14283
|
/**
|
|
14284
14284
|
* ExternalContacts service.
|
|
14285
14285
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14286
|
-
* @version
|
|
14286
|
+
* @version 142.0.0
|
|
14287
14287
|
*/
|
|
14288
14288
|
|
|
14289
14289
|
/**
|
|
@@ -16026,7 +16026,7 @@ class FaxApi {
|
|
|
16026
16026
|
/**
|
|
16027
16027
|
* Fax service.
|
|
16028
16028
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16029
|
-
* @version
|
|
16029
|
+
* @version 142.0.0
|
|
16030
16030
|
*/
|
|
16031
16031
|
|
|
16032
16032
|
/**
|
|
@@ -16197,7 +16197,7 @@ class FlowsApi {
|
|
|
16197
16197
|
/**
|
|
16198
16198
|
* Flows service.
|
|
16199
16199
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16200
|
-
* @version
|
|
16200
|
+
* @version 142.0.0
|
|
16201
16201
|
*/
|
|
16202
16202
|
|
|
16203
16203
|
/**
|
|
@@ -16268,7 +16268,7 @@ class GamificationApi {
|
|
|
16268
16268
|
/**
|
|
16269
16269
|
* Gamification service.
|
|
16270
16270
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16271
|
-
* @version
|
|
16271
|
+
* @version 142.0.0
|
|
16272
16272
|
*/
|
|
16273
16273
|
|
|
16274
16274
|
/**
|
|
@@ -16891,6 +16891,157 @@ class GamificationApi {
|
|
|
16891
16891
|
);
|
|
16892
16892
|
}
|
|
16893
16893
|
|
|
16894
|
+
/**
|
|
16895
|
+
* Average performance values trends by metric of a user
|
|
16896
|
+
*
|
|
16897
|
+
* @param {String} profileId performanceProfileId
|
|
16898
|
+
* @param {String} metricId metricId
|
|
16899
|
+
* @param {String} userId
|
|
16900
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
16901
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
16902
|
+
* @param {Object} opts Optional parameters
|
|
16903
|
+
* @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
|
|
16904
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
16905
|
+
*/
|
|
16906
|
+
getGamificationScorecardsProfileMetricUserValuesTrends(profileId, metricId, userId, startWorkday, endWorkday, opts) {
|
|
16907
|
+
opts = opts || {};
|
|
16908
|
+
|
|
16909
|
+
// verify the required parameter 'profileId' is set
|
|
16910
|
+
if (profileId === undefined || profileId === null) {
|
|
16911
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16912
|
+
}
|
|
16913
|
+
// verify the required parameter 'metricId' is set
|
|
16914
|
+
if (metricId === undefined || metricId === null) {
|
|
16915
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16916
|
+
}
|
|
16917
|
+
// verify the required parameter 'userId' is set
|
|
16918
|
+
if (userId === undefined || userId === null) {
|
|
16919
|
+
throw 'Missing the required parameter "userId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16920
|
+
}
|
|
16921
|
+
// verify the required parameter 'startWorkday' is set
|
|
16922
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
16923
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16924
|
+
}
|
|
16925
|
+
// verify the required parameter 'endWorkday' is set
|
|
16926
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
16927
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16928
|
+
}
|
|
16929
|
+
|
|
16930
|
+
return this.apiClient.callApi(
|
|
16931
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends',
|
|
16932
|
+
'GET',
|
|
16933
|
+
{ 'profileId': profileId,'metricId': metricId,'userId': userId },
|
|
16934
|
+
{ 'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
16935
|
+
{ },
|
|
16936
|
+
{ },
|
|
16937
|
+
null,
|
|
16938
|
+
['PureCloud OAuth'],
|
|
16939
|
+
['application/json'],
|
|
16940
|
+
['application/json']
|
|
16941
|
+
);
|
|
16942
|
+
}
|
|
16943
|
+
|
|
16944
|
+
/**
|
|
16945
|
+
* Average performance values trends by metric of a division or a performance profile
|
|
16946
|
+
*
|
|
16947
|
+
* @param {String} profileId performanceProfileId
|
|
16948
|
+
* @param {String} metricId metricId
|
|
16949
|
+
* @param {Object} filterType Filter type for the query request.
|
|
16950
|
+
* @param {String} filterId ID for the filter type. For example, division Id
|
|
16951
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
16952
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
16953
|
+
* @param {Object} opts Optional parameters
|
|
16954
|
+
* @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
|
|
16955
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
16956
|
+
*/
|
|
16957
|
+
getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, filterId, startWorkday, endWorkday, opts) {
|
|
16958
|
+
opts = opts || {};
|
|
16959
|
+
|
|
16960
|
+
// verify the required parameter 'profileId' is set
|
|
16961
|
+
if (profileId === undefined || profileId === null) {
|
|
16962
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16963
|
+
}
|
|
16964
|
+
// verify the required parameter 'metricId' is set
|
|
16965
|
+
if (metricId === undefined || metricId === null) {
|
|
16966
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16967
|
+
}
|
|
16968
|
+
// verify the required parameter 'filterType' is set
|
|
16969
|
+
if (filterType === undefined || filterType === null) {
|
|
16970
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16971
|
+
}
|
|
16972
|
+
// verify the required parameter 'filterId' is set
|
|
16973
|
+
if (filterId === undefined || filterId === null) {
|
|
16974
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16975
|
+
}
|
|
16976
|
+
// verify the required parameter 'startWorkday' is set
|
|
16977
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
16978
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16979
|
+
}
|
|
16980
|
+
// verify the required parameter 'endWorkday' is set
|
|
16981
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
16982
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16983
|
+
}
|
|
16984
|
+
|
|
16985
|
+
return this.apiClient.callApi(
|
|
16986
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends',
|
|
16987
|
+
'GET',
|
|
16988
|
+
{ 'profileId': profileId,'metricId': metricId },
|
|
16989
|
+
{ 'filterType': filterType,'filterId': filterId,'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
16990
|
+
{ },
|
|
16991
|
+
{ },
|
|
16992
|
+
null,
|
|
16993
|
+
['PureCloud OAuth'],
|
|
16994
|
+
['application/json'],
|
|
16995
|
+
['application/json']
|
|
16996
|
+
);
|
|
16997
|
+
}
|
|
16998
|
+
|
|
16999
|
+
/**
|
|
17000
|
+
* Average performance values trends by metric of the requesting user
|
|
17001
|
+
*
|
|
17002
|
+
* @param {String} profileId performanceProfileId
|
|
17003
|
+
* @param {String} metricId metricId
|
|
17004
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
17005
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
17006
|
+
* @param {Object} opts Optional parameters
|
|
17007
|
+
* @param {Object} opts.filterType Filter type for the query request. If not set, returns the values trends of the requesting user
|
|
17008
|
+
* @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
|
|
17009
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
17010
|
+
*/
|
|
17011
|
+
getGamificationScorecardsProfileMetricValuesTrends(profileId, metricId, startWorkday, endWorkday, opts) {
|
|
17012
|
+
opts = opts || {};
|
|
17013
|
+
|
|
17014
|
+
// verify the required parameter 'profileId' is set
|
|
17015
|
+
if (profileId === undefined || profileId === null) {
|
|
17016
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
17017
|
+
}
|
|
17018
|
+
// verify the required parameter 'metricId' is set
|
|
17019
|
+
if (metricId === undefined || metricId === null) {
|
|
17020
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
17021
|
+
}
|
|
17022
|
+
// verify the required parameter 'startWorkday' is set
|
|
17023
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
17024
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
17025
|
+
}
|
|
17026
|
+
// verify the required parameter 'endWorkday' is set
|
|
17027
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
17028
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
17029
|
+
}
|
|
17030
|
+
|
|
17031
|
+
return this.apiClient.callApi(
|
|
17032
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends',
|
|
17033
|
+
'GET',
|
|
17034
|
+
{ 'profileId': profileId,'metricId': metricId },
|
|
17035
|
+
{ 'filterType': opts['filterType'],'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
17036
|
+
{ },
|
|
17037
|
+
{ },
|
|
17038
|
+
null,
|
|
17039
|
+
['PureCloud OAuth'],
|
|
17040
|
+
['application/json'],
|
|
17041
|
+
['application/json']
|
|
17042
|
+
);
|
|
17043
|
+
}
|
|
17044
|
+
|
|
16894
17045
|
/**
|
|
16895
17046
|
* Workday performance metrics for a user
|
|
16896
17047
|
*
|
|
@@ -17699,7 +17850,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
17699
17850
|
/**
|
|
17700
17851
|
* GeneralDataProtectionRegulation service.
|
|
17701
17852
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
17702
|
-
* @version
|
|
17853
|
+
* @version 142.0.0
|
|
17703
17854
|
*/
|
|
17704
17855
|
|
|
17705
17856
|
/**
|
|
@@ -17829,7 +17980,7 @@ class GeolocationApi {
|
|
|
17829
17980
|
/**
|
|
17830
17981
|
* Geolocation service.
|
|
17831
17982
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17832
|
-
* @version
|
|
17983
|
+
* @version 142.0.0
|
|
17833
17984
|
*/
|
|
17834
17985
|
|
|
17835
17986
|
/**
|
|
@@ -17960,7 +18111,7 @@ class GreetingsApi {
|
|
|
17960
18111
|
/**
|
|
17961
18112
|
* Greetings service.
|
|
17962
18113
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17963
|
-
* @version
|
|
18114
|
+
* @version 142.0.0
|
|
17964
18115
|
*/
|
|
17965
18116
|
|
|
17966
18117
|
/**
|
|
@@ -18415,7 +18566,7 @@ class GroupsApi {
|
|
|
18415
18566
|
/**
|
|
18416
18567
|
* Groups service.
|
|
18417
18568
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
18418
|
-
* @version
|
|
18569
|
+
* @version 142.0.0
|
|
18419
18570
|
*/
|
|
18420
18571
|
|
|
18421
18572
|
/**
|
|
@@ -18820,7 +18971,7 @@ class IdentityProviderApi {
|
|
|
18820
18971
|
/**
|
|
18821
18972
|
* IdentityProvider service.
|
|
18822
18973
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18823
|
-
* @version
|
|
18974
|
+
* @version 142.0.0
|
|
18824
18975
|
*/
|
|
18825
18976
|
|
|
18826
18977
|
/**
|
|
@@ -19576,7 +19727,7 @@ class IntegrationsApi {
|
|
|
19576
19727
|
/**
|
|
19577
19728
|
* Integrations service.
|
|
19578
19729
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
19579
|
-
* @version
|
|
19730
|
+
* @version 142.0.0
|
|
19580
19731
|
*/
|
|
19581
19732
|
|
|
19582
19733
|
/**
|
|
@@ -21253,7 +21404,7 @@ class JourneyApi {
|
|
|
21253
21404
|
/**
|
|
21254
21405
|
* Journey service.
|
|
21255
21406
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
21256
|
-
* @version
|
|
21407
|
+
* @version 142.0.0
|
|
21257
21408
|
*/
|
|
21258
21409
|
|
|
21259
21410
|
/**
|
|
@@ -21964,7 +22115,7 @@ class KnowledgeApi {
|
|
|
21964
22115
|
/**
|
|
21965
22116
|
* Knowledge service.
|
|
21966
22117
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21967
|
-
* @version
|
|
22118
|
+
* @version 142.0.0
|
|
21968
22119
|
*/
|
|
21969
22120
|
|
|
21970
22121
|
/**
|
|
@@ -22864,7 +23015,7 @@ class LanguageUnderstandingApi {
|
|
|
22864
23015
|
/**
|
|
22865
23016
|
* LanguageUnderstanding service.
|
|
22866
23017
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22867
|
-
* @version
|
|
23018
|
+
* @version 142.0.0
|
|
22868
23019
|
*/
|
|
22869
23020
|
|
|
22870
23021
|
/**
|
|
@@ -23768,7 +23919,7 @@ class LanguagesApi {
|
|
|
23768
23919
|
/**
|
|
23769
23920
|
* Languages service.
|
|
23770
23921
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
23771
|
-
* @version
|
|
23922
|
+
* @version 142.0.0
|
|
23772
23923
|
*/
|
|
23773
23924
|
|
|
23774
23925
|
/**
|
|
@@ -24036,7 +24187,7 @@ class LearningApi {
|
|
|
24036
24187
|
/**
|
|
24037
24188
|
* Learning service.
|
|
24038
24189
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
24039
|
-
* @version
|
|
24190
|
+
* @version 142.0.0
|
|
24040
24191
|
*/
|
|
24041
24192
|
|
|
24042
24193
|
/**
|
|
@@ -24355,6 +24506,40 @@ class LearningApi {
|
|
|
24355
24506
|
);
|
|
24356
24507
|
}
|
|
24357
24508
|
|
|
24509
|
+
/**
|
|
24510
|
+
* Get all learning modules of an organization including assignments for a specific user
|
|
24511
|
+
*
|
|
24512
|
+
* @param {Array.<String>} userIds The IDs of the users to include
|
|
24513
|
+
* @param {Object} opts Optional parameters
|
|
24514
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
24515
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
24516
|
+
* @param {String} opts.searchTerm Search Term (searches by name and description)
|
|
24517
|
+
* @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)
|
|
24518
|
+
* @param {Array.<String>} opts.assignmentStates Specifies the assignment states to return.
|
|
24519
|
+
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
24520
|
+
*/
|
|
24521
|
+
getLearningModulesAssignments(userIds, opts) {
|
|
24522
|
+
opts = opts || {};
|
|
24523
|
+
|
|
24524
|
+
// verify the required parameter 'userIds' is set
|
|
24525
|
+
if (userIds === undefined || userIds === null) {
|
|
24526
|
+
throw 'Missing the required parameter "userIds" when calling getLearningModulesAssignments';
|
|
24527
|
+
}
|
|
24528
|
+
|
|
24529
|
+
return this.apiClient.callApi(
|
|
24530
|
+
'/api/v2/learning/modules/assignments',
|
|
24531
|
+
'GET',
|
|
24532
|
+
{ },
|
|
24533
|
+
{ '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') },
|
|
24534
|
+
{ },
|
|
24535
|
+
{ },
|
|
24536
|
+
null,
|
|
24537
|
+
['PureCloud OAuth'],
|
|
24538
|
+
['application/json'],
|
|
24539
|
+
['application/json']
|
|
24540
|
+
);
|
|
24541
|
+
}
|
|
24542
|
+
|
|
24358
24543
|
/**
|
|
24359
24544
|
* Update Learning Assignment
|
|
24360
24545
|
*
|
|
@@ -24737,7 +24922,7 @@ class LicenseApi {
|
|
|
24737
24922
|
/**
|
|
24738
24923
|
* License service.
|
|
24739
24924
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
24740
|
-
* @version
|
|
24925
|
+
* @version 142.0.0
|
|
24741
24926
|
*/
|
|
24742
24927
|
|
|
24743
24928
|
/**
|
|
@@ -24975,7 +25160,7 @@ class LocationsApi {
|
|
|
24975
25160
|
/**
|
|
24976
25161
|
* Locations service.
|
|
24977
25162
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24978
|
-
* @version
|
|
25163
|
+
* @version 142.0.0
|
|
24979
25164
|
*/
|
|
24980
25165
|
|
|
24981
25166
|
/**
|
|
@@ -25211,7 +25396,7 @@ class MessagingApi {
|
|
|
25211
25396
|
/**
|
|
25212
25397
|
* Messaging service.
|
|
25213
25398
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
25214
|
-
* @version
|
|
25399
|
+
* @version 142.0.0
|
|
25215
25400
|
*/
|
|
25216
25401
|
|
|
25217
25402
|
/**
|
|
@@ -25362,7 +25547,7 @@ class MobileDevicesApi {
|
|
|
25362
25547
|
/**
|
|
25363
25548
|
* MobileDevices service.
|
|
25364
25549
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
25365
|
-
* @version
|
|
25550
|
+
* @version 142.0.0
|
|
25366
25551
|
*/
|
|
25367
25552
|
|
|
25368
25553
|
/**
|
|
@@ -25513,7 +25698,7 @@ class NotificationsApi {
|
|
|
25513
25698
|
/**
|
|
25514
25699
|
* Notifications service.
|
|
25515
25700
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
25516
|
-
* @version
|
|
25701
|
+
* @version 142.0.0
|
|
25517
25702
|
*/
|
|
25518
25703
|
|
|
25519
25704
|
/**
|
|
@@ -25738,7 +25923,7 @@ class OAuthApi {
|
|
|
25738
25923
|
/**
|
|
25739
25924
|
* OAuth service.
|
|
25740
25925
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
25741
|
-
* @version
|
|
25926
|
+
* @version 142.0.0
|
|
25742
25927
|
*/
|
|
25743
25928
|
|
|
25744
25929
|
/**
|
|
@@ -26104,7 +26289,7 @@ class ObjectsApi {
|
|
|
26104
26289
|
/**
|
|
26105
26290
|
* Objects service.
|
|
26106
26291
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
26107
|
-
* @version
|
|
26292
|
+
* @version 142.0.0
|
|
26108
26293
|
*/
|
|
26109
26294
|
|
|
26110
26295
|
/**
|
|
@@ -26375,7 +26560,7 @@ class OrganizationApi {
|
|
|
26375
26560
|
/**
|
|
26376
26561
|
* Organization service.
|
|
26377
26562
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
26378
|
-
* @version
|
|
26563
|
+
* @version 142.0.0
|
|
26379
26564
|
*/
|
|
26380
26565
|
|
|
26381
26566
|
/**
|
|
@@ -26778,7 +26963,7 @@ class OrganizationAuthorizationApi {
|
|
|
26778
26963
|
/**
|
|
26779
26964
|
* OrganizationAuthorization service.
|
|
26780
26965
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
26781
|
-
* @version
|
|
26966
|
+
* @version 142.0.0
|
|
26782
26967
|
*/
|
|
26783
26968
|
|
|
26784
26969
|
/**
|
|
@@ -27703,7 +27888,7 @@ class OutboundApi {
|
|
|
27703
27888
|
/**
|
|
27704
27889
|
* Outbound service.
|
|
27705
27890
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
27706
|
-
* @version
|
|
27891
|
+
* @version 142.0.0
|
|
27707
27892
|
*/
|
|
27708
27893
|
|
|
27709
27894
|
/**
|
|
@@ -30958,7 +31143,7 @@ class PresenceApi {
|
|
|
30958
31143
|
/**
|
|
30959
31144
|
* Presence service.
|
|
30960
31145
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
30961
|
-
* @version
|
|
31146
|
+
* @version 142.0.0
|
|
30962
31147
|
*/
|
|
30963
31148
|
|
|
30964
31149
|
/**
|
|
@@ -31280,7 +31465,7 @@ class QualityApi {
|
|
|
31280
31465
|
/**
|
|
31281
31466
|
* Quality service.
|
|
31282
31467
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
31283
|
-
* @version
|
|
31468
|
+
* @version 142.0.0
|
|
31284
31469
|
*/
|
|
31285
31470
|
|
|
31286
31471
|
/**
|
|
@@ -32858,7 +33043,7 @@ class RecordingApi {
|
|
|
32858
33043
|
/**
|
|
32859
33044
|
* Recording service.
|
|
32860
33045
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
32861
|
-
* @version
|
|
33046
|
+
* @version 142.0.0
|
|
32862
33047
|
*/
|
|
32863
33048
|
|
|
32864
33049
|
/**
|
|
@@ -34511,7 +34696,7 @@ class ResponseManagementApi {
|
|
|
34511
34696
|
/**
|
|
34512
34697
|
* ResponseManagement service.
|
|
34513
34698
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
34514
|
-
* @version
|
|
34699
|
+
* @version 142.0.0
|
|
34515
34700
|
*/
|
|
34516
34701
|
|
|
34517
34702
|
/**
|
|
@@ -34995,7 +35180,7 @@ class RoutingApi {
|
|
|
34995
35180
|
/**
|
|
34996
35181
|
* Routing service.
|
|
34997
35182
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
34998
|
-
* @version
|
|
35183
|
+
* @version 142.0.0
|
|
34999
35184
|
*/
|
|
35000
35185
|
|
|
35001
35186
|
/**
|
|
@@ -36105,6 +36290,8 @@ class RoutingApi {
|
|
|
36105
36290
|
* @param {String} opts.name Filter by queue name
|
|
36106
36291
|
* @param {Array.<String>} opts.id Filter by queue ID(s)
|
|
36107
36292
|
* @param {Array.<String>} opts.divisionId Filter by queue division ID(s)
|
|
36293
|
+
* @param {Array.<String>} opts.peerId Filter by queue peer ID(s)
|
|
36294
|
+
* @param {Boolean} opts.hasPeer Filter by queues associated with peer
|
|
36108
36295
|
*/
|
|
36109
36296
|
getRoutingQueues(opts) {
|
|
36110
36297
|
opts = opts || {};
|
|
@@ -36114,7 +36301,7 @@ class RoutingApi {
|
|
|
36114
36301
|
'/api/v2/routing/queues',
|
|
36115
36302
|
'GET',
|
|
36116
36303
|
{ },
|
|
36117
|
-
{ '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') },
|
|
36304
|
+
{ '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'] },
|
|
36118
36305
|
{ },
|
|
36119
36306
|
{ },
|
|
36120
36307
|
null,
|
|
@@ -37914,7 +38101,7 @@ class SCIMApi {
|
|
|
37914
38101
|
/**
|
|
37915
38102
|
* SCIM service.
|
|
37916
38103
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
37917
|
-
* @version
|
|
38104
|
+
* @version 142.0.0
|
|
37918
38105
|
*/
|
|
37919
38106
|
|
|
37920
38107
|
/**
|
|
@@ -38791,7 +38978,7 @@ class ScriptsApi {
|
|
|
38791
38978
|
/**
|
|
38792
38979
|
* Scripts service.
|
|
38793
38980
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
38794
|
-
* @version
|
|
38981
|
+
* @version 142.0.0
|
|
38795
38982
|
*/
|
|
38796
38983
|
|
|
38797
38984
|
/**
|
|
@@ -39210,7 +39397,7 @@ class SearchApi {
|
|
|
39210
39397
|
/**
|
|
39211
39398
|
* Search service.
|
|
39212
39399
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
39213
|
-
* @version
|
|
39400
|
+
* @version 142.0.0
|
|
39214
39401
|
*/
|
|
39215
39402
|
|
|
39216
39403
|
/**
|
|
@@ -39689,6 +39876,31 @@ class SearchApi {
|
|
|
39689
39876
|
);
|
|
39690
39877
|
}
|
|
39691
39878
|
|
|
39879
|
+
/**
|
|
39880
|
+
* Search resources.
|
|
39881
|
+
*
|
|
39882
|
+
* @param {Object} body Search request options
|
|
39883
|
+
*/
|
|
39884
|
+
postTeamsSearch(body) {
|
|
39885
|
+
// verify the required parameter 'body' is set
|
|
39886
|
+
if (body === undefined || body === null) {
|
|
39887
|
+
throw 'Missing the required parameter "body" when calling postTeamsSearch';
|
|
39888
|
+
}
|
|
39889
|
+
|
|
39890
|
+
return this.apiClient.callApi(
|
|
39891
|
+
'/api/v2/teams/search',
|
|
39892
|
+
'POST',
|
|
39893
|
+
{ },
|
|
39894
|
+
{ },
|
|
39895
|
+
{ },
|
|
39896
|
+
{ },
|
|
39897
|
+
body,
|
|
39898
|
+
['PureCloud OAuth'],
|
|
39899
|
+
['application/json'],
|
|
39900
|
+
['application/json']
|
|
39901
|
+
);
|
|
39902
|
+
}
|
|
39903
|
+
|
|
39692
39904
|
/**
|
|
39693
39905
|
* Search users
|
|
39694
39906
|
*
|
|
@@ -39745,7 +39957,7 @@ class SpeechTextAnalyticsApi {
|
|
|
39745
39957
|
/**
|
|
39746
39958
|
* SpeechTextAnalytics service.
|
|
39747
39959
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
39748
|
-
* @version
|
|
39960
|
+
* @version 142.0.0
|
|
39749
39961
|
*/
|
|
39750
39962
|
|
|
39751
39963
|
/**
|
|
@@ -39970,6 +40182,7 @@ class SpeechTextAnalyticsApi {
|
|
|
39970
40182
|
* @param {Object} opts Optional parameters
|
|
39971
40183
|
* @param {String} opts.nextPage The key for listing the next page
|
|
39972
40184
|
* @param {Number} opts.pageSize The page size for the listing (default to 20)
|
|
40185
|
+
* @param {Object} opts.state Program state. Defaults to Latest
|
|
39973
40186
|
*/
|
|
39974
40187
|
getSpeechandtextanalyticsPrograms(opts) {
|
|
39975
40188
|
opts = opts || {};
|
|
@@ -39979,7 +40192,7 @@ class SpeechTextAnalyticsApi {
|
|
|
39979
40192
|
'/api/v2/speechandtextanalytics/programs',
|
|
39980
40193
|
'GET',
|
|
39981
40194
|
{ },
|
|
39982
|
-
{ 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'] },
|
|
40195
|
+
{ 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'],'state': opts['state'] },
|
|
39983
40196
|
{ },
|
|
39984
40197
|
{ },
|
|
39985
40198
|
null,
|
|
@@ -40598,7 +40811,7 @@ class StationsApi {
|
|
|
40598
40811
|
/**
|
|
40599
40812
|
* Stations service.
|
|
40600
40813
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
40601
|
-
* @version
|
|
40814
|
+
* @version 142.0.0
|
|
40602
40815
|
*/
|
|
40603
40816
|
|
|
40604
40817
|
/**
|
|
@@ -40745,7 +40958,7 @@ class SuggestApi {
|
|
|
40745
40958
|
/**
|
|
40746
40959
|
* Suggest service.
|
|
40747
40960
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
40748
|
-
* @version
|
|
40961
|
+
* @version 142.0.0
|
|
40749
40962
|
*/
|
|
40750
40963
|
|
|
40751
40964
|
/**
|
|
@@ -40880,11 +41093,190 @@ class SuggestApi {
|
|
|
40880
41093
|
|
|
40881
41094
|
}
|
|
40882
41095
|
|
|
41096
|
+
class TeamsApi {
|
|
41097
|
+
/**
|
|
41098
|
+
* Teams service.
|
|
41099
|
+
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
41100
|
+
* @version 142.0.0
|
|
41101
|
+
*/
|
|
41102
|
+
|
|
41103
|
+
/**
|
|
41104
|
+
* Constructs a new TeamsApi.
|
|
41105
|
+
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
41106
|
+
* @class
|
|
41107
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
41108
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
41109
|
+
*/
|
|
41110
|
+
constructor(apiClient) {
|
|
41111
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
41112
|
+
}
|
|
41113
|
+
|
|
41114
|
+
|
|
41115
|
+
/**
|
|
41116
|
+
* Delete team
|
|
41117
|
+
*
|
|
41118
|
+
* @param {String} teamId Team ID
|
|
41119
|
+
*/
|
|
41120
|
+
deleteTeam(teamId) {
|
|
41121
|
+
// verify the required parameter 'teamId' is set
|
|
41122
|
+
if (teamId === undefined || teamId === null) {
|
|
41123
|
+
throw 'Missing the required parameter "teamId" when calling deleteTeam';
|
|
41124
|
+
}
|
|
41125
|
+
|
|
41126
|
+
return this.apiClient.callApi(
|
|
41127
|
+
'/api/v2/teams/{teamId}',
|
|
41128
|
+
'DELETE',
|
|
41129
|
+
{ 'teamId': teamId },
|
|
41130
|
+
{ },
|
|
41131
|
+
{ },
|
|
41132
|
+
{ },
|
|
41133
|
+
null,
|
|
41134
|
+
['PureCloud OAuth'],
|
|
41135
|
+
['application/json'],
|
|
41136
|
+
['application/json']
|
|
41137
|
+
);
|
|
41138
|
+
}
|
|
41139
|
+
|
|
41140
|
+
/**
|
|
41141
|
+
* Get team
|
|
41142
|
+
*
|
|
41143
|
+
* @param {String} teamId Team ID
|
|
41144
|
+
*/
|
|
41145
|
+
getTeam(teamId) {
|
|
41146
|
+
// verify the required parameter 'teamId' is set
|
|
41147
|
+
if (teamId === undefined || teamId === null) {
|
|
41148
|
+
throw 'Missing the required parameter "teamId" when calling getTeam';
|
|
41149
|
+
}
|
|
41150
|
+
|
|
41151
|
+
return this.apiClient.callApi(
|
|
41152
|
+
'/api/v2/teams/{teamId}',
|
|
41153
|
+
'GET',
|
|
41154
|
+
{ 'teamId': teamId },
|
|
41155
|
+
{ },
|
|
41156
|
+
{ },
|
|
41157
|
+
{ },
|
|
41158
|
+
null,
|
|
41159
|
+
['PureCloud OAuth'],
|
|
41160
|
+
['application/json'],
|
|
41161
|
+
['application/json']
|
|
41162
|
+
);
|
|
41163
|
+
}
|
|
41164
|
+
|
|
41165
|
+
/**
|
|
41166
|
+
* Get Team listing
|
|
41167
|
+
*
|
|
41168
|
+
* @param {Object} opts Optional parameters
|
|
41169
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
41170
|
+
* @param {String} opts.name Return only teams whose names start with this value (case-insensitive matching)
|
|
41171
|
+
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
41172
|
+
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
41173
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
41174
|
+
*/
|
|
41175
|
+
getTeams(opts) {
|
|
41176
|
+
opts = opts || {};
|
|
41177
|
+
|
|
41178
|
+
|
|
41179
|
+
return this.apiClient.callApi(
|
|
41180
|
+
'/api/v2/teams',
|
|
41181
|
+
'GET',
|
|
41182
|
+
{ },
|
|
41183
|
+
{ 'pageSize': opts['pageSize'],'name': opts['name'],'after': opts['after'],'before': opts['before'],'expand': opts['expand'] },
|
|
41184
|
+
{ },
|
|
41185
|
+
{ },
|
|
41186
|
+
null,
|
|
41187
|
+
['PureCloud OAuth'],
|
|
41188
|
+
['application/json'],
|
|
41189
|
+
['application/json']
|
|
41190
|
+
);
|
|
41191
|
+
}
|
|
41192
|
+
|
|
41193
|
+
/**
|
|
41194
|
+
* Update team
|
|
41195
|
+
*
|
|
41196
|
+
* @param {String} teamId Team ID
|
|
41197
|
+
* @param {Object} body Team
|
|
41198
|
+
*/
|
|
41199
|
+
patchTeam(teamId, body) {
|
|
41200
|
+
// verify the required parameter 'teamId' is set
|
|
41201
|
+
if (teamId === undefined || teamId === null) {
|
|
41202
|
+
throw 'Missing the required parameter "teamId" when calling patchTeam';
|
|
41203
|
+
}
|
|
41204
|
+
// verify the required parameter 'body' is set
|
|
41205
|
+
if (body === undefined || body === null) {
|
|
41206
|
+
throw 'Missing the required parameter "body" when calling patchTeam';
|
|
41207
|
+
}
|
|
41208
|
+
|
|
41209
|
+
return this.apiClient.callApi(
|
|
41210
|
+
'/api/v2/teams/{teamId}',
|
|
41211
|
+
'PATCH',
|
|
41212
|
+
{ 'teamId': teamId },
|
|
41213
|
+
{ },
|
|
41214
|
+
{ },
|
|
41215
|
+
{ },
|
|
41216
|
+
body,
|
|
41217
|
+
['PureCloud OAuth'],
|
|
41218
|
+
['application/json'],
|
|
41219
|
+
['application/json']
|
|
41220
|
+
);
|
|
41221
|
+
}
|
|
41222
|
+
|
|
41223
|
+
/**
|
|
41224
|
+
* Create a team
|
|
41225
|
+
*
|
|
41226
|
+
* @param {Object} body Team
|
|
41227
|
+
*/
|
|
41228
|
+
postTeams(body) {
|
|
41229
|
+
// verify the required parameter 'body' is set
|
|
41230
|
+
if (body === undefined || body === null) {
|
|
41231
|
+
throw 'Missing the required parameter "body" when calling postTeams';
|
|
41232
|
+
}
|
|
41233
|
+
|
|
41234
|
+
return this.apiClient.callApi(
|
|
41235
|
+
'/api/v2/teams',
|
|
41236
|
+
'POST',
|
|
41237
|
+
{ },
|
|
41238
|
+
{ },
|
|
41239
|
+
{ },
|
|
41240
|
+
{ },
|
|
41241
|
+
body,
|
|
41242
|
+
['PureCloud OAuth'],
|
|
41243
|
+
['application/json'],
|
|
41244
|
+
['application/json']
|
|
41245
|
+
);
|
|
41246
|
+
}
|
|
41247
|
+
|
|
41248
|
+
/**
|
|
41249
|
+
* Search resources.
|
|
41250
|
+
*
|
|
41251
|
+
* @param {Object} body Search request options
|
|
41252
|
+
*/
|
|
41253
|
+
postTeamsSearch(body) {
|
|
41254
|
+
// verify the required parameter 'body' is set
|
|
41255
|
+
if (body === undefined || body === null) {
|
|
41256
|
+
throw 'Missing the required parameter "body" when calling postTeamsSearch';
|
|
41257
|
+
}
|
|
41258
|
+
|
|
41259
|
+
return this.apiClient.callApi(
|
|
41260
|
+
'/api/v2/teams/search',
|
|
41261
|
+
'POST',
|
|
41262
|
+
{ },
|
|
41263
|
+
{ },
|
|
41264
|
+
{ },
|
|
41265
|
+
{ },
|
|
41266
|
+
body,
|
|
41267
|
+
['PureCloud OAuth'],
|
|
41268
|
+
['application/json'],
|
|
41269
|
+
['application/json']
|
|
41270
|
+
);
|
|
41271
|
+
}
|
|
41272
|
+
|
|
41273
|
+
}
|
|
41274
|
+
|
|
40883
41275
|
class TelephonyApi {
|
|
40884
41276
|
/**
|
|
40885
41277
|
* Telephony service.
|
|
40886
41278
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
40887
|
-
* @version
|
|
41279
|
+
* @version 142.0.0
|
|
40888
41280
|
*/
|
|
40889
41281
|
|
|
40890
41282
|
/**
|
|
@@ -40992,7 +41384,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
40992
41384
|
/**
|
|
40993
41385
|
* TelephonyProvidersEdge service.
|
|
40994
41386
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
40995
|
-
* @version
|
|
41387
|
+
* @version 142.0.0
|
|
40996
41388
|
*/
|
|
40997
41389
|
|
|
40998
41390
|
/**
|
|
@@ -44625,7 +45017,7 @@ class TextbotsApi {
|
|
|
44625
45017
|
/**
|
|
44626
45018
|
* Textbots service.
|
|
44627
45019
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
44628
|
-
* @version
|
|
45020
|
+
* @version 142.0.0
|
|
44629
45021
|
*/
|
|
44630
45022
|
|
|
44631
45023
|
/**
|
|
@@ -44753,7 +45145,7 @@ class TokensApi {
|
|
|
44753
45145
|
/**
|
|
44754
45146
|
* Tokens service.
|
|
44755
45147
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
44756
|
-
* @version
|
|
45148
|
+
* @version 142.0.0
|
|
44757
45149
|
*/
|
|
44758
45150
|
|
|
44759
45151
|
/**
|
|
@@ -44859,7 +45251,7 @@ class UploadsApi {
|
|
|
44859
45251
|
/**
|
|
44860
45252
|
* Uploads service.
|
|
44861
45253
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
44862
|
-
* @version
|
|
45254
|
+
* @version 142.0.0
|
|
44863
45255
|
*/
|
|
44864
45256
|
|
|
44865
45257
|
/**
|
|
@@ -45010,7 +45402,7 @@ class UsageApi {
|
|
|
45010
45402
|
/**
|
|
45011
45403
|
* Usage service.
|
|
45012
45404
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
45013
|
-
* @version
|
|
45405
|
+
* @version 142.0.0
|
|
45014
45406
|
*/
|
|
45015
45407
|
|
|
45016
45408
|
/**
|
|
@@ -45081,7 +45473,7 @@ class UserRecordingsApi {
|
|
|
45081
45473
|
/**
|
|
45082
45474
|
* UserRecordings service.
|
|
45083
45475
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
45084
|
-
* @version
|
|
45476
|
+
* @version 142.0.0
|
|
45085
45477
|
*/
|
|
45086
45478
|
|
|
45087
45479
|
/**
|
|
@@ -45265,7 +45657,7 @@ class UsersApi {
|
|
|
45265
45657
|
/**
|
|
45266
45658
|
* Users service.
|
|
45267
45659
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
45268
|
-
* @version
|
|
45660
|
+
* @version 142.0.0
|
|
45269
45661
|
*/
|
|
45270
45662
|
|
|
45271
45663
|
/**
|
|
@@ -47567,7 +47959,7 @@ class UtilitiesApi {
|
|
|
47567
47959
|
/**
|
|
47568
47960
|
* Utilities service.
|
|
47569
47961
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
47570
|
-
* @version
|
|
47962
|
+
* @version 142.0.0
|
|
47571
47963
|
*/
|
|
47572
47964
|
|
|
47573
47965
|
/**
|
|
@@ -47678,7 +48070,7 @@ class VoicemailApi {
|
|
|
47678
48070
|
/**
|
|
47679
48071
|
* Voicemail service.
|
|
47680
48072
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
47681
|
-
* @version
|
|
48073
|
+
* @version 142.0.0
|
|
47682
48074
|
*/
|
|
47683
48075
|
|
|
47684
48076
|
/**
|
|
@@ -48345,7 +48737,7 @@ class WebChatApi {
|
|
|
48345
48737
|
/**
|
|
48346
48738
|
* WebChat service.
|
|
48347
48739
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
48348
|
-
* @version
|
|
48740
|
+
* @version 142.0.0
|
|
48349
48741
|
*/
|
|
48350
48742
|
|
|
48351
48743
|
/**
|
|
@@ -48889,7 +49281,7 @@ class WebDeploymentsApi {
|
|
|
48889
49281
|
/**
|
|
48890
49282
|
* WebDeployments service.
|
|
48891
49283
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
48892
|
-
* @version
|
|
49284
|
+
* @version 142.0.0
|
|
48893
49285
|
*/
|
|
48894
49286
|
|
|
48895
49287
|
/**
|
|
@@ -49244,7 +49636,7 @@ class WebMessagingApi {
|
|
|
49244
49636
|
/**
|
|
49245
49637
|
* WebMessaging service.
|
|
49246
49638
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
49247
|
-
* @version
|
|
49639
|
+
* @version 142.0.0
|
|
49248
49640
|
*/
|
|
49249
49641
|
|
|
49250
49642
|
/**
|
|
@@ -49290,7 +49682,7 @@ class WidgetsApi {
|
|
|
49290
49682
|
/**
|
|
49291
49683
|
* Widgets service.
|
|
49292
49684
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
49293
|
-
* @version
|
|
49685
|
+
* @version 142.0.0
|
|
49294
49686
|
*/
|
|
49295
49687
|
|
|
49296
49688
|
/**
|
|
@@ -49436,7 +49828,7 @@ class WorkforceManagementApi {
|
|
|
49436
49828
|
/**
|
|
49437
49829
|
* WorkforceManagement service.
|
|
49438
49830
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
49439
|
-
* @version
|
|
49831
|
+
* @version 142.0.0
|
|
49440
49832
|
*/
|
|
49441
49833
|
|
|
49442
49834
|
/**
|
|
@@ -49856,6 +50248,31 @@ class WorkforceManagementApi {
|
|
|
49856
50248
|
);
|
|
49857
50249
|
}
|
|
49858
50250
|
|
|
50251
|
+
/**
|
|
50252
|
+
* Query the status of a historical adherence request operation. Only the user who started the operation can query the status
|
|
50253
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
50254
|
+
* @param {String} jobId jobId
|
|
50255
|
+
*/
|
|
50256
|
+
getWorkforcemanagementAdherenceHistoricalJob(jobId) {
|
|
50257
|
+
// verify the required parameter 'jobId' is set
|
|
50258
|
+
if (jobId === undefined || jobId === null) {
|
|
50259
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceHistoricalJob';
|
|
50260
|
+
}
|
|
50261
|
+
|
|
50262
|
+
return this.apiClient.callApi(
|
|
50263
|
+
'/api/v2/workforcemanagement/adherence/historical/jobs/{jobId}',
|
|
50264
|
+
'GET',
|
|
50265
|
+
{ 'jobId': jobId },
|
|
50266
|
+
{ },
|
|
50267
|
+
{ },
|
|
50268
|
+
{ },
|
|
50269
|
+
null,
|
|
50270
|
+
['PureCloud OAuth'],
|
|
50271
|
+
['application/json'],
|
|
50272
|
+
['application/json']
|
|
50273
|
+
);
|
|
50274
|
+
}
|
|
50275
|
+
|
|
49859
50276
|
/**
|
|
49860
50277
|
* Get status of the modeling job
|
|
49861
50278
|
*
|
|
@@ -53687,7 +54104,7 @@ class WorkforceManagementApi {
|
|
|
53687
54104
|
* </pre>
|
|
53688
54105
|
* </p>
|
|
53689
54106
|
* @module purecloud-platform-client-v2/index
|
|
53690
|
-
* @version
|
|
54107
|
+
* @version 142.0.0
|
|
53691
54108
|
*/
|
|
53692
54109
|
class platformClient {
|
|
53693
54110
|
constructor() {
|
|
@@ -53936,6 +54353,11 @@ class platformClient {
|
|
|
53936
54353
|
* @property {module:purecloud-platform-client-v2/api/SuggestApi}
|
|
53937
54354
|
*/
|
|
53938
54355
|
this.SuggestApi = SuggestApi;
|
|
54356
|
+
/**
|
|
54357
|
+
* The TeamsApi service constructor.
|
|
54358
|
+
* @property {module:purecloud-platform-client-v2/api/TeamsApi}
|
|
54359
|
+
*/
|
|
54360
|
+
this.TeamsApi = TeamsApi;
|
|
53939
54361
|
/**
|
|
53940
54362
|
* The TelephonyApi service constructor.
|
|
53941
54363
|
* @property {module:purecloud-platform-client-v2/api/TelephonyApi}
|