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
|
@@ -398,7 +398,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
398
398
|
|
|
399
399
|
/**
|
|
400
400
|
* @module purecloud-platform-client-v2/ApiClient
|
|
401
|
-
* @version
|
|
401
|
+
* @version 142.0.0
|
|
402
402
|
*/
|
|
403
403
|
class ApiClient {
|
|
404
404
|
/**
|
|
@@ -1477,7 +1477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1477
1477
|
/**
|
|
1478
1478
|
* Alerting service.
|
|
1479
1479
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1480
|
-
* @version
|
|
1480
|
+
* @version 142.0.0
|
|
1481
1481
|
*/
|
|
1482
1482
|
|
|
1483
1483
|
/**
|
|
@@ -1791,7 +1791,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1791
1791
|
/**
|
|
1792
1792
|
* Analytics service.
|
|
1793
1793
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1794
|
-
* @version
|
|
1794
|
+
* @version 142.0.0
|
|
1795
1795
|
*/
|
|
1796
1796
|
|
|
1797
1797
|
/**
|
|
@@ -2973,7 +2973,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2973
2973
|
/**
|
|
2974
2974
|
* Architect service.
|
|
2975
2975
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2976
|
-
* @version
|
|
2976
|
+
* @version 142.0.0
|
|
2977
2977
|
*/
|
|
2978
2978
|
|
|
2979
2979
|
/**
|
|
@@ -6018,7 +6018,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6018
6018
|
/**
|
|
6019
6019
|
* Audit service.
|
|
6020
6020
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6021
|
-
* @version
|
|
6021
|
+
* @version 142.0.0
|
|
6022
6022
|
*/
|
|
6023
6023
|
|
|
6024
6024
|
/**
|
|
@@ -6189,7 +6189,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6189
6189
|
/**
|
|
6190
6190
|
* Authorization service.
|
|
6191
6191
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6192
|
-
* @version
|
|
6192
|
+
* @version 142.0.0
|
|
6193
6193
|
*/
|
|
6194
6194
|
|
|
6195
6195
|
/**
|
|
@@ -7372,7 +7372,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7372
7372
|
/**
|
|
7373
7373
|
* Billing service.
|
|
7374
7374
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7375
|
-
* @version
|
|
7375
|
+
* @version 142.0.0
|
|
7376
7376
|
*/
|
|
7377
7377
|
|
|
7378
7378
|
/**
|
|
@@ -7452,7 +7452,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7452
7452
|
/**
|
|
7453
7453
|
* Chat service.
|
|
7454
7454
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7455
|
-
* @version
|
|
7455
|
+
* @version 142.0.0
|
|
7456
7456
|
*/
|
|
7457
7457
|
|
|
7458
7458
|
/**
|
|
@@ -7543,7 +7543,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7543
7543
|
/**
|
|
7544
7544
|
* Coaching service.
|
|
7545
7545
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7546
|
-
* @version
|
|
7546
|
+
* @version 142.0.0
|
|
7547
7547
|
*/
|
|
7548
7548
|
|
|
7549
7549
|
/**
|
|
@@ -8120,7 +8120,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8120
8120
|
/**
|
|
8121
8121
|
* ContentManagement service.
|
|
8122
8122
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8123
|
-
* @version
|
|
8123
|
+
* @version 142.0.0
|
|
8124
8124
|
*/
|
|
8125
8125
|
|
|
8126
8126
|
/**
|
|
@@ -9260,7 +9260,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9260
9260
|
/**
|
|
9261
9261
|
* Conversations service.
|
|
9262
9262
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9263
|
-
* @version
|
|
9263
|
+
* @version 142.0.0
|
|
9264
9264
|
*/
|
|
9265
9265
|
|
|
9266
9266
|
/**
|
|
@@ -14194,7 +14194,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14194
14194
|
/**
|
|
14195
14195
|
* DataExtensions service.
|
|
14196
14196
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14197
|
-
* @version
|
|
14197
|
+
* @version 142.0.0
|
|
14198
14198
|
*/
|
|
14199
14199
|
|
|
14200
14200
|
/**
|
|
@@ -14280,7 +14280,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14280
14280
|
/**
|
|
14281
14281
|
* ExternalContacts service.
|
|
14282
14282
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14283
|
-
* @version
|
|
14283
|
+
* @version 142.0.0
|
|
14284
14284
|
*/
|
|
14285
14285
|
|
|
14286
14286
|
/**
|
|
@@ -16023,7 +16023,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16023
16023
|
/**
|
|
16024
16024
|
* Fax service.
|
|
16025
16025
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16026
|
-
* @version
|
|
16026
|
+
* @version 142.0.0
|
|
16027
16027
|
*/
|
|
16028
16028
|
|
|
16029
16029
|
/**
|
|
@@ -16194,7 +16194,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16194
16194
|
/**
|
|
16195
16195
|
* Flows service.
|
|
16196
16196
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16197
|
-
* @version
|
|
16197
|
+
* @version 142.0.0
|
|
16198
16198
|
*/
|
|
16199
16199
|
|
|
16200
16200
|
/**
|
|
@@ -16265,7 +16265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16265
16265
|
/**
|
|
16266
16266
|
* Gamification service.
|
|
16267
16267
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16268
|
-
* @version
|
|
16268
|
+
* @version 142.0.0
|
|
16269
16269
|
*/
|
|
16270
16270
|
|
|
16271
16271
|
/**
|
|
@@ -16888,6 +16888,157 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16888
16888
|
);
|
|
16889
16889
|
}
|
|
16890
16890
|
|
|
16891
|
+
/**
|
|
16892
|
+
* Average performance values trends by metric of a user
|
|
16893
|
+
*
|
|
16894
|
+
* @param {String} profileId performanceProfileId
|
|
16895
|
+
* @param {String} metricId metricId
|
|
16896
|
+
* @param {String} userId
|
|
16897
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
16898
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
16899
|
+
* @param {Object} opts Optional parameters
|
|
16900
|
+
* @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
|
|
16901
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
16902
|
+
*/
|
|
16903
|
+
getGamificationScorecardsProfileMetricUserValuesTrends(profileId, metricId, userId, startWorkday, endWorkday, opts) {
|
|
16904
|
+
opts = opts || {};
|
|
16905
|
+
|
|
16906
|
+
// verify the required parameter 'profileId' is set
|
|
16907
|
+
if (profileId === undefined || profileId === null) {
|
|
16908
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16909
|
+
}
|
|
16910
|
+
// verify the required parameter 'metricId' is set
|
|
16911
|
+
if (metricId === undefined || metricId === null) {
|
|
16912
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16913
|
+
}
|
|
16914
|
+
// verify the required parameter 'userId' is set
|
|
16915
|
+
if (userId === undefined || userId === null) {
|
|
16916
|
+
throw 'Missing the required parameter "userId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16917
|
+
}
|
|
16918
|
+
// verify the required parameter 'startWorkday' is set
|
|
16919
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
16920
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16921
|
+
}
|
|
16922
|
+
// verify the required parameter 'endWorkday' is set
|
|
16923
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
16924
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16925
|
+
}
|
|
16926
|
+
|
|
16927
|
+
return this.apiClient.callApi(
|
|
16928
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends',
|
|
16929
|
+
'GET',
|
|
16930
|
+
{ 'profileId': profileId,'metricId': metricId,'userId': userId },
|
|
16931
|
+
{ 'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
16932
|
+
{ },
|
|
16933
|
+
{ },
|
|
16934
|
+
null,
|
|
16935
|
+
['PureCloud OAuth'],
|
|
16936
|
+
['application/json'],
|
|
16937
|
+
['application/json']
|
|
16938
|
+
);
|
|
16939
|
+
}
|
|
16940
|
+
|
|
16941
|
+
/**
|
|
16942
|
+
* Average performance values trends by metric of a division or a performance profile
|
|
16943
|
+
*
|
|
16944
|
+
* @param {String} profileId performanceProfileId
|
|
16945
|
+
* @param {String} metricId metricId
|
|
16946
|
+
* @param {Object} filterType Filter type for the query request.
|
|
16947
|
+
* @param {String} filterId ID for the filter type. For example, division Id
|
|
16948
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
16949
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
16950
|
+
* @param {Object} opts Optional parameters
|
|
16951
|
+
* @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
|
|
16952
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
16953
|
+
*/
|
|
16954
|
+
getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, filterId, startWorkday, endWorkday, opts) {
|
|
16955
|
+
opts = opts || {};
|
|
16956
|
+
|
|
16957
|
+
// verify the required parameter 'profileId' is set
|
|
16958
|
+
if (profileId === undefined || profileId === null) {
|
|
16959
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16960
|
+
}
|
|
16961
|
+
// verify the required parameter 'metricId' is set
|
|
16962
|
+
if (metricId === undefined || metricId === null) {
|
|
16963
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16964
|
+
}
|
|
16965
|
+
// verify the required parameter 'filterType' is set
|
|
16966
|
+
if (filterType === undefined || filterType === null) {
|
|
16967
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16968
|
+
}
|
|
16969
|
+
// verify the required parameter 'filterId' is set
|
|
16970
|
+
if (filterId === undefined || filterId === null) {
|
|
16971
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16972
|
+
}
|
|
16973
|
+
// verify the required parameter 'startWorkday' is set
|
|
16974
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
16975
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16976
|
+
}
|
|
16977
|
+
// verify the required parameter 'endWorkday' is set
|
|
16978
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
16979
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16980
|
+
}
|
|
16981
|
+
|
|
16982
|
+
return this.apiClient.callApi(
|
|
16983
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends',
|
|
16984
|
+
'GET',
|
|
16985
|
+
{ 'profileId': profileId,'metricId': metricId },
|
|
16986
|
+
{ 'filterType': filterType,'filterId': filterId,'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
16987
|
+
{ },
|
|
16988
|
+
{ },
|
|
16989
|
+
null,
|
|
16990
|
+
['PureCloud OAuth'],
|
|
16991
|
+
['application/json'],
|
|
16992
|
+
['application/json']
|
|
16993
|
+
);
|
|
16994
|
+
}
|
|
16995
|
+
|
|
16996
|
+
/**
|
|
16997
|
+
* Average performance values trends by metric of the requesting user
|
|
16998
|
+
*
|
|
16999
|
+
* @param {String} profileId performanceProfileId
|
|
17000
|
+
* @param {String} metricId metricId
|
|
17001
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
17002
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
17003
|
+
* @param {Object} opts Optional parameters
|
|
17004
|
+
* @param {Object} opts.filterType Filter type for the query request. If not set, returns the values trends of the requesting user
|
|
17005
|
+
* @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
|
|
17006
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
17007
|
+
*/
|
|
17008
|
+
getGamificationScorecardsProfileMetricValuesTrends(profileId, metricId, startWorkday, endWorkday, opts) {
|
|
17009
|
+
opts = opts || {};
|
|
17010
|
+
|
|
17011
|
+
// verify the required parameter 'profileId' is set
|
|
17012
|
+
if (profileId === undefined || profileId === null) {
|
|
17013
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
17014
|
+
}
|
|
17015
|
+
// verify the required parameter 'metricId' is set
|
|
17016
|
+
if (metricId === undefined || metricId === null) {
|
|
17017
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
17018
|
+
}
|
|
17019
|
+
// verify the required parameter 'startWorkday' is set
|
|
17020
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
17021
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
17022
|
+
}
|
|
17023
|
+
// verify the required parameter 'endWorkday' is set
|
|
17024
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
17025
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
17026
|
+
}
|
|
17027
|
+
|
|
17028
|
+
return this.apiClient.callApi(
|
|
17029
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends',
|
|
17030
|
+
'GET',
|
|
17031
|
+
{ 'profileId': profileId,'metricId': metricId },
|
|
17032
|
+
{ 'filterType': opts['filterType'],'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
17033
|
+
{ },
|
|
17034
|
+
{ },
|
|
17035
|
+
null,
|
|
17036
|
+
['PureCloud OAuth'],
|
|
17037
|
+
['application/json'],
|
|
17038
|
+
['application/json']
|
|
17039
|
+
);
|
|
17040
|
+
}
|
|
17041
|
+
|
|
16891
17042
|
/**
|
|
16892
17043
|
* Workday performance metrics for a user
|
|
16893
17044
|
*
|
|
@@ -17696,7 +17847,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17696
17847
|
/**
|
|
17697
17848
|
* GeneralDataProtectionRegulation service.
|
|
17698
17849
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
17699
|
-
* @version
|
|
17850
|
+
* @version 142.0.0
|
|
17700
17851
|
*/
|
|
17701
17852
|
|
|
17702
17853
|
/**
|
|
@@ -17826,7 +17977,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17826
17977
|
/**
|
|
17827
17978
|
* Geolocation service.
|
|
17828
17979
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17829
|
-
* @version
|
|
17980
|
+
* @version 142.0.0
|
|
17830
17981
|
*/
|
|
17831
17982
|
|
|
17832
17983
|
/**
|
|
@@ -17957,7 +18108,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17957
18108
|
/**
|
|
17958
18109
|
* Greetings service.
|
|
17959
18110
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17960
|
-
* @version
|
|
18111
|
+
* @version 142.0.0
|
|
17961
18112
|
*/
|
|
17962
18113
|
|
|
17963
18114
|
/**
|
|
@@ -18412,7 +18563,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18412
18563
|
/**
|
|
18413
18564
|
* Groups service.
|
|
18414
18565
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
18415
|
-
* @version
|
|
18566
|
+
* @version 142.0.0
|
|
18416
18567
|
*/
|
|
18417
18568
|
|
|
18418
18569
|
/**
|
|
@@ -18817,7 +18968,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18817
18968
|
/**
|
|
18818
18969
|
* IdentityProvider service.
|
|
18819
18970
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18820
|
-
* @version
|
|
18971
|
+
* @version 142.0.0
|
|
18821
18972
|
*/
|
|
18822
18973
|
|
|
18823
18974
|
/**
|
|
@@ -19573,7 +19724,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19573
19724
|
/**
|
|
19574
19725
|
* Integrations service.
|
|
19575
19726
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
19576
|
-
* @version
|
|
19727
|
+
* @version 142.0.0
|
|
19577
19728
|
*/
|
|
19578
19729
|
|
|
19579
19730
|
/**
|
|
@@ -21250,7 +21401,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21250
21401
|
/**
|
|
21251
21402
|
* Journey service.
|
|
21252
21403
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
21253
|
-
* @version
|
|
21404
|
+
* @version 142.0.0
|
|
21254
21405
|
*/
|
|
21255
21406
|
|
|
21256
21407
|
/**
|
|
@@ -21961,7 +22112,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21961
22112
|
/**
|
|
21962
22113
|
* Knowledge service.
|
|
21963
22114
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21964
|
-
* @version
|
|
22115
|
+
* @version 142.0.0
|
|
21965
22116
|
*/
|
|
21966
22117
|
|
|
21967
22118
|
/**
|
|
@@ -22861,7 +23012,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22861
23012
|
/**
|
|
22862
23013
|
* LanguageUnderstanding service.
|
|
22863
23014
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22864
|
-
* @version
|
|
23015
|
+
* @version 142.0.0
|
|
22865
23016
|
*/
|
|
22866
23017
|
|
|
22867
23018
|
/**
|
|
@@ -23765,7 +23916,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23765
23916
|
/**
|
|
23766
23917
|
* Languages service.
|
|
23767
23918
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
23768
|
-
* @version
|
|
23919
|
+
* @version 142.0.0
|
|
23769
23920
|
*/
|
|
23770
23921
|
|
|
23771
23922
|
/**
|
|
@@ -24033,7 +24184,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24033
24184
|
/**
|
|
24034
24185
|
* Learning service.
|
|
24035
24186
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
24036
|
-
* @version
|
|
24187
|
+
* @version 142.0.0
|
|
24037
24188
|
*/
|
|
24038
24189
|
|
|
24039
24190
|
/**
|
|
@@ -24352,6 +24503,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24352
24503
|
);
|
|
24353
24504
|
}
|
|
24354
24505
|
|
|
24506
|
+
/**
|
|
24507
|
+
* Get all learning modules of an organization including assignments for a specific user
|
|
24508
|
+
*
|
|
24509
|
+
* @param {Array.<String>} userIds The IDs of the users to include
|
|
24510
|
+
* @param {Object} opts Optional parameters
|
|
24511
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
24512
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
24513
|
+
* @param {String} opts.searchTerm Search Term (searches by name and description)
|
|
24514
|
+
* @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)
|
|
24515
|
+
* @param {Array.<String>} opts.assignmentStates Specifies the assignment states to return.
|
|
24516
|
+
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
24517
|
+
*/
|
|
24518
|
+
getLearningModulesAssignments(userIds, opts) {
|
|
24519
|
+
opts = opts || {};
|
|
24520
|
+
|
|
24521
|
+
// verify the required parameter 'userIds' is set
|
|
24522
|
+
if (userIds === undefined || userIds === null) {
|
|
24523
|
+
throw 'Missing the required parameter "userIds" when calling getLearningModulesAssignments';
|
|
24524
|
+
}
|
|
24525
|
+
|
|
24526
|
+
return this.apiClient.callApi(
|
|
24527
|
+
'/api/v2/learning/modules/assignments',
|
|
24528
|
+
'GET',
|
|
24529
|
+
{ },
|
|
24530
|
+
{ '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') },
|
|
24531
|
+
{ },
|
|
24532
|
+
{ },
|
|
24533
|
+
null,
|
|
24534
|
+
['PureCloud OAuth'],
|
|
24535
|
+
['application/json'],
|
|
24536
|
+
['application/json']
|
|
24537
|
+
);
|
|
24538
|
+
}
|
|
24539
|
+
|
|
24355
24540
|
/**
|
|
24356
24541
|
* Update Learning Assignment
|
|
24357
24542
|
*
|
|
@@ -24734,7 +24919,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24734
24919
|
/**
|
|
24735
24920
|
* License service.
|
|
24736
24921
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
24737
|
-
* @version
|
|
24922
|
+
* @version 142.0.0
|
|
24738
24923
|
*/
|
|
24739
24924
|
|
|
24740
24925
|
/**
|
|
@@ -24972,7 +25157,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24972
25157
|
/**
|
|
24973
25158
|
* Locations service.
|
|
24974
25159
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24975
|
-
* @version
|
|
25160
|
+
* @version 142.0.0
|
|
24976
25161
|
*/
|
|
24977
25162
|
|
|
24978
25163
|
/**
|
|
@@ -25208,7 +25393,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25208
25393
|
/**
|
|
25209
25394
|
* Messaging service.
|
|
25210
25395
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
25211
|
-
* @version
|
|
25396
|
+
* @version 142.0.0
|
|
25212
25397
|
*/
|
|
25213
25398
|
|
|
25214
25399
|
/**
|
|
@@ -25359,7 +25544,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25359
25544
|
/**
|
|
25360
25545
|
* MobileDevices service.
|
|
25361
25546
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
25362
|
-
* @version
|
|
25547
|
+
* @version 142.0.0
|
|
25363
25548
|
*/
|
|
25364
25549
|
|
|
25365
25550
|
/**
|
|
@@ -25510,7 +25695,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25510
25695
|
/**
|
|
25511
25696
|
* Notifications service.
|
|
25512
25697
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
25513
|
-
* @version
|
|
25698
|
+
* @version 142.0.0
|
|
25514
25699
|
*/
|
|
25515
25700
|
|
|
25516
25701
|
/**
|
|
@@ -25735,7 +25920,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25735
25920
|
/**
|
|
25736
25921
|
* OAuth service.
|
|
25737
25922
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
25738
|
-
* @version
|
|
25923
|
+
* @version 142.0.0
|
|
25739
25924
|
*/
|
|
25740
25925
|
|
|
25741
25926
|
/**
|
|
@@ -26101,7 +26286,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26101
26286
|
/**
|
|
26102
26287
|
* Objects service.
|
|
26103
26288
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
26104
|
-
* @version
|
|
26289
|
+
* @version 142.0.0
|
|
26105
26290
|
*/
|
|
26106
26291
|
|
|
26107
26292
|
/**
|
|
@@ -26372,7 +26557,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26372
26557
|
/**
|
|
26373
26558
|
* Organization service.
|
|
26374
26559
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
26375
|
-
* @version
|
|
26560
|
+
* @version 142.0.0
|
|
26376
26561
|
*/
|
|
26377
26562
|
|
|
26378
26563
|
/**
|
|
@@ -26775,7 +26960,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26775
26960
|
/**
|
|
26776
26961
|
* OrganizationAuthorization service.
|
|
26777
26962
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
26778
|
-
* @version
|
|
26963
|
+
* @version 142.0.0
|
|
26779
26964
|
*/
|
|
26780
26965
|
|
|
26781
26966
|
/**
|
|
@@ -27700,7 +27885,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27700
27885
|
/**
|
|
27701
27886
|
* Outbound service.
|
|
27702
27887
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
27703
|
-
* @version
|
|
27888
|
+
* @version 142.0.0
|
|
27704
27889
|
*/
|
|
27705
27890
|
|
|
27706
27891
|
/**
|
|
@@ -30955,7 +31140,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30955
31140
|
/**
|
|
30956
31141
|
* Presence service.
|
|
30957
31142
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
30958
|
-
* @version
|
|
31143
|
+
* @version 142.0.0
|
|
30959
31144
|
*/
|
|
30960
31145
|
|
|
30961
31146
|
/**
|
|
@@ -31277,7 +31462,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31277
31462
|
/**
|
|
31278
31463
|
* Quality service.
|
|
31279
31464
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
31280
|
-
* @version
|
|
31465
|
+
* @version 142.0.0
|
|
31281
31466
|
*/
|
|
31282
31467
|
|
|
31283
31468
|
/**
|
|
@@ -32855,7 +33040,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32855
33040
|
/**
|
|
32856
33041
|
* Recording service.
|
|
32857
33042
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
32858
|
-
* @version
|
|
33043
|
+
* @version 142.0.0
|
|
32859
33044
|
*/
|
|
32860
33045
|
|
|
32861
33046
|
/**
|
|
@@ -34508,7 +34693,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34508
34693
|
/**
|
|
34509
34694
|
* ResponseManagement service.
|
|
34510
34695
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
34511
|
-
* @version
|
|
34696
|
+
* @version 142.0.0
|
|
34512
34697
|
*/
|
|
34513
34698
|
|
|
34514
34699
|
/**
|
|
@@ -34992,7 +35177,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34992
35177
|
/**
|
|
34993
35178
|
* Routing service.
|
|
34994
35179
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
34995
|
-
* @version
|
|
35180
|
+
* @version 142.0.0
|
|
34996
35181
|
*/
|
|
34997
35182
|
|
|
34998
35183
|
/**
|
|
@@ -36102,6 +36287,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36102
36287
|
* @param {String} opts.name Filter by queue name
|
|
36103
36288
|
* @param {Array.<String>} opts.id Filter by queue ID(s)
|
|
36104
36289
|
* @param {Array.<String>} opts.divisionId Filter by queue division ID(s)
|
|
36290
|
+
* @param {Array.<String>} opts.peerId Filter by queue peer ID(s)
|
|
36291
|
+
* @param {Boolean} opts.hasPeer Filter by queues associated with peer
|
|
36105
36292
|
*/
|
|
36106
36293
|
getRoutingQueues(opts) {
|
|
36107
36294
|
opts = opts || {};
|
|
@@ -36111,7 +36298,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36111
36298
|
'/api/v2/routing/queues',
|
|
36112
36299
|
'GET',
|
|
36113
36300
|
{ },
|
|
36114
|
-
{ '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') },
|
|
36301
|
+
{ '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'] },
|
|
36115
36302
|
{ },
|
|
36116
36303
|
{ },
|
|
36117
36304
|
null,
|
|
@@ -37911,7 +38098,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37911
38098
|
/**
|
|
37912
38099
|
* SCIM service.
|
|
37913
38100
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
37914
|
-
* @version
|
|
38101
|
+
* @version 142.0.0
|
|
37915
38102
|
*/
|
|
37916
38103
|
|
|
37917
38104
|
/**
|
|
@@ -38788,7 +38975,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38788
38975
|
/**
|
|
38789
38976
|
* Scripts service.
|
|
38790
38977
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
38791
|
-
* @version
|
|
38978
|
+
* @version 142.0.0
|
|
38792
38979
|
*/
|
|
38793
38980
|
|
|
38794
38981
|
/**
|
|
@@ -39207,7 +39394,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39207
39394
|
/**
|
|
39208
39395
|
* Search service.
|
|
39209
39396
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
39210
|
-
* @version
|
|
39397
|
+
* @version 142.0.0
|
|
39211
39398
|
*/
|
|
39212
39399
|
|
|
39213
39400
|
/**
|
|
@@ -39686,6 +39873,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39686
39873
|
);
|
|
39687
39874
|
}
|
|
39688
39875
|
|
|
39876
|
+
/**
|
|
39877
|
+
* Search resources.
|
|
39878
|
+
*
|
|
39879
|
+
* @param {Object} body Search request options
|
|
39880
|
+
*/
|
|
39881
|
+
postTeamsSearch(body) {
|
|
39882
|
+
// verify the required parameter 'body' is set
|
|
39883
|
+
if (body === undefined || body === null) {
|
|
39884
|
+
throw 'Missing the required parameter "body" when calling postTeamsSearch';
|
|
39885
|
+
}
|
|
39886
|
+
|
|
39887
|
+
return this.apiClient.callApi(
|
|
39888
|
+
'/api/v2/teams/search',
|
|
39889
|
+
'POST',
|
|
39890
|
+
{ },
|
|
39891
|
+
{ },
|
|
39892
|
+
{ },
|
|
39893
|
+
{ },
|
|
39894
|
+
body,
|
|
39895
|
+
['PureCloud OAuth'],
|
|
39896
|
+
['application/json'],
|
|
39897
|
+
['application/json']
|
|
39898
|
+
);
|
|
39899
|
+
}
|
|
39900
|
+
|
|
39689
39901
|
/**
|
|
39690
39902
|
* Search users
|
|
39691
39903
|
*
|
|
@@ -39742,7 +39954,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39742
39954
|
/**
|
|
39743
39955
|
* SpeechTextAnalytics service.
|
|
39744
39956
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
39745
|
-
* @version
|
|
39957
|
+
* @version 142.0.0
|
|
39746
39958
|
*/
|
|
39747
39959
|
|
|
39748
39960
|
/**
|
|
@@ -39967,6 +40179,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39967
40179
|
* @param {Object} opts Optional parameters
|
|
39968
40180
|
* @param {String} opts.nextPage The key for listing the next page
|
|
39969
40181
|
* @param {Number} opts.pageSize The page size for the listing (default to 20)
|
|
40182
|
+
* @param {Object} opts.state Program state. Defaults to Latest
|
|
39970
40183
|
*/
|
|
39971
40184
|
getSpeechandtextanalyticsPrograms(opts) {
|
|
39972
40185
|
opts = opts || {};
|
|
@@ -39976,7 +40189,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39976
40189
|
'/api/v2/speechandtextanalytics/programs',
|
|
39977
40190
|
'GET',
|
|
39978
40191
|
{ },
|
|
39979
|
-
{ 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'] },
|
|
40192
|
+
{ 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'],'state': opts['state'] },
|
|
39980
40193
|
{ },
|
|
39981
40194
|
{ },
|
|
39982
40195
|
null,
|
|
@@ -40595,7 +40808,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40595
40808
|
/**
|
|
40596
40809
|
* Stations service.
|
|
40597
40810
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
40598
|
-
* @version
|
|
40811
|
+
* @version 142.0.0
|
|
40599
40812
|
*/
|
|
40600
40813
|
|
|
40601
40814
|
/**
|
|
@@ -40742,7 +40955,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40742
40955
|
/**
|
|
40743
40956
|
* Suggest service.
|
|
40744
40957
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
40745
|
-
* @version
|
|
40958
|
+
* @version 142.0.0
|
|
40746
40959
|
*/
|
|
40747
40960
|
|
|
40748
40961
|
/**
|
|
@@ -40877,11 +41090,190 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40877
41090
|
|
|
40878
41091
|
}
|
|
40879
41092
|
|
|
41093
|
+
class TeamsApi {
|
|
41094
|
+
/**
|
|
41095
|
+
* Teams service.
|
|
41096
|
+
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
41097
|
+
* @version 142.0.0
|
|
41098
|
+
*/
|
|
41099
|
+
|
|
41100
|
+
/**
|
|
41101
|
+
* Constructs a new TeamsApi.
|
|
41102
|
+
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
41103
|
+
* @class
|
|
41104
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
41105
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
41106
|
+
*/
|
|
41107
|
+
constructor(apiClient) {
|
|
41108
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
41109
|
+
}
|
|
41110
|
+
|
|
41111
|
+
|
|
41112
|
+
/**
|
|
41113
|
+
* Delete team
|
|
41114
|
+
*
|
|
41115
|
+
* @param {String} teamId Team ID
|
|
41116
|
+
*/
|
|
41117
|
+
deleteTeam(teamId) {
|
|
41118
|
+
// verify the required parameter 'teamId' is set
|
|
41119
|
+
if (teamId === undefined || teamId === null) {
|
|
41120
|
+
throw 'Missing the required parameter "teamId" when calling deleteTeam';
|
|
41121
|
+
}
|
|
41122
|
+
|
|
41123
|
+
return this.apiClient.callApi(
|
|
41124
|
+
'/api/v2/teams/{teamId}',
|
|
41125
|
+
'DELETE',
|
|
41126
|
+
{ 'teamId': teamId },
|
|
41127
|
+
{ },
|
|
41128
|
+
{ },
|
|
41129
|
+
{ },
|
|
41130
|
+
null,
|
|
41131
|
+
['PureCloud OAuth'],
|
|
41132
|
+
['application/json'],
|
|
41133
|
+
['application/json']
|
|
41134
|
+
);
|
|
41135
|
+
}
|
|
41136
|
+
|
|
41137
|
+
/**
|
|
41138
|
+
* Get team
|
|
41139
|
+
*
|
|
41140
|
+
* @param {String} teamId Team ID
|
|
41141
|
+
*/
|
|
41142
|
+
getTeam(teamId) {
|
|
41143
|
+
// verify the required parameter 'teamId' is set
|
|
41144
|
+
if (teamId === undefined || teamId === null) {
|
|
41145
|
+
throw 'Missing the required parameter "teamId" when calling getTeam';
|
|
41146
|
+
}
|
|
41147
|
+
|
|
41148
|
+
return this.apiClient.callApi(
|
|
41149
|
+
'/api/v2/teams/{teamId}',
|
|
41150
|
+
'GET',
|
|
41151
|
+
{ 'teamId': teamId },
|
|
41152
|
+
{ },
|
|
41153
|
+
{ },
|
|
41154
|
+
{ },
|
|
41155
|
+
null,
|
|
41156
|
+
['PureCloud OAuth'],
|
|
41157
|
+
['application/json'],
|
|
41158
|
+
['application/json']
|
|
41159
|
+
);
|
|
41160
|
+
}
|
|
41161
|
+
|
|
41162
|
+
/**
|
|
41163
|
+
* Get Team listing
|
|
41164
|
+
*
|
|
41165
|
+
* @param {Object} opts Optional parameters
|
|
41166
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
41167
|
+
* @param {String} opts.name Return only teams whose names start with this value (case-insensitive matching)
|
|
41168
|
+
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
41169
|
+
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
41170
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
41171
|
+
*/
|
|
41172
|
+
getTeams(opts) {
|
|
41173
|
+
opts = opts || {};
|
|
41174
|
+
|
|
41175
|
+
|
|
41176
|
+
return this.apiClient.callApi(
|
|
41177
|
+
'/api/v2/teams',
|
|
41178
|
+
'GET',
|
|
41179
|
+
{ },
|
|
41180
|
+
{ 'pageSize': opts['pageSize'],'name': opts['name'],'after': opts['after'],'before': opts['before'],'expand': opts['expand'] },
|
|
41181
|
+
{ },
|
|
41182
|
+
{ },
|
|
41183
|
+
null,
|
|
41184
|
+
['PureCloud OAuth'],
|
|
41185
|
+
['application/json'],
|
|
41186
|
+
['application/json']
|
|
41187
|
+
);
|
|
41188
|
+
}
|
|
41189
|
+
|
|
41190
|
+
/**
|
|
41191
|
+
* Update team
|
|
41192
|
+
*
|
|
41193
|
+
* @param {String} teamId Team ID
|
|
41194
|
+
* @param {Object} body Team
|
|
41195
|
+
*/
|
|
41196
|
+
patchTeam(teamId, body) {
|
|
41197
|
+
// verify the required parameter 'teamId' is set
|
|
41198
|
+
if (teamId === undefined || teamId === null) {
|
|
41199
|
+
throw 'Missing the required parameter "teamId" when calling patchTeam';
|
|
41200
|
+
}
|
|
41201
|
+
// verify the required parameter 'body' is set
|
|
41202
|
+
if (body === undefined || body === null) {
|
|
41203
|
+
throw 'Missing the required parameter "body" when calling patchTeam';
|
|
41204
|
+
}
|
|
41205
|
+
|
|
41206
|
+
return this.apiClient.callApi(
|
|
41207
|
+
'/api/v2/teams/{teamId}',
|
|
41208
|
+
'PATCH',
|
|
41209
|
+
{ 'teamId': teamId },
|
|
41210
|
+
{ },
|
|
41211
|
+
{ },
|
|
41212
|
+
{ },
|
|
41213
|
+
body,
|
|
41214
|
+
['PureCloud OAuth'],
|
|
41215
|
+
['application/json'],
|
|
41216
|
+
['application/json']
|
|
41217
|
+
);
|
|
41218
|
+
}
|
|
41219
|
+
|
|
41220
|
+
/**
|
|
41221
|
+
* Create a team
|
|
41222
|
+
*
|
|
41223
|
+
* @param {Object} body Team
|
|
41224
|
+
*/
|
|
41225
|
+
postTeams(body) {
|
|
41226
|
+
// verify the required parameter 'body' is set
|
|
41227
|
+
if (body === undefined || body === null) {
|
|
41228
|
+
throw 'Missing the required parameter "body" when calling postTeams';
|
|
41229
|
+
}
|
|
41230
|
+
|
|
41231
|
+
return this.apiClient.callApi(
|
|
41232
|
+
'/api/v2/teams',
|
|
41233
|
+
'POST',
|
|
41234
|
+
{ },
|
|
41235
|
+
{ },
|
|
41236
|
+
{ },
|
|
41237
|
+
{ },
|
|
41238
|
+
body,
|
|
41239
|
+
['PureCloud OAuth'],
|
|
41240
|
+
['application/json'],
|
|
41241
|
+
['application/json']
|
|
41242
|
+
);
|
|
41243
|
+
}
|
|
41244
|
+
|
|
41245
|
+
/**
|
|
41246
|
+
* Search resources.
|
|
41247
|
+
*
|
|
41248
|
+
* @param {Object} body Search request options
|
|
41249
|
+
*/
|
|
41250
|
+
postTeamsSearch(body) {
|
|
41251
|
+
// verify the required parameter 'body' is set
|
|
41252
|
+
if (body === undefined || body === null) {
|
|
41253
|
+
throw 'Missing the required parameter "body" when calling postTeamsSearch';
|
|
41254
|
+
}
|
|
41255
|
+
|
|
41256
|
+
return this.apiClient.callApi(
|
|
41257
|
+
'/api/v2/teams/search',
|
|
41258
|
+
'POST',
|
|
41259
|
+
{ },
|
|
41260
|
+
{ },
|
|
41261
|
+
{ },
|
|
41262
|
+
{ },
|
|
41263
|
+
body,
|
|
41264
|
+
['PureCloud OAuth'],
|
|
41265
|
+
['application/json'],
|
|
41266
|
+
['application/json']
|
|
41267
|
+
);
|
|
41268
|
+
}
|
|
41269
|
+
|
|
41270
|
+
}
|
|
41271
|
+
|
|
40880
41272
|
class TelephonyApi {
|
|
40881
41273
|
/**
|
|
40882
41274
|
* Telephony service.
|
|
40883
41275
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
40884
|
-
* @version
|
|
41276
|
+
* @version 142.0.0
|
|
40885
41277
|
*/
|
|
40886
41278
|
|
|
40887
41279
|
/**
|
|
@@ -40989,7 +41381,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40989
41381
|
/**
|
|
40990
41382
|
* TelephonyProvidersEdge service.
|
|
40991
41383
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
40992
|
-
* @version
|
|
41384
|
+
* @version 142.0.0
|
|
40993
41385
|
*/
|
|
40994
41386
|
|
|
40995
41387
|
/**
|
|
@@ -44622,7 +45014,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44622
45014
|
/**
|
|
44623
45015
|
* Textbots service.
|
|
44624
45016
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
44625
|
-
* @version
|
|
45017
|
+
* @version 142.0.0
|
|
44626
45018
|
*/
|
|
44627
45019
|
|
|
44628
45020
|
/**
|
|
@@ -44750,7 +45142,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44750
45142
|
/**
|
|
44751
45143
|
* Tokens service.
|
|
44752
45144
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
44753
|
-
* @version
|
|
45145
|
+
* @version 142.0.0
|
|
44754
45146
|
*/
|
|
44755
45147
|
|
|
44756
45148
|
/**
|
|
@@ -44856,7 +45248,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44856
45248
|
/**
|
|
44857
45249
|
* Uploads service.
|
|
44858
45250
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
44859
|
-
* @version
|
|
45251
|
+
* @version 142.0.0
|
|
44860
45252
|
*/
|
|
44861
45253
|
|
|
44862
45254
|
/**
|
|
@@ -45007,7 +45399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45007
45399
|
/**
|
|
45008
45400
|
* Usage service.
|
|
45009
45401
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
45010
|
-
* @version
|
|
45402
|
+
* @version 142.0.0
|
|
45011
45403
|
*/
|
|
45012
45404
|
|
|
45013
45405
|
/**
|
|
@@ -45078,7 +45470,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45078
45470
|
/**
|
|
45079
45471
|
* UserRecordings service.
|
|
45080
45472
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
45081
|
-
* @version
|
|
45473
|
+
* @version 142.0.0
|
|
45082
45474
|
*/
|
|
45083
45475
|
|
|
45084
45476
|
/**
|
|
@@ -45262,7 +45654,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45262
45654
|
/**
|
|
45263
45655
|
* Users service.
|
|
45264
45656
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
45265
|
-
* @version
|
|
45657
|
+
* @version 142.0.0
|
|
45266
45658
|
*/
|
|
45267
45659
|
|
|
45268
45660
|
/**
|
|
@@ -47564,7 +47956,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47564
47956
|
/**
|
|
47565
47957
|
* Utilities service.
|
|
47566
47958
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
47567
|
-
* @version
|
|
47959
|
+
* @version 142.0.0
|
|
47568
47960
|
*/
|
|
47569
47961
|
|
|
47570
47962
|
/**
|
|
@@ -47675,7 +48067,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47675
48067
|
/**
|
|
47676
48068
|
* Voicemail service.
|
|
47677
48069
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
47678
|
-
* @version
|
|
48070
|
+
* @version 142.0.0
|
|
47679
48071
|
*/
|
|
47680
48072
|
|
|
47681
48073
|
/**
|
|
@@ -48342,7 +48734,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48342
48734
|
/**
|
|
48343
48735
|
* WebChat service.
|
|
48344
48736
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
48345
|
-
* @version
|
|
48737
|
+
* @version 142.0.0
|
|
48346
48738
|
*/
|
|
48347
48739
|
|
|
48348
48740
|
/**
|
|
@@ -48886,7 +49278,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48886
49278
|
/**
|
|
48887
49279
|
* WebDeployments service.
|
|
48888
49280
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
48889
|
-
* @version
|
|
49281
|
+
* @version 142.0.0
|
|
48890
49282
|
*/
|
|
48891
49283
|
|
|
48892
49284
|
/**
|
|
@@ -49241,7 +49633,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49241
49633
|
/**
|
|
49242
49634
|
* WebMessaging service.
|
|
49243
49635
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
49244
|
-
* @version
|
|
49636
|
+
* @version 142.0.0
|
|
49245
49637
|
*/
|
|
49246
49638
|
|
|
49247
49639
|
/**
|
|
@@ -49287,7 +49679,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49287
49679
|
/**
|
|
49288
49680
|
* Widgets service.
|
|
49289
49681
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
49290
|
-
* @version
|
|
49682
|
+
* @version 142.0.0
|
|
49291
49683
|
*/
|
|
49292
49684
|
|
|
49293
49685
|
/**
|
|
@@ -49433,7 +49825,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49433
49825
|
/**
|
|
49434
49826
|
* WorkforceManagement service.
|
|
49435
49827
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
49436
|
-
* @version
|
|
49828
|
+
* @version 142.0.0
|
|
49437
49829
|
*/
|
|
49438
49830
|
|
|
49439
49831
|
/**
|
|
@@ -49853,6 +50245,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49853
50245
|
);
|
|
49854
50246
|
}
|
|
49855
50247
|
|
|
50248
|
+
/**
|
|
50249
|
+
* Query the status of a historical adherence request operation. Only the user who started the operation can query the status
|
|
50250
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
50251
|
+
* @param {String} jobId jobId
|
|
50252
|
+
*/
|
|
50253
|
+
getWorkforcemanagementAdherenceHistoricalJob(jobId) {
|
|
50254
|
+
// verify the required parameter 'jobId' is set
|
|
50255
|
+
if (jobId === undefined || jobId === null) {
|
|
50256
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceHistoricalJob';
|
|
50257
|
+
}
|
|
50258
|
+
|
|
50259
|
+
return this.apiClient.callApi(
|
|
50260
|
+
'/api/v2/workforcemanagement/adherence/historical/jobs/{jobId}',
|
|
50261
|
+
'GET',
|
|
50262
|
+
{ 'jobId': jobId },
|
|
50263
|
+
{ },
|
|
50264
|
+
{ },
|
|
50265
|
+
{ },
|
|
50266
|
+
null,
|
|
50267
|
+
['PureCloud OAuth'],
|
|
50268
|
+
['application/json'],
|
|
50269
|
+
['application/json']
|
|
50270
|
+
);
|
|
50271
|
+
}
|
|
50272
|
+
|
|
49856
50273
|
/**
|
|
49857
50274
|
* Get status of the modeling job
|
|
49858
50275
|
*
|
|
@@ -53684,7 +54101,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53684
54101
|
* </pre>
|
|
53685
54102
|
* </p>
|
|
53686
54103
|
* @module purecloud-platform-client-v2/index
|
|
53687
|
-
* @version
|
|
54104
|
+
* @version 142.0.0
|
|
53688
54105
|
*/
|
|
53689
54106
|
class platformClient {
|
|
53690
54107
|
constructor() {
|
|
@@ -53933,6 +54350,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53933
54350
|
* @property {module:purecloud-platform-client-v2/api/SuggestApi}
|
|
53934
54351
|
*/
|
|
53935
54352
|
this.SuggestApi = SuggestApi;
|
|
54353
|
+
/**
|
|
54354
|
+
* The TeamsApi service constructor.
|
|
54355
|
+
* @property {module:purecloud-platform-client-v2/api/TeamsApi}
|
|
54356
|
+
*/
|
|
54357
|
+
this.TeamsApi = TeamsApi;
|
|
53936
54358
|
/**
|
|
53937
54359
|
* The TelephonyApi service constructor.
|
|
53938
54360
|
* @property {module:purecloud-platform-client-v2/api/TelephonyApi}
|