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
|
@@ -9306,7 +9306,7 @@ class Configuration {
|
|
|
9306
9306
|
|
|
9307
9307
|
/**
|
|
9308
9308
|
* @module purecloud-platform-client-v2/ApiClient
|
|
9309
|
-
* @version
|
|
9309
|
+
* @version 142.0.0
|
|
9310
9310
|
*/
|
|
9311
9311
|
class ApiClient {
|
|
9312
9312
|
/**
|
|
@@ -10378,7 +10378,7 @@ class AlertingApi {
|
|
|
10378
10378
|
/**
|
|
10379
10379
|
* Alerting service.
|
|
10380
10380
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
10381
|
-
* @version
|
|
10381
|
+
* @version 142.0.0
|
|
10382
10382
|
*/
|
|
10383
10383
|
|
|
10384
10384
|
/**
|
|
@@ -10692,7 +10692,7 @@ class AnalyticsApi {
|
|
|
10692
10692
|
/**
|
|
10693
10693
|
* Analytics service.
|
|
10694
10694
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
10695
|
-
* @version
|
|
10695
|
+
* @version 142.0.0
|
|
10696
10696
|
*/
|
|
10697
10697
|
|
|
10698
10698
|
/**
|
|
@@ -11874,7 +11874,7 @@ class ArchitectApi {
|
|
|
11874
11874
|
/**
|
|
11875
11875
|
* Architect service.
|
|
11876
11876
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
11877
|
-
* @version
|
|
11877
|
+
* @version 142.0.0
|
|
11878
11878
|
*/
|
|
11879
11879
|
|
|
11880
11880
|
/**
|
|
@@ -14919,7 +14919,7 @@ class AuditApi {
|
|
|
14919
14919
|
/**
|
|
14920
14920
|
* Audit service.
|
|
14921
14921
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
14922
|
-
* @version
|
|
14922
|
+
* @version 142.0.0
|
|
14923
14923
|
*/
|
|
14924
14924
|
|
|
14925
14925
|
/**
|
|
@@ -15090,7 +15090,7 @@ class AuthorizationApi {
|
|
|
15090
15090
|
/**
|
|
15091
15091
|
* Authorization service.
|
|
15092
15092
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
15093
|
-
* @version
|
|
15093
|
+
* @version 142.0.0
|
|
15094
15094
|
*/
|
|
15095
15095
|
|
|
15096
15096
|
/**
|
|
@@ -16273,7 +16273,7 @@ class BillingApi {
|
|
|
16273
16273
|
/**
|
|
16274
16274
|
* Billing service.
|
|
16275
16275
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16276
|
-
* @version
|
|
16276
|
+
* @version 142.0.0
|
|
16277
16277
|
*/
|
|
16278
16278
|
|
|
16279
16279
|
/**
|
|
@@ -16353,7 +16353,7 @@ class ChatApi {
|
|
|
16353
16353
|
/**
|
|
16354
16354
|
* Chat service.
|
|
16355
16355
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
16356
|
-
* @version
|
|
16356
|
+
* @version 142.0.0
|
|
16357
16357
|
*/
|
|
16358
16358
|
|
|
16359
16359
|
/**
|
|
@@ -16444,7 +16444,7 @@ class CoachingApi {
|
|
|
16444
16444
|
/**
|
|
16445
16445
|
* Coaching service.
|
|
16446
16446
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
16447
|
-
* @version
|
|
16447
|
+
* @version 142.0.0
|
|
16448
16448
|
*/
|
|
16449
16449
|
|
|
16450
16450
|
/**
|
|
@@ -17021,7 +17021,7 @@ class ContentManagementApi {
|
|
|
17021
17021
|
/**
|
|
17022
17022
|
* ContentManagement service.
|
|
17023
17023
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
17024
|
-
* @version
|
|
17024
|
+
* @version 142.0.0
|
|
17025
17025
|
*/
|
|
17026
17026
|
|
|
17027
17027
|
/**
|
|
@@ -18161,7 +18161,7 @@ class ConversationsApi {
|
|
|
18161
18161
|
/**
|
|
18162
18162
|
* Conversations service.
|
|
18163
18163
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
18164
|
-
* @version
|
|
18164
|
+
* @version 142.0.0
|
|
18165
18165
|
*/
|
|
18166
18166
|
|
|
18167
18167
|
/**
|
|
@@ -23095,7 +23095,7 @@ class DataExtensionsApi {
|
|
|
23095
23095
|
/**
|
|
23096
23096
|
* DataExtensions service.
|
|
23097
23097
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
23098
|
-
* @version
|
|
23098
|
+
* @version 142.0.0
|
|
23099
23099
|
*/
|
|
23100
23100
|
|
|
23101
23101
|
/**
|
|
@@ -23181,7 +23181,7 @@ class ExternalContactsApi {
|
|
|
23181
23181
|
/**
|
|
23182
23182
|
* ExternalContacts service.
|
|
23183
23183
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
23184
|
-
* @version
|
|
23184
|
+
* @version 142.0.0
|
|
23185
23185
|
*/
|
|
23186
23186
|
|
|
23187
23187
|
/**
|
|
@@ -24924,7 +24924,7 @@ class FaxApi {
|
|
|
24924
24924
|
/**
|
|
24925
24925
|
* Fax service.
|
|
24926
24926
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
24927
|
-
* @version
|
|
24927
|
+
* @version 142.0.0
|
|
24928
24928
|
*/
|
|
24929
24929
|
|
|
24930
24930
|
/**
|
|
@@ -25095,7 +25095,7 @@ class FlowsApi {
|
|
|
25095
25095
|
/**
|
|
25096
25096
|
* Flows service.
|
|
25097
25097
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25098
|
-
* @version
|
|
25098
|
+
* @version 142.0.0
|
|
25099
25099
|
*/
|
|
25100
25100
|
|
|
25101
25101
|
/**
|
|
@@ -25166,7 +25166,7 @@ class GamificationApi {
|
|
|
25166
25166
|
/**
|
|
25167
25167
|
* Gamification service.
|
|
25168
25168
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25169
|
-
* @version
|
|
25169
|
+
* @version 142.0.0
|
|
25170
25170
|
*/
|
|
25171
25171
|
|
|
25172
25172
|
/**
|
|
@@ -25789,6 +25789,157 @@ class GamificationApi {
|
|
|
25789
25789
|
);
|
|
25790
25790
|
}
|
|
25791
25791
|
|
|
25792
|
+
/**
|
|
25793
|
+
* Average performance values trends by metric of a user
|
|
25794
|
+
*
|
|
25795
|
+
* @param {String} profileId performanceProfileId
|
|
25796
|
+
* @param {String} metricId metricId
|
|
25797
|
+
* @param {String} userId
|
|
25798
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
25799
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
25800
|
+
* @param {Object} opts Optional parameters
|
|
25801
|
+
* @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
|
|
25802
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
25803
|
+
*/
|
|
25804
|
+
getGamificationScorecardsProfileMetricUserValuesTrends(profileId, metricId, userId, startWorkday, endWorkday, opts) {
|
|
25805
|
+
opts = opts || {};
|
|
25806
|
+
|
|
25807
|
+
// verify the required parameter 'profileId' is set
|
|
25808
|
+
if (profileId === undefined || profileId === null) {
|
|
25809
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
25810
|
+
}
|
|
25811
|
+
// verify the required parameter 'metricId' is set
|
|
25812
|
+
if (metricId === undefined || metricId === null) {
|
|
25813
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
25814
|
+
}
|
|
25815
|
+
// verify the required parameter 'userId' is set
|
|
25816
|
+
if (userId === undefined || userId === null) {
|
|
25817
|
+
throw 'Missing the required parameter "userId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
25818
|
+
}
|
|
25819
|
+
// verify the required parameter 'startWorkday' is set
|
|
25820
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
25821
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
25822
|
+
}
|
|
25823
|
+
// verify the required parameter 'endWorkday' is set
|
|
25824
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
25825
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
25826
|
+
}
|
|
25827
|
+
|
|
25828
|
+
return this.apiClient.callApi(
|
|
25829
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends',
|
|
25830
|
+
'GET',
|
|
25831
|
+
{ 'profileId': profileId,'metricId': metricId,'userId': userId },
|
|
25832
|
+
{ 'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
25833
|
+
{ },
|
|
25834
|
+
{ },
|
|
25835
|
+
null,
|
|
25836
|
+
['PureCloud OAuth'],
|
|
25837
|
+
['application/json'],
|
|
25838
|
+
['application/json']
|
|
25839
|
+
);
|
|
25840
|
+
}
|
|
25841
|
+
|
|
25842
|
+
/**
|
|
25843
|
+
* Average performance values trends by metric of a division or a performance profile
|
|
25844
|
+
*
|
|
25845
|
+
* @param {String} profileId performanceProfileId
|
|
25846
|
+
* @param {String} metricId metricId
|
|
25847
|
+
* @param {Object} filterType Filter type for the query request.
|
|
25848
|
+
* @param {String} filterId ID for the filter type. For example, division Id
|
|
25849
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
25850
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
25851
|
+
* @param {Object} opts Optional parameters
|
|
25852
|
+
* @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
|
|
25853
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
25854
|
+
*/
|
|
25855
|
+
getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, filterId, startWorkday, endWorkday, opts) {
|
|
25856
|
+
opts = opts || {};
|
|
25857
|
+
|
|
25858
|
+
// verify the required parameter 'profileId' is set
|
|
25859
|
+
if (profileId === undefined || profileId === null) {
|
|
25860
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
25861
|
+
}
|
|
25862
|
+
// verify the required parameter 'metricId' is set
|
|
25863
|
+
if (metricId === undefined || metricId === null) {
|
|
25864
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
25865
|
+
}
|
|
25866
|
+
// verify the required parameter 'filterType' is set
|
|
25867
|
+
if (filterType === undefined || filterType === null) {
|
|
25868
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
25869
|
+
}
|
|
25870
|
+
// verify the required parameter 'filterId' is set
|
|
25871
|
+
if (filterId === undefined || filterId === null) {
|
|
25872
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
25873
|
+
}
|
|
25874
|
+
// verify the required parameter 'startWorkday' is set
|
|
25875
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
25876
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
25877
|
+
}
|
|
25878
|
+
// verify the required parameter 'endWorkday' is set
|
|
25879
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
25880
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
25881
|
+
}
|
|
25882
|
+
|
|
25883
|
+
return this.apiClient.callApi(
|
|
25884
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends',
|
|
25885
|
+
'GET',
|
|
25886
|
+
{ 'profileId': profileId,'metricId': metricId },
|
|
25887
|
+
{ 'filterType': filterType,'filterId': filterId,'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
25888
|
+
{ },
|
|
25889
|
+
{ },
|
|
25890
|
+
null,
|
|
25891
|
+
['PureCloud OAuth'],
|
|
25892
|
+
['application/json'],
|
|
25893
|
+
['application/json']
|
|
25894
|
+
);
|
|
25895
|
+
}
|
|
25896
|
+
|
|
25897
|
+
/**
|
|
25898
|
+
* Average performance values trends by metric of the requesting user
|
|
25899
|
+
*
|
|
25900
|
+
* @param {String} profileId performanceProfileId
|
|
25901
|
+
* @param {String} metricId metricId
|
|
25902
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
25903
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
25904
|
+
* @param {Object} opts Optional parameters
|
|
25905
|
+
* @param {Object} opts.filterType Filter type for the query request. If not set, returns the values trends of the requesting user
|
|
25906
|
+
* @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
|
|
25907
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
25908
|
+
*/
|
|
25909
|
+
getGamificationScorecardsProfileMetricValuesTrends(profileId, metricId, startWorkday, endWorkday, opts) {
|
|
25910
|
+
opts = opts || {};
|
|
25911
|
+
|
|
25912
|
+
// verify the required parameter 'profileId' is set
|
|
25913
|
+
if (profileId === undefined || profileId === null) {
|
|
25914
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
25915
|
+
}
|
|
25916
|
+
// verify the required parameter 'metricId' is set
|
|
25917
|
+
if (metricId === undefined || metricId === null) {
|
|
25918
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
25919
|
+
}
|
|
25920
|
+
// verify the required parameter 'startWorkday' is set
|
|
25921
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
25922
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
25923
|
+
}
|
|
25924
|
+
// verify the required parameter 'endWorkday' is set
|
|
25925
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
25926
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
25927
|
+
}
|
|
25928
|
+
|
|
25929
|
+
return this.apiClient.callApi(
|
|
25930
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends',
|
|
25931
|
+
'GET',
|
|
25932
|
+
{ 'profileId': profileId,'metricId': metricId },
|
|
25933
|
+
{ 'filterType': opts['filterType'],'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
25934
|
+
{ },
|
|
25935
|
+
{ },
|
|
25936
|
+
null,
|
|
25937
|
+
['PureCloud OAuth'],
|
|
25938
|
+
['application/json'],
|
|
25939
|
+
['application/json']
|
|
25940
|
+
);
|
|
25941
|
+
}
|
|
25942
|
+
|
|
25792
25943
|
/**
|
|
25793
25944
|
* Workday performance metrics for a user
|
|
25794
25945
|
*
|
|
@@ -26597,7 +26748,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
26597
26748
|
/**
|
|
26598
26749
|
* GeneralDataProtectionRegulation service.
|
|
26599
26750
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26600
|
-
* @version
|
|
26751
|
+
* @version 142.0.0
|
|
26601
26752
|
*/
|
|
26602
26753
|
|
|
26603
26754
|
/**
|
|
@@ -26727,7 +26878,7 @@ class GeolocationApi {
|
|
|
26727
26878
|
/**
|
|
26728
26879
|
* Geolocation service.
|
|
26729
26880
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
26730
|
-
* @version
|
|
26881
|
+
* @version 142.0.0
|
|
26731
26882
|
*/
|
|
26732
26883
|
|
|
26733
26884
|
/**
|
|
@@ -26858,7 +27009,7 @@ class GreetingsApi {
|
|
|
26858
27009
|
/**
|
|
26859
27010
|
* Greetings service.
|
|
26860
27011
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
26861
|
-
* @version
|
|
27012
|
+
* @version 142.0.0
|
|
26862
27013
|
*/
|
|
26863
27014
|
|
|
26864
27015
|
/**
|
|
@@ -27313,7 +27464,7 @@ class GroupsApi {
|
|
|
27313
27464
|
/**
|
|
27314
27465
|
* Groups service.
|
|
27315
27466
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
27316
|
-
* @version
|
|
27467
|
+
* @version 142.0.0
|
|
27317
27468
|
*/
|
|
27318
27469
|
|
|
27319
27470
|
/**
|
|
@@ -27718,7 +27869,7 @@ class IdentityProviderApi {
|
|
|
27718
27869
|
/**
|
|
27719
27870
|
* IdentityProvider service.
|
|
27720
27871
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
27721
|
-
* @version
|
|
27872
|
+
* @version 142.0.0
|
|
27722
27873
|
*/
|
|
27723
27874
|
|
|
27724
27875
|
/**
|
|
@@ -28474,7 +28625,7 @@ class IntegrationsApi {
|
|
|
28474
28625
|
/**
|
|
28475
28626
|
* Integrations service.
|
|
28476
28627
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28477
|
-
* @version
|
|
28628
|
+
* @version 142.0.0
|
|
28478
28629
|
*/
|
|
28479
28630
|
|
|
28480
28631
|
/**
|
|
@@ -30151,7 +30302,7 @@ class JourneyApi {
|
|
|
30151
30302
|
/**
|
|
30152
30303
|
* Journey service.
|
|
30153
30304
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30154
|
-
* @version
|
|
30305
|
+
* @version 142.0.0
|
|
30155
30306
|
*/
|
|
30156
30307
|
|
|
30157
30308
|
/**
|
|
@@ -30862,7 +31013,7 @@ class KnowledgeApi {
|
|
|
30862
31013
|
/**
|
|
30863
31014
|
* Knowledge service.
|
|
30864
31015
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
30865
|
-
* @version
|
|
31016
|
+
* @version 142.0.0
|
|
30866
31017
|
*/
|
|
30867
31018
|
|
|
30868
31019
|
/**
|
|
@@ -31762,7 +31913,7 @@ class LanguageUnderstandingApi {
|
|
|
31762
31913
|
/**
|
|
31763
31914
|
* LanguageUnderstanding service.
|
|
31764
31915
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
31765
|
-
* @version
|
|
31916
|
+
* @version 142.0.0
|
|
31766
31917
|
*/
|
|
31767
31918
|
|
|
31768
31919
|
/**
|
|
@@ -32666,7 +32817,7 @@ class LanguagesApi {
|
|
|
32666
32817
|
/**
|
|
32667
32818
|
* Languages service.
|
|
32668
32819
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
32669
|
-
* @version
|
|
32820
|
+
* @version 142.0.0
|
|
32670
32821
|
*/
|
|
32671
32822
|
|
|
32672
32823
|
/**
|
|
@@ -32934,7 +33085,7 @@ class LearningApi {
|
|
|
32934
33085
|
/**
|
|
32935
33086
|
* Learning service.
|
|
32936
33087
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
32937
|
-
* @version
|
|
33088
|
+
* @version 142.0.0
|
|
32938
33089
|
*/
|
|
32939
33090
|
|
|
32940
33091
|
/**
|
|
@@ -33253,6 +33404,40 @@ class LearningApi {
|
|
|
33253
33404
|
);
|
|
33254
33405
|
}
|
|
33255
33406
|
|
|
33407
|
+
/**
|
|
33408
|
+
* Get all learning modules of an organization including assignments for a specific user
|
|
33409
|
+
*
|
|
33410
|
+
* @param {Array.<String>} userIds The IDs of the users to include
|
|
33411
|
+
* @param {Object} opts Optional parameters
|
|
33412
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
33413
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
33414
|
+
* @param {String} opts.searchTerm Search Term (searches by name and description)
|
|
33415
|
+
* @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)
|
|
33416
|
+
* @param {Array.<String>} opts.assignmentStates Specifies the assignment states to return.
|
|
33417
|
+
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
33418
|
+
*/
|
|
33419
|
+
getLearningModulesAssignments(userIds, opts) {
|
|
33420
|
+
opts = opts || {};
|
|
33421
|
+
|
|
33422
|
+
// verify the required parameter 'userIds' is set
|
|
33423
|
+
if (userIds === undefined || userIds === null) {
|
|
33424
|
+
throw 'Missing the required parameter "userIds" when calling getLearningModulesAssignments';
|
|
33425
|
+
}
|
|
33426
|
+
|
|
33427
|
+
return this.apiClient.callApi(
|
|
33428
|
+
'/api/v2/learning/modules/assignments',
|
|
33429
|
+
'GET',
|
|
33430
|
+
{ },
|
|
33431
|
+
{ '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') },
|
|
33432
|
+
{ },
|
|
33433
|
+
{ },
|
|
33434
|
+
null,
|
|
33435
|
+
['PureCloud OAuth'],
|
|
33436
|
+
['application/json'],
|
|
33437
|
+
['application/json']
|
|
33438
|
+
);
|
|
33439
|
+
}
|
|
33440
|
+
|
|
33256
33441
|
/**
|
|
33257
33442
|
* Update Learning Assignment
|
|
33258
33443
|
*
|
|
@@ -33635,7 +33820,7 @@ class LicenseApi {
|
|
|
33635
33820
|
/**
|
|
33636
33821
|
* License service.
|
|
33637
33822
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
33638
|
-
* @version
|
|
33823
|
+
* @version 142.0.0
|
|
33639
33824
|
*/
|
|
33640
33825
|
|
|
33641
33826
|
/**
|
|
@@ -33873,7 +34058,7 @@ class LocationsApi {
|
|
|
33873
34058
|
/**
|
|
33874
34059
|
* Locations service.
|
|
33875
34060
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
33876
|
-
* @version
|
|
34061
|
+
* @version 142.0.0
|
|
33877
34062
|
*/
|
|
33878
34063
|
|
|
33879
34064
|
/**
|
|
@@ -34109,7 +34294,7 @@ class MessagingApi {
|
|
|
34109
34294
|
/**
|
|
34110
34295
|
* Messaging service.
|
|
34111
34296
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
34112
|
-
* @version
|
|
34297
|
+
* @version 142.0.0
|
|
34113
34298
|
*/
|
|
34114
34299
|
|
|
34115
34300
|
/**
|
|
@@ -34260,7 +34445,7 @@ class MobileDevicesApi {
|
|
|
34260
34445
|
/**
|
|
34261
34446
|
* MobileDevices service.
|
|
34262
34447
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
34263
|
-
* @version
|
|
34448
|
+
* @version 142.0.0
|
|
34264
34449
|
*/
|
|
34265
34450
|
|
|
34266
34451
|
/**
|
|
@@ -34411,7 +34596,7 @@ class NotificationsApi {
|
|
|
34411
34596
|
/**
|
|
34412
34597
|
* Notifications service.
|
|
34413
34598
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
34414
|
-
* @version
|
|
34599
|
+
* @version 142.0.0
|
|
34415
34600
|
*/
|
|
34416
34601
|
|
|
34417
34602
|
/**
|
|
@@ -34636,7 +34821,7 @@ class OAuthApi {
|
|
|
34636
34821
|
/**
|
|
34637
34822
|
* OAuth service.
|
|
34638
34823
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
34639
|
-
* @version
|
|
34824
|
+
* @version 142.0.0
|
|
34640
34825
|
*/
|
|
34641
34826
|
|
|
34642
34827
|
/**
|
|
@@ -35002,7 +35187,7 @@ class ObjectsApi {
|
|
|
35002
35187
|
/**
|
|
35003
35188
|
* Objects service.
|
|
35004
35189
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
35005
|
-
* @version
|
|
35190
|
+
* @version 142.0.0
|
|
35006
35191
|
*/
|
|
35007
35192
|
|
|
35008
35193
|
/**
|
|
@@ -35273,7 +35458,7 @@ class OrganizationApi {
|
|
|
35273
35458
|
/**
|
|
35274
35459
|
* Organization service.
|
|
35275
35460
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
35276
|
-
* @version
|
|
35461
|
+
* @version 142.0.0
|
|
35277
35462
|
*/
|
|
35278
35463
|
|
|
35279
35464
|
/**
|
|
@@ -35676,7 +35861,7 @@ class OrganizationAuthorizationApi {
|
|
|
35676
35861
|
/**
|
|
35677
35862
|
* OrganizationAuthorization service.
|
|
35678
35863
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
35679
|
-
* @version
|
|
35864
|
+
* @version 142.0.0
|
|
35680
35865
|
*/
|
|
35681
35866
|
|
|
35682
35867
|
/**
|
|
@@ -36601,7 +36786,7 @@ class OutboundApi {
|
|
|
36601
36786
|
/**
|
|
36602
36787
|
* Outbound service.
|
|
36603
36788
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
36604
|
-
* @version
|
|
36789
|
+
* @version 142.0.0
|
|
36605
36790
|
*/
|
|
36606
36791
|
|
|
36607
36792
|
/**
|
|
@@ -39856,7 +40041,7 @@ class PresenceApi {
|
|
|
39856
40041
|
/**
|
|
39857
40042
|
* Presence service.
|
|
39858
40043
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
39859
|
-
* @version
|
|
40044
|
+
* @version 142.0.0
|
|
39860
40045
|
*/
|
|
39861
40046
|
|
|
39862
40047
|
/**
|
|
@@ -40178,7 +40363,7 @@ class QualityApi {
|
|
|
40178
40363
|
/**
|
|
40179
40364
|
* Quality service.
|
|
40180
40365
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
40181
|
-
* @version
|
|
40366
|
+
* @version 142.0.0
|
|
40182
40367
|
*/
|
|
40183
40368
|
|
|
40184
40369
|
/**
|
|
@@ -41756,7 +41941,7 @@ class RecordingApi {
|
|
|
41756
41941
|
/**
|
|
41757
41942
|
* Recording service.
|
|
41758
41943
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
41759
|
-
* @version
|
|
41944
|
+
* @version 142.0.0
|
|
41760
41945
|
*/
|
|
41761
41946
|
|
|
41762
41947
|
/**
|
|
@@ -43409,7 +43594,7 @@ class ResponseManagementApi {
|
|
|
43409
43594
|
/**
|
|
43410
43595
|
* ResponseManagement service.
|
|
43411
43596
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
43412
|
-
* @version
|
|
43597
|
+
* @version 142.0.0
|
|
43413
43598
|
*/
|
|
43414
43599
|
|
|
43415
43600
|
/**
|
|
@@ -43893,7 +44078,7 @@ class RoutingApi {
|
|
|
43893
44078
|
/**
|
|
43894
44079
|
* Routing service.
|
|
43895
44080
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
43896
|
-
* @version
|
|
44081
|
+
* @version 142.0.0
|
|
43897
44082
|
*/
|
|
43898
44083
|
|
|
43899
44084
|
/**
|
|
@@ -45003,6 +45188,8 @@ class RoutingApi {
|
|
|
45003
45188
|
* @param {String} opts.name Filter by queue name
|
|
45004
45189
|
* @param {Array.<String>} opts.id Filter by queue ID(s)
|
|
45005
45190
|
* @param {Array.<String>} opts.divisionId Filter by queue division ID(s)
|
|
45191
|
+
* @param {Array.<String>} opts.peerId Filter by queue peer ID(s)
|
|
45192
|
+
* @param {Boolean} opts.hasPeer Filter by queues associated with peer
|
|
45006
45193
|
*/
|
|
45007
45194
|
getRoutingQueues(opts) {
|
|
45008
45195
|
opts = opts || {};
|
|
@@ -45012,7 +45199,7 @@ class RoutingApi {
|
|
|
45012
45199
|
'/api/v2/routing/queues',
|
|
45013
45200
|
'GET',
|
|
45014
45201
|
{ },
|
|
45015
|
-
{ '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') },
|
|
45202
|
+
{ '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'] },
|
|
45016
45203
|
{ },
|
|
45017
45204
|
{ },
|
|
45018
45205
|
null,
|
|
@@ -46812,7 +46999,7 @@ class SCIMApi {
|
|
|
46812
46999
|
/**
|
|
46813
47000
|
* SCIM service.
|
|
46814
47001
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
46815
|
-
* @version
|
|
47002
|
+
* @version 142.0.0
|
|
46816
47003
|
*/
|
|
46817
47004
|
|
|
46818
47005
|
/**
|
|
@@ -47689,7 +47876,7 @@ class ScriptsApi {
|
|
|
47689
47876
|
/**
|
|
47690
47877
|
* Scripts service.
|
|
47691
47878
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
47692
|
-
* @version
|
|
47879
|
+
* @version 142.0.0
|
|
47693
47880
|
*/
|
|
47694
47881
|
|
|
47695
47882
|
/**
|
|
@@ -48108,7 +48295,7 @@ class SearchApi {
|
|
|
48108
48295
|
/**
|
|
48109
48296
|
* Search service.
|
|
48110
48297
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
48111
|
-
* @version
|
|
48298
|
+
* @version 142.0.0
|
|
48112
48299
|
*/
|
|
48113
48300
|
|
|
48114
48301
|
/**
|
|
@@ -48587,6 +48774,31 @@ class SearchApi {
|
|
|
48587
48774
|
);
|
|
48588
48775
|
}
|
|
48589
48776
|
|
|
48777
|
+
/**
|
|
48778
|
+
* Search resources.
|
|
48779
|
+
*
|
|
48780
|
+
* @param {Object} body Search request options
|
|
48781
|
+
*/
|
|
48782
|
+
postTeamsSearch(body) {
|
|
48783
|
+
// verify the required parameter 'body' is set
|
|
48784
|
+
if (body === undefined || body === null) {
|
|
48785
|
+
throw 'Missing the required parameter "body" when calling postTeamsSearch';
|
|
48786
|
+
}
|
|
48787
|
+
|
|
48788
|
+
return this.apiClient.callApi(
|
|
48789
|
+
'/api/v2/teams/search',
|
|
48790
|
+
'POST',
|
|
48791
|
+
{ },
|
|
48792
|
+
{ },
|
|
48793
|
+
{ },
|
|
48794
|
+
{ },
|
|
48795
|
+
body,
|
|
48796
|
+
['PureCloud OAuth'],
|
|
48797
|
+
['application/json'],
|
|
48798
|
+
['application/json']
|
|
48799
|
+
);
|
|
48800
|
+
}
|
|
48801
|
+
|
|
48590
48802
|
/**
|
|
48591
48803
|
* Search users
|
|
48592
48804
|
*
|
|
@@ -48643,7 +48855,7 @@ class SpeechTextAnalyticsApi {
|
|
|
48643
48855
|
/**
|
|
48644
48856
|
* SpeechTextAnalytics service.
|
|
48645
48857
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
48646
|
-
* @version
|
|
48858
|
+
* @version 142.0.0
|
|
48647
48859
|
*/
|
|
48648
48860
|
|
|
48649
48861
|
/**
|
|
@@ -48868,6 +49080,7 @@ class SpeechTextAnalyticsApi {
|
|
|
48868
49080
|
* @param {Object} opts Optional parameters
|
|
48869
49081
|
* @param {String} opts.nextPage The key for listing the next page
|
|
48870
49082
|
* @param {Number} opts.pageSize The page size for the listing (default to 20)
|
|
49083
|
+
* @param {Object} opts.state Program state. Defaults to Latest
|
|
48871
49084
|
*/
|
|
48872
49085
|
getSpeechandtextanalyticsPrograms(opts) {
|
|
48873
49086
|
opts = opts || {};
|
|
@@ -48877,7 +49090,7 @@ class SpeechTextAnalyticsApi {
|
|
|
48877
49090
|
'/api/v2/speechandtextanalytics/programs',
|
|
48878
49091
|
'GET',
|
|
48879
49092
|
{ },
|
|
48880
|
-
{ 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'] },
|
|
49093
|
+
{ 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'],'state': opts['state'] },
|
|
48881
49094
|
{ },
|
|
48882
49095
|
{ },
|
|
48883
49096
|
null,
|
|
@@ -49496,7 +49709,7 @@ class StationsApi {
|
|
|
49496
49709
|
/**
|
|
49497
49710
|
* Stations service.
|
|
49498
49711
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
49499
|
-
* @version
|
|
49712
|
+
* @version 142.0.0
|
|
49500
49713
|
*/
|
|
49501
49714
|
|
|
49502
49715
|
/**
|
|
@@ -49643,7 +49856,7 @@ class SuggestApi {
|
|
|
49643
49856
|
/**
|
|
49644
49857
|
* Suggest service.
|
|
49645
49858
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
49646
|
-
* @version
|
|
49859
|
+
* @version 142.0.0
|
|
49647
49860
|
*/
|
|
49648
49861
|
|
|
49649
49862
|
/**
|
|
@@ -49778,11 +49991,190 @@ class SuggestApi {
|
|
|
49778
49991
|
|
|
49779
49992
|
}
|
|
49780
49993
|
|
|
49994
|
+
class TeamsApi {
|
|
49995
|
+
/**
|
|
49996
|
+
* Teams service.
|
|
49997
|
+
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
49998
|
+
* @version 142.0.0
|
|
49999
|
+
*/
|
|
50000
|
+
|
|
50001
|
+
/**
|
|
50002
|
+
* Constructs a new TeamsApi.
|
|
50003
|
+
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
50004
|
+
* @class
|
|
50005
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
50006
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
50007
|
+
*/
|
|
50008
|
+
constructor(apiClient) {
|
|
50009
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
50010
|
+
}
|
|
50011
|
+
|
|
50012
|
+
|
|
50013
|
+
/**
|
|
50014
|
+
* Delete team
|
|
50015
|
+
*
|
|
50016
|
+
* @param {String} teamId Team ID
|
|
50017
|
+
*/
|
|
50018
|
+
deleteTeam(teamId) {
|
|
50019
|
+
// verify the required parameter 'teamId' is set
|
|
50020
|
+
if (teamId === undefined || teamId === null) {
|
|
50021
|
+
throw 'Missing the required parameter "teamId" when calling deleteTeam';
|
|
50022
|
+
}
|
|
50023
|
+
|
|
50024
|
+
return this.apiClient.callApi(
|
|
50025
|
+
'/api/v2/teams/{teamId}',
|
|
50026
|
+
'DELETE',
|
|
50027
|
+
{ 'teamId': teamId },
|
|
50028
|
+
{ },
|
|
50029
|
+
{ },
|
|
50030
|
+
{ },
|
|
50031
|
+
null,
|
|
50032
|
+
['PureCloud OAuth'],
|
|
50033
|
+
['application/json'],
|
|
50034
|
+
['application/json']
|
|
50035
|
+
);
|
|
50036
|
+
}
|
|
50037
|
+
|
|
50038
|
+
/**
|
|
50039
|
+
* Get team
|
|
50040
|
+
*
|
|
50041
|
+
* @param {String} teamId Team ID
|
|
50042
|
+
*/
|
|
50043
|
+
getTeam(teamId) {
|
|
50044
|
+
// verify the required parameter 'teamId' is set
|
|
50045
|
+
if (teamId === undefined || teamId === null) {
|
|
50046
|
+
throw 'Missing the required parameter "teamId" when calling getTeam';
|
|
50047
|
+
}
|
|
50048
|
+
|
|
50049
|
+
return this.apiClient.callApi(
|
|
50050
|
+
'/api/v2/teams/{teamId}',
|
|
50051
|
+
'GET',
|
|
50052
|
+
{ 'teamId': teamId },
|
|
50053
|
+
{ },
|
|
50054
|
+
{ },
|
|
50055
|
+
{ },
|
|
50056
|
+
null,
|
|
50057
|
+
['PureCloud OAuth'],
|
|
50058
|
+
['application/json'],
|
|
50059
|
+
['application/json']
|
|
50060
|
+
);
|
|
50061
|
+
}
|
|
50062
|
+
|
|
50063
|
+
/**
|
|
50064
|
+
* Get Team listing
|
|
50065
|
+
*
|
|
50066
|
+
* @param {Object} opts Optional parameters
|
|
50067
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
50068
|
+
* @param {String} opts.name Return only teams whose names start with this value (case-insensitive matching)
|
|
50069
|
+
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
50070
|
+
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
50071
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
50072
|
+
*/
|
|
50073
|
+
getTeams(opts) {
|
|
50074
|
+
opts = opts || {};
|
|
50075
|
+
|
|
50076
|
+
|
|
50077
|
+
return this.apiClient.callApi(
|
|
50078
|
+
'/api/v2/teams',
|
|
50079
|
+
'GET',
|
|
50080
|
+
{ },
|
|
50081
|
+
{ 'pageSize': opts['pageSize'],'name': opts['name'],'after': opts['after'],'before': opts['before'],'expand': opts['expand'] },
|
|
50082
|
+
{ },
|
|
50083
|
+
{ },
|
|
50084
|
+
null,
|
|
50085
|
+
['PureCloud OAuth'],
|
|
50086
|
+
['application/json'],
|
|
50087
|
+
['application/json']
|
|
50088
|
+
);
|
|
50089
|
+
}
|
|
50090
|
+
|
|
50091
|
+
/**
|
|
50092
|
+
* Update team
|
|
50093
|
+
*
|
|
50094
|
+
* @param {String} teamId Team ID
|
|
50095
|
+
* @param {Object} body Team
|
|
50096
|
+
*/
|
|
50097
|
+
patchTeam(teamId, body) {
|
|
50098
|
+
// verify the required parameter 'teamId' is set
|
|
50099
|
+
if (teamId === undefined || teamId === null) {
|
|
50100
|
+
throw 'Missing the required parameter "teamId" when calling patchTeam';
|
|
50101
|
+
}
|
|
50102
|
+
// verify the required parameter 'body' is set
|
|
50103
|
+
if (body === undefined || body === null) {
|
|
50104
|
+
throw 'Missing the required parameter "body" when calling patchTeam';
|
|
50105
|
+
}
|
|
50106
|
+
|
|
50107
|
+
return this.apiClient.callApi(
|
|
50108
|
+
'/api/v2/teams/{teamId}',
|
|
50109
|
+
'PATCH',
|
|
50110
|
+
{ 'teamId': teamId },
|
|
50111
|
+
{ },
|
|
50112
|
+
{ },
|
|
50113
|
+
{ },
|
|
50114
|
+
body,
|
|
50115
|
+
['PureCloud OAuth'],
|
|
50116
|
+
['application/json'],
|
|
50117
|
+
['application/json']
|
|
50118
|
+
);
|
|
50119
|
+
}
|
|
50120
|
+
|
|
50121
|
+
/**
|
|
50122
|
+
* Create a team
|
|
50123
|
+
*
|
|
50124
|
+
* @param {Object} body Team
|
|
50125
|
+
*/
|
|
50126
|
+
postTeams(body) {
|
|
50127
|
+
// verify the required parameter 'body' is set
|
|
50128
|
+
if (body === undefined || body === null) {
|
|
50129
|
+
throw 'Missing the required parameter "body" when calling postTeams';
|
|
50130
|
+
}
|
|
50131
|
+
|
|
50132
|
+
return this.apiClient.callApi(
|
|
50133
|
+
'/api/v2/teams',
|
|
50134
|
+
'POST',
|
|
50135
|
+
{ },
|
|
50136
|
+
{ },
|
|
50137
|
+
{ },
|
|
50138
|
+
{ },
|
|
50139
|
+
body,
|
|
50140
|
+
['PureCloud OAuth'],
|
|
50141
|
+
['application/json'],
|
|
50142
|
+
['application/json']
|
|
50143
|
+
);
|
|
50144
|
+
}
|
|
50145
|
+
|
|
50146
|
+
/**
|
|
50147
|
+
* Search resources.
|
|
50148
|
+
*
|
|
50149
|
+
* @param {Object} body Search request options
|
|
50150
|
+
*/
|
|
50151
|
+
postTeamsSearch(body) {
|
|
50152
|
+
// verify the required parameter 'body' is set
|
|
50153
|
+
if (body === undefined || body === null) {
|
|
50154
|
+
throw 'Missing the required parameter "body" when calling postTeamsSearch';
|
|
50155
|
+
}
|
|
50156
|
+
|
|
50157
|
+
return this.apiClient.callApi(
|
|
50158
|
+
'/api/v2/teams/search',
|
|
50159
|
+
'POST',
|
|
50160
|
+
{ },
|
|
50161
|
+
{ },
|
|
50162
|
+
{ },
|
|
50163
|
+
{ },
|
|
50164
|
+
body,
|
|
50165
|
+
['PureCloud OAuth'],
|
|
50166
|
+
['application/json'],
|
|
50167
|
+
['application/json']
|
|
50168
|
+
);
|
|
50169
|
+
}
|
|
50170
|
+
|
|
50171
|
+
}
|
|
50172
|
+
|
|
49781
50173
|
class TelephonyApi {
|
|
49782
50174
|
/**
|
|
49783
50175
|
* Telephony service.
|
|
49784
50176
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
49785
|
-
* @version
|
|
50177
|
+
* @version 142.0.0
|
|
49786
50178
|
*/
|
|
49787
50179
|
|
|
49788
50180
|
/**
|
|
@@ -49890,7 +50282,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
49890
50282
|
/**
|
|
49891
50283
|
* TelephonyProvidersEdge service.
|
|
49892
50284
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
49893
|
-
* @version
|
|
50285
|
+
* @version 142.0.0
|
|
49894
50286
|
*/
|
|
49895
50287
|
|
|
49896
50288
|
/**
|
|
@@ -53523,7 +53915,7 @@ class TextbotsApi {
|
|
|
53523
53915
|
/**
|
|
53524
53916
|
* Textbots service.
|
|
53525
53917
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
53526
|
-
* @version
|
|
53918
|
+
* @version 142.0.0
|
|
53527
53919
|
*/
|
|
53528
53920
|
|
|
53529
53921
|
/**
|
|
@@ -53651,7 +54043,7 @@ class TokensApi {
|
|
|
53651
54043
|
/**
|
|
53652
54044
|
* Tokens service.
|
|
53653
54045
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
53654
|
-
* @version
|
|
54046
|
+
* @version 142.0.0
|
|
53655
54047
|
*/
|
|
53656
54048
|
|
|
53657
54049
|
/**
|
|
@@ -53757,7 +54149,7 @@ class UploadsApi {
|
|
|
53757
54149
|
/**
|
|
53758
54150
|
* Uploads service.
|
|
53759
54151
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
53760
|
-
* @version
|
|
54152
|
+
* @version 142.0.0
|
|
53761
54153
|
*/
|
|
53762
54154
|
|
|
53763
54155
|
/**
|
|
@@ -53908,7 +54300,7 @@ class UsageApi {
|
|
|
53908
54300
|
/**
|
|
53909
54301
|
* Usage service.
|
|
53910
54302
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
53911
|
-
* @version
|
|
54303
|
+
* @version 142.0.0
|
|
53912
54304
|
*/
|
|
53913
54305
|
|
|
53914
54306
|
/**
|
|
@@ -53979,7 +54371,7 @@ class UserRecordingsApi {
|
|
|
53979
54371
|
/**
|
|
53980
54372
|
* UserRecordings service.
|
|
53981
54373
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
53982
|
-
* @version
|
|
54374
|
+
* @version 142.0.0
|
|
53983
54375
|
*/
|
|
53984
54376
|
|
|
53985
54377
|
/**
|
|
@@ -54163,7 +54555,7 @@ class UsersApi {
|
|
|
54163
54555
|
/**
|
|
54164
54556
|
* Users service.
|
|
54165
54557
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
54166
|
-
* @version
|
|
54558
|
+
* @version 142.0.0
|
|
54167
54559
|
*/
|
|
54168
54560
|
|
|
54169
54561
|
/**
|
|
@@ -56465,7 +56857,7 @@ class UtilitiesApi {
|
|
|
56465
56857
|
/**
|
|
56466
56858
|
* Utilities service.
|
|
56467
56859
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
56468
|
-
* @version
|
|
56860
|
+
* @version 142.0.0
|
|
56469
56861
|
*/
|
|
56470
56862
|
|
|
56471
56863
|
/**
|
|
@@ -56576,7 +56968,7 @@ class VoicemailApi {
|
|
|
56576
56968
|
/**
|
|
56577
56969
|
* Voicemail service.
|
|
56578
56970
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
56579
|
-
* @version
|
|
56971
|
+
* @version 142.0.0
|
|
56580
56972
|
*/
|
|
56581
56973
|
|
|
56582
56974
|
/**
|
|
@@ -57243,7 +57635,7 @@ class WebChatApi {
|
|
|
57243
57635
|
/**
|
|
57244
57636
|
* WebChat service.
|
|
57245
57637
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
57246
|
-
* @version
|
|
57638
|
+
* @version 142.0.0
|
|
57247
57639
|
*/
|
|
57248
57640
|
|
|
57249
57641
|
/**
|
|
@@ -57787,7 +58179,7 @@ class WebDeploymentsApi {
|
|
|
57787
58179
|
/**
|
|
57788
58180
|
* WebDeployments service.
|
|
57789
58181
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
57790
|
-
* @version
|
|
58182
|
+
* @version 142.0.0
|
|
57791
58183
|
*/
|
|
57792
58184
|
|
|
57793
58185
|
/**
|
|
@@ -58142,7 +58534,7 @@ class WebMessagingApi {
|
|
|
58142
58534
|
/**
|
|
58143
58535
|
* WebMessaging service.
|
|
58144
58536
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
58145
|
-
* @version
|
|
58537
|
+
* @version 142.0.0
|
|
58146
58538
|
*/
|
|
58147
58539
|
|
|
58148
58540
|
/**
|
|
@@ -58188,7 +58580,7 @@ class WidgetsApi {
|
|
|
58188
58580
|
/**
|
|
58189
58581
|
* Widgets service.
|
|
58190
58582
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
58191
|
-
* @version
|
|
58583
|
+
* @version 142.0.0
|
|
58192
58584
|
*/
|
|
58193
58585
|
|
|
58194
58586
|
/**
|
|
@@ -58334,7 +58726,7 @@ class WorkforceManagementApi {
|
|
|
58334
58726
|
/**
|
|
58335
58727
|
* WorkforceManagement service.
|
|
58336
58728
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
58337
|
-
* @version
|
|
58729
|
+
* @version 142.0.0
|
|
58338
58730
|
*/
|
|
58339
58731
|
|
|
58340
58732
|
/**
|
|
@@ -58754,6 +59146,31 @@ class WorkforceManagementApi {
|
|
|
58754
59146
|
);
|
|
58755
59147
|
}
|
|
58756
59148
|
|
|
59149
|
+
/**
|
|
59150
|
+
* Query the status of a historical adherence request operation. Only the user who started the operation can query the status
|
|
59151
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
59152
|
+
* @param {String} jobId jobId
|
|
59153
|
+
*/
|
|
59154
|
+
getWorkforcemanagementAdherenceHistoricalJob(jobId) {
|
|
59155
|
+
// verify the required parameter 'jobId' is set
|
|
59156
|
+
if (jobId === undefined || jobId === null) {
|
|
59157
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceHistoricalJob';
|
|
59158
|
+
}
|
|
59159
|
+
|
|
59160
|
+
return this.apiClient.callApi(
|
|
59161
|
+
'/api/v2/workforcemanagement/adherence/historical/jobs/{jobId}',
|
|
59162
|
+
'GET',
|
|
59163
|
+
{ 'jobId': jobId },
|
|
59164
|
+
{ },
|
|
59165
|
+
{ },
|
|
59166
|
+
{ },
|
|
59167
|
+
null,
|
|
59168
|
+
['PureCloud OAuth'],
|
|
59169
|
+
['application/json'],
|
|
59170
|
+
['application/json']
|
|
59171
|
+
);
|
|
59172
|
+
}
|
|
59173
|
+
|
|
58757
59174
|
/**
|
|
58758
59175
|
* Get status of the modeling job
|
|
58759
59176
|
*
|
|
@@ -62585,7 +63002,7 @@ class WorkforceManagementApi {
|
|
|
62585
63002
|
* </pre>
|
|
62586
63003
|
* </p>
|
|
62587
63004
|
* @module purecloud-platform-client-v2/index
|
|
62588
|
-
* @version
|
|
63005
|
+
* @version 142.0.0
|
|
62589
63006
|
*/
|
|
62590
63007
|
class platformClient {
|
|
62591
63008
|
constructor() {
|
|
@@ -62834,6 +63251,11 @@ class platformClient {
|
|
|
62834
63251
|
* @property {module:purecloud-platform-client-v2/api/SuggestApi}
|
|
62835
63252
|
*/
|
|
62836
63253
|
this.SuggestApi = SuggestApi;
|
|
63254
|
+
/**
|
|
63255
|
+
* The TeamsApi service constructor.
|
|
63256
|
+
* @property {module:purecloud-platform-client-v2/api/TeamsApi}
|
|
63257
|
+
*/
|
|
63258
|
+
this.TeamsApi = TeamsApi;
|
|
62837
63259
|
/**
|
|
62838
63260
|
* The TelephonyApi service constructor.
|
|
62839
63261
|
* @property {module:purecloud-platform-client-v2/api/TelephonyApi}
|