@ikonintegration/bccsa-program-api 3.0.17 → 3.0.19

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