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
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -2278,7 +2278,7 @@ class Configuration {
|
|
|
2278
2278
|
|
|
2279
2279
|
/**
|
|
2280
2280
|
* @module purecloud-platform-client-v2/ApiClient
|
|
2281
|
-
* @version
|
|
2281
|
+
* @version 142.0.0
|
|
2282
2282
|
*/
|
|
2283
2283
|
class ApiClient {
|
|
2284
2284
|
/**
|
|
@@ -3350,7 +3350,7 @@ class AlertingApi {
|
|
|
3350
3350
|
/**
|
|
3351
3351
|
* Alerting service.
|
|
3352
3352
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3353
|
-
* @version
|
|
3353
|
+
* @version 142.0.0
|
|
3354
3354
|
*/
|
|
3355
3355
|
|
|
3356
3356
|
/**
|
|
@@ -3664,7 +3664,7 @@ class AnalyticsApi {
|
|
|
3664
3664
|
/**
|
|
3665
3665
|
* Analytics service.
|
|
3666
3666
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3667
|
-
* @version
|
|
3667
|
+
* @version 142.0.0
|
|
3668
3668
|
*/
|
|
3669
3669
|
|
|
3670
3670
|
/**
|
|
@@ -4846,7 +4846,7 @@ class ArchitectApi {
|
|
|
4846
4846
|
/**
|
|
4847
4847
|
* Architect service.
|
|
4848
4848
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4849
|
-
* @version
|
|
4849
|
+
* @version 142.0.0
|
|
4850
4850
|
*/
|
|
4851
4851
|
|
|
4852
4852
|
/**
|
|
@@ -7891,7 +7891,7 @@ class AuditApi {
|
|
|
7891
7891
|
/**
|
|
7892
7892
|
* Audit service.
|
|
7893
7893
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7894
|
-
* @version
|
|
7894
|
+
* @version 142.0.0
|
|
7895
7895
|
*/
|
|
7896
7896
|
|
|
7897
7897
|
/**
|
|
@@ -8062,7 +8062,7 @@ class AuthorizationApi {
|
|
|
8062
8062
|
/**
|
|
8063
8063
|
* Authorization service.
|
|
8064
8064
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8065
|
-
* @version
|
|
8065
|
+
* @version 142.0.0
|
|
8066
8066
|
*/
|
|
8067
8067
|
|
|
8068
8068
|
/**
|
|
@@ -9245,7 +9245,7 @@ class BillingApi {
|
|
|
9245
9245
|
/**
|
|
9246
9246
|
* Billing service.
|
|
9247
9247
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9248
|
-
* @version
|
|
9248
|
+
* @version 142.0.0
|
|
9249
9249
|
*/
|
|
9250
9250
|
|
|
9251
9251
|
/**
|
|
@@ -9325,7 +9325,7 @@ class ChatApi {
|
|
|
9325
9325
|
/**
|
|
9326
9326
|
* Chat service.
|
|
9327
9327
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9328
|
-
* @version
|
|
9328
|
+
* @version 142.0.0
|
|
9329
9329
|
*/
|
|
9330
9330
|
|
|
9331
9331
|
/**
|
|
@@ -9416,7 +9416,7 @@ class CoachingApi {
|
|
|
9416
9416
|
/**
|
|
9417
9417
|
* Coaching service.
|
|
9418
9418
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9419
|
-
* @version
|
|
9419
|
+
* @version 142.0.0
|
|
9420
9420
|
*/
|
|
9421
9421
|
|
|
9422
9422
|
/**
|
|
@@ -9993,7 +9993,7 @@ class ContentManagementApi {
|
|
|
9993
9993
|
/**
|
|
9994
9994
|
* ContentManagement service.
|
|
9995
9995
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9996
|
-
* @version
|
|
9996
|
+
* @version 142.0.0
|
|
9997
9997
|
*/
|
|
9998
9998
|
|
|
9999
9999
|
/**
|
|
@@ -11133,7 +11133,7 @@ class ConversationsApi {
|
|
|
11133
11133
|
/**
|
|
11134
11134
|
* Conversations service.
|
|
11135
11135
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11136
|
-
* @version
|
|
11136
|
+
* @version 142.0.0
|
|
11137
11137
|
*/
|
|
11138
11138
|
|
|
11139
11139
|
/**
|
|
@@ -16067,7 +16067,7 @@ class DataExtensionsApi {
|
|
|
16067
16067
|
/**
|
|
16068
16068
|
* DataExtensions service.
|
|
16069
16069
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
16070
|
-
* @version
|
|
16070
|
+
* @version 142.0.0
|
|
16071
16071
|
*/
|
|
16072
16072
|
|
|
16073
16073
|
/**
|
|
@@ -16153,7 +16153,7 @@ class ExternalContactsApi {
|
|
|
16153
16153
|
/**
|
|
16154
16154
|
* ExternalContacts service.
|
|
16155
16155
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
16156
|
-
* @version
|
|
16156
|
+
* @version 142.0.0
|
|
16157
16157
|
*/
|
|
16158
16158
|
|
|
16159
16159
|
/**
|
|
@@ -17896,7 +17896,7 @@ class FaxApi {
|
|
|
17896
17896
|
/**
|
|
17897
17897
|
* Fax service.
|
|
17898
17898
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
17899
|
-
* @version
|
|
17899
|
+
* @version 142.0.0
|
|
17900
17900
|
*/
|
|
17901
17901
|
|
|
17902
17902
|
/**
|
|
@@ -18067,7 +18067,7 @@ class FlowsApi {
|
|
|
18067
18067
|
/**
|
|
18068
18068
|
* Flows service.
|
|
18069
18069
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
18070
|
-
* @version
|
|
18070
|
+
* @version 142.0.0
|
|
18071
18071
|
*/
|
|
18072
18072
|
|
|
18073
18073
|
/**
|
|
@@ -18138,7 +18138,7 @@ class GamificationApi {
|
|
|
18138
18138
|
/**
|
|
18139
18139
|
* Gamification service.
|
|
18140
18140
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
18141
|
-
* @version
|
|
18141
|
+
* @version 142.0.0
|
|
18142
18142
|
*/
|
|
18143
18143
|
|
|
18144
18144
|
/**
|
|
@@ -18761,6 +18761,157 @@ class GamificationApi {
|
|
|
18761
18761
|
);
|
|
18762
18762
|
}
|
|
18763
18763
|
|
|
18764
|
+
/**
|
|
18765
|
+
* Average performance values trends by metric of a user
|
|
18766
|
+
*
|
|
18767
|
+
* @param {String} profileId performanceProfileId
|
|
18768
|
+
* @param {String} metricId metricId
|
|
18769
|
+
* @param {String} userId
|
|
18770
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18771
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18772
|
+
* @param {Object} opts Optional parameters
|
|
18773
|
+
* @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
|
|
18774
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
18775
|
+
*/
|
|
18776
|
+
getGamificationScorecardsProfileMetricUserValuesTrends(profileId, metricId, userId, startWorkday, endWorkday, opts) {
|
|
18777
|
+
opts = opts || {};
|
|
18778
|
+
|
|
18779
|
+
// verify the required parameter 'profileId' is set
|
|
18780
|
+
if (profileId === undefined || profileId === null) {
|
|
18781
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
18782
|
+
}
|
|
18783
|
+
// verify the required parameter 'metricId' is set
|
|
18784
|
+
if (metricId === undefined || metricId === null) {
|
|
18785
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
18786
|
+
}
|
|
18787
|
+
// verify the required parameter 'userId' is set
|
|
18788
|
+
if (userId === undefined || userId === null) {
|
|
18789
|
+
throw 'Missing the required parameter "userId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
18790
|
+
}
|
|
18791
|
+
// verify the required parameter 'startWorkday' is set
|
|
18792
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
18793
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
18794
|
+
}
|
|
18795
|
+
// verify the required parameter 'endWorkday' is set
|
|
18796
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
18797
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
18798
|
+
}
|
|
18799
|
+
|
|
18800
|
+
return this.apiClient.callApi(
|
|
18801
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends',
|
|
18802
|
+
'GET',
|
|
18803
|
+
{ 'profileId': profileId,'metricId': metricId,'userId': userId },
|
|
18804
|
+
{ 'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
18805
|
+
{ },
|
|
18806
|
+
{ },
|
|
18807
|
+
null,
|
|
18808
|
+
['PureCloud OAuth'],
|
|
18809
|
+
['application/json'],
|
|
18810
|
+
['application/json']
|
|
18811
|
+
);
|
|
18812
|
+
}
|
|
18813
|
+
|
|
18814
|
+
/**
|
|
18815
|
+
* Average performance values trends by metric of a division or a performance profile
|
|
18816
|
+
*
|
|
18817
|
+
* @param {String} profileId performanceProfileId
|
|
18818
|
+
* @param {String} metricId metricId
|
|
18819
|
+
* @param {Object} filterType Filter type for the query request.
|
|
18820
|
+
* @param {String} filterId ID for the filter type. For example, division Id
|
|
18821
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18822
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18823
|
+
* @param {Object} opts Optional parameters
|
|
18824
|
+
* @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
|
|
18825
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
18826
|
+
*/
|
|
18827
|
+
getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, filterId, startWorkday, endWorkday, opts) {
|
|
18828
|
+
opts = opts || {};
|
|
18829
|
+
|
|
18830
|
+
// verify the required parameter 'profileId' is set
|
|
18831
|
+
if (profileId === undefined || profileId === null) {
|
|
18832
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
18833
|
+
}
|
|
18834
|
+
// verify the required parameter 'metricId' is set
|
|
18835
|
+
if (metricId === undefined || metricId === null) {
|
|
18836
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
18837
|
+
}
|
|
18838
|
+
// verify the required parameter 'filterType' is set
|
|
18839
|
+
if (filterType === undefined || filterType === null) {
|
|
18840
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
18841
|
+
}
|
|
18842
|
+
// verify the required parameter 'filterId' is set
|
|
18843
|
+
if (filterId === undefined || filterId === null) {
|
|
18844
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
18845
|
+
}
|
|
18846
|
+
// verify the required parameter 'startWorkday' is set
|
|
18847
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
18848
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
18849
|
+
}
|
|
18850
|
+
// verify the required parameter 'endWorkday' is set
|
|
18851
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
18852
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
18853
|
+
}
|
|
18854
|
+
|
|
18855
|
+
return this.apiClient.callApi(
|
|
18856
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends',
|
|
18857
|
+
'GET',
|
|
18858
|
+
{ 'profileId': profileId,'metricId': metricId },
|
|
18859
|
+
{ 'filterType': filterType,'filterId': filterId,'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
18860
|
+
{ },
|
|
18861
|
+
{ },
|
|
18862
|
+
null,
|
|
18863
|
+
['PureCloud OAuth'],
|
|
18864
|
+
['application/json'],
|
|
18865
|
+
['application/json']
|
|
18866
|
+
);
|
|
18867
|
+
}
|
|
18868
|
+
|
|
18869
|
+
/**
|
|
18870
|
+
* Average performance values trends by metric of the requesting user
|
|
18871
|
+
*
|
|
18872
|
+
* @param {String} profileId performanceProfileId
|
|
18873
|
+
* @param {String} metricId metricId
|
|
18874
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18875
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18876
|
+
* @param {Object} opts Optional parameters
|
|
18877
|
+
* @param {Object} opts.filterType Filter type for the query request. If not set, returns the values trends of the requesting user
|
|
18878
|
+
* @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
|
|
18879
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
18880
|
+
*/
|
|
18881
|
+
getGamificationScorecardsProfileMetricValuesTrends(profileId, metricId, startWorkday, endWorkday, opts) {
|
|
18882
|
+
opts = opts || {};
|
|
18883
|
+
|
|
18884
|
+
// verify the required parameter 'profileId' is set
|
|
18885
|
+
if (profileId === undefined || profileId === null) {
|
|
18886
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
18887
|
+
}
|
|
18888
|
+
// verify the required parameter 'metricId' is set
|
|
18889
|
+
if (metricId === undefined || metricId === null) {
|
|
18890
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
18891
|
+
}
|
|
18892
|
+
// verify the required parameter 'startWorkday' is set
|
|
18893
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
18894
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
18895
|
+
}
|
|
18896
|
+
// verify the required parameter 'endWorkday' is set
|
|
18897
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
18898
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
18899
|
+
}
|
|
18900
|
+
|
|
18901
|
+
return this.apiClient.callApi(
|
|
18902
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends',
|
|
18903
|
+
'GET',
|
|
18904
|
+
{ 'profileId': profileId,'metricId': metricId },
|
|
18905
|
+
{ 'filterType': opts['filterType'],'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
18906
|
+
{ },
|
|
18907
|
+
{ },
|
|
18908
|
+
null,
|
|
18909
|
+
['PureCloud OAuth'],
|
|
18910
|
+
['application/json'],
|
|
18911
|
+
['application/json']
|
|
18912
|
+
);
|
|
18913
|
+
}
|
|
18914
|
+
|
|
18764
18915
|
/**
|
|
18765
18916
|
* Workday performance metrics for a user
|
|
18766
18917
|
*
|
|
@@ -19569,7 +19720,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
19569
19720
|
/**
|
|
19570
19721
|
* GeneralDataProtectionRegulation service.
|
|
19571
19722
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
19572
|
-
* @version
|
|
19723
|
+
* @version 142.0.0
|
|
19573
19724
|
*/
|
|
19574
19725
|
|
|
19575
19726
|
/**
|
|
@@ -19699,7 +19850,7 @@ class GeolocationApi {
|
|
|
19699
19850
|
/**
|
|
19700
19851
|
* Geolocation service.
|
|
19701
19852
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
19702
|
-
* @version
|
|
19853
|
+
* @version 142.0.0
|
|
19703
19854
|
*/
|
|
19704
19855
|
|
|
19705
19856
|
/**
|
|
@@ -19830,7 +19981,7 @@ class GreetingsApi {
|
|
|
19830
19981
|
/**
|
|
19831
19982
|
* Greetings service.
|
|
19832
19983
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
19833
|
-
* @version
|
|
19984
|
+
* @version 142.0.0
|
|
19834
19985
|
*/
|
|
19835
19986
|
|
|
19836
19987
|
/**
|
|
@@ -20285,7 +20436,7 @@ class GroupsApi {
|
|
|
20285
20436
|
/**
|
|
20286
20437
|
* Groups service.
|
|
20287
20438
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
20288
|
-
* @version
|
|
20439
|
+
* @version 142.0.0
|
|
20289
20440
|
*/
|
|
20290
20441
|
|
|
20291
20442
|
/**
|
|
@@ -20690,7 +20841,7 @@ class IdentityProviderApi {
|
|
|
20690
20841
|
/**
|
|
20691
20842
|
* IdentityProvider service.
|
|
20692
20843
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
20693
|
-
* @version
|
|
20844
|
+
* @version 142.0.0
|
|
20694
20845
|
*/
|
|
20695
20846
|
|
|
20696
20847
|
/**
|
|
@@ -21446,7 +21597,7 @@ class IntegrationsApi {
|
|
|
21446
21597
|
/**
|
|
21447
21598
|
* Integrations service.
|
|
21448
21599
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
21449
|
-
* @version
|
|
21600
|
+
* @version 142.0.0
|
|
21450
21601
|
*/
|
|
21451
21602
|
|
|
21452
21603
|
/**
|
|
@@ -23123,7 +23274,7 @@ class JourneyApi {
|
|
|
23123
23274
|
/**
|
|
23124
23275
|
* Journey service.
|
|
23125
23276
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
23126
|
-
* @version
|
|
23277
|
+
* @version 142.0.0
|
|
23127
23278
|
*/
|
|
23128
23279
|
|
|
23129
23280
|
/**
|
|
@@ -23834,7 +23985,7 @@ class KnowledgeApi {
|
|
|
23834
23985
|
/**
|
|
23835
23986
|
* Knowledge service.
|
|
23836
23987
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
23837
|
-
* @version
|
|
23988
|
+
* @version 142.0.0
|
|
23838
23989
|
*/
|
|
23839
23990
|
|
|
23840
23991
|
/**
|
|
@@ -24734,7 +24885,7 @@ class LanguageUnderstandingApi {
|
|
|
24734
24885
|
/**
|
|
24735
24886
|
* LanguageUnderstanding service.
|
|
24736
24887
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
24737
|
-
* @version
|
|
24888
|
+
* @version 142.0.0
|
|
24738
24889
|
*/
|
|
24739
24890
|
|
|
24740
24891
|
/**
|
|
@@ -25638,7 +25789,7 @@ class LanguagesApi {
|
|
|
25638
25789
|
/**
|
|
25639
25790
|
* Languages service.
|
|
25640
25791
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
25641
|
-
* @version
|
|
25792
|
+
* @version 142.0.0
|
|
25642
25793
|
*/
|
|
25643
25794
|
|
|
25644
25795
|
/**
|
|
@@ -25906,7 +26057,7 @@ class LearningApi {
|
|
|
25906
26057
|
/**
|
|
25907
26058
|
* Learning service.
|
|
25908
26059
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
25909
|
-
* @version
|
|
26060
|
+
* @version 142.0.0
|
|
25910
26061
|
*/
|
|
25911
26062
|
|
|
25912
26063
|
/**
|
|
@@ -26225,6 +26376,40 @@ class LearningApi {
|
|
|
26225
26376
|
);
|
|
26226
26377
|
}
|
|
26227
26378
|
|
|
26379
|
+
/**
|
|
26380
|
+
* Get all learning modules of an organization including assignments for a specific user
|
|
26381
|
+
*
|
|
26382
|
+
* @param {Array.<String>} userIds The IDs of the users to include
|
|
26383
|
+
* @param {Object} opts Optional parameters
|
|
26384
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
26385
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
26386
|
+
* @param {String} opts.searchTerm Search Term (searches by name and description)
|
|
26387
|
+
* @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)
|
|
26388
|
+
* @param {Array.<String>} opts.assignmentStates Specifies the assignment states to return.
|
|
26389
|
+
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
26390
|
+
*/
|
|
26391
|
+
getLearningModulesAssignments(userIds, opts) {
|
|
26392
|
+
opts = opts || {};
|
|
26393
|
+
|
|
26394
|
+
// verify the required parameter 'userIds' is set
|
|
26395
|
+
if (userIds === undefined || userIds === null) {
|
|
26396
|
+
throw 'Missing the required parameter "userIds" when calling getLearningModulesAssignments';
|
|
26397
|
+
}
|
|
26398
|
+
|
|
26399
|
+
return this.apiClient.callApi(
|
|
26400
|
+
'/api/v2/learning/modules/assignments',
|
|
26401
|
+
'GET',
|
|
26402
|
+
{ },
|
|
26403
|
+
{ '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') },
|
|
26404
|
+
{ },
|
|
26405
|
+
{ },
|
|
26406
|
+
null,
|
|
26407
|
+
['PureCloud OAuth'],
|
|
26408
|
+
['application/json'],
|
|
26409
|
+
['application/json']
|
|
26410
|
+
);
|
|
26411
|
+
}
|
|
26412
|
+
|
|
26228
26413
|
/**
|
|
26229
26414
|
* Update Learning Assignment
|
|
26230
26415
|
*
|
|
@@ -26607,7 +26792,7 @@ class LicenseApi {
|
|
|
26607
26792
|
/**
|
|
26608
26793
|
* License service.
|
|
26609
26794
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
26610
|
-
* @version
|
|
26795
|
+
* @version 142.0.0
|
|
26611
26796
|
*/
|
|
26612
26797
|
|
|
26613
26798
|
/**
|
|
@@ -26845,7 +27030,7 @@ class LocationsApi {
|
|
|
26845
27030
|
/**
|
|
26846
27031
|
* Locations service.
|
|
26847
27032
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
26848
|
-
* @version
|
|
27033
|
+
* @version 142.0.0
|
|
26849
27034
|
*/
|
|
26850
27035
|
|
|
26851
27036
|
/**
|
|
@@ -27081,7 +27266,7 @@ class MessagingApi {
|
|
|
27081
27266
|
/**
|
|
27082
27267
|
* Messaging service.
|
|
27083
27268
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27084
|
-
* @version
|
|
27269
|
+
* @version 142.0.0
|
|
27085
27270
|
*/
|
|
27086
27271
|
|
|
27087
27272
|
/**
|
|
@@ -27232,7 +27417,7 @@ class MobileDevicesApi {
|
|
|
27232
27417
|
/**
|
|
27233
27418
|
* MobileDevices service.
|
|
27234
27419
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27235
|
-
* @version
|
|
27420
|
+
* @version 142.0.0
|
|
27236
27421
|
*/
|
|
27237
27422
|
|
|
27238
27423
|
/**
|
|
@@ -27383,7 +27568,7 @@ class NotificationsApi {
|
|
|
27383
27568
|
/**
|
|
27384
27569
|
* Notifications service.
|
|
27385
27570
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
27386
|
-
* @version
|
|
27571
|
+
* @version 142.0.0
|
|
27387
27572
|
*/
|
|
27388
27573
|
|
|
27389
27574
|
/**
|
|
@@ -27608,7 +27793,7 @@ class OAuthApi {
|
|
|
27608
27793
|
/**
|
|
27609
27794
|
* OAuth service.
|
|
27610
27795
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
27611
|
-
* @version
|
|
27796
|
+
* @version 142.0.0
|
|
27612
27797
|
*/
|
|
27613
27798
|
|
|
27614
27799
|
/**
|
|
@@ -27974,7 +28159,7 @@ class ObjectsApi {
|
|
|
27974
28159
|
/**
|
|
27975
28160
|
* Objects service.
|
|
27976
28161
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
27977
|
-
* @version
|
|
28162
|
+
* @version 142.0.0
|
|
27978
28163
|
*/
|
|
27979
28164
|
|
|
27980
28165
|
/**
|
|
@@ -28245,7 +28430,7 @@ class OrganizationApi {
|
|
|
28245
28430
|
/**
|
|
28246
28431
|
* Organization service.
|
|
28247
28432
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
28248
|
-
* @version
|
|
28433
|
+
* @version 142.0.0
|
|
28249
28434
|
*/
|
|
28250
28435
|
|
|
28251
28436
|
/**
|
|
@@ -28648,7 +28833,7 @@ class OrganizationAuthorizationApi {
|
|
|
28648
28833
|
/**
|
|
28649
28834
|
* OrganizationAuthorization service.
|
|
28650
28835
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
28651
|
-
* @version
|
|
28836
|
+
* @version 142.0.0
|
|
28652
28837
|
*/
|
|
28653
28838
|
|
|
28654
28839
|
/**
|
|
@@ -29573,7 +29758,7 @@ class OutboundApi {
|
|
|
29573
29758
|
/**
|
|
29574
29759
|
* Outbound service.
|
|
29575
29760
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
29576
|
-
* @version
|
|
29761
|
+
* @version 142.0.0
|
|
29577
29762
|
*/
|
|
29578
29763
|
|
|
29579
29764
|
/**
|
|
@@ -32828,7 +33013,7 @@ class PresenceApi {
|
|
|
32828
33013
|
/**
|
|
32829
33014
|
* Presence service.
|
|
32830
33015
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
32831
|
-
* @version
|
|
33016
|
+
* @version 142.0.0
|
|
32832
33017
|
*/
|
|
32833
33018
|
|
|
32834
33019
|
/**
|
|
@@ -33150,7 +33335,7 @@ class QualityApi {
|
|
|
33150
33335
|
/**
|
|
33151
33336
|
* Quality service.
|
|
33152
33337
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
33153
|
-
* @version
|
|
33338
|
+
* @version 142.0.0
|
|
33154
33339
|
*/
|
|
33155
33340
|
|
|
33156
33341
|
/**
|
|
@@ -34728,7 +34913,7 @@ class RecordingApi {
|
|
|
34728
34913
|
/**
|
|
34729
34914
|
* Recording service.
|
|
34730
34915
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
34731
|
-
* @version
|
|
34916
|
+
* @version 142.0.0
|
|
34732
34917
|
*/
|
|
34733
34918
|
|
|
34734
34919
|
/**
|
|
@@ -36381,7 +36566,7 @@ class ResponseManagementApi {
|
|
|
36381
36566
|
/**
|
|
36382
36567
|
* ResponseManagement service.
|
|
36383
36568
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
36384
|
-
* @version
|
|
36569
|
+
* @version 142.0.0
|
|
36385
36570
|
*/
|
|
36386
36571
|
|
|
36387
36572
|
/**
|
|
@@ -36865,7 +37050,7 @@ class RoutingApi {
|
|
|
36865
37050
|
/**
|
|
36866
37051
|
* Routing service.
|
|
36867
37052
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
36868
|
-
* @version
|
|
37053
|
+
* @version 142.0.0
|
|
36869
37054
|
*/
|
|
36870
37055
|
|
|
36871
37056
|
/**
|
|
@@ -37975,6 +38160,8 @@ class RoutingApi {
|
|
|
37975
38160
|
* @param {String} opts.name Filter by queue name
|
|
37976
38161
|
* @param {Array.<String>} opts.id Filter by queue ID(s)
|
|
37977
38162
|
* @param {Array.<String>} opts.divisionId Filter by queue division ID(s)
|
|
38163
|
+
* @param {Array.<String>} opts.peerId Filter by queue peer ID(s)
|
|
38164
|
+
* @param {Boolean} opts.hasPeer Filter by queues associated with peer
|
|
37978
38165
|
*/
|
|
37979
38166
|
getRoutingQueues(opts) {
|
|
37980
38167
|
opts = opts || {};
|
|
@@ -37984,7 +38171,7 @@ class RoutingApi {
|
|
|
37984
38171
|
'/api/v2/routing/queues',
|
|
37985
38172
|
'GET',
|
|
37986
38173
|
{ },
|
|
37987
|
-
{ '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') },
|
|
38174
|
+
{ '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'] },
|
|
37988
38175
|
{ },
|
|
37989
38176
|
{ },
|
|
37990
38177
|
null,
|
|
@@ -39784,7 +39971,7 @@ class SCIMApi {
|
|
|
39784
39971
|
/**
|
|
39785
39972
|
* SCIM service.
|
|
39786
39973
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
39787
|
-
* @version
|
|
39974
|
+
* @version 142.0.0
|
|
39788
39975
|
*/
|
|
39789
39976
|
|
|
39790
39977
|
/**
|
|
@@ -40661,7 +40848,7 @@ class ScriptsApi {
|
|
|
40661
40848
|
/**
|
|
40662
40849
|
* Scripts service.
|
|
40663
40850
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
40664
|
-
* @version
|
|
40851
|
+
* @version 142.0.0
|
|
40665
40852
|
*/
|
|
40666
40853
|
|
|
40667
40854
|
/**
|
|
@@ -41080,7 +41267,7 @@ class SearchApi {
|
|
|
41080
41267
|
/**
|
|
41081
41268
|
* Search service.
|
|
41082
41269
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
41083
|
-
* @version
|
|
41270
|
+
* @version 142.0.0
|
|
41084
41271
|
*/
|
|
41085
41272
|
|
|
41086
41273
|
/**
|
|
@@ -41559,6 +41746,31 @@ class SearchApi {
|
|
|
41559
41746
|
);
|
|
41560
41747
|
}
|
|
41561
41748
|
|
|
41749
|
+
/**
|
|
41750
|
+
* Search resources.
|
|
41751
|
+
*
|
|
41752
|
+
* @param {Object} body Search request options
|
|
41753
|
+
*/
|
|
41754
|
+
postTeamsSearch(body) {
|
|
41755
|
+
// verify the required parameter 'body' is set
|
|
41756
|
+
if (body === undefined || body === null) {
|
|
41757
|
+
throw 'Missing the required parameter "body" when calling postTeamsSearch';
|
|
41758
|
+
}
|
|
41759
|
+
|
|
41760
|
+
return this.apiClient.callApi(
|
|
41761
|
+
'/api/v2/teams/search',
|
|
41762
|
+
'POST',
|
|
41763
|
+
{ },
|
|
41764
|
+
{ },
|
|
41765
|
+
{ },
|
|
41766
|
+
{ },
|
|
41767
|
+
body,
|
|
41768
|
+
['PureCloud OAuth'],
|
|
41769
|
+
['application/json'],
|
|
41770
|
+
['application/json']
|
|
41771
|
+
);
|
|
41772
|
+
}
|
|
41773
|
+
|
|
41562
41774
|
/**
|
|
41563
41775
|
* Search users
|
|
41564
41776
|
*
|
|
@@ -41615,7 +41827,7 @@ class SpeechTextAnalyticsApi {
|
|
|
41615
41827
|
/**
|
|
41616
41828
|
* SpeechTextAnalytics service.
|
|
41617
41829
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
41618
|
-
* @version
|
|
41830
|
+
* @version 142.0.0
|
|
41619
41831
|
*/
|
|
41620
41832
|
|
|
41621
41833
|
/**
|
|
@@ -41840,6 +42052,7 @@ class SpeechTextAnalyticsApi {
|
|
|
41840
42052
|
* @param {Object} opts Optional parameters
|
|
41841
42053
|
* @param {String} opts.nextPage The key for listing the next page
|
|
41842
42054
|
* @param {Number} opts.pageSize The page size for the listing (default to 20)
|
|
42055
|
+
* @param {Object} opts.state Program state. Defaults to Latest
|
|
41843
42056
|
*/
|
|
41844
42057
|
getSpeechandtextanalyticsPrograms(opts) {
|
|
41845
42058
|
opts = opts || {};
|
|
@@ -41849,7 +42062,7 @@ class SpeechTextAnalyticsApi {
|
|
|
41849
42062
|
'/api/v2/speechandtextanalytics/programs',
|
|
41850
42063
|
'GET',
|
|
41851
42064
|
{ },
|
|
41852
|
-
{ 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'] },
|
|
42065
|
+
{ 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'],'state': opts['state'] },
|
|
41853
42066
|
{ },
|
|
41854
42067
|
{ },
|
|
41855
42068
|
null,
|
|
@@ -42468,7 +42681,7 @@ class StationsApi {
|
|
|
42468
42681
|
/**
|
|
42469
42682
|
* Stations service.
|
|
42470
42683
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
42471
|
-
* @version
|
|
42684
|
+
* @version 142.0.0
|
|
42472
42685
|
*/
|
|
42473
42686
|
|
|
42474
42687
|
/**
|
|
@@ -42615,7 +42828,7 @@ class SuggestApi {
|
|
|
42615
42828
|
/**
|
|
42616
42829
|
* Suggest service.
|
|
42617
42830
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
42618
|
-
* @version
|
|
42831
|
+
* @version 142.0.0
|
|
42619
42832
|
*/
|
|
42620
42833
|
|
|
42621
42834
|
/**
|
|
@@ -42750,11 +42963,190 @@ class SuggestApi {
|
|
|
42750
42963
|
|
|
42751
42964
|
}
|
|
42752
42965
|
|
|
42966
|
+
class TeamsApi {
|
|
42967
|
+
/**
|
|
42968
|
+
* Teams service.
|
|
42969
|
+
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
42970
|
+
* @version 142.0.0
|
|
42971
|
+
*/
|
|
42972
|
+
|
|
42973
|
+
/**
|
|
42974
|
+
* Constructs a new TeamsApi.
|
|
42975
|
+
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
42976
|
+
* @class
|
|
42977
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
42978
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
42979
|
+
*/
|
|
42980
|
+
constructor(apiClient) {
|
|
42981
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
42982
|
+
}
|
|
42983
|
+
|
|
42984
|
+
|
|
42985
|
+
/**
|
|
42986
|
+
* Delete team
|
|
42987
|
+
*
|
|
42988
|
+
* @param {String} teamId Team ID
|
|
42989
|
+
*/
|
|
42990
|
+
deleteTeam(teamId) {
|
|
42991
|
+
// verify the required parameter 'teamId' is set
|
|
42992
|
+
if (teamId === undefined || teamId === null) {
|
|
42993
|
+
throw 'Missing the required parameter "teamId" when calling deleteTeam';
|
|
42994
|
+
}
|
|
42995
|
+
|
|
42996
|
+
return this.apiClient.callApi(
|
|
42997
|
+
'/api/v2/teams/{teamId}',
|
|
42998
|
+
'DELETE',
|
|
42999
|
+
{ 'teamId': teamId },
|
|
43000
|
+
{ },
|
|
43001
|
+
{ },
|
|
43002
|
+
{ },
|
|
43003
|
+
null,
|
|
43004
|
+
['PureCloud OAuth'],
|
|
43005
|
+
['application/json'],
|
|
43006
|
+
['application/json']
|
|
43007
|
+
);
|
|
43008
|
+
}
|
|
43009
|
+
|
|
43010
|
+
/**
|
|
43011
|
+
* Get team
|
|
43012
|
+
*
|
|
43013
|
+
* @param {String} teamId Team ID
|
|
43014
|
+
*/
|
|
43015
|
+
getTeam(teamId) {
|
|
43016
|
+
// verify the required parameter 'teamId' is set
|
|
43017
|
+
if (teamId === undefined || teamId === null) {
|
|
43018
|
+
throw 'Missing the required parameter "teamId" when calling getTeam';
|
|
43019
|
+
}
|
|
43020
|
+
|
|
43021
|
+
return this.apiClient.callApi(
|
|
43022
|
+
'/api/v2/teams/{teamId}',
|
|
43023
|
+
'GET',
|
|
43024
|
+
{ 'teamId': teamId },
|
|
43025
|
+
{ },
|
|
43026
|
+
{ },
|
|
43027
|
+
{ },
|
|
43028
|
+
null,
|
|
43029
|
+
['PureCloud OAuth'],
|
|
43030
|
+
['application/json'],
|
|
43031
|
+
['application/json']
|
|
43032
|
+
);
|
|
43033
|
+
}
|
|
43034
|
+
|
|
43035
|
+
/**
|
|
43036
|
+
* Get Team listing
|
|
43037
|
+
*
|
|
43038
|
+
* @param {Object} opts Optional parameters
|
|
43039
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
43040
|
+
* @param {String} opts.name Return only teams whose names start with this value (case-insensitive matching)
|
|
43041
|
+
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
43042
|
+
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
43043
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
43044
|
+
*/
|
|
43045
|
+
getTeams(opts) {
|
|
43046
|
+
opts = opts || {};
|
|
43047
|
+
|
|
43048
|
+
|
|
43049
|
+
return this.apiClient.callApi(
|
|
43050
|
+
'/api/v2/teams',
|
|
43051
|
+
'GET',
|
|
43052
|
+
{ },
|
|
43053
|
+
{ 'pageSize': opts['pageSize'],'name': opts['name'],'after': opts['after'],'before': opts['before'],'expand': opts['expand'] },
|
|
43054
|
+
{ },
|
|
43055
|
+
{ },
|
|
43056
|
+
null,
|
|
43057
|
+
['PureCloud OAuth'],
|
|
43058
|
+
['application/json'],
|
|
43059
|
+
['application/json']
|
|
43060
|
+
);
|
|
43061
|
+
}
|
|
43062
|
+
|
|
43063
|
+
/**
|
|
43064
|
+
* Update team
|
|
43065
|
+
*
|
|
43066
|
+
* @param {String} teamId Team ID
|
|
43067
|
+
* @param {Object} body Team
|
|
43068
|
+
*/
|
|
43069
|
+
patchTeam(teamId, body) {
|
|
43070
|
+
// verify the required parameter 'teamId' is set
|
|
43071
|
+
if (teamId === undefined || teamId === null) {
|
|
43072
|
+
throw 'Missing the required parameter "teamId" when calling patchTeam';
|
|
43073
|
+
}
|
|
43074
|
+
// verify the required parameter 'body' is set
|
|
43075
|
+
if (body === undefined || body === null) {
|
|
43076
|
+
throw 'Missing the required parameter "body" when calling patchTeam';
|
|
43077
|
+
}
|
|
43078
|
+
|
|
43079
|
+
return this.apiClient.callApi(
|
|
43080
|
+
'/api/v2/teams/{teamId}',
|
|
43081
|
+
'PATCH',
|
|
43082
|
+
{ 'teamId': teamId },
|
|
43083
|
+
{ },
|
|
43084
|
+
{ },
|
|
43085
|
+
{ },
|
|
43086
|
+
body,
|
|
43087
|
+
['PureCloud OAuth'],
|
|
43088
|
+
['application/json'],
|
|
43089
|
+
['application/json']
|
|
43090
|
+
);
|
|
43091
|
+
}
|
|
43092
|
+
|
|
43093
|
+
/**
|
|
43094
|
+
* Create a team
|
|
43095
|
+
*
|
|
43096
|
+
* @param {Object} body Team
|
|
43097
|
+
*/
|
|
43098
|
+
postTeams(body) {
|
|
43099
|
+
// verify the required parameter 'body' is set
|
|
43100
|
+
if (body === undefined || body === null) {
|
|
43101
|
+
throw 'Missing the required parameter "body" when calling postTeams';
|
|
43102
|
+
}
|
|
43103
|
+
|
|
43104
|
+
return this.apiClient.callApi(
|
|
43105
|
+
'/api/v2/teams',
|
|
43106
|
+
'POST',
|
|
43107
|
+
{ },
|
|
43108
|
+
{ },
|
|
43109
|
+
{ },
|
|
43110
|
+
{ },
|
|
43111
|
+
body,
|
|
43112
|
+
['PureCloud OAuth'],
|
|
43113
|
+
['application/json'],
|
|
43114
|
+
['application/json']
|
|
43115
|
+
);
|
|
43116
|
+
}
|
|
43117
|
+
|
|
43118
|
+
/**
|
|
43119
|
+
* Search resources.
|
|
43120
|
+
*
|
|
43121
|
+
* @param {Object} body Search request options
|
|
43122
|
+
*/
|
|
43123
|
+
postTeamsSearch(body) {
|
|
43124
|
+
// verify the required parameter 'body' is set
|
|
43125
|
+
if (body === undefined || body === null) {
|
|
43126
|
+
throw 'Missing the required parameter "body" when calling postTeamsSearch';
|
|
43127
|
+
}
|
|
43128
|
+
|
|
43129
|
+
return this.apiClient.callApi(
|
|
43130
|
+
'/api/v2/teams/search',
|
|
43131
|
+
'POST',
|
|
43132
|
+
{ },
|
|
43133
|
+
{ },
|
|
43134
|
+
{ },
|
|
43135
|
+
{ },
|
|
43136
|
+
body,
|
|
43137
|
+
['PureCloud OAuth'],
|
|
43138
|
+
['application/json'],
|
|
43139
|
+
['application/json']
|
|
43140
|
+
);
|
|
43141
|
+
}
|
|
43142
|
+
|
|
43143
|
+
}
|
|
43144
|
+
|
|
42753
43145
|
class TelephonyApi {
|
|
42754
43146
|
/**
|
|
42755
43147
|
* Telephony service.
|
|
42756
43148
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
42757
|
-
* @version
|
|
43149
|
+
* @version 142.0.0
|
|
42758
43150
|
*/
|
|
42759
43151
|
|
|
42760
43152
|
/**
|
|
@@ -42862,7 +43254,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
42862
43254
|
/**
|
|
42863
43255
|
* TelephonyProvidersEdge service.
|
|
42864
43256
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
42865
|
-
* @version
|
|
43257
|
+
* @version 142.0.0
|
|
42866
43258
|
*/
|
|
42867
43259
|
|
|
42868
43260
|
/**
|
|
@@ -46495,7 +46887,7 @@ class TextbotsApi {
|
|
|
46495
46887
|
/**
|
|
46496
46888
|
* Textbots service.
|
|
46497
46889
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
46498
|
-
* @version
|
|
46890
|
+
* @version 142.0.0
|
|
46499
46891
|
*/
|
|
46500
46892
|
|
|
46501
46893
|
/**
|
|
@@ -46623,7 +47015,7 @@ class TokensApi {
|
|
|
46623
47015
|
/**
|
|
46624
47016
|
* Tokens service.
|
|
46625
47017
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
46626
|
-
* @version
|
|
47018
|
+
* @version 142.0.0
|
|
46627
47019
|
*/
|
|
46628
47020
|
|
|
46629
47021
|
/**
|
|
@@ -46729,7 +47121,7 @@ class UploadsApi {
|
|
|
46729
47121
|
/**
|
|
46730
47122
|
* Uploads service.
|
|
46731
47123
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
46732
|
-
* @version
|
|
47124
|
+
* @version 142.0.0
|
|
46733
47125
|
*/
|
|
46734
47126
|
|
|
46735
47127
|
/**
|
|
@@ -46880,7 +47272,7 @@ class UsageApi {
|
|
|
46880
47272
|
/**
|
|
46881
47273
|
* Usage service.
|
|
46882
47274
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
46883
|
-
* @version
|
|
47275
|
+
* @version 142.0.0
|
|
46884
47276
|
*/
|
|
46885
47277
|
|
|
46886
47278
|
/**
|
|
@@ -46951,7 +47343,7 @@ class UserRecordingsApi {
|
|
|
46951
47343
|
/**
|
|
46952
47344
|
* UserRecordings service.
|
|
46953
47345
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
46954
|
-
* @version
|
|
47346
|
+
* @version 142.0.0
|
|
46955
47347
|
*/
|
|
46956
47348
|
|
|
46957
47349
|
/**
|
|
@@ -47135,7 +47527,7 @@ class UsersApi {
|
|
|
47135
47527
|
/**
|
|
47136
47528
|
* Users service.
|
|
47137
47529
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
47138
|
-
* @version
|
|
47530
|
+
* @version 142.0.0
|
|
47139
47531
|
*/
|
|
47140
47532
|
|
|
47141
47533
|
/**
|
|
@@ -49437,7 +49829,7 @@ class UtilitiesApi {
|
|
|
49437
49829
|
/**
|
|
49438
49830
|
* Utilities service.
|
|
49439
49831
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
49440
|
-
* @version
|
|
49832
|
+
* @version 142.0.0
|
|
49441
49833
|
*/
|
|
49442
49834
|
|
|
49443
49835
|
/**
|
|
@@ -49548,7 +49940,7 @@ class VoicemailApi {
|
|
|
49548
49940
|
/**
|
|
49549
49941
|
* Voicemail service.
|
|
49550
49942
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
49551
|
-
* @version
|
|
49943
|
+
* @version 142.0.0
|
|
49552
49944
|
*/
|
|
49553
49945
|
|
|
49554
49946
|
/**
|
|
@@ -50215,7 +50607,7 @@ class WebChatApi {
|
|
|
50215
50607
|
/**
|
|
50216
50608
|
* WebChat service.
|
|
50217
50609
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
50218
|
-
* @version
|
|
50610
|
+
* @version 142.0.0
|
|
50219
50611
|
*/
|
|
50220
50612
|
|
|
50221
50613
|
/**
|
|
@@ -50759,7 +51151,7 @@ class WebDeploymentsApi {
|
|
|
50759
51151
|
/**
|
|
50760
51152
|
* WebDeployments service.
|
|
50761
51153
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
50762
|
-
* @version
|
|
51154
|
+
* @version 142.0.0
|
|
50763
51155
|
*/
|
|
50764
51156
|
|
|
50765
51157
|
/**
|
|
@@ -51114,7 +51506,7 @@ class WebMessagingApi {
|
|
|
51114
51506
|
/**
|
|
51115
51507
|
* WebMessaging service.
|
|
51116
51508
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
51117
|
-
* @version
|
|
51509
|
+
* @version 142.0.0
|
|
51118
51510
|
*/
|
|
51119
51511
|
|
|
51120
51512
|
/**
|
|
@@ -51160,7 +51552,7 @@ class WidgetsApi {
|
|
|
51160
51552
|
/**
|
|
51161
51553
|
* Widgets service.
|
|
51162
51554
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
51163
|
-
* @version
|
|
51555
|
+
* @version 142.0.0
|
|
51164
51556
|
*/
|
|
51165
51557
|
|
|
51166
51558
|
/**
|
|
@@ -51306,7 +51698,7 @@ class WorkforceManagementApi {
|
|
|
51306
51698
|
/**
|
|
51307
51699
|
* WorkforceManagement service.
|
|
51308
51700
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
51309
|
-
* @version
|
|
51701
|
+
* @version 142.0.0
|
|
51310
51702
|
*/
|
|
51311
51703
|
|
|
51312
51704
|
/**
|
|
@@ -51726,6 +52118,31 @@ class WorkforceManagementApi {
|
|
|
51726
52118
|
);
|
|
51727
52119
|
}
|
|
51728
52120
|
|
|
52121
|
+
/**
|
|
52122
|
+
* Query the status of a historical adherence request operation. Only the user who started the operation can query the status
|
|
52123
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
52124
|
+
* @param {String} jobId jobId
|
|
52125
|
+
*/
|
|
52126
|
+
getWorkforcemanagementAdherenceHistoricalJob(jobId) {
|
|
52127
|
+
// verify the required parameter 'jobId' is set
|
|
52128
|
+
if (jobId === undefined || jobId === null) {
|
|
52129
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceHistoricalJob';
|
|
52130
|
+
}
|
|
52131
|
+
|
|
52132
|
+
return this.apiClient.callApi(
|
|
52133
|
+
'/api/v2/workforcemanagement/adherence/historical/jobs/{jobId}',
|
|
52134
|
+
'GET',
|
|
52135
|
+
{ 'jobId': jobId },
|
|
52136
|
+
{ },
|
|
52137
|
+
{ },
|
|
52138
|
+
{ },
|
|
52139
|
+
null,
|
|
52140
|
+
['PureCloud OAuth'],
|
|
52141
|
+
['application/json'],
|
|
52142
|
+
['application/json']
|
|
52143
|
+
);
|
|
52144
|
+
}
|
|
52145
|
+
|
|
51729
52146
|
/**
|
|
51730
52147
|
* Get status of the modeling job
|
|
51731
52148
|
*
|
|
@@ -55557,7 +55974,7 @@ class WorkforceManagementApi {
|
|
|
55557
55974
|
* </pre>
|
|
55558
55975
|
* </p>
|
|
55559
55976
|
* @module purecloud-platform-client-v2/index
|
|
55560
|
-
* @version
|
|
55977
|
+
* @version 142.0.0
|
|
55561
55978
|
*/
|
|
55562
55979
|
class platformClient {
|
|
55563
55980
|
constructor() {
|
|
@@ -55806,6 +56223,11 @@ class platformClient {
|
|
|
55806
56223
|
* @property {module:purecloud-platform-client-v2/api/SuggestApi}
|
|
55807
56224
|
*/
|
|
55808
56225
|
this.SuggestApi = SuggestApi;
|
|
56226
|
+
/**
|
|
56227
|
+
* The TeamsApi service constructor.
|
|
56228
|
+
* @property {module:purecloud-platform-client-v2/api/TeamsApi}
|
|
56229
|
+
*/
|
|
56230
|
+
this.TeamsApi = TeamsApi;
|
|
55809
56231
|
/**
|
|
55810
56232
|
* The TelephonyApi service constructor.
|
|
55811
56233
|
* @property {module:purecloud-platform-client-v2/api/TelephonyApi}
|