purecloud-platform-client-v2 249.0.0 → 250.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 +34 -3
- package/dist/node/purecloud-platform-client-v2.js +20042 -5569
- package/dist/web-amd/purecloud-platform-client-v2.js +20042 -5569
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +11159 -5369
- package/dist/web-cjs/purecloud-platform-client-v2.js +11159 -5369
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +10600 -2242
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +26 -2
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +136 -40
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +130 -39
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +18 -6
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +29 -9
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +86 -26
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +917 -224
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +754 -226
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +36 -11
- package/src/purecloud-platform-client-v2/api/AuditApi.js +38 -12
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +302 -91
- package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/BillingApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +180 -53
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +11 -4
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +187 -56
- package/src/purecloud-platform-client-v2/api/ChatApi.js +223 -65
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +124 -37
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +165 -51
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1992 -578
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +22 -7
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +39 -12
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +28 -9
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +35 -11
- package/src/purecloud-platform-client-v2/api/EventsApi.js +22 -7
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +700 -206
- package/src/purecloud-platform-client-v2/api/FaxApi.js +49 -15
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +42 -13
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +419 -125
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +21 -7
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +29 -9
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +106 -32
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +103 -31
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +267 -77
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +20 -7
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +461 -139
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +93 -28
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +872 -120
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +618 -185
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +221 -66
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +53 -16
- package/src/purecloud-platform-client-v2/api/LearningApi.js +199 -60
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +51 -16
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +45 -14
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +34 -11
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +84 -25
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +28 -9
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +72 -22
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +58 -18
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +21 -7
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +122 -36
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +297 -87
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1066 -312
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +162 -48
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/QualityApi.js +409 -121
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +351 -108
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +113 -34
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +964 -284
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +123 -39
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +50 -17
- package/src/purecloud-platform-client-v2/api/SearchApi.js +147 -44
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +87 -26
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +208 -67
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +389 -114
- package/src/purecloud-platform-client-v2/api/StationsApi.js +18 -6
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +13 -5
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +473 -138
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +55 -17
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +80 -24
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +751 -220
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/TokensApi.js +35 -11
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +78 -23
- package/src/purecloud-platform-client-v2/api/UsageApi.js +62 -19
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +27 -9
- package/src/purecloud-platform-client-v2/api/UsersApi.js +717 -228
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +52 -16
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +154 -46
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +126 -37
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +120 -36
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +36 -11
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +2475 -577
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class GamificationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Gamification service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 250.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,8 +24,12 @@ class GamificationApi {
|
|
|
24
24
|
* Delete an External Metric Definition
|
|
25
25
|
*
|
|
26
26
|
* @param {String} metricId Specifies the External Metric Definition ID
|
|
27
|
+
* @param {Object} opts Optional parameters
|
|
28
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27
29
|
*/
|
|
28
|
-
deleteEmployeeperformanceExternalmetricsDefinition(metricId) {
|
|
30
|
+
deleteEmployeeperformanceExternalmetricsDefinition(metricId, opts) {
|
|
31
|
+
opts = opts || {};
|
|
32
|
+
|
|
29
33
|
// verify the required parameter 'metricId' is set
|
|
30
34
|
if (metricId === undefined || metricId === null || metricId === '') {
|
|
31
35
|
throw 'Missing the required parameter "metricId" when calling deleteEmployeeperformanceExternalmetricsDefinition';
|
|
@@ -41,7 +45,8 @@ class GamificationApi {
|
|
|
41
45
|
null,
|
|
42
46
|
['PureCloud OAuth'],
|
|
43
47
|
['application/json'],
|
|
44
|
-
['application/json']
|
|
48
|
+
['application/json'],
|
|
49
|
+
opts['customHeaders']
|
|
45
50
|
);
|
|
46
51
|
}
|
|
47
52
|
|
|
@@ -49,8 +54,12 @@ class GamificationApi {
|
|
|
49
54
|
* Delete a Contest by Id
|
|
50
55
|
*
|
|
51
56
|
* @param {String} contestId The ID of the contest
|
|
57
|
+
* @param {Object} opts Optional parameters
|
|
58
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
52
59
|
*/
|
|
53
|
-
deleteGamificationContest(contestId) {
|
|
60
|
+
deleteGamificationContest(contestId, opts) {
|
|
61
|
+
opts = opts || {};
|
|
62
|
+
|
|
54
63
|
// verify the required parameter 'contestId' is set
|
|
55
64
|
if (contestId === undefined || contestId === null || contestId === '') {
|
|
56
65
|
throw 'Missing the required parameter "contestId" when calling deleteGamificationContest';
|
|
@@ -66,7 +75,8 @@ class GamificationApi {
|
|
|
66
75
|
null,
|
|
67
76
|
['PureCloud OAuth'],
|
|
68
77
|
['application/json'],
|
|
69
|
-
['application/json']
|
|
78
|
+
['application/json'],
|
|
79
|
+
opts['customHeaders']
|
|
70
80
|
);
|
|
71
81
|
}
|
|
72
82
|
|
|
@@ -74,8 +84,12 @@ class GamificationApi {
|
|
|
74
84
|
* Get an External Metric Definition
|
|
75
85
|
*
|
|
76
86
|
* @param {String} metricId Specifies the External Metric Definition ID
|
|
87
|
+
* @param {Object} opts Optional parameters
|
|
88
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
77
89
|
*/
|
|
78
|
-
getEmployeeperformanceExternalmetricsDefinition(metricId) {
|
|
90
|
+
getEmployeeperformanceExternalmetricsDefinition(metricId, opts) {
|
|
91
|
+
opts = opts || {};
|
|
92
|
+
|
|
79
93
|
// verify the required parameter 'metricId' is set
|
|
80
94
|
if (metricId === undefined || metricId === null || metricId === '') {
|
|
81
95
|
throw 'Missing the required parameter "metricId" when calling getEmployeeperformanceExternalmetricsDefinition';
|
|
@@ -91,7 +105,8 @@ class GamificationApi {
|
|
|
91
105
|
null,
|
|
92
106
|
['PureCloud OAuth'],
|
|
93
107
|
['application/json'],
|
|
94
|
-
['application/json']
|
|
108
|
+
['application/json'],
|
|
109
|
+
opts['customHeaders']
|
|
95
110
|
);
|
|
96
111
|
}
|
|
97
112
|
|
|
@@ -101,6 +116,7 @@ class GamificationApi {
|
|
|
101
116
|
* @param {Object} opts Optional parameters
|
|
102
117
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
103
118
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
119
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
104
120
|
*/
|
|
105
121
|
getEmployeeperformanceExternalmetricsDefinitions(opts) {
|
|
106
122
|
opts = opts || {};
|
|
@@ -116,7 +132,8 @@ class GamificationApi {
|
|
|
116
132
|
null,
|
|
117
133
|
['PureCloud OAuth'],
|
|
118
134
|
['application/json'],
|
|
119
|
-
['application/json']
|
|
135
|
+
['application/json'],
|
|
136
|
+
opts['customHeaders']
|
|
120
137
|
);
|
|
121
138
|
}
|
|
122
139
|
|
|
@@ -124,8 +141,12 @@ class GamificationApi {
|
|
|
124
141
|
* Get a Contest by Id
|
|
125
142
|
*
|
|
126
143
|
* @param {String} contestId The ID of the contest
|
|
144
|
+
* @param {Object} opts Optional parameters
|
|
145
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
127
146
|
*/
|
|
128
|
-
getGamificationContest(contestId) {
|
|
147
|
+
getGamificationContest(contestId, opts) {
|
|
148
|
+
opts = opts || {};
|
|
149
|
+
|
|
129
150
|
// verify the required parameter 'contestId' is set
|
|
130
151
|
if (contestId === undefined || contestId === null || contestId === '') {
|
|
131
152
|
throw 'Missing the required parameter "contestId" when calling getGamificationContest';
|
|
@@ -141,7 +162,8 @@ class GamificationApi {
|
|
|
141
162
|
null,
|
|
142
163
|
['PureCloud OAuth'],
|
|
143
164
|
['application/json'],
|
|
144
|
-
['application/json']
|
|
165
|
+
['application/json'],
|
|
166
|
+
opts['customHeaders']
|
|
145
167
|
);
|
|
146
168
|
}
|
|
147
169
|
|
|
@@ -154,6 +176,7 @@ class GamificationApi {
|
|
|
154
176
|
* @param {Number} opts.pageSize (default to 25)
|
|
155
177
|
* @param {String} opts.workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
156
178
|
* @param {Object} opts.returnsView Desired response results (default to All)
|
|
179
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
157
180
|
*/
|
|
158
181
|
getGamificationContestAgentsScores(contestId, opts) {
|
|
159
182
|
opts = opts || {};
|
|
@@ -173,7 +196,8 @@ class GamificationApi {
|
|
|
173
196
|
null,
|
|
174
197
|
['PureCloud OAuth'],
|
|
175
198
|
['application/json'],
|
|
176
|
-
['application/json']
|
|
199
|
+
['application/json'],
|
|
200
|
+
opts['customHeaders']
|
|
177
201
|
);
|
|
178
202
|
}
|
|
179
203
|
|
|
@@ -186,6 +210,7 @@ class GamificationApi {
|
|
|
186
210
|
* @param {Number} opts.pageSize (default to 25)
|
|
187
211
|
* @param {String} opts.workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
188
212
|
* @param {Object} opts.returnsView Desired response results (Supervisor Only) (default to All)
|
|
213
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
189
214
|
*/
|
|
190
215
|
getGamificationContestAgentsScoresMe(contestId, opts) {
|
|
191
216
|
opts = opts || {};
|
|
@@ -205,7 +230,8 @@ class GamificationApi {
|
|
|
205
230
|
null,
|
|
206
231
|
['PureCloud OAuth'],
|
|
207
232
|
['application/json'],
|
|
208
|
-
['application/json']
|
|
233
|
+
['application/json'],
|
|
234
|
+
opts['customHeaders']
|
|
209
235
|
);
|
|
210
236
|
}
|
|
211
237
|
|
|
@@ -213,8 +239,12 @@ class GamificationApi {
|
|
|
213
239
|
* Get a Contest Score Trend (Average Trend)
|
|
214
240
|
*
|
|
215
241
|
* @param {String} contestId The ID of the contest
|
|
242
|
+
* @param {Object} opts Optional parameters
|
|
243
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
216
244
|
*/
|
|
217
|
-
getGamificationContestAgentsScoresTrends(contestId) {
|
|
245
|
+
getGamificationContestAgentsScoresTrends(contestId, opts) {
|
|
246
|
+
opts = opts || {};
|
|
247
|
+
|
|
218
248
|
// verify the required parameter 'contestId' is set
|
|
219
249
|
if (contestId === undefined || contestId === null || contestId === '') {
|
|
220
250
|
throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresTrends';
|
|
@@ -230,7 +260,8 @@ class GamificationApi {
|
|
|
230
260
|
null,
|
|
231
261
|
['PureCloud OAuth'],
|
|
232
262
|
['application/json'],
|
|
233
|
-
['application/json']
|
|
263
|
+
['application/json'],
|
|
264
|
+
opts['customHeaders']
|
|
234
265
|
);
|
|
235
266
|
}
|
|
236
267
|
|
|
@@ -238,8 +269,12 @@ class GamificationApi {
|
|
|
238
269
|
* Get a Contest Score Trend for the requesting Agent
|
|
239
270
|
*
|
|
240
271
|
* @param {String} contestId The ID of the contest
|
|
272
|
+
* @param {Object} opts Optional parameters
|
|
273
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
241
274
|
*/
|
|
242
|
-
getGamificationContestAgentsScoresTrendsMe(contestId) {
|
|
275
|
+
getGamificationContestAgentsScoresTrendsMe(contestId, opts) {
|
|
276
|
+
opts = opts || {};
|
|
277
|
+
|
|
243
278
|
// verify the required parameter 'contestId' is set
|
|
244
279
|
if (contestId === undefined || contestId === null || contestId === '') {
|
|
245
280
|
throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresTrendsMe';
|
|
@@ -255,7 +290,8 @@ class GamificationApi {
|
|
|
255
290
|
null,
|
|
256
291
|
['PureCloud OAuth'],
|
|
257
292
|
['application/json'],
|
|
258
|
-
['application/json']
|
|
293
|
+
['application/json'],
|
|
294
|
+
opts['customHeaders']
|
|
259
295
|
);
|
|
260
296
|
}
|
|
261
297
|
|
|
@@ -264,8 +300,12 @@ class GamificationApi {
|
|
|
264
300
|
*
|
|
265
301
|
* @param {String} contestId The ID of the contest
|
|
266
302
|
* @param {String} prizeImageId The ID of the prize image
|
|
303
|
+
* @param {Object} opts Optional parameters
|
|
304
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
267
305
|
*/
|
|
268
|
-
getGamificationContestPrizeimage(contestId, prizeImageId) {
|
|
306
|
+
getGamificationContestPrizeimage(contestId, prizeImageId, opts) {
|
|
307
|
+
opts = opts || {};
|
|
308
|
+
|
|
269
309
|
// verify the required parameter 'contestId' is set
|
|
270
310
|
if (contestId === undefined || contestId === null || contestId === '') {
|
|
271
311
|
throw 'Missing the required parameter "contestId" when calling getGamificationContestPrizeimage';
|
|
@@ -285,7 +325,8 @@ class GamificationApi {
|
|
|
285
325
|
null,
|
|
286
326
|
['PureCloud OAuth'],
|
|
287
327
|
['application/json'],
|
|
288
|
-
['application/json']
|
|
328
|
+
['application/json'],
|
|
329
|
+
opts['customHeaders']
|
|
289
330
|
);
|
|
290
331
|
}
|
|
291
332
|
|
|
@@ -300,6 +341,7 @@ class GamificationApi {
|
|
|
300
341
|
* @param {Array.<String>} opts.status
|
|
301
342
|
* @param {Object} opts.sortBy (default to dateStart)
|
|
302
343
|
* @param {Object} opts.sortOrder (default to desc)
|
|
344
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
303
345
|
*/
|
|
304
346
|
getGamificationContests(opts) {
|
|
305
347
|
opts = opts || {};
|
|
@@ -315,7 +357,8 @@ class GamificationApi {
|
|
|
315
357
|
null,
|
|
316
358
|
['PureCloud OAuth'],
|
|
317
359
|
['application/json'],
|
|
318
|
-
['application/json']
|
|
360
|
+
['application/json'],
|
|
361
|
+
opts['customHeaders']
|
|
319
362
|
);
|
|
320
363
|
}
|
|
321
364
|
|
|
@@ -331,6 +374,7 @@ class GamificationApi {
|
|
|
331
374
|
* @param {Object} opts.sortBy (default to dateStart)
|
|
332
375
|
* @param {Object} opts.sortOrder (default to desc)
|
|
333
376
|
* @param {Object} opts.view (default to participant)
|
|
377
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
334
378
|
*/
|
|
335
379
|
getGamificationContestsMe(opts) {
|
|
336
380
|
opts = opts || {};
|
|
@@ -346,7 +390,8 @@ class GamificationApi {
|
|
|
346
390
|
null,
|
|
347
391
|
['PureCloud OAuth'],
|
|
348
392
|
['application/json'],
|
|
349
|
-
['application/json']
|
|
393
|
+
['application/json'],
|
|
394
|
+
opts['customHeaders']
|
|
350
395
|
);
|
|
351
396
|
}
|
|
352
397
|
|
|
@@ -366,6 +411,7 @@ class GamificationApi {
|
|
|
366
411
|
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
367
412
|
* @param {String} opts.userIds A list of up to 100 comma-separated user Ids
|
|
368
413
|
* @param {String} opts.reportsTo The reportsTo used by ABAC policies.
|
|
414
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
369
415
|
*/
|
|
370
416
|
getGamificationInsights(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, opts) {
|
|
371
417
|
opts = opts || {};
|
|
@@ -401,7 +447,8 @@ class GamificationApi {
|
|
|
401
447
|
null,
|
|
402
448
|
['PureCloud OAuth'],
|
|
403
449
|
['application/json'],
|
|
404
|
-
['application/json']
|
|
450
|
+
['application/json'],
|
|
451
|
+
opts['customHeaders']
|
|
405
452
|
);
|
|
406
453
|
}
|
|
407
454
|
|
|
@@ -413,8 +460,12 @@ class GamificationApi {
|
|
|
413
460
|
* @param {Object} granularity Granularity
|
|
414
461
|
* @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
415
462
|
* @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
463
|
+
* @param {Object} opts Optional parameters
|
|
464
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
416
465
|
*/
|
|
417
|
-
getGamificationInsightsDetails(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday) {
|
|
466
|
+
getGamificationInsightsDetails(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, opts) {
|
|
467
|
+
opts = opts || {};
|
|
468
|
+
|
|
418
469
|
// verify the required parameter 'filterType' is set
|
|
419
470
|
if (filterType === undefined || filterType === null) {
|
|
420
471
|
throw 'Missing the required parameter "filterType" when calling getGamificationInsightsDetails';
|
|
@@ -446,7 +497,8 @@ class GamificationApi {
|
|
|
446
497
|
null,
|
|
447
498
|
['PureCloud OAuth'],
|
|
448
499
|
['application/json'],
|
|
449
|
-
['application/json']
|
|
500
|
+
['application/json'],
|
|
501
|
+
opts['customHeaders']
|
|
450
502
|
);
|
|
451
503
|
}
|
|
452
504
|
|
|
@@ -460,8 +512,12 @@ class GamificationApi {
|
|
|
460
512
|
* @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
461
513
|
* @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
462
514
|
* @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
515
|
+
* @param {Object} opts Optional parameters
|
|
516
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
463
517
|
*/
|
|
464
|
-
getGamificationInsightsGroupsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
|
|
518
|
+
getGamificationInsightsGroupsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday, opts) {
|
|
519
|
+
opts = opts || {};
|
|
520
|
+
|
|
465
521
|
// verify the required parameter 'filterType' is set
|
|
466
522
|
if (filterType === undefined || filterType === null) {
|
|
467
523
|
throw 'Missing the required parameter "filterType" when calling getGamificationInsightsGroupsTrends';
|
|
@@ -501,7 +557,8 @@ class GamificationApi {
|
|
|
501
557
|
null,
|
|
502
558
|
['PureCloud OAuth'],
|
|
503
559
|
['application/json'],
|
|
504
|
-
['application/json']
|
|
560
|
+
['application/json'],
|
|
561
|
+
opts['customHeaders']
|
|
505
562
|
);
|
|
506
563
|
}
|
|
507
564
|
|
|
@@ -515,8 +572,12 @@ class GamificationApi {
|
|
|
515
572
|
* @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
516
573
|
* @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
517
574
|
* @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
575
|
+
* @param {Object} opts Optional parameters
|
|
576
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
518
577
|
*/
|
|
519
|
-
getGamificationInsightsGroupsTrendsAll(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
|
|
578
|
+
getGamificationInsightsGroupsTrendsAll(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday, opts) {
|
|
579
|
+
opts = opts || {};
|
|
580
|
+
|
|
520
581
|
// verify the required parameter 'filterType' is set
|
|
521
582
|
if (filterType === undefined || filterType === null) {
|
|
522
583
|
throw 'Missing the required parameter "filterType" when calling getGamificationInsightsGroupsTrendsAll';
|
|
@@ -556,7 +617,8 @@ class GamificationApi {
|
|
|
556
617
|
null,
|
|
557
618
|
['PureCloud OAuth'],
|
|
558
619
|
['application/json'],
|
|
559
|
-
['application/json']
|
|
620
|
+
['application/json'],
|
|
621
|
+
opts['customHeaders']
|
|
560
622
|
);
|
|
561
623
|
}
|
|
562
624
|
|
|
@@ -570,6 +632,7 @@ class GamificationApi {
|
|
|
570
632
|
* @param {Object} opts Optional parameters
|
|
571
633
|
* @param {Number} opts.pageSize Page size (default to 100)
|
|
572
634
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
635
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
573
636
|
*/
|
|
574
637
|
getGamificationInsightsManagers(filterType, filterId, granularity, startWorkday, opts) {
|
|
575
638
|
opts = opts || {};
|
|
@@ -601,7 +664,8 @@ class GamificationApi {
|
|
|
601
664
|
null,
|
|
602
665
|
['PureCloud OAuth'],
|
|
603
666
|
['application/json'],
|
|
604
|
-
['application/json']
|
|
667
|
+
['application/json'],
|
|
668
|
+
opts['customHeaders']
|
|
605
669
|
);
|
|
606
670
|
}
|
|
607
671
|
|
|
@@ -614,6 +678,7 @@ class GamificationApi {
|
|
|
614
678
|
* @param {String} startWorkday The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
615
679
|
* @param {Object} opts Optional parameters
|
|
616
680
|
* @param {String} opts.reportsTo The reportsTo used by ABAC policies.
|
|
681
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
617
682
|
*/
|
|
618
683
|
getGamificationInsightsMembers(filterType, filterId, granularity, startWorkday, opts) {
|
|
619
684
|
opts = opts || {};
|
|
@@ -645,7 +710,8 @@ class GamificationApi {
|
|
|
645
710
|
null,
|
|
646
711
|
['PureCloud OAuth'],
|
|
647
712
|
['application/json'],
|
|
648
|
-
['application/json']
|
|
713
|
+
['application/json'],
|
|
714
|
+
opts['customHeaders']
|
|
649
715
|
);
|
|
650
716
|
}
|
|
651
717
|
|
|
@@ -663,6 +729,7 @@ class GamificationApi {
|
|
|
663
729
|
* @param {Number} opts.sectionSize The number of top and bottom users to return before ties
|
|
664
730
|
* @param {String} opts.userIds A list of up to 100 comma-separated user Ids
|
|
665
731
|
* @param {String} opts.reportsTo The reportsTo used by ABAC policies.
|
|
732
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
666
733
|
*/
|
|
667
734
|
getGamificationInsightsRankings(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, sortKey, opts) {
|
|
668
735
|
opts = opts || {};
|
|
@@ -702,7 +769,8 @@ class GamificationApi {
|
|
|
702
769
|
null,
|
|
703
770
|
['PureCloud OAuth'],
|
|
704
771
|
['application/json'],
|
|
705
|
-
['application/json']
|
|
772
|
+
['application/json'],
|
|
773
|
+
opts['customHeaders']
|
|
706
774
|
);
|
|
707
775
|
}
|
|
708
776
|
|
|
@@ -716,8 +784,12 @@ class GamificationApi {
|
|
|
716
784
|
* @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
717
785
|
* @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
718
786
|
* @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
787
|
+
* @param {Object} opts Optional parameters
|
|
788
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
719
789
|
*/
|
|
720
|
-
getGamificationInsightsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
|
|
790
|
+
getGamificationInsightsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday, opts) {
|
|
791
|
+
opts = opts || {};
|
|
792
|
+
|
|
721
793
|
// verify the required parameter 'filterType' is set
|
|
722
794
|
if (filterType === undefined || filterType === null) {
|
|
723
795
|
throw 'Missing the required parameter "filterType" when calling getGamificationInsightsTrends';
|
|
@@ -757,7 +829,8 @@ class GamificationApi {
|
|
|
757
829
|
null,
|
|
758
830
|
['PureCloud OAuth'],
|
|
759
831
|
['application/json'],
|
|
760
|
-
['application/json']
|
|
832
|
+
['application/json'],
|
|
833
|
+
opts['customHeaders']
|
|
761
834
|
);
|
|
762
835
|
}
|
|
763
836
|
|
|
@@ -770,8 +843,12 @@ class GamificationApi {
|
|
|
770
843
|
* @param {Object} granularity Granularity
|
|
771
844
|
* @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
772
845
|
* @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
846
|
+
* @param {Object} opts Optional parameters
|
|
847
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
773
848
|
*/
|
|
774
|
-
getGamificationInsightsUserDetails(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday) {
|
|
849
|
+
getGamificationInsightsUserDetails(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, opts) {
|
|
850
|
+
opts = opts || {};
|
|
851
|
+
|
|
775
852
|
// verify the required parameter 'userId' is set
|
|
776
853
|
if (userId === undefined || userId === null || userId === '') {
|
|
777
854
|
throw 'Missing the required parameter "userId" when calling getGamificationInsightsUserDetails';
|
|
@@ -807,7 +884,8 @@ class GamificationApi {
|
|
|
807
884
|
null,
|
|
808
885
|
['PureCloud OAuth'],
|
|
809
886
|
['application/json'],
|
|
810
|
-
['application/json']
|
|
887
|
+
['application/json'],
|
|
888
|
+
opts['customHeaders']
|
|
811
889
|
);
|
|
812
890
|
}
|
|
813
891
|
|
|
@@ -822,8 +900,12 @@ class GamificationApi {
|
|
|
822
900
|
* @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
823
901
|
* @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
824
902
|
* @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
903
|
+
* @param {Object} opts Optional parameters
|
|
904
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
825
905
|
*/
|
|
826
|
-
getGamificationInsightsUserTrends(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
|
|
906
|
+
getGamificationInsightsUserTrends(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday, opts) {
|
|
907
|
+
opts = opts || {};
|
|
908
|
+
|
|
827
909
|
// verify the required parameter 'userId' is set
|
|
828
910
|
if (userId === undefined || userId === null || userId === '') {
|
|
829
911
|
throw 'Missing the required parameter "userId" when calling getGamificationInsightsUserTrends';
|
|
@@ -867,7 +949,8 @@ class GamificationApi {
|
|
|
867
949
|
null,
|
|
868
950
|
['PureCloud OAuth'],
|
|
869
951
|
['application/json'],
|
|
870
|
-
['application/json']
|
|
952
|
+
['application/json'],
|
|
953
|
+
opts['customHeaders']
|
|
871
954
|
);
|
|
872
955
|
}
|
|
873
956
|
|
|
@@ -878,6 +961,7 @@ class GamificationApi {
|
|
|
878
961
|
* @param {String} endWorkday End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
879
962
|
* @param {Object} opts Optional parameters
|
|
880
963
|
* @param {String} opts.metricId Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given.
|
|
964
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
881
965
|
*/
|
|
882
966
|
getGamificationLeaderboard(startWorkday, endWorkday, opts) {
|
|
883
967
|
opts = opts || {};
|
|
@@ -901,7 +985,8 @@ class GamificationApi {
|
|
|
901
985
|
null,
|
|
902
986
|
['PureCloud OAuth'],
|
|
903
987
|
['application/json'],
|
|
904
|
-
['application/json']
|
|
988
|
+
['application/json'],
|
|
989
|
+
opts['customHeaders']
|
|
905
990
|
);
|
|
906
991
|
}
|
|
907
992
|
|
|
@@ -914,6 +999,7 @@ class GamificationApi {
|
|
|
914
999
|
* @param {String} endWorkday End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
915
1000
|
* @param {Object} opts Optional parameters
|
|
916
1001
|
* @param {String} opts.metricId Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given.
|
|
1002
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
917
1003
|
*/
|
|
918
1004
|
getGamificationLeaderboardAll(filterType, filterId, startWorkday, endWorkday, opts) {
|
|
919
1005
|
opts = opts || {};
|
|
@@ -945,7 +1031,8 @@ class GamificationApi {
|
|
|
945
1031
|
null,
|
|
946
1032
|
['PureCloud OAuth'],
|
|
947
1033
|
['application/json'],
|
|
948
|
-
['application/json']
|
|
1034
|
+
['application/json'],
|
|
1035
|
+
opts['customHeaders']
|
|
949
1036
|
);
|
|
950
1037
|
}
|
|
951
1038
|
|
|
@@ -954,8 +1041,12 @@ class GamificationApi {
|
|
|
954
1041
|
*
|
|
955
1042
|
* @param {Object} filterType Filter type for the query request.
|
|
956
1043
|
* @param {String} filterId ID for the filter type. For example, division or performance profile Id
|
|
1044
|
+
* @param {Object} opts Optional parameters
|
|
1045
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
957
1046
|
*/
|
|
958
|
-
getGamificationLeaderboardAllBestpoints(filterType, filterId) {
|
|
1047
|
+
getGamificationLeaderboardAllBestpoints(filterType, filterId, opts) {
|
|
1048
|
+
opts = opts || {};
|
|
1049
|
+
|
|
959
1050
|
// verify the required parameter 'filterType' is set
|
|
960
1051
|
if (filterType === undefined || filterType === null) {
|
|
961
1052
|
throw 'Missing the required parameter "filterType" when calling getGamificationLeaderboardAllBestpoints';
|
|
@@ -975,15 +1066,20 @@ class GamificationApi {
|
|
|
975
1066
|
null,
|
|
976
1067
|
['PureCloud OAuth'],
|
|
977
1068
|
['application/json'],
|
|
978
|
-
['application/json']
|
|
1069
|
+
['application/json'],
|
|
1070
|
+
opts['customHeaders']
|
|
979
1071
|
);
|
|
980
1072
|
}
|
|
981
1073
|
|
|
982
1074
|
/**
|
|
983
1075
|
* Best Points of the requesting user's current performance profile or division
|
|
984
1076
|
*
|
|
1077
|
+
* @param {Object} opts Optional parameters
|
|
1078
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
985
1079
|
*/
|
|
986
|
-
getGamificationLeaderboardBestpoints() {
|
|
1080
|
+
getGamificationLeaderboardBestpoints(opts) {
|
|
1081
|
+
opts = opts || {};
|
|
1082
|
+
|
|
987
1083
|
|
|
988
1084
|
return this.apiClient.callApi(
|
|
989
1085
|
'/api/v2/gamification/leaderboard/bestpoints',
|
|
@@ -995,7 +1091,8 @@ class GamificationApi {
|
|
|
995
1091
|
null,
|
|
996
1092
|
['PureCloud OAuth'],
|
|
997
1093
|
['application/json'],
|
|
998
|
-
['application/json']
|
|
1094
|
+
['application/json'],
|
|
1095
|
+
opts['customHeaders']
|
|
999
1096
|
);
|
|
1000
1097
|
}
|
|
1001
1098
|
|
|
@@ -1003,8 +1100,12 @@ class GamificationApi {
|
|
|
1003
1100
|
* Metric definition by id
|
|
1004
1101
|
*
|
|
1005
1102
|
* @param {String} metricDefinitionId metric definition id
|
|
1103
|
+
* @param {Object} opts Optional parameters
|
|
1104
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1006
1105
|
*/
|
|
1007
|
-
getGamificationMetricdefinition(metricDefinitionId) {
|
|
1106
|
+
getGamificationMetricdefinition(metricDefinitionId, opts) {
|
|
1107
|
+
opts = opts || {};
|
|
1108
|
+
|
|
1008
1109
|
// verify the required parameter 'metricDefinitionId' is set
|
|
1009
1110
|
if (metricDefinitionId === undefined || metricDefinitionId === null || metricDefinitionId === '') {
|
|
1010
1111
|
throw 'Missing the required parameter "metricDefinitionId" when calling getGamificationMetricdefinition';
|
|
@@ -1020,15 +1121,20 @@ class GamificationApi {
|
|
|
1020
1121
|
null,
|
|
1021
1122
|
['PureCloud OAuth'],
|
|
1022
1123
|
['application/json'],
|
|
1023
|
-
['application/json']
|
|
1124
|
+
['application/json'],
|
|
1125
|
+
opts['customHeaders']
|
|
1024
1126
|
);
|
|
1025
1127
|
}
|
|
1026
1128
|
|
|
1027
1129
|
/**
|
|
1028
1130
|
* All metric definitions
|
|
1029
1131
|
* Retrieves the metric definitions and their corresponding default objectives used to create a gamified metric
|
|
1132
|
+
* @param {Object} opts Optional parameters
|
|
1133
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1030
1134
|
*/
|
|
1031
|
-
getGamificationMetricdefinitions() {
|
|
1135
|
+
getGamificationMetricdefinitions(opts) {
|
|
1136
|
+
opts = opts || {};
|
|
1137
|
+
|
|
1032
1138
|
|
|
1033
1139
|
return this.apiClient.callApi(
|
|
1034
1140
|
'/api/v2/gamification/metricdefinitions',
|
|
@@ -1040,7 +1146,8 @@ class GamificationApi {
|
|
|
1040
1146
|
null,
|
|
1041
1147
|
['PureCloud OAuth'],
|
|
1042
1148
|
['application/json'],
|
|
1043
|
-
['application/json']
|
|
1149
|
+
['application/json'],
|
|
1150
|
+
opts['customHeaders']
|
|
1044
1151
|
);
|
|
1045
1152
|
}
|
|
1046
1153
|
|
|
@@ -1048,8 +1155,12 @@ class GamificationApi {
|
|
|
1048
1155
|
* Performance profile by id
|
|
1049
1156
|
*
|
|
1050
1157
|
* @param {String} profileId performanceProfileId
|
|
1158
|
+
* @param {Object} opts Optional parameters
|
|
1159
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1051
1160
|
*/
|
|
1052
|
-
getGamificationProfile(profileId) {
|
|
1161
|
+
getGamificationProfile(profileId, opts) {
|
|
1162
|
+
opts = opts || {};
|
|
1163
|
+
|
|
1053
1164
|
// verify the required parameter 'profileId' is set
|
|
1054
1165
|
if (profileId === undefined || profileId === null || profileId === '') {
|
|
1055
1166
|
throw 'Missing the required parameter "profileId" when calling getGamificationProfile';
|
|
@@ -1065,7 +1176,8 @@ class GamificationApi {
|
|
|
1065
1176
|
null,
|
|
1066
1177
|
['PureCloud OAuth'],
|
|
1067
1178
|
['application/json'],
|
|
1068
|
-
['application/json']
|
|
1179
|
+
['application/json'],
|
|
1180
|
+
opts['customHeaders']
|
|
1069
1181
|
);
|
|
1070
1182
|
}
|
|
1071
1183
|
|
|
@@ -1073,8 +1185,12 @@ class GamificationApi {
|
|
|
1073
1185
|
* Members of a given performance profile
|
|
1074
1186
|
*
|
|
1075
1187
|
* @param {String} profileId Profile Id
|
|
1188
|
+
* @param {Object} opts Optional parameters
|
|
1189
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1076
1190
|
*/
|
|
1077
|
-
getGamificationProfileMembers(profileId) {
|
|
1191
|
+
getGamificationProfileMembers(profileId, opts) {
|
|
1192
|
+
opts = opts || {};
|
|
1193
|
+
|
|
1078
1194
|
// verify the required parameter 'profileId' is set
|
|
1079
1195
|
if (profileId === undefined || profileId === null || profileId === '') {
|
|
1080
1196
|
throw 'Missing the required parameter "profileId" when calling getGamificationProfileMembers';
|
|
@@ -1090,7 +1206,8 @@ class GamificationApi {
|
|
|
1090
1206
|
null,
|
|
1091
1207
|
['PureCloud OAuth'],
|
|
1092
1208
|
['application/json'],
|
|
1093
|
-
['application/json']
|
|
1209
|
+
['application/json'],
|
|
1210
|
+
opts['customHeaders']
|
|
1094
1211
|
);
|
|
1095
1212
|
}
|
|
1096
1213
|
|
|
@@ -1101,6 +1218,7 @@ class GamificationApi {
|
|
|
1101
1218
|
* @param {String} metricId Metric Id
|
|
1102
1219
|
* @param {Object} opts Optional parameters
|
|
1103
1220
|
* @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1221
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1104
1222
|
*/
|
|
1105
1223
|
getGamificationProfileMetric(profileId, metricId, opts) {
|
|
1106
1224
|
opts = opts || {};
|
|
@@ -1124,7 +1242,8 @@ class GamificationApi {
|
|
|
1124
1242
|
null,
|
|
1125
1243
|
['PureCloud OAuth'],
|
|
1126
1244
|
['application/json'],
|
|
1127
|
-
['application/json']
|
|
1245
|
+
['application/json'],
|
|
1246
|
+
opts['customHeaders']
|
|
1128
1247
|
);
|
|
1129
1248
|
}
|
|
1130
1249
|
|
|
@@ -1136,6 +1255,7 @@ class GamificationApi {
|
|
|
1136
1255
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
1137
1256
|
* @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1138
1257
|
* @param {String} opts.metricIds List of metric ids to filter the response (Optional, comma-separated).
|
|
1258
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1139
1259
|
*/
|
|
1140
1260
|
getGamificationProfileMetrics(profileId, opts) {
|
|
1141
1261
|
opts = opts || {};
|
|
@@ -1155,7 +1275,8 @@ class GamificationApi {
|
|
|
1155
1275
|
null,
|
|
1156
1276
|
['PureCloud OAuth'],
|
|
1157
1277
|
['application/json'],
|
|
1158
|
-
['application/json']
|
|
1278
|
+
['application/json'],
|
|
1279
|
+
opts['customHeaders']
|
|
1159
1280
|
);
|
|
1160
1281
|
}
|
|
1161
1282
|
|
|
@@ -1165,6 +1286,7 @@ class GamificationApi {
|
|
|
1165
1286
|
* @param {String} profileId Performance Profile Id
|
|
1166
1287
|
* @param {Object} opts Optional parameters
|
|
1167
1288
|
* @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1289
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1168
1290
|
*/
|
|
1169
1291
|
getGamificationProfileMetricsObjectivedetails(profileId, opts) {
|
|
1170
1292
|
opts = opts || {};
|
|
@@ -1184,15 +1306,20 @@ class GamificationApi {
|
|
|
1184
1306
|
null,
|
|
1185
1307
|
['PureCloud OAuth'],
|
|
1186
1308
|
['application/json'],
|
|
1187
|
-
['application/json']
|
|
1309
|
+
['application/json'],
|
|
1310
|
+
opts['customHeaders']
|
|
1188
1311
|
);
|
|
1189
1312
|
}
|
|
1190
1313
|
|
|
1191
1314
|
/**
|
|
1192
1315
|
* All performance profiles
|
|
1193
1316
|
*
|
|
1317
|
+
* @param {Object} opts Optional parameters
|
|
1318
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1194
1319
|
*/
|
|
1195
|
-
getGamificationProfiles() {
|
|
1320
|
+
getGamificationProfiles(opts) {
|
|
1321
|
+
opts = opts || {};
|
|
1322
|
+
|
|
1196
1323
|
|
|
1197
1324
|
return this.apiClient.callApi(
|
|
1198
1325
|
'/api/v2/gamification/profiles',
|
|
@@ -1204,7 +1331,8 @@ class GamificationApi {
|
|
|
1204
1331
|
null,
|
|
1205
1332
|
['PureCloud OAuth'],
|
|
1206
1333
|
['application/json'],
|
|
1207
|
-
['application/json']
|
|
1334
|
+
['application/json'],
|
|
1335
|
+
opts['customHeaders']
|
|
1208
1336
|
);
|
|
1209
1337
|
}
|
|
1210
1338
|
|
|
@@ -1214,6 +1342,7 @@ class GamificationApi {
|
|
|
1214
1342
|
* @param {String} userId
|
|
1215
1343
|
* @param {Object} opts Optional parameters
|
|
1216
1344
|
* @param {String} opts.workday Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1345
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1217
1346
|
*/
|
|
1218
1347
|
getGamificationProfilesUser(userId, opts) {
|
|
1219
1348
|
opts = opts || {};
|
|
@@ -1233,7 +1362,8 @@ class GamificationApi {
|
|
|
1233
1362
|
null,
|
|
1234
1363
|
['PureCloud OAuth'],
|
|
1235
1364
|
['application/json'],
|
|
1236
|
-
['application/json']
|
|
1365
|
+
['application/json'],
|
|
1366
|
+
opts['customHeaders']
|
|
1237
1367
|
);
|
|
1238
1368
|
}
|
|
1239
1369
|
|
|
@@ -1242,6 +1372,7 @@ class GamificationApi {
|
|
|
1242
1372
|
*
|
|
1243
1373
|
* @param {Object} opts Optional parameters
|
|
1244
1374
|
* @param {String} opts.workday Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1375
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1245
1376
|
*/
|
|
1246
1377
|
getGamificationProfilesUsersMe(opts) {
|
|
1247
1378
|
opts = opts || {};
|
|
@@ -1257,7 +1388,8 @@ class GamificationApi {
|
|
|
1257
1388
|
null,
|
|
1258
1389
|
['PureCloud OAuth'],
|
|
1259
1390
|
['application/json'],
|
|
1260
|
-
['application/json']
|
|
1391
|
+
['application/json'],
|
|
1392
|
+
opts['customHeaders']
|
|
1261
1393
|
);
|
|
1262
1394
|
}
|
|
1263
1395
|
|
|
@@ -1267,6 +1399,7 @@ class GamificationApi {
|
|
|
1267
1399
|
* @param {String} workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1268
1400
|
* @param {Object} opts Optional parameters
|
|
1269
1401
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
1402
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1270
1403
|
*/
|
|
1271
1404
|
getGamificationScorecards(workday, opts) {
|
|
1272
1405
|
opts = opts || {};
|
|
@@ -1286,7 +1419,8 @@ class GamificationApi {
|
|
|
1286
1419
|
null,
|
|
1287
1420
|
['PureCloud OAuth'],
|
|
1288
1421
|
['application/json'],
|
|
1289
|
-
['application/json']
|
|
1422
|
+
['application/json'],
|
|
1423
|
+
opts['customHeaders']
|
|
1290
1424
|
);
|
|
1291
1425
|
}
|
|
1292
1426
|
|
|
@@ -1295,8 +1429,12 @@ class GamificationApi {
|
|
|
1295
1429
|
*
|
|
1296
1430
|
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1297
1431
|
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1432
|
+
* @param {Object} opts Optional parameters
|
|
1433
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1298
1434
|
*/
|
|
1299
|
-
getGamificationScorecardsAttendance(startWorkday, endWorkday) {
|
|
1435
|
+
getGamificationScorecardsAttendance(startWorkday, endWorkday, opts) {
|
|
1436
|
+
opts = opts || {};
|
|
1437
|
+
|
|
1300
1438
|
// verify the required parameter 'startWorkday' is set
|
|
1301
1439
|
if (startWorkday === undefined || startWorkday === null) {
|
|
1302
1440
|
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsAttendance';
|
|
@@ -1316,15 +1454,20 @@ class GamificationApi {
|
|
|
1316
1454
|
null,
|
|
1317
1455
|
['PureCloud OAuth'],
|
|
1318
1456
|
['application/json'],
|
|
1319
|
-
['application/json']
|
|
1457
|
+
['application/json'],
|
|
1458
|
+
opts['customHeaders']
|
|
1320
1459
|
);
|
|
1321
1460
|
}
|
|
1322
1461
|
|
|
1323
1462
|
/**
|
|
1324
1463
|
* Best points of the requesting user
|
|
1325
1464
|
*
|
|
1465
|
+
* @param {Object} opts Optional parameters
|
|
1466
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1326
1467
|
*/
|
|
1327
|
-
getGamificationScorecardsBestpoints() {
|
|
1468
|
+
getGamificationScorecardsBestpoints(opts) {
|
|
1469
|
+
opts = opts || {};
|
|
1470
|
+
|
|
1328
1471
|
|
|
1329
1472
|
return this.apiClient.callApi(
|
|
1330
1473
|
'/api/v2/gamification/scorecards/bestpoints',
|
|
@@ -1336,7 +1479,8 @@ class GamificationApi {
|
|
|
1336
1479
|
null,
|
|
1337
1480
|
['PureCloud OAuth'],
|
|
1338
1481
|
['application/json'],
|
|
1339
|
-
['application/json']
|
|
1482
|
+
['application/json'],
|
|
1483
|
+
opts['customHeaders']
|
|
1340
1484
|
);
|
|
1341
1485
|
}
|
|
1342
1486
|
|
|
@@ -1344,8 +1488,12 @@ class GamificationApi {
|
|
|
1344
1488
|
* All-time points of the requesting user
|
|
1345
1489
|
*
|
|
1346
1490
|
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1491
|
+
* @param {Object} opts Optional parameters
|
|
1492
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1347
1493
|
*/
|
|
1348
|
-
getGamificationScorecardsPointsAlltime(endWorkday) {
|
|
1494
|
+
getGamificationScorecardsPointsAlltime(endWorkday, opts) {
|
|
1495
|
+
opts = opts || {};
|
|
1496
|
+
|
|
1349
1497
|
// verify the required parameter 'endWorkday' is set
|
|
1350
1498
|
if (endWorkday === undefined || endWorkday === null) {
|
|
1351
1499
|
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsPointsAlltime';
|
|
@@ -1361,7 +1509,8 @@ class GamificationApi {
|
|
|
1361
1509
|
null,
|
|
1362
1510
|
['PureCloud OAuth'],
|
|
1363
1511
|
['application/json'],
|
|
1364
|
-
['application/json']
|
|
1512
|
+
['application/json'],
|
|
1513
|
+
opts['customHeaders']
|
|
1365
1514
|
);
|
|
1366
1515
|
}
|
|
1367
1516
|
|
|
@@ -1369,8 +1518,12 @@ class GamificationApi {
|
|
|
1369
1518
|
* Average points of the requesting user's division or performance profile
|
|
1370
1519
|
*
|
|
1371
1520
|
* @param {String} workday The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1521
|
+
* @param {Object} opts Optional parameters
|
|
1522
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1372
1523
|
*/
|
|
1373
|
-
getGamificationScorecardsPointsAverage(workday) {
|
|
1524
|
+
getGamificationScorecardsPointsAverage(workday, opts) {
|
|
1525
|
+
opts = opts || {};
|
|
1526
|
+
|
|
1374
1527
|
// verify the required parameter 'workday' is set
|
|
1375
1528
|
if (workday === undefined || workday === null) {
|
|
1376
1529
|
throw 'Missing the required parameter "workday" when calling getGamificationScorecardsPointsAverage';
|
|
@@ -1386,7 +1539,8 @@ class GamificationApi {
|
|
|
1386
1539
|
null,
|
|
1387
1540
|
['PureCloud OAuth'],
|
|
1388
1541
|
['application/json'],
|
|
1389
|
-
['application/json']
|
|
1542
|
+
['application/json'],
|
|
1543
|
+
opts['customHeaders']
|
|
1390
1544
|
);
|
|
1391
1545
|
}
|
|
1392
1546
|
|
|
@@ -1397,6 +1551,7 @@ class GamificationApi {
|
|
|
1397
1551
|
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1398
1552
|
* @param {Object} opts Optional parameters
|
|
1399
1553
|
* @param {Object} opts.dayOfWeek Optional filter to specify which day of weeks to be included in the response
|
|
1554
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1400
1555
|
*/
|
|
1401
1556
|
getGamificationScorecardsPointsTrends(startWorkday, endWorkday, opts) {
|
|
1402
1557
|
opts = opts || {};
|
|
@@ -1420,7 +1575,8 @@ class GamificationApi {
|
|
|
1420
1575
|
null,
|
|
1421
1576
|
['PureCloud OAuth'],
|
|
1422
1577
|
['application/json'],
|
|
1423
|
-
['application/json']
|
|
1578
|
+
['application/json'],
|
|
1579
|
+
opts['customHeaders']
|
|
1424
1580
|
);
|
|
1425
1581
|
}
|
|
1426
1582
|
|
|
@@ -1435,6 +1591,7 @@ class GamificationApi {
|
|
|
1435
1591
|
* @param {Object} opts Optional parameters
|
|
1436
1592
|
* @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
|
|
1437
1593
|
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
1594
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1438
1595
|
*/
|
|
1439
1596
|
getGamificationScorecardsProfileMetricUserValuesTrends(profileId, metricId, userId, startWorkday, endWorkday, opts) {
|
|
1440
1597
|
opts = opts || {};
|
|
@@ -1470,7 +1627,8 @@ class GamificationApi {
|
|
|
1470
1627
|
null,
|
|
1471
1628
|
['PureCloud OAuth'],
|
|
1472
1629
|
['application/json'],
|
|
1473
|
-
['application/json']
|
|
1630
|
+
['application/json'],
|
|
1631
|
+
opts['customHeaders']
|
|
1474
1632
|
);
|
|
1475
1633
|
}
|
|
1476
1634
|
|
|
@@ -1486,6 +1644,7 @@ class GamificationApi {
|
|
|
1486
1644
|
* @param {String} opts.filterId ID for the filter type. Only required when filterType is Division.
|
|
1487
1645
|
* @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
|
|
1488
1646
|
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
1647
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1489
1648
|
*/
|
|
1490
1649
|
getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, startWorkday, endWorkday, opts) {
|
|
1491
1650
|
opts = opts || {};
|
|
@@ -1521,7 +1680,8 @@ class GamificationApi {
|
|
|
1521
1680
|
null,
|
|
1522
1681
|
['PureCloud OAuth'],
|
|
1523
1682
|
['application/json'],
|
|
1524
|
-
['application/json']
|
|
1683
|
+
['application/json'],
|
|
1684
|
+
opts['customHeaders']
|
|
1525
1685
|
);
|
|
1526
1686
|
}
|
|
1527
1687
|
|
|
@@ -1536,6 +1696,7 @@ class GamificationApi {
|
|
|
1536
1696
|
* @param {Object} opts.filterType Filter type for the query request. If not set, returns the values trends of the requesting user
|
|
1537
1697
|
* @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
|
|
1538
1698
|
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
1699
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1539
1700
|
*/
|
|
1540
1701
|
getGamificationScorecardsProfileMetricValuesTrends(profileId, metricId, startWorkday, endWorkday, opts) {
|
|
1541
1702
|
opts = opts || {};
|
|
@@ -1567,7 +1728,8 @@ class GamificationApi {
|
|
|
1567
1728
|
null,
|
|
1568
1729
|
['PureCloud OAuth'],
|
|
1569
1730
|
['application/json'],
|
|
1570
|
-
['application/json']
|
|
1731
|
+
['application/json'],
|
|
1732
|
+
opts['customHeaders']
|
|
1571
1733
|
);
|
|
1572
1734
|
}
|
|
1573
1735
|
|
|
@@ -1578,6 +1740,7 @@ class GamificationApi {
|
|
|
1578
1740
|
* @param {String} workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1579
1741
|
* @param {Object} opts Optional parameters
|
|
1580
1742
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
1743
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1581
1744
|
*/
|
|
1582
1745
|
getGamificationScorecardsUser(userId, workday, opts) {
|
|
1583
1746
|
opts = opts || {};
|
|
@@ -1601,7 +1764,8 @@ class GamificationApi {
|
|
|
1601
1764
|
null,
|
|
1602
1765
|
['PureCloud OAuth'],
|
|
1603
1766
|
['application/json'],
|
|
1604
|
-
['application/json']
|
|
1767
|
+
['application/json'],
|
|
1768
|
+
opts['customHeaders']
|
|
1605
1769
|
);
|
|
1606
1770
|
}
|
|
1607
1771
|
|
|
@@ -1611,8 +1775,12 @@ class GamificationApi {
|
|
|
1611
1775
|
* @param {String} userId
|
|
1612
1776
|
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1613
1777
|
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1778
|
+
* @param {Object} opts Optional parameters
|
|
1779
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1614
1780
|
*/
|
|
1615
|
-
getGamificationScorecardsUserAttendance(userId, startWorkday, endWorkday) {
|
|
1781
|
+
getGamificationScorecardsUserAttendance(userId, startWorkday, endWorkday, opts) {
|
|
1782
|
+
opts = opts || {};
|
|
1783
|
+
|
|
1616
1784
|
// verify the required parameter 'userId' is set
|
|
1617
1785
|
if (userId === undefined || userId === null || userId === '') {
|
|
1618
1786
|
throw 'Missing the required parameter "userId" when calling getGamificationScorecardsUserAttendance';
|
|
@@ -1636,7 +1804,8 @@ class GamificationApi {
|
|
|
1636
1804
|
null,
|
|
1637
1805
|
['PureCloud OAuth'],
|
|
1638
1806
|
['application/json'],
|
|
1639
|
-
['application/json']
|
|
1807
|
+
['application/json'],
|
|
1808
|
+
opts['customHeaders']
|
|
1640
1809
|
);
|
|
1641
1810
|
}
|
|
1642
1811
|
|
|
@@ -1644,8 +1813,12 @@ class GamificationApi {
|
|
|
1644
1813
|
* Best points of a user
|
|
1645
1814
|
*
|
|
1646
1815
|
* @param {String} userId
|
|
1816
|
+
* @param {Object} opts Optional parameters
|
|
1817
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1647
1818
|
*/
|
|
1648
|
-
getGamificationScorecardsUserBestpoints(userId) {
|
|
1819
|
+
getGamificationScorecardsUserBestpoints(userId, opts) {
|
|
1820
|
+
opts = opts || {};
|
|
1821
|
+
|
|
1649
1822
|
// verify the required parameter 'userId' is set
|
|
1650
1823
|
if (userId === undefined || userId === null || userId === '') {
|
|
1651
1824
|
throw 'Missing the required parameter "userId" when calling getGamificationScorecardsUserBestpoints';
|
|
@@ -1661,7 +1834,8 @@ class GamificationApi {
|
|
|
1661
1834
|
null,
|
|
1662
1835
|
['PureCloud OAuth'],
|
|
1663
1836
|
['application/json'],
|
|
1664
|
-
['application/json']
|
|
1837
|
+
['application/json'],
|
|
1838
|
+
opts['customHeaders']
|
|
1665
1839
|
);
|
|
1666
1840
|
}
|
|
1667
1841
|
|
|
@@ -1670,8 +1844,12 @@ class GamificationApi {
|
|
|
1670
1844
|
*
|
|
1671
1845
|
* @param {String} userId
|
|
1672
1846
|
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1847
|
+
* @param {Object} opts Optional parameters
|
|
1848
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1673
1849
|
*/
|
|
1674
|
-
getGamificationScorecardsUserPointsAlltime(userId, endWorkday) {
|
|
1850
|
+
getGamificationScorecardsUserPointsAlltime(userId, endWorkday, opts) {
|
|
1851
|
+
opts = opts || {};
|
|
1852
|
+
|
|
1675
1853
|
// verify the required parameter 'userId' is set
|
|
1676
1854
|
if (userId === undefined || userId === null || userId === '') {
|
|
1677
1855
|
throw 'Missing the required parameter "userId" when calling getGamificationScorecardsUserPointsAlltime';
|
|
@@ -1691,7 +1869,8 @@ class GamificationApi {
|
|
|
1691
1869
|
null,
|
|
1692
1870
|
['PureCloud OAuth'],
|
|
1693
1871
|
['application/json'],
|
|
1694
|
-
['application/json']
|
|
1872
|
+
['application/json'],
|
|
1873
|
+
opts['customHeaders']
|
|
1695
1874
|
);
|
|
1696
1875
|
}
|
|
1697
1876
|
|
|
@@ -1703,6 +1882,7 @@ class GamificationApi {
|
|
|
1703
1882
|
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1704
1883
|
* @param {Object} opts Optional parameters
|
|
1705
1884
|
* @param {Object} opts.dayOfWeek Optional filter to specify which day of weeks to be included in the response
|
|
1885
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1706
1886
|
*/
|
|
1707
1887
|
getGamificationScorecardsUserPointsTrends(userId, startWorkday, endWorkday, opts) {
|
|
1708
1888
|
opts = opts || {};
|
|
@@ -1730,7 +1910,8 @@ class GamificationApi {
|
|
|
1730
1910
|
null,
|
|
1731
1911
|
['PureCloud OAuth'],
|
|
1732
1912
|
['application/json'],
|
|
1733
|
-
['application/json']
|
|
1913
|
+
['application/json'],
|
|
1914
|
+
opts['customHeaders']
|
|
1734
1915
|
);
|
|
1735
1916
|
}
|
|
1736
1917
|
|
|
@@ -1742,6 +1923,7 @@ class GamificationApi {
|
|
|
1742
1923
|
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1743
1924
|
* @param {Object} opts Optional parameters
|
|
1744
1925
|
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
1926
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1745
1927
|
*/
|
|
1746
1928
|
getGamificationScorecardsUserValuesTrends(userId, startWorkday, endWorkday, opts) {
|
|
1747
1929
|
opts = opts || {};
|
|
@@ -1769,7 +1951,8 @@ class GamificationApi {
|
|
|
1769
1951
|
null,
|
|
1770
1952
|
['PureCloud OAuth'],
|
|
1771
1953
|
['application/json'],
|
|
1772
|
-
['application/json']
|
|
1954
|
+
['application/json'],
|
|
1955
|
+
opts['customHeaders']
|
|
1773
1956
|
);
|
|
1774
1957
|
}
|
|
1775
1958
|
|
|
@@ -1779,8 +1962,12 @@ class GamificationApi {
|
|
|
1779
1962
|
* @param {Object} filterType Filter type for the query request.
|
|
1780
1963
|
* @param {String} filterId ID for the filter type.
|
|
1781
1964
|
* @param {String} workday The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1965
|
+
* @param {Object} opts Optional parameters
|
|
1966
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1782
1967
|
*/
|
|
1783
|
-
getGamificationScorecardsUsersPointsAverage(filterType, filterId, workday) {
|
|
1968
|
+
getGamificationScorecardsUsersPointsAverage(filterType, filterId, workday, opts) {
|
|
1969
|
+
opts = opts || {};
|
|
1970
|
+
|
|
1784
1971
|
// verify the required parameter 'filterType' is set
|
|
1785
1972
|
if (filterType === undefined || filterType === null) {
|
|
1786
1973
|
throw 'Missing the required parameter "filterType" when calling getGamificationScorecardsUsersPointsAverage';
|
|
@@ -1804,7 +1991,8 @@ class GamificationApi {
|
|
|
1804
1991
|
null,
|
|
1805
1992
|
['PureCloud OAuth'],
|
|
1806
1993
|
['application/json'],
|
|
1807
|
-
['application/json']
|
|
1994
|
+
['application/json'],
|
|
1995
|
+
opts['customHeaders']
|
|
1808
1996
|
);
|
|
1809
1997
|
}
|
|
1810
1998
|
|
|
@@ -1816,6 +2004,7 @@ class GamificationApi {
|
|
|
1816
2004
|
* @param {String} workday The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1817
2005
|
* @param {Object} opts Optional parameters
|
|
1818
2006
|
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
2007
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1819
2008
|
*/
|
|
1820
2009
|
getGamificationScorecardsUsersValuesAverage(filterType, filterId, workday, opts) {
|
|
1821
2010
|
opts = opts || {};
|
|
@@ -1843,7 +2032,8 @@ class GamificationApi {
|
|
|
1843
2032
|
null,
|
|
1844
2033
|
['PureCloud OAuth'],
|
|
1845
2034
|
['application/json'],
|
|
1846
|
-
['application/json']
|
|
2035
|
+
['application/json'],
|
|
2036
|
+
opts['customHeaders']
|
|
1847
2037
|
);
|
|
1848
2038
|
}
|
|
1849
2039
|
|
|
@@ -1856,6 +2046,7 @@ class GamificationApi {
|
|
|
1856
2046
|
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1857
2047
|
* @param {Object} opts Optional parameters
|
|
1858
2048
|
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
2049
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1859
2050
|
*/
|
|
1860
2051
|
getGamificationScorecardsUsersValuesTrends(filterType, filterId, startWorkday, endWorkday, opts) {
|
|
1861
2052
|
opts = opts || {};
|
|
@@ -1887,7 +2078,8 @@ class GamificationApi {
|
|
|
1887
2078
|
null,
|
|
1888
2079
|
['PureCloud OAuth'],
|
|
1889
2080
|
['application/json'],
|
|
1890
|
-
['application/json']
|
|
2081
|
+
['application/json'],
|
|
2082
|
+
opts['customHeaders']
|
|
1891
2083
|
);
|
|
1892
2084
|
}
|
|
1893
2085
|
|
|
@@ -1897,6 +2089,7 @@ class GamificationApi {
|
|
|
1897
2089
|
* @param {String} workday The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1898
2090
|
* @param {Object} opts Optional parameters
|
|
1899
2091
|
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
2092
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1900
2093
|
*/
|
|
1901
2094
|
getGamificationScorecardsValuesAverage(workday, opts) {
|
|
1902
2095
|
opts = opts || {};
|
|
@@ -1916,7 +2109,8 @@ class GamificationApi {
|
|
|
1916
2109
|
null,
|
|
1917
2110
|
['PureCloud OAuth'],
|
|
1918
2111
|
['application/json'],
|
|
1919
|
-
['application/json']
|
|
2112
|
+
['application/json'],
|
|
2113
|
+
opts['customHeaders']
|
|
1920
2114
|
);
|
|
1921
2115
|
}
|
|
1922
2116
|
|
|
@@ -1929,6 +2123,7 @@ class GamificationApi {
|
|
|
1929
2123
|
* @param {Object} opts.filterType Filter type for the query request. If not set, then the request is for the requesting user.
|
|
1930
2124
|
* @param {String} opts.referenceWorkday Reference workday for the trend. Used to determine the profile of the user as of this date. If not set, then the user's current profile will be used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1931
2125
|
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
2126
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1932
2127
|
*/
|
|
1933
2128
|
getGamificationScorecardsValuesTrends(startWorkday, endWorkday, opts) {
|
|
1934
2129
|
opts = opts || {};
|
|
@@ -1952,15 +2147,20 @@ class GamificationApi {
|
|
|
1952
2147
|
null,
|
|
1953
2148
|
['PureCloud OAuth'],
|
|
1954
2149
|
['application/json'],
|
|
1955
|
-
['application/json']
|
|
2150
|
+
['application/json'],
|
|
2151
|
+
opts['customHeaders']
|
|
1956
2152
|
);
|
|
1957
2153
|
}
|
|
1958
2154
|
|
|
1959
2155
|
/**
|
|
1960
2156
|
* Gamification activation status
|
|
1961
2157
|
*
|
|
2158
|
+
* @param {Object} opts Optional parameters
|
|
2159
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1962
2160
|
*/
|
|
1963
|
-
getGamificationStatus() {
|
|
2161
|
+
getGamificationStatus(opts) {
|
|
2162
|
+
opts = opts || {};
|
|
2163
|
+
|
|
1964
2164
|
|
|
1965
2165
|
return this.apiClient.callApi(
|
|
1966
2166
|
'/api/v2/gamification/status',
|
|
@@ -1972,7 +2172,8 @@ class GamificationApi {
|
|
|
1972
2172
|
null,
|
|
1973
2173
|
['PureCloud OAuth'],
|
|
1974
2174
|
['application/json'],
|
|
1975
|
-
['application/json']
|
|
2175
|
+
['application/json'],
|
|
2176
|
+
opts['customHeaders']
|
|
1976
2177
|
);
|
|
1977
2178
|
}
|
|
1978
2179
|
|
|
@@ -1980,8 +2181,12 @@ class GamificationApi {
|
|
|
1980
2181
|
* Objective template by id
|
|
1981
2182
|
*
|
|
1982
2183
|
* @param {String} templateId template id
|
|
2184
|
+
* @param {Object} opts Optional parameters
|
|
2185
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1983
2186
|
*/
|
|
1984
|
-
getGamificationTemplate(templateId) {
|
|
2187
|
+
getGamificationTemplate(templateId, opts) {
|
|
2188
|
+
opts = opts || {};
|
|
2189
|
+
|
|
1985
2190
|
// verify the required parameter 'templateId' is set
|
|
1986
2191
|
if (templateId === undefined || templateId === null || templateId === '') {
|
|
1987
2192
|
throw 'Missing the required parameter "templateId" when calling getGamificationTemplate';
|
|
@@ -1997,15 +2202,20 @@ class GamificationApi {
|
|
|
1997
2202
|
null,
|
|
1998
2203
|
['PureCloud OAuth'],
|
|
1999
2204
|
['application/json'],
|
|
2000
|
-
['application/json']
|
|
2205
|
+
['application/json'],
|
|
2206
|
+
opts['customHeaders']
|
|
2001
2207
|
);
|
|
2002
2208
|
}
|
|
2003
2209
|
|
|
2004
2210
|
/**
|
|
2005
2211
|
* All objective templates
|
|
2006
2212
|
*
|
|
2213
|
+
* @param {Object} opts Optional parameters
|
|
2214
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2007
2215
|
*/
|
|
2008
|
-
getGamificationTemplates() {
|
|
2216
|
+
getGamificationTemplates(opts) {
|
|
2217
|
+
opts = opts || {};
|
|
2218
|
+
|
|
2009
2219
|
|
|
2010
2220
|
return this.apiClient.callApi(
|
|
2011
2221
|
'/api/v2/gamification/templates',
|
|
@@ -2017,7 +2227,8 @@ class GamificationApi {
|
|
|
2017
2227
|
null,
|
|
2018
2228
|
['PureCloud OAuth'],
|
|
2019
2229
|
['application/json'],
|
|
2020
|
-
['application/json']
|
|
2230
|
+
['application/json'],
|
|
2231
|
+
opts['customHeaders']
|
|
2021
2232
|
);
|
|
2022
2233
|
}
|
|
2023
2234
|
|
|
@@ -2026,8 +2237,12 @@ class GamificationApi {
|
|
|
2026
2237
|
*
|
|
2027
2238
|
* @param {String} metricId Specifies the metric definition ID
|
|
2028
2239
|
* @param {Object} body The External Metric Definition parameters to be updated
|
|
2240
|
+
* @param {Object} opts Optional parameters
|
|
2241
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2029
2242
|
*/
|
|
2030
|
-
patchEmployeeperformanceExternalmetricsDefinition(metricId, body) {
|
|
2243
|
+
patchEmployeeperformanceExternalmetricsDefinition(metricId, body, opts) {
|
|
2244
|
+
opts = opts || {};
|
|
2245
|
+
|
|
2031
2246
|
// verify the required parameter 'metricId' is set
|
|
2032
2247
|
if (metricId === undefined || metricId === null || metricId === '') {
|
|
2033
2248
|
throw 'Missing the required parameter "metricId" when calling patchEmployeeperformanceExternalmetricsDefinition';
|
|
@@ -2047,7 +2262,8 @@ class GamificationApi {
|
|
|
2047
2262
|
body,
|
|
2048
2263
|
['PureCloud OAuth'],
|
|
2049
2264
|
['application/json'],
|
|
2050
|
-
['application/json']
|
|
2265
|
+
['application/json'],
|
|
2266
|
+
opts['customHeaders']
|
|
2051
2267
|
);
|
|
2052
2268
|
}
|
|
2053
2269
|
|
|
@@ -2056,8 +2272,12 @@ class GamificationApi {
|
|
|
2056
2272
|
*
|
|
2057
2273
|
* @param {String} contestId The ID of the contest
|
|
2058
2274
|
* @param {Object} body Finalize Contest
|
|
2275
|
+
* @param {Object} opts Optional parameters
|
|
2276
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2059
2277
|
*/
|
|
2060
|
-
patchGamificationContest(contestId, body) {
|
|
2278
|
+
patchGamificationContest(contestId, body, opts) {
|
|
2279
|
+
opts = opts || {};
|
|
2280
|
+
|
|
2061
2281
|
// verify the required parameter 'contestId' is set
|
|
2062
2282
|
if (contestId === undefined || contestId === null || contestId === '') {
|
|
2063
2283
|
throw 'Missing the required parameter "contestId" when calling patchGamificationContest';
|
|
@@ -2077,7 +2297,8 @@ class GamificationApi {
|
|
|
2077
2297
|
body,
|
|
2078
2298
|
['PureCloud OAuth'],
|
|
2079
2299
|
['application/json'],
|
|
2080
|
-
['application/json']
|
|
2300
|
+
['application/json'],
|
|
2301
|
+
opts['customHeaders']
|
|
2081
2302
|
);
|
|
2082
2303
|
}
|
|
2083
2304
|
|
|
@@ -2086,6 +2307,7 @@ class GamificationApi {
|
|
|
2086
2307
|
*
|
|
2087
2308
|
* @param {Object} opts Optional parameters
|
|
2088
2309
|
* @param {Object} opts.body The External Metric Data to be added
|
|
2310
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2089
2311
|
*/
|
|
2090
2312
|
postEmployeeperformanceExternalmetricsData(opts) {
|
|
2091
2313
|
opts = opts || {};
|
|
@@ -2101,7 +2323,8 @@ class GamificationApi {
|
|
|
2101
2323
|
opts['body'],
|
|
2102
2324
|
['PureCloud OAuth'],
|
|
2103
2325
|
['application/json'],
|
|
2104
|
-
['application/json']
|
|
2326
|
+
['application/json'],
|
|
2327
|
+
opts['customHeaders']
|
|
2105
2328
|
);
|
|
2106
2329
|
}
|
|
2107
2330
|
|
|
@@ -2110,6 +2333,7 @@ class GamificationApi {
|
|
|
2110
2333
|
*
|
|
2111
2334
|
* @param {Object} opts Optional parameters
|
|
2112
2335
|
* @param {Object} opts.body The External Metric Definition to be created
|
|
2336
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2113
2337
|
*/
|
|
2114
2338
|
postEmployeeperformanceExternalmetricsDefinitions(opts) {
|
|
2115
2339
|
opts = opts || {};
|
|
@@ -2125,7 +2349,8 @@ class GamificationApi {
|
|
|
2125
2349
|
opts['body'],
|
|
2126
2350
|
['PureCloud OAuth'],
|
|
2127
2351
|
['application/json'],
|
|
2128
|
-
['application/json']
|
|
2352
|
+
['application/json'],
|
|
2353
|
+
opts['customHeaders']
|
|
2129
2354
|
);
|
|
2130
2355
|
}
|
|
2131
2356
|
|
|
@@ -2133,8 +2358,12 @@ class GamificationApi {
|
|
|
2133
2358
|
* Creates a Contest
|
|
2134
2359
|
*
|
|
2135
2360
|
* @param {Object} body Create Contest
|
|
2361
|
+
* @param {Object} opts Optional parameters
|
|
2362
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2136
2363
|
*/
|
|
2137
|
-
postGamificationContests(body) {
|
|
2364
|
+
postGamificationContests(body, opts) {
|
|
2365
|
+
opts = opts || {};
|
|
2366
|
+
|
|
2138
2367
|
// verify the required parameter 'body' is set
|
|
2139
2368
|
if (body === undefined || body === null) {
|
|
2140
2369
|
throw 'Missing the required parameter "body" when calling postGamificationContests';
|
|
@@ -2150,7 +2379,8 @@ class GamificationApi {
|
|
|
2150
2379
|
body,
|
|
2151
2380
|
['PureCloud OAuth'],
|
|
2152
2381
|
['application/json'],
|
|
2153
|
-
['application/json']
|
|
2382
|
+
['application/json'],
|
|
2383
|
+
opts['customHeaders']
|
|
2154
2384
|
);
|
|
2155
2385
|
}
|
|
2156
2386
|
|
|
@@ -2158,8 +2388,12 @@ class GamificationApi {
|
|
|
2158
2388
|
* Generates pre-signed URL to upload a prize image for gamification contests
|
|
2159
2389
|
*
|
|
2160
2390
|
* @param {Object} body query
|
|
2391
|
+
* @param {Object} opts Optional parameters
|
|
2392
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2161
2393
|
*/
|
|
2162
|
-
postGamificationContestsUploadsPrizeimages(body) {
|
|
2394
|
+
postGamificationContestsUploadsPrizeimages(body, opts) {
|
|
2395
|
+
opts = opts || {};
|
|
2396
|
+
|
|
2163
2397
|
// verify the required parameter 'body' is set
|
|
2164
2398
|
if (body === undefined || body === null) {
|
|
2165
2399
|
throw 'Missing the required parameter "body" when calling postGamificationContestsUploadsPrizeimages';
|
|
@@ -2175,7 +2409,8 @@ class GamificationApi {
|
|
|
2175
2409
|
body,
|
|
2176
2410
|
['PureCloud OAuth'],
|
|
2177
2411
|
['application/json'],
|
|
2178
|
-
['application/json']
|
|
2412
|
+
['application/json'],
|
|
2413
|
+
opts['customHeaders']
|
|
2179
2414
|
);
|
|
2180
2415
|
}
|
|
2181
2416
|
|
|
@@ -2183,8 +2418,12 @@ class GamificationApi {
|
|
|
2183
2418
|
* Activate a performance profile
|
|
2184
2419
|
*
|
|
2185
2420
|
* @param {String} profileId performanceProfileId
|
|
2421
|
+
* @param {Object} opts Optional parameters
|
|
2422
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2186
2423
|
*/
|
|
2187
|
-
postGamificationProfileActivate(profileId) {
|
|
2424
|
+
postGamificationProfileActivate(profileId, opts) {
|
|
2425
|
+
opts = opts || {};
|
|
2426
|
+
|
|
2188
2427
|
// verify the required parameter 'profileId' is set
|
|
2189
2428
|
if (profileId === undefined || profileId === null || profileId === '') {
|
|
2190
2429
|
throw 'Missing the required parameter "profileId" when calling postGamificationProfileActivate';
|
|
@@ -2200,7 +2439,8 @@ class GamificationApi {
|
|
|
2200
2439
|
null,
|
|
2201
2440
|
['PureCloud OAuth'],
|
|
2202
2441
|
['application/json'],
|
|
2203
|
-
['application/json']
|
|
2442
|
+
['application/json'],
|
|
2443
|
+
opts['customHeaders']
|
|
2204
2444
|
);
|
|
2205
2445
|
}
|
|
2206
2446
|
|
|
@@ -2208,8 +2448,12 @@ class GamificationApi {
|
|
|
2208
2448
|
* Deactivate a performance profile
|
|
2209
2449
|
*
|
|
2210
2450
|
* @param {String} profileId performanceProfileId
|
|
2451
|
+
* @param {Object} opts Optional parameters
|
|
2452
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2211
2453
|
*/
|
|
2212
|
-
postGamificationProfileDeactivate(profileId) {
|
|
2454
|
+
postGamificationProfileDeactivate(profileId, opts) {
|
|
2455
|
+
opts = opts || {};
|
|
2456
|
+
|
|
2213
2457
|
// verify the required parameter 'profileId' is set
|
|
2214
2458
|
if (profileId === undefined || profileId === null || profileId === '') {
|
|
2215
2459
|
throw 'Missing the required parameter "profileId" when calling postGamificationProfileDeactivate';
|
|
@@ -2225,7 +2469,8 @@ class GamificationApi {
|
|
|
2225
2469
|
null,
|
|
2226
2470
|
['PureCloud OAuth'],
|
|
2227
2471
|
['application/json'],
|
|
2228
|
-
['application/json']
|
|
2472
|
+
['application/json'],
|
|
2473
|
+
opts['customHeaders']
|
|
2229
2474
|
);
|
|
2230
2475
|
}
|
|
2231
2476
|
|
|
@@ -2234,8 +2479,12 @@ class GamificationApi {
|
|
|
2234
2479
|
*
|
|
2235
2480
|
* @param {String} profileId Profile Id
|
|
2236
2481
|
* @param {Object} body assignUsers
|
|
2482
|
+
* @param {Object} opts Optional parameters
|
|
2483
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2237
2484
|
*/
|
|
2238
|
-
postGamificationProfileMembers(profileId, body) {
|
|
2485
|
+
postGamificationProfileMembers(profileId, body, opts) {
|
|
2486
|
+
opts = opts || {};
|
|
2487
|
+
|
|
2239
2488
|
// verify the required parameter 'profileId' is set
|
|
2240
2489
|
if (profileId === undefined || profileId === null || profileId === '') {
|
|
2241
2490
|
throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembers';
|
|
@@ -2255,7 +2504,8 @@ class GamificationApi {
|
|
|
2255
2504
|
body,
|
|
2256
2505
|
['PureCloud OAuth'],
|
|
2257
2506
|
['application/json'],
|
|
2258
|
-
['application/json']
|
|
2507
|
+
['application/json'],
|
|
2508
|
+
opts['customHeaders']
|
|
2259
2509
|
);
|
|
2260
2510
|
}
|
|
2261
2511
|
|
|
@@ -2264,8 +2514,12 @@ class GamificationApi {
|
|
|
2264
2514
|
*
|
|
2265
2515
|
* @param {String} profileId Profile Id
|
|
2266
2516
|
* @param {Object} body memberAssignments
|
|
2517
|
+
* @param {Object} opts Optional parameters
|
|
2518
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2267
2519
|
*/
|
|
2268
|
-
postGamificationProfileMembersValidate(profileId, body) {
|
|
2520
|
+
postGamificationProfileMembersValidate(profileId, body, opts) {
|
|
2521
|
+
opts = opts || {};
|
|
2522
|
+
|
|
2269
2523
|
// verify the required parameter 'profileId' is set
|
|
2270
2524
|
if (profileId === undefined || profileId === null || profileId === '') {
|
|
2271
2525
|
throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembersValidate';
|
|
@@ -2285,7 +2539,8 @@ class GamificationApi {
|
|
|
2285
2539
|
body,
|
|
2286
2540
|
['PureCloud OAuth'],
|
|
2287
2541
|
['application/json'],
|
|
2288
|
-
['application/json']
|
|
2542
|
+
['application/json'],
|
|
2543
|
+
opts['customHeaders']
|
|
2289
2544
|
);
|
|
2290
2545
|
}
|
|
2291
2546
|
|
|
@@ -2295,8 +2550,12 @@ class GamificationApi {
|
|
|
2295
2550
|
* @param {String} sourceProfileId Source Performance Profile Id
|
|
2296
2551
|
* @param {String} sourceMetricId Source Metric Id
|
|
2297
2552
|
* @param {Object} body linkedMetric
|
|
2553
|
+
* @param {Object} opts Optional parameters
|
|
2554
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2298
2555
|
*/
|
|
2299
|
-
postGamificationProfileMetricLink(sourceProfileId, sourceMetricId, body) {
|
|
2556
|
+
postGamificationProfileMetricLink(sourceProfileId, sourceMetricId, body, opts) {
|
|
2557
|
+
opts = opts || {};
|
|
2558
|
+
|
|
2300
2559
|
// verify the required parameter 'sourceProfileId' is set
|
|
2301
2560
|
if (sourceProfileId === undefined || sourceProfileId === null || sourceProfileId === '') {
|
|
2302
2561
|
throw 'Missing the required parameter "sourceProfileId" when calling postGamificationProfileMetricLink';
|
|
@@ -2320,7 +2579,8 @@ class GamificationApi {
|
|
|
2320
2579
|
body,
|
|
2321
2580
|
['PureCloud OAuth'],
|
|
2322
2581
|
['application/json'],
|
|
2323
|
-
['application/json']
|
|
2582
|
+
['application/json'],
|
|
2583
|
+
opts['customHeaders']
|
|
2324
2584
|
);
|
|
2325
2585
|
}
|
|
2326
2586
|
|
|
@@ -2329,8 +2589,12 @@ class GamificationApi {
|
|
|
2329
2589
|
*
|
|
2330
2590
|
* @param {String} profileId Performance Profile Id
|
|
2331
2591
|
* @param {Object} body Metric
|
|
2592
|
+
* @param {Object} opts Optional parameters
|
|
2593
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2332
2594
|
*/
|
|
2333
|
-
postGamificationProfileMetrics(profileId, body) {
|
|
2595
|
+
postGamificationProfileMetrics(profileId, body, opts) {
|
|
2596
|
+
opts = opts || {};
|
|
2597
|
+
|
|
2334
2598
|
// verify the required parameter 'profileId' is set
|
|
2335
2599
|
if (profileId === undefined || profileId === null || profileId === '') {
|
|
2336
2600
|
throw 'Missing the required parameter "profileId" when calling postGamificationProfileMetrics';
|
|
@@ -2350,7 +2614,8 @@ class GamificationApi {
|
|
|
2350
2614
|
body,
|
|
2351
2615
|
['PureCloud OAuth'],
|
|
2352
2616
|
['application/json'],
|
|
2353
|
-
['application/json']
|
|
2617
|
+
['application/json'],
|
|
2618
|
+
opts['customHeaders']
|
|
2354
2619
|
);
|
|
2355
2620
|
}
|
|
2356
2621
|
|
|
@@ -2360,6 +2625,7 @@ class GamificationApi {
|
|
|
2360
2625
|
* @param {Object} body performanceProfile
|
|
2361
2626
|
* @param {Object} opts Optional parameters
|
|
2362
2627
|
* @param {Boolean} opts.copyMetrics Flag to copy metrics. If set to false, there will be no metrics associated with the new profile. If set to true or is absent (the default behavior), all metrics from the default profile will be copied over into the new profile. (default to true)
|
|
2628
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2363
2629
|
*/
|
|
2364
2630
|
postGamificationProfiles(body, opts) {
|
|
2365
2631
|
opts = opts || {};
|
|
@@ -2379,7 +2645,8 @@ class GamificationApi {
|
|
|
2379
2645
|
body,
|
|
2380
2646
|
['PureCloud OAuth'],
|
|
2381
2647
|
['application/json'],
|
|
2382
|
-
['application/json']
|
|
2648
|
+
['application/json'],
|
|
2649
|
+
opts['customHeaders']
|
|
2383
2650
|
);
|
|
2384
2651
|
}
|
|
2385
2652
|
|
|
@@ -2388,8 +2655,12 @@ class GamificationApi {
|
|
|
2388
2655
|
*
|
|
2389
2656
|
* @param {String} userId The ID of a user.
|
|
2390
2657
|
* @param {Object} body The date range of work day.
|
|
2658
|
+
* @param {Object} opts Optional parameters
|
|
2659
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2391
2660
|
*/
|
|
2392
|
-
postGamificationProfilesUserQuery(userId, body) {
|
|
2661
|
+
postGamificationProfilesUserQuery(userId, body, opts) {
|
|
2662
|
+
opts = opts || {};
|
|
2663
|
+
|
|
2393
2664
|
// verify the required parameter 'userId' is set
|
|
2394
2665
|
if (userId === undefined || userId === null || userId === '') {
|
|
2395
2666
|
throw 'Missing the required parameter "userId" when calling postGamificationProfilesUserQuery';
|
|
@@ -2409,7 +2680,8 @@ class GamificationApi {
|
|
|
2409
2680
|
body,
|
|
2410
2681
|
['PureCloud OAuth'],
|
|
2411
2682
|
['application/json'],
|
|
2412
|
-
['application/json']
|
|
2683
|
+
['application/json'],
|
|
2684
|
+
opts['customHeaders']
|
|
2413
2685
|
);
|
|
2414
2686
|
}
|
|
2415
2687
|
|
|
@@ -2417,8 +2689,12 @@ class GamificationApi {
|
|
|
2417
2689
|
* Query performance profiles in date range for the current user
|
|
2418
2690
|
*
|
|
2419
2691
|
* @param {Object} body The date range of work day.
|
|
2692
|
+
* @param {Object} opts Optional parameters
|
|
2693
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2420
2694
|
*/
|
|
2421
|
-
postGamificationProfilesUsersMeQuery(body) {
|
|
2695
|
+
postGamificationProfilesUsersMeQuery(body, opts) {
|
|
2696
|
+
opts = opts || {};
|
|
2697
|
+
|
|
2422
2698
|
// verify the required parameter 'body' is set
|
|
2423
2699
|
if (body === undefined || body === null) {
|
|
2424
2700
|
throw 'Missing the required parameter "body" when calling postGamificationProfilesUsersMeQuery';
|
|
@@ -2434,7 +2710,8 @@ class GamificationApi {
|
|
|
2434
2710
|
body,
|
|
2435
2711
|
['PureCloud OAuth'],
|
|
2436
2712
|
['application/json'],
|
|
2437
|
-
['application/json']
|
|
2713
|
+
['application/json'],
|
|
2714
|
+
opts['customHeaders']
|
|
2438
2715
|
);
|
|
2439
2716
|
}
|
|
2440
2717
|
|
|
@@ -2443,8 +2720,12 @@ class GamificationApi {
|
|
|
2443
2720
|
*
|
|
2444
2721
|
* @param {String} contestId The ID of the contest
|
|
2445
2722
|
* @param {Object} body Contest
|
|
2723
|
+
* @param {Object} opts Optional parameters
|
|
2724
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2446
2725
|
*/
|
|
2447
|
-
putGamificationContest(contestId, body) {
|
|
2726
|
+
putGamificationContest(contestId, body, opts) {
|
|
2727
|
+
opts = opts || {};
|
|
2728
|
+
|
|
2448
2729
|
// verify the required parameter 'contestId' is set
|
|
2449
2730
|
if (contestId === undefined || contestId === null || contestId === '') {
|
|
2450
2731
|
throw 'Missing the required parameter "contestId" when calling putGamificationContest';
|
|
@@ -2464,7 +2745,8 @@ class GamificationApi {
|
|
|
2464
2745
|
body,
|
|
2465
2746
|
['PureCloud OAuth'],
|
|
2466
2747
|
['application/json'],
|
|
2467
|
-
['application/json']
|
|
2748
|
+
['application/json'],
|
|
2749
|
+
opts['customHeaders']
|
|
2468
2750
|
);
|
|
2469
2751
|
}
|
|
2470
2752
|
|
|
@@ -2474,6 +2756,7 @@ class GamificationApi {
|
|
|
2474
2756
|
* @param {String} profileId performanceProfileId
|
|
2475
2757
|
* @param {Object} opts Optional parameters
|
|
2476
2758
|
* @param {Object} opts.body performanceProfile
|
|
2759
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2477
2760
|
*/
|
|
2478
2761
|
putGamificationProfile(profileId, opts) {
|
|
2479
2762
|
opts = opts || {};
|
|
@@ -2493,7 +2776,8 @@ class GamificationApi {
|
|
|
2493
2776
|
opts['body'],
|
|
2494
2777
|
['PureCloud OAuth'],
|
|
2495
2778
|
['application/json'],
|
|
2496
|
-
['application/json']
|
|
2779
|
+
['application/json'],
|
|
2780
|
+
opts['customHeaders']
|
|
2497
2781
|
);
|
|
2498
2782
|
}
|
|
2499
2783
|
|
|
@@ -2503,8 +2787,12 @@ class GamificationApi {
|
|
|
2503
2787
|
* @param {String} profileId Performance Profile Id
|
|
2504
2788
|
* @param {String} metricId Metric Id
|
|
2505
2789
|
* @param {Object} body Metric
|
|
2790
|
+
* @param {Object} opts Optional parameters
|
|
2791
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2506
2792
|
*/
|
|
2507
|
-
putGamificationProfileMetric(profileId, metricId, body) {
|
|
2793
|
+
putGamificationProfileMetric(profileId, metricId, body, opts) {
|
|
2794
|
+
opts = opts || {};
|
|
2795
|
+
|
|
2508
2796
|
// verify the required parameter 'profileId' is set
|
|
2509
2797
|
if (profileId === undefined || profileId === null || profileId === '') {
|
|
2510
2798
|
throw 'Missing the required parameter "profileId" when calling putGamificationProfileMetric';
|
|
@@ -2528,7 +2816,8 @@ class GamificationApi {
|
|
|
2528
2816
|
body,
|
|
2529
2817
|
['PureCloud OAuth'],
|
|
2530
2818
|
['application/json'],
|
|
2531
|
-
['application/json']
|
|
2819
|
+
['application/json'],
|
|
2820
|
+
opts['customHeaders']
|
|
2532
2821
|
);
|
|
2533
2822
|
}
|
|
2534
2823
|
|
|
@@ -2536,8 +2825,12 @@ class GamificationApi {
|
|
|
2536
2825
|
* Update gamification activation status
|
|
2537
2826
|
*
|
|
2538
2827
|
* @param {Object} status Gamification status
|
|
2828
|
+
* @param {Object} opts Optional parameters
|
|
2829
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2539
2830
|
*/
|
|
2540
|
-
putGamificationStatus(status) {
|
|
2831
|
+
putGamificationStatus(status, opts) {
|
|
2832
|
+
opts = opts || {};
|
|
2833
|
+
|
|
2541
2834
|
// verify the required parameter 'status' is set
|
|
2542
2835
|
if (status === undefined || status === null) {
|
|
2543
2836
|
throw 'Missing the required parameter "status" when calling putGamificationStatus';
|
|
@@ -2553,7 +2846,8 @@ class GamificationApi {
|
|
|
2553
2846
|
status,
|
|
2554
2847
|
['PureCloud OAuth'],
|
|
2555
2848
|
['application/json'],
|
|
2556
|
-
['application/json']
|
|
2849
|
+
['application/json'],
|
|
2850
|
+
opts['customHeaders']
|
|
2557
2851
|
);
|
|
2558
2852
|
}
|
|
2559
2853
|
|