@ikonintegration/bccsa-program-api 3.0.19 → 3.0.21
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/Api.ts +338 -437
- package/dist/Api.d.ts +3107 -0
- package/dist/Api.js +1623 -0
- package/dist/Api.js.map +1 -0
- package/package.json +2 -2
- package/tsconfig.json +4 -2
package/dist/Api.js
ADDED
|
@@ -0,0 +1,1623 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/*
|
|
5
|
+
* ---------------------------------------------------------------
|
|
6
|
+
* ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API ##
|
|
7
|
+
* ## ##
|
|
8
|
+
* ## AUTHOR: acacode ##
|
|
9
|
+
* ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
|
|
10
|
+
* ---------------------------------------------------------------
|
|
11
|
+
*/
|
|
12
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
13
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
14
|
+
};
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.Api = exports.HttpClient = exports.ContentType = exports.Input855Mqx9IfeValueEnum = exports.ReportXlsxSchemaContentTypeEnum = void 0;
|
|
17
|
+
var ReportXlsxSchemaContentTypeEnum;
|
|
18
|
+
(function (ReportXlsxSchemaContentTypeEnum) {
|
|
19
|
+
ReportXlsxSchemaContentTypeEnum["ApplicationVndOpenxmlformatsOfficedocumentSpreadsheetmlSheet"] = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
|
|
20
|
+
})(ReportXlsxSchemaContentTypeEnum || (exports.ReportXlsxSchemaContentTypeEnum = ReportXlsxSchemaContentTypeEnum = {}));
|
|
21
|
+
/**
|
|
22
|
+
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
23
|
+
* @example "CHECKED"
|
|
24
|
+
*/
|
|
25
|
+
var Input855Mqx9IfeValueEnum;
|
|
26
|
+
(function (Input855Mqx9IfeValueEnum) {
|
|
27
|
+
Input855Mqx9IfeValueEnum["CHECKED"] = "CHECKED";
|
|
28
|
+
Input855Mqx9IfeValueEnum["UNCHECKED"] = "UNCHECKED";
|
|
29
|
+
Input855Mqx9IfeValueEnum["NOVALUE"] = "NOVALUE";
|
|
30
|
+
})(Input855Mqx9IfeValueEnum || (exports.Input855Mqx9IfeValueEnum = Input855Mqx9IfeValueEnum = {}));
|
|
31
|
+
const axios_1 = __importDefault(require("axios"));
|
|
32
|
+
var ContentType;
|
|
33
|
+
(function (ContentType) {
|
|
34
|
+
ContentType["Json"] = "application/json";
|
|
35
|
+
ContentType["FormData"] = "multipart/form-data";
|
|
36
|
+
ContentType["UrlEncoded"] = "application/x-www-form-urlencoded";
|
|
37
|
+
ContentType["Text"] = "text/plain";
|
|
38
|
+
})(ContentType || (exports.ContentType = ContentType = {}));
|
|
39
|
+
class HttpClient {
|
|
40
|
+
constructor({ securityWorker, secure, format, ...axiosConfig } = {}) {
|
|
41
|
+
this.securityData = null;
|
|
42
|
+
this.setSecurityData = (data) => {
|
|
43
|
+
this.securityData = data;
|
|
44
|
+
};
|
|
45
|
+
this.request = async ({ secure, path, type, query, format, body, ...params }) => {
|
|
46
|
+
const secureParams = ((typeof secure === 'boolean' ? secure : this.secure) &&
|
|
47
|
+
this.securityWorker &&
|
|
48
|
+
(await this.securityWorker(this.securityData))) ||
|
|
49
|
+
{};
|
|
50
|
+
const requestParams = this.mergeRequestParams(params, secureParams);
|
|
51
|
+
const responseFormat = format || this.format || undefined;
|
|
52
|
+
if (type === ContentType.FormData && body && body !== null && typeof body === 'object') {
|
|
53
|
+
body = this.createFormData(body);
|
|
54
|
+
}
|
|
55
|
+
if (type === ContentType.Text && body && body !== null && typeof body !== 'string') {
|
|
56
|
+
body = JSON.stringify(body);
|
|
57
|
+
}
|
|
58
|
+
return this.instance
|
|
59
|
+
.request({
|
|
60
|
+
...requestParams,
|
|
61
|
+
headers: {
|
|
62
|
+
...(requestParams.headers || {}),
|
|
63
|
+
...(type ? { 'Content-Type': type } : {}),
|
|
64
|
+
},
|
|
65
|
+
params: query,
|
|
66
|
+
responseType: responseFormat,
|
|
67
|
+
data: body,
|
|
68
|
+
url: path,
|
|
69
|
+
})
|
|
70
|
+
.then(response => response.data);
|
|
71
|
+
};
|
|
72
|
+
this.instance = axios_1.default.create({ ...axiosConfig, baseURL: axiosConfig.baseURL || 'http://localhost:8080' });
|
|
73
|
+
this.secure = secure;
|
|
74
|
+
this.format = format;
|
|
75
|
+
this.securityWorker = securityWorker;
|
|
76
|
+
}
|
|
77
|
+
mergeRequestParams(params1, params2) {
|
|
78
|
+
const method = params1.method || (params2 && params2.method);
|
|
79
|
+
return {
|
|
80
|
+
...this.instance.defaults,
|
|
81
|
+
...params1,
|
|
82
|
+
...(params2 || {}),
|
|
83
|
+
headers: {
|
|
84
|
+
...((method && this.instance.defaults.headers[method.toLowerCase()]) || {}),
|
|
85
|
+
...(params1.headers || {}),
|
|
86
|
+
...((params2 && params2.headers) || {}),
|
|
87
|
+
},
|
|
88
|
+
};
|
|
89
|
+
}
|
|
90
|
+
stringifyFormItem(formItem) {
|
|
91
|
+
if (typeof formItem === 'object' && formItem !== null) {
|
|
92
|
+
return JSON.stringify(formItem);
|
|
93
|
+
}
|
|
94
|
+
else {
|
|
95
|
+
return `${formItem}`;
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
createFormData(input) {
|
|
99
|
+
if (input instanceof FormData) {
|
|
100
|
+
return input;
|
|
101
|
+
}
|
|
102
|
+
return Object.keys(input || {}).reduce((formData, key) => {
|
|
103
|
+
const property = input[key];
|
|
104
|
+
const propertyContent = property instanceof Array ? property : [property];
|
|
105
|
+
for (const formItem of propertyContent) {
|
|
106
|
+
const isFileType = formItem instanceof Blob || formItem instanceof File;
|
|
107
|
+
formData.append(key, isFileType ? formItem : this.stringifyFormItem(formItem));
|
|
108
|
+
}
|
|
109
|
+
return formData;
|
|
110
|
+
}, new FormData());
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
exports.HttpClient = HttpClient;
|
|
114
|
+
/**
|
|
115
|
+
* @title BCCSA Program API
|
|
116
|
+
* @version 3.0.21
|
|
117
|
+
* @baseUrl http://localhost:8080
|
|
118
|
+
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
119
|
+
*/
|
|
120
|
+
class Api extends HttpClient {
|
|
121
|
+
constructor() {
|
|
122
|
+
super(...arguments);
|
|
123
|
+
this.contactUs = {
|
|
124
|
+
/**
|
|
125
|
+
* @description This endpoint allows users to submit a contact form with their name, email, and comments. The form submission is processed and an email is sent to the admin recipient specified in the tenant configuration.
|
|
126
|
+
*
|
|
127
|
+
* @tags Contact Us
|
|
128
|
+
* @name ListContactUs
|
|
129
|
+
* @summary Contact Us
|
|
130
|
+
* @request POST:/contactUs
|
|
131
|
+
* @secure
|
|
132
|
+
*/
|
|
133
|
+
listContactUs: (data, params = {}) => this.request({
|
|
134
|
+
path: `/contactUs`,
|
|
135
|
+
method: 'POST',
|
|
136
|
+
body: data,
|
|
137
|
+
secure: true,
|
|
138
|
+
type: ContentType.Json,
|
|
139
|
+
...params,
|
|
140
|
+
}),
|
|
141
|
+
};
|
|
142
|
+
this.customer = {
|
|
143
|
+
/**
|
|
144
|
+
* @description Retrieve config from customer.
|
|
145
|
+
*
|
|
146
|
+
* @tags Config
|
|
147
|
+
* @name ListConfig
|
|
148
|
+
* @summary Get Config
|
|
149
|
+
* @request GET:/customer/config
|
|
150
|
+
* @secure
|
|
151
|
+
*/
|
|
152
|
+
listConfig: (params = {}) => this.request({
|
|
153
|
+
path: `/customer/config`,
|
|
154
|
+
method: 'GET',
|
|
155
|
+
secure: true,
|
|
156
|
+
...params,
|
|
157
|
+
}),
|
|
158
|
+
/**
|
|
159
|
+
* @description Retrieve user from customer.
|
|
160
|
+
*
|
|
161
|
+
* @tags User
|
|
162
|
+
* @name GetUser
|
|
163
|
+
* @summary Get User
|
|
164
|
+
* @request GET:/customer/user/{userID}
|
|
165
|
+
* @secure
|
|
166
|
+
*/
|
|
167
|
+
getUser: ({ userId, ...query }, params = {}) => this.request({
|
|
168
|
+
path: `/customer/user/${userId}`,
|
|
169
|
+
method: 'GET',
|
|
170
|
+
query: query,
|
|
171
|
+
secure: true,
|
|
172
|
+
format: 'json',
|
|
173
|
+
...params,
|
|
174
|
+
}),
|
|
175
|
+
/**
|
|
176
|
+
* @description Retrieve user events from customer within a specified time range.
|
|
177
|
+
*
|
|
178
|
+
* @tags Events
|
|
179
|
+
* @name GetEvents
|
|
180
|
+
* @summary Get User Events
|
|
181
|
+
* @request GET:/customer/events/{startTime}/{endTime}
|
|
182
|
+
* @secure
|
|
183
|
+
*/
|
|
184
|
+
getEvents: ({ startTime, endTime, ...query }, params = {}) => this.request({
|
|
185
|
+
path: `/customer/events/${startTime}/${endTime}`,
|
|
186
|
+
method: 'GET',
|
|
187
|
+
query: query,
|
|
188
|
+
secure: true,
|
|
189
|
+
...params,
|
|
190
|
+
}),
|
|
191
|
+
};
|
|
192
|
+
this.tenant = {
|
|
193
|
+
/**
|
|
194
|
+
* @description Delete bridge
|
|
195
|
+
*
|
|
196
|
+
* @tags Tenant
|
|
197
|
+
* @name DeleteOrg
|
|
198
|
+
* @summary Delete bridge
|
|
199
|
+
* @request DELETE:/tenant/org/{orgID}
|
|
200
|
+
* @secure
|
|
201
|
+
*/
|
|
202
|
+
deleteOrg: (orgId, params = {}) => this.request({
|
|
203
|
+
path: `/tenant/org/${orgId}`,
|
|
204
|
+
method: 'DELETE',
|
|
205
|
+
secure: true,
|
|
206
|
+
...params,
|
|
207
|
+
}),
|
|
208
|
+
/**
|
|
209
|
+
* @description Retrieve Affiliate Payments for the tenant.
|
|
210
|
+
*
|
|
211
|
+
* @tags Tenant
|
|
212
|
+
* @name ListReportAffiliate
|
|
213
|
+
* @summary Get Affiliate Payments
|
|
214
|
+
* @request GET:/tenant/report/affiliate
|
|
215
|
+
* @secure
|
|
216
|
+
*/
|
|
217
|
+
listReportAffiliate: (query, params = {}) => this.request({
|
|
218
|
+
path: `/tenant/report/affiliate`,
|
|
219
|
+
method: 'GET',
|
|
220
|
+
query: query,
|
|
221
|
+
secure: true,
|
|
222
|
+
...params,
|
|
223
|
+
}),
|
|
224
|
+
/**
|
|
225
|
+
* @description List users that achieved their designation and allow their data to be published.
|
|
226
|
+
*
|
|
227
|
+
* @tags Tenant
|
|
228
|
+
* @name ListReportCompletedWithConsent
|
|
229
|
+
* @summary Get users with completed designations and consent for publication
|
|
230
|
+
* @request GET:/tenant/report/completedWithConsent
|
|
231
|
+
* @secure
|
|
232
|
+
*/
|
|
233
|
+
listReportCompletedWithConsent: (params = {}) => this.request({
|
|
234
|
+
path: `/tenant/report/completedWithConsent`,
|
|
235
|
+
method: 'GET',
|
|
236
|
+
secure: true,
|
|
237
|
+
...params,
|
|
238
|
+
}),
|
|
239
|
+
/**
|
|
240
|
+
* @description Retrieve pending applications for the tenant.
|
|
241
|
+
*
|
|
242
|
+
* @tags Tenant
|
|
243
|
+
* @name ListPendingApplications
|
|
244
|
+
* @summary Get Pending Applications
|
|
245
|
+
* @request GET:/tenant/pendingApplications
|
|
246
|
+
* @secure
|
|
247
|
+
*/
|
|
248
|
+
listPendingApplications: (params = {}) => this.request({
|
|
249
|
+
path: `/tenant/pendingApplications`,
|
|
250
|
+
method: 'GET',
|
|
251
|
+
secure: true,
|
|
252
|
+
format: 'json',
|
|
253
|
+
...params,
|
|
254
|
+
}),
|
|
255
|
+
/**
|
|
256
|
+
* @description Retrieve pending approvals for the tenant.
|
|
257
|
+
*
|
|
258
|
+
* @tags Tenant
|
|
259
|
+
* @name ListPendingApprovals
|
|
260
|
+
* @summary Get Pending Approvals
|
|
261
|
+
* @request GET:/tenant/pendingApprovals
|
|
262
|
+
* @secure
|
|
263
|
+
*/
|
|
264
|
+
listPendingApprovals: (params = {}) => this.request({
|
|
265
|
+
path: `/tenant/pendingApprovals`,
|
|
266
|
+
method: 'GET',
|
|
267
|
+
secure: true,
|
|
268
|
+
format: 'json',
|
|
269
|
+
...params,
|
|
270
|
+
}),
|
|
271
|
+
/**
|
|
272
|
+
* @description Retrieve config for the tenant.
|
|
273
|
+
*
|
|
274
|
+
* @tags Tenant
|
|
275
|
+
* @name ListConfig
|
|
276
|
+
* @summary Get Tenant Config
|
|
277
|
+
* @request GET:/tenant/config
|
|
278
|
+
* @secure
|
|
279
|
+
*/
|
|
280
|
+
listConfig: (params = {}) => this.request({
|
|
281
|
+
path: `/tenant/config`,
|
|
282
|
+
method: 'GET',
|
|
283
|
+
secure: true,
|
|
284
|
+
...params,
|
|
285
|
+
}),
|
|
286
|
+
/**
|
|
287
|
+
* @description Export a report of applications based on the provided filters.
|
|
288
|
+
*
|
|
289
|
+
* @tags Application
|
|
290
|
+
* @name CreateReportApplicationExport
|
|
291
|
+
* @summary Application report
|
|
292
|
+
* @request POST:/tenant/report/applicationExport
|
|
293
|
+
* @secure
|
|
294
|
+
*/
|
|
295
|
+
createReportApplicationExport: (data, params = {}) => this.request({
|
|
296
|
+
path: `/tenant/report/applicationExport`,
|
|
297
|
+
method: 'POST',
|
|
298
|
+
body: data,
|
|
299
|
+
secure: true,
|
|
300
|
+
type: ContentType.Json,
|
|
301
|
+
...params,
|
|
302
|
+
}),
|
|
303
|
+
/**
|
|
304
|
+
* @description Export a report of applications based on the provided filters.
|
|
305
|
+
*
|
|
306
|
+
* @tags Applications
|
|
307
|
+
* @name ListReportApplicationStatus
|
|
308
|
+
* @summary Applications report
|
|
309
|
+
* @request POST:/tenant/report/applicationStatus
|
|
310
|
+
* @secure
|
|
311
|
+
*/
|
|
312
|
+
listReportApplicationStatus: (data, params = {}) => this.request({
|
|
313
|
+
path: `/tenant/report/applicationStatus`,
|
|
314
|
+
method: 'POST',
|
|
315
|
+
body: data,
|
|
316
|
+
secure: true,
|
|
317
|
+
type: ContentType.Json,
|
|
318
|
+
...params,
|
|
319
|
+
}),
|
|
320
|
+
/**
|
|
321
|
+
* @description Export a report of applications based on the provided filters.
|
|
322
|
+
*
|
|
323
|
+
* @tags Applications
|
|
324
|
+
* @name CreateReportApplicationsReport
|
|
325
|
+
* @summary Applications report
|
|
326
|
+
* @request POST:/tenant/report/applicationsReport
|
|
327
|
+
* @secure
|
|
328
|
+
*/
|
|
329
|
+
createReportApplicationsReport: (data, params = {}) => this.request({
|
|
330
|
+
path: `/tenant/report/applicationsReport`,
|
|
331
|
+
method: 'POST',
|
|
332
|
+
body: data,
|
|
333
|
+
secure: true,
|
|
334
|
+
type: ContentType.Json,
|
|
335
|
+
...params,
|
|
336
|
+
}),
|
|
337
|
+
/**
|
|
338
|
+
* @description This route allows you to post certificates email for the tenant.
|
|
339
|
+
*
|
|
340
|
+
* @tags Tenant
|
|
341
|
+
* @name CreateCertificatesEmail
|
|
342
|
+
* @summary Post Certificates Email
|
|
343
|
+
* @request POST:/tenant/certificates/email
|
|
344
|
+
* @secure
|
|
345
|
+
*/
|
|
346
|
+
createCertificatesEmail: (data, params = {}) => this.request({
|
|
347
|
+
path: `/tenant/certificates/email`,
|
|
348
|
+
method: 'POST',
|
|
349
|
+
body: data,
|
|
350
|
+
secure: true,
|
|
351
|
+
type: ContentType.Json,
|
|
352
|
+
...params,
|
|
353
|
+
}),
|
|
354
|
+
/**
|
|
355
|
+
* @description Generate a preview of the completed certifications report.
|
|
356
|
+
*
|
|
357
|
+
* @tags CompletedCertifications
|
|
358
|
+
* @name CreateReportCompletedCertificationsPreview
|
|
359
|
+
* @summary Preview Completed Certifications Report
|
|
360
|
+
* @request POST:/tenant/report/completedCertifications/preview
|
|
361
|
+
* @secure
|
|
362
|
+
*/
|
|
363
|
+
createReportCompletedCertificationsPreview: (query, params = {}) => this.request({
|
|
364
|
+
path: `/tenant/report/completedCertifications/preview`,
|
|
365
|
+
method: 'POST',
|
|
366
|
+
query: query,
|
|
367
|
+
secure: true,
|
|
368
|
+
...params,
|
|
369
|
+
}),
|
|
370
|
+
/**
|
|
371
|
+
* @description Generates the completed certifications report.
|
|
372
|
+
*
|
|
373
|
+
* @tags CompletedCertifications
|
|
374
|
+
* @name ListReportCompletedCertifications
|
|
375
|
+
* @summary Completed Certifications Report
|
|
376
|
+
* @request POST:/tenant/report/completedCertifications
|
|
377
|
+
* @secure
|
|
378
|
+
*/
|
|
379
|
+
listReportCompletedCertifications: (query, params = {}) => this.request({
|
|
380
|
+
path: `/tenant/report/completedCertifications`,
|
|
381
|
+
method: 'POST',
|
|
382
|
+
query: query,
|
|
383
|
+
secure: true,
|
|
384
|
+
...params,
|
|
385
|
+
}),
|
|
386
|
+
/**
|
|
387
|
+
* @description Redeems a license for a user by product ID.
|
|
388
|
+
*
|
|
389
|
+
* @tags License
|
|
390
|
+
* @name CreateLicenseRedeem
|
|
391
|
+
* @summary Redeem a License for a User
|
|
392
|
+
* @request POST:/tenant/license/redeem/{userID}
|
|
393
|
+
* @secure
|
|
394
|
+
*/
|
|
395
|
+
createLicenseRedeem: (userId, data, params = {}) => this.request({
|
|
396
|
+
path: `/tenant/license/redeem/${userId}`,
|
|
397
|
+
method: 'POST',
|
|
398
|
+
body: data,
|
|
399
|
+
secure: true,
|
|
400
|
+
type: ContentType.Json,
|
|
401
|
+
...params,
|
|
402
|
+
}),
|
|
403
|
+
/**
|
|
404
|
+
* @description Generate a of the organization licenses report based on search filters.
|
|
405
|
+
*
|
|
406
|
+
* @tags OrgLicenses
|
|
407
|
+
* @name ListReportOrglicenses
|
|
408
|
+
* @summary Org Licenses Report
|
|
409
|
+
* @request POST:/tenant/report/orglicenses/
|
|
410
|
+
* @secure
|
|
411
|
+
*/
|
|
412
|
+
listReportOrglicenses: (data, params = {}) => this.request({
|
|
413
|
+
path: `/tenant/report/orglicenses/`,
|
|
414
|
+
method: 'POST',
|
|
415
|
+
body: data,
|
|
416
|
+
secure: true,
|
|
417
|
+
type: ContentType.Json,
|
|
418
|
+
...params,
|
|
419
|
+
}),
|
|
420
|
+
/**
|
|
421
|
+
* @description Generate a preview of the organization licenses report based on search filters.
|
|
422
|
+
*
|
|
423
|
+
* @tags OrgLicenses
|
|
424
|
+
* @name CreateReportOrglicensesPreview
|
|
425
|
+
* @summary Preview Org Licenses Report
|
|
426
|
+
* @request POST:/tenant/report/orglicenses/preview
|
|
427
|
+
* @secure
|
|
428
|
+
*/
|
|
429
|
+
createReportOrglicensesPreview: (data, params = {}) => this.request({
|
|
430
|
+
path: `/tenant/report/orglicenses/preview`,
|
|
431
|
+
method: 'POST',
|
|
432
|
+
body: data,
|
|
433
|
+
secure: true,
|
|
434
|
+
type: ContentType.Json,
|
|
435
|
+
...params,
|
|
436
|
+
}),
|
|
437
|
+
/**
|
|
438
|
+
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
439
|
+
*
|
|
440
|
+
* @tags Reports
|
|
441
|
+
* @name CreateReportNcsoReportExport
|
|
442
|
+
* @summary NCSO Export report
|
|
443
|
+
* @request POST:/tenant/report/ncsoReport/export
|
|
444
|
+
* @secure
|
|
445
|
+
*/
|
|
446
|
+
createReportNcsoReportExport: (data, params = {}) => this.request({
|
|
447
|
+
path: `/tenant/report/ncsoReport/export`,
|
|
448
|
+
method: 'POST',
|
|
449
|
+
body: data,
|
|
450
|
+
secure: true,
|
|
451
|
+
type: ContentType.Json,
|
|
452
|
+
format: 'json',
|
|
453
|
+
...params,
|
|
454
|
+
}),
|
|
455
|
+
/**
|
|
456
|
+
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
457
|
+
*
|
|
458
|
+
* @tags Reports
|
|
459
|
+
* @name CreateReportNcsoReport
|
|
460
|
+
* @summary NCSO Export report
|
|
461
|
+
* @request POST:/tenant/report/ncsoReport
|
|
462
|
+
* @secure
|
|
463
|
+
*/
|
|
464
|
+
createReportNcsoReport: (data, params = {}) => this.request({
|
|
465
|
+
path: `/tenant/report/ncsoReport`,
|
|
466
|
+
method: 'POST',
|
|
467
|
+
body: data,
|
|
468
|
+
secure: true,
|
|
469
|
+
type: ContentType.Json,
|
|
470
|
+
format: 'json',
|
|
471
|
+
...params,
|
|
472
|
+
}),
|
|
473
|
+
/**
|
|
474
|
+
* @description Advanced search for users in the tenant by filters, with report generation.
|
|
475
|
+
*
|
|
476
|
+
* @tags Users
|
|
477
|
+
* @name CreateReportUsersAdvanced
|
|
478
|
+
* @summary Advanced report generated by search users from tenant by filters
|
|
479
|
+
* @request POST:/tenant/report/users/advanced
|
|
480
|
+
* @secure
|
|
481
|
+
*/
|
|
482
|
+
createReportUsersAdvanced: (data, params = {}) => this.request({
|
|
483
|
+
path: `/tenant/report/users/advanced`,
|
|
484
|
+
method: 'POST',
|
|
485
|
+
body: data,
|
|
486
|
+
secure: true,
|
|
487
|
+
type: ContentType.Json,
|
|
488
|
+
...params,
|
|
489
|
+
}),
|
|
490
|
+
/**
|
|
491
|
+
* @description Searches for users in the tenant by their IDs.
|
|
492
|
+
*
|
|
493
|
+
* @tags Users
|
|
494
|
+
* @name ListSearchUsersIds
|
|
495
|
+
* @summary Search Users from tenant by IDs
|
|
496
|
+
* @request POST:/tenant/search/users/ids
|
|
497
|
+
* @secure
|
|
498
|
+
*/
|
|
499
|
+
listSearchUsersIds: (data, params = {}) => this.request({
|
|
500
|
+
path: `/tenant/search/users/ids`,
|
|
501
|
+
method: 'POST',
|
|
502
|
+
body: data,
|
|
503
|
+
secure: true,
|
|
504
|
+
type: ContentType.Json,
|
|
505
|
+
...params,
|
|
506
|
+
}),
|
|
507
|
+
/**
|
|
508
|
+
* @description Searches for users in the tenant by term and filters.
|
|
509
|
+
*
|
|
510
|
+
* @tags Users
|
|
511
|
+
* @name CreateSearchUsersTerm
|
|
512
|
+
* @summary Search Users from tenant by term
|
|
513
|
+
* @request POST:/tenant/search/users/term
|
|
514
|
+
* @secure
|
|
515
|
+
*/
|
|
516
|
+
createSearchUsersTerm: (data, params = {}) => this.request({
|
|
517
|
+
path: `/tenant/search/users/term`,
|
|
518
|
+
method: 'POST',
|
|
519
|
+
body: data,
|
|
520
|
+
secure: true,
|
|
521
|
+
type: ContentType.Json,
|
|
522
|
+
...params,
|
|
523
|
+
}),
|
|
524
|
+
/**
|
|
525
|
+
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
526
|
+
*
|
|
527
|
+
* @tags Users
|
|
528
|
+
* @name CreateReportUsersSimple
|
|
529
|
+
* @summary Simple report generated by search users from tenant by term
|
|
530
|
+
* @request POST:/tenant/report/users/simple
|
|
531
|
+
* @secure
|
|
532
|
+
*/
|
|
533
|
+
createReportUsersSimple: (data, params = {}) => this.request({
|
|
534
|
+
path: `/tenant/report/users/simple`,
|
|
535
|
+
method: 'POST',
|
|
536
|
+
body: data,
|
|
537
|
+
secure: true,
|
|
538
|
+
type: ContentType.Json,
|
|
539
|
+
...params,
|
|
540
|
+
}),
|
|
541
|
+
/**
|
|
542
|
+
* @description Retrieve user by ID.
|
|
543
|
+
*
|
|
544
|
+
* @tags User
|
|
545
|
+
* @name CreateSearchUsersCount
|
|
546
|
+
* @summary Retrieve tenant user count
|
|
547
|
+
* @request POST:/tenant/search/users/count
|
|
548
|
+
* @secure
|
|
549
|
+
*/
|
|
550
|
+
createSearchUsersCount: (params = {}) => this.request({
|
|
551
|
+
path: `/tenant/search/users/count`,
|
|
552
|
+
method: 'POST',
|
|
553
|
+
secure: true,
|
|
554
|
+
format: 'json',
|
|
555
|
+
...params,
|
|
556
|
+
}),
|
|
557
|
+
};
|
|
558
|
+
this.user = {
|
|
559
|
+
/**
|
|
560
|
+
* @description This route allows you to acknowledge a pre approval review for a certification application for a user. This is used to acknowledge the decision made during the pre approval review.
|
|
561
|
+
*
|
|
562
|
+
* @tags Application
|
|
563
|
+
* @name CreateCertificationApplicationAcknowledge
|
|
564
|
+
* @summary Acknowledge Certification Application Pre Approval Review
|
|
565
|
+
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/acknowledge
|
|
566
|
+
* @secure
|
|
567
|
+
*/
|
|
568
|
+
createCertificationApplicationAcknowledge: (userId, certProcId, applicationType, params = {}) => this.request({
|
|
569
|
+
path: `/user/${userId}/certification/${certProcId}/application/${applicationType}/acknowledge`,
|
|
570
|
+
method: 'POST',
|
|
571
|
+
secure: true,
|
|
572
|
+
...params,
|
|
573
|
+
}),
|
|
574
|
+
/**
|
|
575
|
+
* @description Delete application item by type.
|
|
576
|
+
*
|
|
577
|
+
* @tags Application
|
|
578
|
+
* @name DeleteCertificationApplicationItem
|
|
579
|
+
* @summary Delete Application Item
|
|
580
|
+
* @request DELETE:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
581
|
+
* @secure
|
|
582
|
+
*/
|
|
583
|
+
deleteCertificationApplicationItem: (userId, certProcId, applicationType, sourceId, params = {}) => this.request({
|
|
584
|
+
path: `/user/${userId}/certification/${certProcId}/application/${applicationType}/item/${sourceId}`,
|
|
585
|
+
method: 'DELETE',
|
|
586
|
+
secure: true,
|
|
587
|
+
...params,
|
|
588
|
+
}),
|
|
589
|
+
/**
|
|
590
|
+
* @description This route allows you to add an item to a certification application for a user.
|
|
591
|
+
*
|
|
592
|
+
* @tags Application
|
|
593
|
+
* @name CreateCertificationApplicationItem
|
|
594
|
+
* @summary Add Application Item
|
|
595
|
+
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
596
|
+
* @secure
|
|
597
|
+
*/
|
|
598
|
+
createCertificationApplicationItem: (userId, certProcId, applicationType, sourceId, data, params = {}) => this.request({
|
|
599
|
+
path: `/user/${userId}/certification/${certProcId}/application/${applicationType}/item/${sourceId}`,
|
|
600
|
+
method: 'POST',
|
|
601
|
+
body: data,
|
|
602
|
+
secure: true,
|
|
603
|
+
type: ContentType.Json,
|
|
604
|
+
...params,
|
|
605
|
+
}),
|
|
606
|
+
/**
|
|
607
|
+
* @description Delete a certification process application by type.
|
|
608
|
+
*
|
|
609
|
+
* @tags Application
|
|
610
|
+
* @name DeleteCertificationApplicationBlacklist
|
|
611
|
+
* @summary Delete Certification Process Application
|
|
612
|
+
* @request DELETE:/user/{userID}/certification/{certProcID}/application/{applicationType}/blacklist/{sourceID}
|
|
613
|
+
* @secure
|
|
614
|
+
*/
|
|
615
|
+
deleteCertificationApplicationBlacklist: (userId, certProcId, applicationType, sourceId, params = {}) => this.request({
|
|
616
|
+
path: `/user/${userId}/certification/${certProcId}/application/${applicationType}/blacklist/${sourceId}`,
|
|
617
|
+
method: 'DELETE',
|
|
618
|
+
secure: true,
|
|
619
|
+
...params,
|
|
620
|
+
}),
|
|
621
|
+
/**
|
|
622
|
+
* @description Delete certification process by user and certproc IDs.
|
|
623
|
+
*
|
|
624
|
+
* @tags Certification
|
|
625
|
+
* @name DeleteCertification
|
|
626
|
+
* @summary Delete Certification Process
|
|
627
|
+
* @request DELETE:/user/{userID}/certification/{certProcID}
|
|
628
|
+
* @secure
|
|
629
|
+
*/
|
|
630
|
+
deleteCertification: (userId, certProcId, params = {}) => this.request({
|
|
631
|
+
path: `/user/${userId}/certification/${certProcId}`,
|
|
632
|
+
method: 'DELETE',
|
|
633
|
+
secure: true,
|
|
634
|
+
...params,
|
|
635
|
+
}),
|
|
636
|
+
/**
|
|
637
|
+
* @description Retrieve course for a user by their user ID.
|
|
638
|
+
*
|
|
639
|
+
* @tags Certification
|
|
640
|
+
* @name GetCertification
|
|
641
|
+
* @summary Get Certification Process for User
|
|
642
|
+
* @request GET:/user/{userID}/certification/{certProcID}
|
|
643
|
+
* @secure
|
|
644
|
+
*/
|
|
645
|
+
getCertification: (userId, certProcId, params = {}) => this.request({
|
|
646
|
+
path: `/user/${userId}/certification/${certProcId}`,
|
|
647
|
+
method: 'GET',
|
|
648
|
+
secure: true,
|
|
649
|
+
format: 'json',
|
|
650
|
+
...params,
|
|
651
|
+
}),
|
|
652
|
+
/**
|
|
653
|
+
* @description This route allows you to start a certification process for a user.
|
|
654
|
+
*
|
|
655
|
+
* @tags Certification
|
|
656
|
+
* @name CreateCertification
|
|
657
|
+
* @summary Start Certification Process
|
|
658
|
+
* @request POST:/user/{userID}/certification/{certProcID}
|
|
659
|
+
* @secure
|
|
660
|
+
*/
|
|
661
|
+
createCertification: (userId, certProcId, params = {}) => this.request({
|
|
662
|
+
path: `/user/${userId}/certification/${certProcId}`,
|
|
663
|
+
method: 'POST',
|
|
664
|
+
secure: true,
|
|
665
|
+
...params,
|
|
666
|
+
}),
|
|
667
|
+
/**
|
|
668
|
+
* @description Delete a certification process application by type.
|
|
669
|
+
*
|
|
670
|
+
* @tags Application
|
|
671
|
+
* @name DeleteCertificationApplication
|
|
672
|
+
* @summary Delete Certification Process Application
|
|
673
|
+
* @request DELETE:/user/{userID}/certification/{certProcID}/application/{applicationType}
|
|
674
|
+
* @secure
|
|
675
|
+
*/
|
|
676
|
+
deleteCertificationApplication: (userId, certProcId, applicationType, params = {}) => this.request({
|
|
677
|
+
path: `/user/${userId}/certification/${certProcId}/application/${applicationType}`,
|
|
678
|
+
method: 'DELETE',
|
|
679
|
+
secure: true,
|
|
680
|
+
...params,
|
|
681
|
+
}),
|
|
682
|
+
/**
|
|
683
|
+
* @description Get certification process application by type.
|
|
684
|
+
*
|
|
685
|
+
* @tags Application
|
|
686
|
+
* @name GetCertificationApplication
|
|
687
|
+
* @summary Get Certification Process
|
|
688
|
+
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}
|
|
689
|
+
* @secure
|
|
690
|
+
*/
|
|
691
|
+
getCertificationApplication: (userId, certProcId, applicationType, params = {}) => this.request({
|
|
692
|
+
path: `/user/${userId}/certification/${certProcId}/application/${applicationType}`,
|
|
693
|
+
method: 'GET',
|
|
694
|
+
secure: true,
|
|
695
|
+
format: 'json',
|
|
696
|
+
...params,
|
|
697
|
+
}),
|
|
698
|
+
/**
|
|
699
|
+
* @description Start certification process application by type.
|
|
700
|
+
*
|
|
701
|
+
* @tags User
|
|
702
|
+
* @name CreateCertificationApplication
|
|
703
|
+
* @summary Start Certification Process Application
|
|
704
|
+
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}
|
|
705
|
+
* @secure
|
|
706
|
+
*/
|
|
707
|
+
createCertificationApplication: (userId, certProcId, applicationType, params = {}) => this.request({
|
|
708
|
+
path: `/user/${userId}/certification/${certProcId}/application/${applicationType}`,
|
|
709
|
+
method: 'POST',
|
|
710
|
+
secure: true,
|
|
711
|
+
...params,
|
|
712
|
+
}),
|
|
713
|
+
/**
|
|
714
|
+
* @description Delete course file for a user by IDs.
|
|
715
|
+
*
|
|
716
|
+
* @tags Course
|
|
717
|
+
* @name DeleteCertificationCourseFileSign
|
|
718
|
+
* @summary Delete Course File
|
|
719
|
+
* @request DELETE:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
720
|
+
* @secure
|
|
721
|
+
*/
|
|
722
|
+
deleteCertificationCourseFileSign: (userId, certProcId, courseId, fileId, params = {}) => this.request({
|
|
723
|
+
path: `/user/${userId}/certification/${certProcId}/course/${courseId}/fileSign/${fileId}`,
|
|
724
|
+
method: 'DELETE',
|
|
725
|
+
secure: true,
|
|
726
|
+
...params,
|
|
727
|
+
}),
|
|
728
|
+
/**
|
|
729
|
+
* @description Retrieve course file for a user by IDs.
|
|
730
|
+
*
|
|
731
|
+
* @tags Course
|
|
732
|
+
* @name GetCertificationCourseFileSign
|
|
733
|
+
* @summary Get Course File
|
|
734
|
+
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
735
|
+
* @secure
|
|
736
|
+
*/
|
|
737
|
+
getCertificationCourseFileSign: (userId, certProcId, courseId, fileId, params = {}) => this.request({
|
|
738
|
+
path: `/user/${userId}/certification/${certProcId}/course/${courseId}/fileSign/${fileId}`,
|
|
739
|
+
method: 'GET',
|
|
740
|
+
secure: true,
|
|
741
|
+
format: 'json',
|
|
742
|
+
...params,
|
|
743
|
+
}),
|
|
744
|
+
/**
|
|
745
|
+
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
746
|
+
*
|
|
747
|
+
* @tags Course
|
|
748
|
+
* @name CreateCertificationCourseFileSign
|
|
749
|
+
* @summary Course file
|
|
750
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
751
|
+
* @secure
|
|
752
|
+
*/
|
|
753
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }, params = {}) => this.request({
|
|
754
|
+
path: `/user/${userId}/certification/${certProcId}/course/${courseId}/fileSign/${fileId}`,
|
|
755
|
+
method: 'POST',
|
|
756
|
+
query: query,
|
|
757
|
+
secure: true,
|
|
758
|
+
format: 'json',
|
|
759
|
+
...params,
|
|
760
|
+
}),
|
|
761
|
+
/**
|
|
762
|
+
* @description Delete submission item (file) for a user in a course by IDs.
|
|
763
|
+
*
|
|
764
|
+
* @tags Course
|
|
765
|
+
* @name DeleteCertificationCourseDocument
|
|
766
|
+
* @summary Delete Submission Item
|
|
767
|
+
* @request DELETE:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
768
|
+
* @secure
|
|
769
|
+
*/
|
|
770
|
+
deleteCertificationCourseDocument: (userId, certProcId, courseId, fileId, params = {}) => this.request({
|
|
771
|
+
path: `/user/${userId}/certification/${certProcId}/course/${courseId}/document/${fileId}`,
|
|
772
|
+
method: 'DELETE',
|
|
773
|
+
secure: true,
|
|
774
|
+
...params,
|
|
775
|
+
}),
|
|
776
|
+
/**
|
|
777
|
+
* @description This route allows you to set or override a course submission item (file) for a user in a specific course.
|
|
778
|
+
*
|
|
779
|
+
* @tags Course
|
|
780
|
+
* @name CreateCertificationCourseDocument
|
|
781
|
+
* @summary Set Course Submission Item
|
|
782
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
783
|
+
* @secure
|
|
784
|
+
*/
|
|
785
|
+
createCertificationCourseDocument: (userId, certProcId, courseId, fileId, data, params = {}) => this.request({
|
|
786
|
+
path: `/user/${userId}/certification/${certProcId}/course/${courseId}/document/${fileId}`,
|
|
787
|
+
method: 'POST',
|
|
788
|
+
body: data,
|
|
789
|
+
secure: true,
|
|
790
|
+
type: ContentType.Json,
|
|
791
|
+
format: 'json',
|
|
792
|
+
...params,
|
|
793
|
+
}),
|
|
794
|
+
/**
|
|
795
|
+
* @description Delete user by ID.
|
|
796
|
+
*
|
|
797
|
+
* @tags User
|
|
798
|
+
* @name DeleteUser
|
|
799
|
+
* @summary Delete User
|
|
800
|
+
* @request DELETE:/user/{userID}
|
|
801
|
+
* @secure
|
|
802
|
+
*/
|
|
803
|
+
deleteUser: (userId, params = {}) => this.request({
|
|
804
|
+
path: `/user/${userId}`,
|
|
805
|
+
method: 'DELETE',
|
|
806
|
+
secure: true,
|
|
807
|
+
...params,
|
|
808
|
+
}),
|
|
809
|
+
/**
|
|
810
|
+
* @description Retrieve user by ID.
|
|
811
|
+
*
|
|
812
|
+
* @tags User
|
|
813
|
+
* @name GetUser
|
|
814
|
+
* @summary Get User
|
|
815
|
+
* @request GET:/user/{userID}
|
|
816
|
+
* @secure
|
|
817
|
+
*/
|
|
818
|
+
getUser: (userId, params = {}) => this.request({
|
|
819
|
+
path: `/user/${userId}`,
|
|
820
|
+
method: 'GET',
|
|
821
|
+
secure: true,
|
|
822
|
+
format: 'json',
|
|
823
|
+
...params,
|
|
824
|
+
}),
|
|
825
|
+
/**
|
|
826
|
+
* @description Create a new user in the system. This endpoint allows you to create a user with the provided details. The user will be added to the database and an email notification will be sent to the user.
|
|
827
|
+
*
|
|
828
|
+
* @tags User
|
|
829
|
+
* @name CreateUser
|
|
830
|
+
* @summary CreateUser
|
|
831
|
+
* @request POST:/user/{userID}
|
|
832
|
+
* @secure
|
|
833
|
+
*/
|
|
834
|
+
createUser: (userId, data, params = {}) => this.request({
|
|
835
|
+
path: `/user/${userId}`,
|
|
836
|
+
method: 'POST',
|
|
837
|
+
body: data,
|
|
838
|
+
secure: true,
|
|
839
|
+
type: ContentType.Json,
|
|
840
|
+
...params,
|
|
841
|
+
}),
|
|
842
|
+
/**
|
|
843
|
+
* @description Update user in the system. This endpoint allows you to update a user with the provided details. The user will be updated to the database and an email notification will be sent to the user.
|
|
844
|
+
*
|
|
845
|
+
* @tags User
|
|
846
|
+
* @name UpdateUser
|
|
847
|
+
* @summary Update User
|
|
848
|
+
* @request PUT:/user/{userID}
|
|
849
|
+
* @secure
|
|
850
|
+
*/
|
|
851
|
+
updateUser: (userId, data, params = {}) => this.request({
|
|
852
|
+
path: `/user/${userId}`,
|
|
853
|
+
method: 'PUT',
|
|
854
|
+
body: data,
|
|
855
|
+
secure: true,
|
|
856
|
+
type: ContentType.Json,
|
|
857
|
+
...params,
|
|
858
|
+
}),
|
|
859
|
+
/**
|
|
860
|
+
* @description Delete course from user
|
|
861
|
+
*
|
|
862
|
+
* @tags User
|
|
863
|
+
* @name DeleteCertificationCourse
|
|
864
|
+
* @summary Delete course from user
|
|
865
|
+
* @request DELETE:/user/{userID}/certification/{certProcID}/course/{courseID}
|
|
866
|
+
* @secure
|
|
867
|
+
*/
|
|
868
|
+
deleteCertificationCourse: (userId, certProcId, courseId, params = {}) => this.request({
|
|
869
|
+
path: `/user/${userId}/certification/${certProcId}/course/${courseId}`,
|
|
870
|
+
method: 'DELETE',
|
|
871
|
+
secure: true,
|
|
872
|
+
...params,
|
|
873
|
+
}),
|
|
874
|
+
/**
|
|
875
|
+
* @description Generate a signed url to download a specific file version of an application item for a user in a certification process.
|
|
876
|
+
*
|
|
877
|
+
* @tags Application
|
|
878
|
+
* @name GetCertificationApplicationItemFile
|
|
879
|
+
* @summary Get Application Item File
|
|
880
|
+
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
881
|
+
* @secure
|
|
882
|
+
*/
|
|
883
|
+
getCertificationApplicationItemFile: (userId, certProcId, sourceId, fileVersion, params = {}) => this.request({
|
|
884
|
+
path: `/user/${userId}/certification/${certProcId}/applicationItem/${sourceId}/file/${fileVersion}`,
|
|
885
|
+
method: 'GET',
|
|
886
|
+
secure: true,
|
|
887
|
+
format: 'json',
|
|
888
|
+
...params,
|
|
889
|
+
}),
|
|
890
|
+
/**
|
|
891
|
+
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
892
|
+
*
|
|
893
|
+
* @tags Application
|
|
894
|
+
* @name CreateCertificationApplicationItemFile
|
|
895
|
+
* @summary Post Application Item File
|
|
896
|
+
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
897
|
+
* @secure
|
|
898
|
+
*/
|
|
899
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }, params = {}) => this.request({
|
|
900
|
+
path: `/user/${userId}/certification/${certProcId}/applicationItem/${sourceId}/file/${fileVersion}`,
|
|
901
|
+
method: 'POST',
|
|
902
|
+
query: query,
|
|
903
|
+
secure: true,
|
|
904
|
+
format: 'json',
|
|
905
|
+
...params,
|
|
906
|
+
}),
|
|
907
|
+
/**
|
|
908
|
+
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
909
|
+
*
|
|
910
|
+
* @tags Course
|
|
911
|
+
* @name GetCertificationCourseSessionCalcCancelationCharges
|
|
912
|
+
* @summary Get cancelation charges
|
|
913
|
+
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
914
|
+
* @secure
|
|
915
|
+
*/
|
|
916
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId, certProcId, courseId, sessionId, params = {}) => this.request({
|
|
917
|
+
path: `/user/${userId}/certification/${certProcId}/course/${courseId}/session/${sessionId}/calcCancelationCharges`,
|
|
918
|
+
method: 'GET',
|
|
919
|
+
secure: true,
|
|
920
|
+
format: 'json',
|
|
921
|
+
...params,
|
|
922
|
+
}),
|
|
923
|
+
/**
|
|
924
|
+
* @description Retrieves the certification processes for a user by their user ID.
|
|
925
|
+
*
|
|
926
|
+
* @tags Certifications
|
|
927
|
+
* @name GetCertifications
|
|
928
|
+
* @summary Certifications for User
|
|
929
|
+
* @request GET:/user/{userID}/certifications
|
|
930
|
+
* @secure
|
|
931
|
+
*/
|
|
932
|
+
getCertifications: (userId, params = {}) => this.request({
|
|
933
|
+
path: `/user/${userId}/certifications`,
|
|
934
|
+
method: 'GET',
|
|
935
|
+
secure: true,
|
|
936
|
+
format: 'json',
|
|
937
|
+
...params,
|
|
938
|
+
}),
|
|
939
|
+
/**
|
|
940
|
+
* @description Retrieve course for a user by their user ID and courseID (cpID::examID).
|
|
941
|
+
*
|
|
942
|
+
* @tags Course
|
|
943
|
+
* @name GetCourse
|
|
944
|
+
* @summary Get Course
|
|
945
|
+
* @request GET:/user/{userID}/course/{courseID}
|
|
946
|
+
* @secure
|
|
947
|
+
*/
|
|
948
|
+
getCourse: (userId, courseId, params = {}) => this.request({
|
|
949
|
+
path: `/user/${userId}/course/${courseId}`,
|
|
950
|
+
method: 'GET',
|
|
951
|
+
secure: true,
|
|
952
|
+
format: 'json',
|
|
953
|
+
...params,
|
|
954
|
+
}),
|
|
955
|
+
/**
|
|
956
|
+
* @description Retrieves the certification processes expanded for a user by their user ID.
|
|
957
|
+
*
|
|
958
|
+
* @tags Certifications
|
|
959
|
+
* @name GetCertificationsExpanded
|
|
960
|
+
* @summary Certifications expanded for User
|
|
961
|
+
* @request GET:/user/{userID}/certifications/expanded
|
|
962
|
+
* @secure
|
|
963
|
+
*/
|
|
964
|
+
getCertificationsExpanded: (userId, params = {}) => this.request({
|
|
965
|
+
path: `/user/${userId}/certifications/expanded`,
|
|
966
|
+
method: 'GET',
|
|
967
|
+
secure: true,
|
|
968
|
+
format: 'json',
|
|
969
|
+
...params,
|
|
970
|
+
}),
|
|
971
|
+
/**
|
|
972
|
+
* @description Get certification process application by type.
|
|
973
|
+
*
|
|
974
|
+
* @tags Application
|
|
975
|
+
* @name GetCertificationApplicationForeignFill
|
|
976
|
+
* @summary Get Certification Process
|
|
977
|
+
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
978
|
+
* @secure
|
|
979
|
+
*/
|
|
980
|
+
getCertificationApplicationForeignFill: (userId, certProcId, applicationType, params = {}) => this.request({
|
|
981
|
+
path: `/user/${userId}/certification/${certProcId}/application/${applicationType}/foreignFill`,
|
|
982
|
+
method: 'GET',
|
|
983
|
+
secure: true,
|
|
984
|
+
format: 'json',
|
|
985
|
+
...params,
|
|
986
|
+
}),
|
|
987
|
+
/**
|
|
988
|
+
* @description This endpoint will print certificate
|
|
989
|
+
*
|
|
990
|
+
* @tags Certification
|
|
991
|
+
* @name GetCertificationPrint
|
|
992
|
+
* @summary Print Certificate
|
|
993
|
+
* @request GET:/user/{userID}/certification/{certProcID}/print
|
|
994
|
+
* @secure
|
|
995
|
+
*/
|
|
996
|
+
getCertificationPrint: (userId, certProcId, params = {}) => this.request({
|
|
997
|
+
path: `/user/${userId}/certification/${certProcId}/print`,
|
|
998
|
+
method: 'GET',
|
|
999
|
+
secure: true,
|
|
1000
|
+
...params,
|
|
1001
|
+
}),
|
|
1002
|
+
/**
|
|
1003
|
+
* @description This endpoint will print course
|
|
1004
|
+
*
|
|
1005
|
+
* @tags Course
|
|
1006
|
+
* @name GetCertificationCoursePrint
|
|
1007
|
+
* @summary Print Course
|
|
1008
|
+
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/print
|
|
1009
|
+
* @secure
|
|
1010
|
+
*/
|
|
1011
|
+
getCertificationCoursePrint: (userId, certProcId, courseId, params = {}) => this.request({
|
|
1012
|
+
path: `/user/${userId}/certification/${certProcId}/course/${courseId}/print`,
|
|
1013
|
+
method: 'GET',
|
|
1014
|
+
secure: true,
|
|
1015
|
+
...params,
|
|
1016
|
+
}),
|
|
1017
|
+
/**
|
|
1018
|
+
* @description Returns the requirement status (e.g. student history) for a given user and source (e.g. course)
|
|
1019
|
+
*
|
|
1020
|
+
* @tags Requirement
|
|
1021
|
+
* @name GetRequirement
|
|
1022
|
+
* @summary Get user requirement status
|
|
1023
|
+
* @request GET:/user/{userID}/requirement/{sourceID}
|
|
1024
|
+
* @secure
|
|
1025
|
+
*/
|
|
1026
|
+
getRequirement: (userId, sourceId, params = {}) => this.request({
|
|
1027
|
+
path: `/user/${userId}/requirement/${sourceId}`,
|
|
1028
|
+
method: 'GET',
|
|
1029
|
+
secure: true,
|
|
1030
|
+
format: 'json',
|
|
1031
|
+
...params,
|
|
1032
|
+
}),
|
|
1033
|
+
/**
|
|
1034
|
+
* @description Retrieves the upcoming courses for a user by their user ID.
|
|
1035
|
+
*
|
|
1036
|
+
* @tags Certifications
|
|
1037
|
+
* @name GetCertificationsUpcomingCourses
|
|
1038
|
+
* @summary Get Upcoming Courses for User
|
|
1039
|
+
* @request GET:/user/{userID}/certifications/upcomingCourses
|
|
1040
|
+
* @secure
|
|
1041
|
+
*/
|
|
1042
|
+
getCertificationsUpcomingCourses: (userId, params = {}) => this.request({
|
|
1043
|
+
path: `/user/${userId}/certifications/upcomingCourses`,
|
|
1044
|
+
method: 'GET',
|
|
1045
|
+
secure: true,
|
|
1046
|
+
format: 'json',
|
|
1047
|
+
...params,
|
|
1048
|
+
}),
|
|
1049
|
+
/**
|
|
1050
|
+
* @description Retrieve user data from IDM including user profile and partition data. Uses API credentials for full read access.
|
|
1051
|
+
*
|
|
1052
|
+
* @tags User
|
|
1053
|
+
* @name GetUserData
|
|
1054
|
+
* @summary Get User Data
|
|
1055
|
+
* @request GET:/user/{userID}/userData
|
|
1056
|
+
* @secure
|
|
1057
|
+
*/
|
|
1058
|
+
getUserData: (userId, params = {}) => this.request({
|
|
1059
|
+
path: `/user/${userId}/userData`,
|
|
1060
|
+
method: 'GET',
|
|
1061
|
+
secure: true,
|
|
1062
|
+
format: 'json',
|
|
1063
|
+
...params,
|
|
1064
|
+
}),
|
|
1065
|
+
/**
|
|
1066
|
+
* @description This route indicates users should not be able to advance or make changes to applications in this certification.
|
|
1067
|
+
*
|
|
1068
|
+
* @tags Application
|
|
1069
|
+
* @name CreateCertificationApplicationLock
|
|
1070
|
+
* @summary Lock Certification Application
|
|
1071
|
+
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
1072
|
+
* @secure
|
|
1073
|
+
*/
|
|
1074
|
+
createCertificationApplicationLock: (userId, certProcId, applicationType, data, params = {}) => this.request({
|
|
1075
|
+
path: `/user/${userId}/certification/${certProcId}/application/${applicationType}/lock`,
|
|
1076
|
+
method: 'POST',
|
|
1077
|
+
body: data,
|
|
1078
|
+
secure: true,
|
|
1079
|
+
type: ContentType.Json,
|
|
1080
|
+
...params,
|
|
1081
|
+
}),
|
|
1082
|
+
/**
|
|
1083
|
+
* @description This endpoint allows you to add a user to a session in a certification process. It requires the user ID, certification process ID, secondary user ID, course ID, and session ID as path parameters.
|
|
1084
|
+
*
|
|
1085
|
+
* @tags User
|
|
1086
|
+
* @name CreateSessionAdd
|
|
1087
|
+
* @summary Add user to session
|
|
1088
|
+
* @request POST:/user/{userID}/session/{sessionID}/add
|
|
1089
|
+
* @secure
|
|
1090
|
+
*/
|
|
1091
|
+
createSessionAdd: (userId, sessionId, params = {}) => this.request({
|
|
1092
|
+
path: `/user/${userId}/session/${sessionId}/add`,
|
|
1093
|
+
method: 'POST',
|
|
1094
|
+
secure: true,
|
|
1095
|
+
...params,
|
|
1096
|
+
}),
|
|
1097
|
+
/**
|
|
1098
|
+
* @description This route allows a user to request pre-approval for an application type in a certification process.
|
|
1099
|
+
*
|
|
1100
|
+
* @tags Application
|
|
1101
|
+
* @name CreateCertificationApplicationPreApproval
|
|
1102
|
+
* @summary Certification Application Pre Approval
|
|
1103
|
+
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApproval
|
|
1104
|
+
* @secure
|
|
1105
|
+
*/
|
|
1106
|
+
createCertificationApplicationPreApproval: (userId, certProcId, applicationType, params = {}) => this.request({
|
|
1107
|
+
path: `/user/${userId}/certification/${certProcId}/application/${applicationType}/preApproval`,
|
|
1108
|
+
method: 'POST',
|
|
1109
|
+
secure: true,
|
|
1110
|
+
...params,
|
|
1111
|
+
}),
|
|
1112
|
+
/**
|
|
1113
|
+
* @description This route allows you to review a certification application for a user.
|
|
1114
|
+
*
|
|
1115
|
+
* @tags Application
|
|
1116
|
+
* @name CreateCertificationApplicationReview
|
|
1117
|
+
* @summary Review Certification Application
|
|
1118
|
+
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
1119
|
+
* @secure
|
|
1120
|
+
*/
|
|
1121
|
+
createCertificationApplicationReview: (userId, certProcId, applicationType, data, params = {}) => this.request({
|
|
1122
|
+
path: `/user/${userId}/certification/${certProcId}/application/${applicationType}/review`,
|
|
1123
|
+
method: 'POST',
|
|
1124
|
+
body: data,
|
|
1125
|
+
secure: true,
|
|
1126
|
+
type: ContentType.Json,
|
|
1127
|
+
...params,
|
|
1128
|
+
}),
|
|
1129
|
+
/**
|
|
1130
|
+
* @description This route allows you to pre approval review a certification application for a user. This is used to review applications before they are submitted for final approval.
|
|
1131
|
+
*
|
|
1132
|
+
* @tags Application
|
|
1133
|
+
* @name CreateCertificationApplicationPreApprovalReview
|
|
1134
|
+
* @summary Pre Approval Review Certification Application
|
|
1135
|
+
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
1136
|
+
* @secure
|
|
1137
|
+
*/
|
|
1138
|
+
createCertificationApplicationPreApprovalReview: (userId, certProcId, applicationType, data, params = {}) => this.request({
|
|
1139
|
+
path: `/user/${userId}/certification/${certProcId}/application/${applicationType}/preApprovalReview`,
|
|
1140
|
+
method: 'POST',
|
|
1141
|
+
body: data,
|
|
1142
|
+
secure: true,
|
|
1143
|
+
type: ContentType.Json,
|
|
1144
|
+
...params,
|
|
1145
|
+
}),
|
|
1146
|
+
/**
|
|
1147
|
+
* @description This endpoint allows the redemption of a batch course for a user in a certification process. It requires the user ID and certification process ID as path parameters, and the course redemption details in the request body.
|
|
1148
|
+
*
|
|
1149
|
+
* @tags Certification
|
|
1150
|
+
* @name CreateCertificationCourseBatchRedeem
|
|
1151
|
+
* @summary Redeem Batch Course for User
|
|
1152
|
+
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
1153
|
+
* @secure
|
|
1154
|
+
*/
|
|
1155
|
+
createCertificationCourseBatchRedeem: (certSpecId, data, params = {}) => this.request({
|
|
1156
|
+
path: `/user/certification/${certSpecId}/course/batchRedeem`,
|
|
1157
|
+
method: 'POST',
|
|
1158
|
+
body: data,
|
|
1159
|
+
secure: true,
|
|
1160
|
+
type: ContentType.Json,
|
|
1161
|
+
...params,
|
|
1162
|
+
}),
|
|
1163
|
+
/**
|
|
1164
|
+
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
1165
|
+
*
|
|
1166
|
+
* @tags Course
|
|
1167
|
+
* @name CreateCertificationCourseBatchInvite
|
|
1168
|
+
* @summary Batch Course Invite
|
|
1169
|
+
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
1170
|
+
* @secure
|
|
1171
|
+
*/
|
|
1172
|
+
createCertificationCourseBatchInvite: (certSpecId, data, params = {}) => this.request({
|
|
1173
|
+
path: `/user/certification/${certSpecId}/course/batchInvite`,
|
|
1174
|
+
method: 'POST',
|
|
1175
|
+
body: data,
|
|
1176
|
+
secure: true,
|
|
1177
|
+
type: ContentType.Json,
|
|
1178
|
+
...params,
|
|
1179
|
+
}),
|
|
1180
|
+
/**
|
|
1181
|
+
* @description This endpoint allows you to cancel a certification enrolment for a user in a specific course session. It requires the user ID, certification process ID, course ID, and session ID as path parameters.
|
|
1182
|
+
*
|
|
1183
|
+
* @tags Certification
|
|
1184
|
+
* @name CreateCertificationCourseSessionCancelEnrol
|
|
1185
|
+
* @summary Cancel Certification Enrolment
|
|
1186
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/cancelEnrol
|
|
1187
|
+
* @secure
|
|
1188
|
+
*/
|
|
1189
|
+
createCertificationCourseSessionCancelEnrol: (userId, certProcId, courseId, sessionId, params = {}) => this.request({
|
|
1190
|
+
path: `/user/${userId}/certification/${certProcId}/course/${courseId}/session/${sessionId}/cancelEnrol`,
|
|
1191
|
+
method: 'POST',
|
|
1192
|
+
secure: true,
|
|
1193
|
+
...params,
|
|
1194
|
+
}),
|
|
1195
|
+
/**
|
|
1196
|
+
* @description This route allows you to renew a certification process for a user. It will change the state of the certification process to "in progress" and reset the expiration date.
|
|
1197
|
+
*
|
|
1198
|
+
* @tags Certification
|
|
1199
|
+
* @name CreateCertificationRenew
|
|
1200
|
+
* @summary Renew Certification Process
|
|
1201
|
+
* @request POST:/user/{userID}/certification/{certProcID}/renew
|
|
1202
|
+
* @secure
|
|
1203
|
+
*/
|
|
1204
|
+
createCertificationRenew: (userId, certProcId, params = {}) => this.request({
|
|
1205
|
+
path: `/user/${userId}/certification/${certProcId}/renew`,
|
|
1206
|
+
method: 'POST',
|
|
1207
|
+
secure: true,
|
|
1208
|
+
...params,
|
|
1209
|
+
}),
|
|
1210
|
+
/**
|
|
1211
|
+
* @description This route allows you to restart a certification process for a user.
|
|
1212
|
+
*
|
|
1213
|
+
* @tags Certification
|
|
1214
|
+
* @name CreateCertificationRestart
|
|
1215
|
+
* @summary Restart Certification Process
|
|
1216
|
+
* @request POST:/user/{userID}/certification/{certProcID}/restart
|
|
1217
|
+
* @secure
|
|
1218
|
+
*/
|
|
1219
|
+
createCertificationRestart: (userId, certProcId, params = {}) => this.request({
|
|
1220
|
+
path: `/user/${userId}/certification/${certProcId}/restart`,
|
|
1221
|
+
method: 'POST',
|
|
1222
|
+
secure: true,
|
|
1223
|
+
...params,
|
|
1224
|
+
}),
|
|
1225
|
+
/**
|
|
1226
|
+
* @description This route allows you to waive a certification process for a user.
|
|
1227
|
+
*
|
|
1228
|
+
* @tags Certification
|
|
1229
|
+
* @name CreateCertificationWaive
|
|
1230
|
+
* @summary Waive Certification Process
|
|
1231
|
+
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
1232
|
+
* @secure
|
|
1233
|
+
*/
|
|
1234
|
+
createCertificationWaive: (userId, certProcId, data, params = {}) => this.request({
|
|
1235
|
+
path: `/user/${userId}/certification/${certProcId}/waive`,
|
|
1236
|
+
method: 'POST',
|
|
1237
|
+
body: data,
|
|
1238
|
+
secure: true,
|
|
1239
|
+
type: ContentType.Json,
|
|
1240
|
+
...params,
|
|
1241
|
+
}),
|
|
1242
|
+
/**
|
|
1243
|
+
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
1244
|
+
*
|
|
1245
|
+
* @tags Certification
|
|
1246
|
+
* @name CreateCertificationMove
|
|
1247
|
+
* @summary Move Certification
|
|
1248
|
+
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
1249
|
+
* @secure
|
|
1250
|
+
*/
|
|
1251
|
+
createCertificationMove: (userId, certProcId, secUserId, params = {}) => this.request({
|
|
1252
|
+
path: `/user/${userId}/certification/${certProcId}/move/${secUserId}`,
|
|
1253
|
+
method: 'POST',
|
|
1254
|
+
secure: true,
|
|
1255
|
+
format: 'json',
|
|
1256
|
+
...params,
|
|
1257
|
+
}),
|
|
1258
|
+
/**
|
|
1259
|
+
* @description This endpoint allows you to replace a certification enrolment for a user in a specific course session. It requires the user ID, certification process ID, secondary user ID, course ID, and session ID as path parameters.
|
|
1260
|
+
*
|
|
1261
|
+
* @tags Certification
|
|
1262
|
+
* @name CreateCertificationCourseSessionReplace
|
|
1263
|
+
* @summary Replace Certification Enrolment
|
|
1264
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/replace/{secUserID}
|
|
1265
|
+
* @secure
|
|
1266
|
+
*/
|
|
1267
|
+
createCertificationCourseSessionReplace: (userId, certProcId, courseId, sessionId, secUserId, params = {}) => this.request({
|
|
1268
|
+
path: `/user/${userId}/certification/${certProcId}/course/${courseId}/session/${sessionId}/replace/${secUserId}`,
|
|
1269
|
+
method: 'POST',
|
|
1270
|
+
secure: true,
|
|
1271
|
+
...params,
|
|
1272
|
+
}),
|
|
1273
|
+
/**
|
|
1274
|
+
* @description This route allows you to set a trigger check for a certification process, such as blocking courses.
|
|
1275
|
+
*
|
|
1276
|
+
* @tags Certification
|
|
1277
|
+
* @name CreateCertificationTriggerCheck
|
|
1278
|
+
* @summary Set trigger check for certification process
|
|
1279
|
+
* @request POST:/user/{userID}/certification/{certProcID}/trigger/check
|
|
1280
|
+
* @secure
|
|
1281
|
+
*/
|
|
1282
|
+
createCertificationTriggerCheck: (userId, certProcId, params = {}) => this.request({
|
|
1283
|
+
path: `/user/${userId}/certification/${certProcId}/trigger/check`,
|
|
1284
|
+
method: 'POST',
|
|
1285
|
+
secure: true,
|
|
1286
|
+
...params,
|
|
1287
|
+
}),
|
|
1288
|
+
/**
|
|
1289
|
+
* @description This route allows you to set a trigger for a certification process, such as blocking courses.
|
|
1290
|
+
*
|
|
1291
|
+
* @tags Certification
|
|
1292
|
+
* @name CreateCertificationTriggerSet
|
|
1293
|
+
* @summary Set trigger for certification process
|
|
1294
|
+
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
1295
|
+
* @secure
|
|
1296
|
+
*/
|
|
1297
|
+
createCertificationTriggerSet: (userId, certProcId, data, params = {}) => this.request({
|
|
1298
|
+
path: `/user/${userId}/certification/${certProcId}/trigger/set`,
|
|
1299
|
+
method: 'POST',
|
|
1300
|
+
body: data,
|
|
1301
|
+
secure: true,
|
|
1302
|
+
type: ContentType.Json,
|
|
1303
|
+
...params,
|
|
1304
|
+
}),
|
|
1305
|
+
/**
|
|
1306
|
+
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
1307
|
+
*
|
|
1308
|
+
* @tags User
|
|
1309
|
+
* @name CreateRefreshOrgMembership
|
|
1310
|
+
* @summary Refresh Organization Membership
|
|
1311
|
+
* @request POST:/user/{userID}/refreshOrgMembership
|
|
1312
|
+
* @secure
|
|
1313
|
+
*/
|
|
1314
|
+
createRefreshOrgMembership: (userId, params = {}) => this.request({
|
|
1315
|
+
path: `/user/${userId}/refreshOrgMembership`,
|
|
1316
|
+
method: 'POST',
|
|
1317
|
+
secure: true,
|
|
1318
|
+
...params,
|
|
1319
|
+
}),
|
|
1320
|
+
/**
|
|
1321
|
+
* @description This route allows you to retake a course for a certification process for a user in a specific course.
|
|
1322
|
+
*
|
|
1323
|
+
* @tags Course
|
|
1324
|
+
* @name CreateCertificationCourseRetake
|
|
1325
|
+
* @summary Retake Course
|
|
1326
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/retake
|
|
1327
|
+
* @secure
|
|
1328
|
+
*/
|
|
1329
|
+
createCertificationCourseRetake: (userId, certProcId, courseId, params = {}) => this.request({
|
|
1330
|
+
path: `/user/${userId}/certification/${certProcId}/course/${courseId}/retake`,
|
|
1331
|
+
method: 'POST',
|
|
1332
|
+
secure: true,
|
|
1333
|
+
...params,
|
|
1334
|
+
}),
|
|
1335
|
+
/**
|
|
1336
|
+
* @description This route allows you to revoke a course for a certification process for a user in a specific course.
|
|
1337
|
+
*
|
|
1338
|
+
* @tags Course
|
|
1339
|
+
* @name CreateCertificationCourseRevoke
|
|
1340
|
+
* @summary Revoke Course
|
|
1341
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/revoke
|
|
1342
|
+
* @secure
|
|
1343
|
+
*/
|
|
1344
|
+
createCertificationCourseRevoke: (userId, certProcId, courseId, params = {}) => this.request({
|
|
1345
|
+
path: `/user/${userId}/certification/${certProcId}/course/${courseId}/revoke`,
|
|
1346
|
+
method: 'POST',
|
|
1347
|
+
secure: true,
|
|
1348
|
+
...params,
|
|
1349
|
+
}),
|
|
1350
|
+
/**
|
|
1351
|
+
* @description Remove a specific version of an application item for a user in a certification process.
|
|
1352
|
+
*
|
|
1353
|
+
* @tags Application
|
|
1354
|
+
* @name CreateCertificationApplicationItemRemove
|
|
1355
|
+
* @summary Remove Application Item
|
|
1356
|
+
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/remove/{itemVersion}
|
|
1357
|
+
* @secure
|
|
1358
|
+
*/
|
|
1359
|
+
createCertificationApplicationItemRemove: (userId, certProcId, sourceId, itemVersion, params = {}) => this.request({
|
|
1360
|
+
path: `/user/${userId}/certification/${certProcId}/applicationItem/${sourceId}/remove/${itemVersion}`,
|
|
1361
|
+
method: 'POST',
|
|
1362
|
+
secure: true,
|
|
1363
|
+
...params,
|
|
1364
|
+
}),
|
|
1365
|
+
/**
|
|
1366
|
+
* @description Remove a specific version of an application item for a user in a certification process.
|
|
1367
|
+
*
|
|
1368
|
+
* @tags Application
|
|
1369
|
+
* @name CreateCertificationApplicationItemReview
|
|
1370
|
+
* @summary Remove Application Item
|
|
1371
|
+
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
1372
|
+
* @secure
|
|
1373
|
+
*/
|
|
1374
|
+
createCertificationApplicationItemReview: (userId, certProcId, sourceId, itemVersion, data, params = {}) => this.request({
|
|
1375
|
+
path: `/user/${userId}/certification/${certProcId}/applicationItem/${sourceId}/review/${itemVersion}`,
|
|
1376
|
+
method: 'POST',
|
|
1377
|
+
body: data,
|
|
1378
|
+
secure: true,
|
|
1379
|
+
type: ContentType.Json,
|
|
1380
|
+
...params,
|
|
1381
|
+
}),
|
|
1382
|
+
/**
|
|
1383
|
+
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
1384
|
+
*
|
|
1385
|
+
* @tags Requirements
|
|
1386
|
+
* @name ListRequirements
|
|
1387
|
+
* @summary User requirements status
|
|
1388
|
+
* @request POST:/user/{userID}/requirements
|
|
1389
|
+
* @secure
|
|
1390
|
+
*/
|
|
1391
|
+
listRequirements: (userId, data, params = {}) => this.request({
|
|
1392
|
+
path: `/user/${userId}/requirements`,
|
|
1393
|
+
method: 'POST',
|
|
1394
|
+
body: data,
|
|
1395
|
+
secure: true,
|
|
1396
|
+
type: ContentType.Json,
|
|
1397
|
+
format: 'json',
|
|
1398
|
+
...params,
|
|
1399
|
+
}),
|
|
1400
|
+
/**
|
|
1401
|
+
* @description Request certification process application submission approval
|
|
1402
|
+
*
|
|
1403
|
+
* @tags Application
|
|
1404
|
+
* @name CreateCertificationApplicationSubmit
|
|
1405
|
+
* @summary Submit Application Approval
|
|
1406
|
+
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
1407
|
+
* @secure
|
|
1408
|
+
*/
|
|
1409
|
+
createCertificationApplicationSubmit: (userId, certProcId, applicationType, data, params = {}) => this.request({
|
|
1410
|
+
path: `/user/${userId}/certification/${certProcId}/application/${applicationType}/submit`,
|
|
1411
|
+
method: 'POST',
|
|
1412
|
+
body: data,
|
|
1413
|
+
secure: true,
|
|
1414
|
+
type: ContentType.Json,
|
|
1415
|
+
...params,
|
|
1416
|
+
}),
|
|
1417
|
+
/**
|
|
1418
|
+
* @description This route allows you to submit a pending approval.
|
|
1419
|
+
*
|
|
1420
|
+
* @tags Course
|
|
1421
|
+
* @name CreateCertificationCoursePendingApproval
|
|
1422
|
+
* @summary Submit Pending Approval
|
|
1423
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
1424
|
+
* @secure
|
|
1425
|
+
*/
|
|
1426
|
+
createCertificationCoursePendingApproval: (userId, certProcId, courseId, paId, data, params = {}) => this.request({
|
|
1427
|
+
path: `/user/${userId}/certification/${certProcId}/course/${courseId}/pendingApproval/${paId}`,
|
|
1428
|
+
method: 'POST',
|
|
1429
|
+
body: data,
|
|
1430
|
+
secure: true,
|
|
1431
|
+
type: ContentType.Json,
|
|
1432
|
+
...params,
|
|
1433
|
+
}),
|
|
1434
|
+
/**
|
|
1435
|
+
* @description This route allows you to review a pending approval.
|
|
1436
|
+
*
|
|
1437
|
+
* @tags Course
|
|
1438
|
+
* @name UpdateCertificationCoursePendingApproval
|
|
1439
|
+
* @summary Review Pending Approval
|
|
1440
|
+
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
1441
|
+
* @secure
|
|
1442
|
+
*/
|
|
1443
|
+
updateCertificationCoursePendingApproval: (userId, certProcId, courseId, paId, data, params = {}) => this.request({
|
|
1444
|
+
path: `/user/${userId}/certification/${certProcId}/course/${courseId}/pendingApproval/${paId}`,
|
|
1445
|
+
method: 'PUT',
|
|
1446
|
+
body: data,
|
|
1447
|
+
secure: true,
|
|
1448
|
+
type: ContentType.Json,
|
|
1449
|
+
...params,
|
|
1450
|
+
}),
|
|
1451
|
+
/**
|
|
1452
|
+
* @description Redeems a license for a user by product ID.
|
|
1453
|
+
*
|
|
1454
|
+
* @tags License
|
|
1455
|
+
* @name CreateCertificationCourseRedeem
|
|
1456
|
+
* @summary Redeem a License for a User
|
|
1457
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
1458
|
+
* @secure
|
|
1459
|
+
*/
|
|
1460
|
+
createCertificationCourseRedeem: (userId, certProcId, data, params = {}) => this.request({
|
|
1461
|
+
path: `/user/${userId}/certification/${certProcId}/course/redeem`,
|
|
1462
|
+
method: 'POST',
|
|
1463
|
+
body: data,
|
|
1464
|
+
secure: true,
|
|
1465
|
+
type: ContentType.Json,
|
|
1466
|
+
...params,
|
|
1467
|
+
}),
|
|
1468
|
+
/**
|
|
1469
|
+
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
1470
|
+
*
|
|
1471
|
+
* @tags Certification
|
|
1472
|
+
* @name CreateCertificationMoveValidate
|
|
1473
|
+
* @summary Validate Certification Move
|
|
1474
|
+
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
1475
|
+
* @secure
|
|
1476
|
+
*/
|
|
1477
|
+
createCertificationMoveValidate: (userId, certProcId, secUserId, params = {}) => this.request({
|
|
1478
|
+
path: `/user/${userId}/certification/${certProcId}/move/${secUserId}/validate`,
|
|
1479
|
+
method: 'POST',
|
|
1480
|
+
secure: true,
|
|
1481
|
+
format: 'json',
|
|
1482
|
+
...params,
|
|
1483
|
+
}),
|
|
1484
|
+
/**
|
|
1485
|
+
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
1486
|
+
*
|
|
1487
|
+
* @tags Course
|
|
1488
|
+
* @name CreateCertificationCourseEndCooldown
|
|
1489
|
+
* @summary End Course Cooldown
|
|
1490
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
1491
|
+
* @secure
|
|
1492
|
+
*/
|
|
1493
|
+
createCertificationCourseEndCooldown: (userId, certProcId, courseId, data, params = {}) => this.request({
|
|
1494
|
+
path: `/user/${userId}/certification/${certProcId}/course/${courseId}/endCooldown`,
|
|
1495
|
+
method: 'POST',
|
|
1496
|
+
body: data,
|
|
1497
|
+
secure: true,
|
|
1498
|
+
type: ContentType.Json,
|
|
1499
|
+
...params,
|
|
1500
|
+
}),
|
|
1501
|
+
/**
|
|
1502
|
+
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
1503
|
+
*
|
|
1504
|
+
* @tags Course
|
|
1505
|
+
* @name CreateCertificationCourseUnlockCourse
|
|
1506
|
+
* @summary Unlock Course
|
|
1507
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
1508
|
+
* @secure
|
|
1509
|
+
*/
|
|
1510
|
+
createCertificationCourseUnlockCourse: (userId, certProcId, courseId, data, params = {}) => this.request({
|
|
1511
|
+
path: `/user/${userId}/certification/${certProcId}/course/${courseId}/unlockCourse`,
|
|
1512
|
+
method: 'POST',
|
|
1513
|
+
body: data,
|
|
1514
|
+
secure: true,
|
|
1515
|
+
type: ContentType.Json,
|
|
1516
|
+
...params,
|
|
1517
|
+
}),
|
|
1518
|
+
/**
|
|
1519
|
+
* @description This endpoint allows updating the ITA number for a user. It requires the user ID as a path parameter and the new ITA number in the request body.
|
|
1520
|
+
*
|
|
1521
|
+
* @tags User
|
|
1522
|
+
* @name CreateUpdateIta
|
|
1523
|
+
* @summary Update User ITA Number
|
|
1524
|
+
* @request POST:/user/{userID}/updateITA
|
|
1525
|
+
* @secure
|
|
1526
|
+
*/
|
|
1527
|
+
createUpdateIta: (userId, data, params = {}) => this.request({
|
|
1528
|
+
path: `/user/${userId}/updateITA`,
|
|
1529
|
+
method: 'POST',
|
|
1530
|
+
body: data,
|
|
1531
|
+
secure: true,
|
|
1532
|
+
type: ContentType.Json,
|
|
1533
|
+
...params,
|
|
1534
|
+
}),
|
|
1535
|
+
/**
|
|
1536
|
+
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
1537
|
+
*
|
|
1538
|
+
* @tags Course
|
|
1539
|
+
* @name UpdateCertificationCourseOverrideResult
|
|
1540
|
+
* @summary Override Course Result
|
|
1541
|
+
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
1542
|
+
* @secure
|
|
1543
|
+
*/
|
|
1544
|
+
updateCertificationCourseOverrideResult: (userId, certProcId, courseId, data, params = {}) => this.request({
|
|
1545
|
+
path: `/user/${userId}/certification/${certProcId}/course/${courseId}/overrideResult`,
|
|
1546
|
+
method: 'PUT',
|
|
1547
|
+
body: data,
|
|
1548
|
+
secure: true,
|
|
1549
|
+
type: ContentType.Json,
|
|
1550
|
+
...params,
|
|
1551
|
+
}),
|
|
1552
|
+
/**
|
|
1553
|
+
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
1554
|
+
*
|
|
1555
|
+
* @tags Certification
|
|
1556
|
+
* @name UpdateCertificationSetDates
|
|
1557
|
+
* @summary Set Certification Dates
|
|
1558
|
+
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
1559
|
+
* @secure
|
|
1560
|
+
*/
|
|
1561
|
+
updateCertificationSetDates: (userId, certProcId, data, params = {}) => this.request({
|
|
1562
|
+
path: `/user/${userId}/certification/${certProcId}/setDates`,
|
|
1563
|
+
method: 'PUT',
|
|
1564
|
+
body: data,
|
|
1565
|
+
secure: true,
|
|
1566
|
+
type: ContentType.Json,
|
|
1567
|
+
...params,
|
|
1568
|
+
}),
|
|
1569
|
+
/**
|
|
1570
|
+
* @description This route allows you to publish certification information to a LMS event bus.
|
|
1571
|
+
*
|
|
1572
|
+
* @tags Certification
|
|
1573
|
+
* @name CreateCertificationPublishInfo
|
|
1574
|
+
* @summary Publish certification information to LMS event bus
|
|
1575
|
+
* @request POST:/user/{userID}/certification/{certProcID}/publishInfo
|
|
1576
|
+
* @secure
|
|
1577
|
+
*/
|
|
1578
|
+
createCertificationPublishInfo: (userId, certProcId, params = {}) => this.request({
|
|
1579
|
+
path: `/user/${userId}/certification/${certProcId}/publishInfo`,
|
|
1580
|
+
method: 'POST',
|
|
1581
|
+
secure: true,
|
|
1582
|
+
...params,
|
|
1583
|
+
}),
|
|
1584
|
+
};
|
|
1585
|
+
this.users = {
|
|
1586
|
+
/**
|
|
1587
|
+
* @description Searches for users by their certification specifications.
|
|
1588
|
+
*
|
|
1589
|
+
* @tags Users
|
|
1590
|
+
* @name CreateCertification
|
|
1591
|
+
* @summary Search Users by Certification
|
|
1592
|
+
* @request POST:/users/certification/{certSpecID}
|
|
1593
|
+
* @secure
|
|
1594
|
+
*/
|
|
1595
|
+
createCertification: (certSpecId, data, params = {}) => this.request({
|
|
1596
|
+
path: `/users/certification/${certSpecId}`,
|
|
1597
|
+
method: 'POST',
|
|
1598
|
+
body: data,
|
|
1599
|
+
secure: true,
|
|
1600
|
+
type: ContentType.Json,
|
|
1601
|
+
format: 'json',
|
|
1602
|
+
...params,
|
|
1603
|
+
}),
|
|
1604
|
+
/**
|
|
1605
|
+
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
1606
|
+
*
|
|
1607
|
+
* @tags Users
|
|
1608
|
+
* @name CreateCertificationPublishInfo
|
|
1609
|
+
* @summary Publish Certification Information
|
|
1610
|
+
* @request POST:/users/certification/{certSpecID}/publishInfo
|
|
1611
|
+
* @secure
|
|
1612
|
+
*/
|
|
1613
|
+
createCertificationPublishInfo: (certSpecId, params = {}) => this.request({
|
|
1614
|
+
path: `/users/certification/${certSpecId}/publishInfo`,
|
|
1615
|
+
method: 'POST',
|
|
1616
|
+
secure: true,
|
|
1617
|
+
...params,
|
|
1618
|
+
}),
|
|
1619
|
+
};
|
|
1620
|
+
}
|
|
1621
|
+
}
|
|
1622
|
+
exports.Api = Api;
|
|
1623
|
+
//# sourceMappingURL=Api.js.map
|