@ikonintegration/bccsa-program-api 3.0.23 → 3.0.25
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 +151 -98
- package/dist/Api.d.ts +148 -102
- package/dist/Api.js +23 -8
- package/dist/Api.js.map +1 -1
- package/package.json +2 -2
- package/tsconfig.json +3 -2
package/dist/Api.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ export interface ErrorResponse {
|
|
|
5
5
|
/** Error code */
|
|
6
6
|
errCode: string;
|
|
7
7
|
}
|
|
8
|
-
export interface
|
|
8
|
+
export interface Input39Efkhxkou {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -232,6 +232,10 @@ export interface UserResponseEntity {
|
|
|
232
232
|
waivedOn?: WaivedOn;
|
|
233
233
|
/** Justifications for overridden course restrictions */
|
|
234
234
|
overwrittenJustification?: OverwrittenJustification;
|
|
235
|
+
/** ID of the user who revoked the course */
|
|
236
|
+
revokedByID?: RevokedByID;
|
|
237
|
+
/** Display name of the user who revoked the course */
|
|
238
|
+
revokedByName?: RevokedByName;
|
|
235
239
|
}[];
|
|
236
240
|
};
|
|
237
241
|
transactionID?: string | null;
|
|
@@ -320,6 +324,10 @@ export interface OverwrittenJustification {
|
|
|
320
324
|
cooldown_override?: string;
|
|
321
325
|
course_unlock?: string;
|
|
322
326
|
}
|
|
327
|
+
/** ID of the user who revoked the course */
|
|
328
|
+
export type RevokedByID = string;
|
|
329
|
+
/** Display name of the user who revoked the course */
|
|
330
|
+
export type RevokedByName = string;
|
|
323
331
|
/** Response schema for applications */
|
|
324
332
|
export interface ApplicationResponseSchema {
|
|
325
333
|
applications: {
|
|
@@ -419,8 +427,18 @@ export interface PendingApprovalResponseSchema {
|
|
|
419
427
|
courseID?: CourseID;
|
|
420
428
|
/** User display name */
|
|
421
429
|
displayName?: DisplayName;
|
|
430
|
+
/** Email address of the user who submitted the pending approval */
|
|
431
|
+
email?: Email;
|
|
422
432
|
/** List of submitted files for approval */
|
|
423
433
|
submissionItems?: SubmissionItems;
|
|
434
|
+
/** Current review state of the request (PENDING, APPROVED, REJECTED) */
|
|
435
|
+
approvalState?: ApprovalState;
|
|
436
|
+
/** Notes entered by the admin during approval/rejection */
|
|
437
|
+
approvalNotes?: ApprovalNotes;
|
|
438
|
+
/** User ID of the admin that reviewed the request */
|
|
439
|
+
reviewedBy?: ReviewedBy;
|
|
440
|
+
/** Timestamp of the review */
|
|
441
|
+
reviewedOn?: ReviewedOn;
|
|
424
442
|
}[] | null;
|
|
425
443
|
}
|
|
426
444
|
/** Timestamp when the entry was last updated */
|
|
@@ -431,7 +449,9 @@ export type Name = string;
|
|
|
431
449
|
export type CertTitle = string;
|
|
432
450
|
/** User display name */
|
|
433
451
|
export type DisplayName = string;
|
|
434
|
-
|
|
452
|
+
/** Email address of the user who submitted the pending approval */
|
|
453
|
+
export type Email = string;
|
|
454
|
+
export interface InputL5Mafsqfat {
|
|
435
455
|
/**
|
|
436
456
|
* ID of the certification to filter applications by
|
|
437
457
|
* @example "certification123"
|
|
@@ -488,7 +508,7 @@ export interface InputU4C3V4De8Hg {
|
|
|
488
508
|
*/
|
|
489
509
|
ignoreCompletedCertifications?: boolean | null;
|
|
490
510
|
}
|
|
491
|
-
export interface
|
|
511
|
+
export interface InputF4Q99Ghr8W {
|
|
492
512
|
/**
|
|
493
513
|
* ID of the certification to filter applications by
|
|
494
514
|
* @example "certification123"
|
|
@@ -545,7 +565,7 @@ export interface InputVsl3M1Bf02 {
|
|
|
545
565
|
*/
|
|
546
566
|
ignoreCompletedCertifications?: boolean | null;
|
|
547
567
|
}
|
|
548
|
-
export interface
|
|
568
|
+
export interface Input51Kql6P0Xu {
|
|
549
569
|
/**
|
|
550
570
|
* ID of the certification to filter applications by
|
|
551
571
|
* @example "certification123"
|
|
@@ -602,7 +622,7 @@ export interface InputQtxygdy6Sp {
|
|
|
602
622
|
*/
|
|
603
623
|
ignoreCompletedCertifications?: boolean | null;
|
|
604
624
|
}
|
|
605
|
-
export interface
|
|
625
|
+
export interface Input2T5Dq39Ke9 {
|
|
606
626
|
/**
|
|
607
627
|
* The ID of the certificate specifications to be used for the email
|
|
608
628
|
* @example "certSpecsID123"
|
|
@@ -643,7 +663,7 @@ export interface InputW7Byz2Y6Du {
|
|
|
643
663
|
emailAddress: string;
|
|
644
664
|
}[];
|
|
645
665
|
}
|
|
646
|
-
export interface
|
|
666
|
+
export interface InputCryywuj0K5 {
|
|
647
667
|
/**
|
|
648
668
|
* The ID of the product for which the license is being redeemed
|
|
649
669
|
* @example "productID123"
|
|
@@ -655,7 +675,7 @@ export interface Input72I12Ohjlb {
|
|
|
655
675
|
*/
|
|
656
676
|
sessionID?: string;
|
|
657
677
|
}
|
|
658
|
-
export interface
|
|
678
|
+
export interface Input7Fm6Ar6Ikc {
|
|
659
679
|
/**
|
|
660
680
|
* Search term to filter licenses
|
|
661
681
|
* @example "active"
|
|
@@ -672,7 +692,7 @@ export interface Input9X53Pc16Nx {
|
|
|
672
692
|
*/
|
|
673
693
|
sortField?: any;
|
|
674
694
|
}
|
|
675
|
-
export interface
|
|
695
|
+
export interface InputAeyuq9T9Ag {
|
|
676
696
|
/**
|
|
677
697
|
* Search term to filter licenses
|
|
678
698
|
* @example "active"
|
|
@@ -728,7 +748,7 @@ export interface ReportXLSXSchema {
|
|
|
728
748
|
xlsxStream: File;
|
|
729
749
|
contentType: ReportXlsxSchemaContentTypeEnum;
|
|
730
750
|
}
|
|
731
|
-
export interface
|
|
751
|
+
export interface Input4O1N8Cqdn6J {
|
|
732
752
|
/**
|
|
733
753
|
* Start date for the report
|
|
734
754
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -750,11 +770,11 @@ export interface InputF7Vlnyefnb {
|
|
|
750
770
|
*/
|
|
751
771
|
dateType?: string;
|
|
752
772
|
}
|
|
753
|
-
export interface
|
|
773
|
+
export interface InputEejfjazx8Gi {
|
|
754
774
|
/** List of user IDs to search for in the tenant. */
|
|
755
775
|
IDs: (string | null)[];
|
|
756
776
|
}
|
|
757
|
-
export interface
|
|
777
|
+
export interface Input4Bmr5Tztvtf {
|
|
758
778
|
/** The term to search for in the user profiles. */
|
|
759
779
|
searchTerm?: string | null;
|
|
760
780
|
/** Filter criteria for the user search. */
|
|
@@ -794,7 +814,7 @@ export interface Input6Eq5Uhd3Vt {
|
|
|
794
814
|
};
|
|
795
815
|
};
|
|
796
816
|
}
|
|
797
|
-
export interface
|
|
817
|
+
export interface Input14Wsadu67R {
|
|
798
818
|
/** The term to search for in the user profiles. */
|
|
799
819
|
searchTerm?: string | null;
|
|
800
820
|
/** Filter criteria for the user search. */
|
|
@@ -834,21 +854,21 @@ export interface InputMwks4Uarfm {
|
|
|
834
854
|
};
|
|
835
855
|
};
|
|
836
856
|
}
|
|
837
|
-
export interface
|
|
857
|
+
export interface Output5Av211Zxuf {
|
|
838
858
|
/** External system ID 2 */
|
|
839
859
|
userCount: ExternalID2;
|
|
840
860
|
transactionID?: string | null;
|
|
841
861
|
}
|
|
842
862
|
/** External system ID 2 */
|
|
843
863
|
export type ExternalID2 = number;
|
|
844
|
-
export interface
|
|
864
|
+
export interface OutputZok71Yo152 {
|
|
845
865
|
/**
|
|
846
866
|
* Signed URL for the course file
|
|
847
867
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
848
868
|
*/
|
|
849
869
|
fileURL: string;
|
|
850
870
|
}
|
|
851
|
-
export interface
|
|
871
|
+
export interface OutputLuus5Iz0Upf {
|
|
852
872
|
/**
|
|
853
873
|
* Amount to be refunded for the cancellation
|
|
854
874
|
* @example 0
|
|
@@ -947,6 +967,11 @@ export interface CertificationProcessResponseSchema {
|
|
|
947
967
|
expireReminders?: ExpireReminders;
|
|
948
968
|
/** Status information for trigger states (e.g., NEW, RENEW) */
|
|
949
969
|
triggerState?: TriggerState;
|
|
970
|
+
/**
|
|
971
|
+
* Pending approval state per course. Keys are course spec IDs of courses in the certification, values are the approval state for that course (e.g. PENDING, APPROVED, REJECTED).
|
|
972
|
+
* @example {"course001":"PENDING","course002":"APPROVED"}
|
|
973
|
+
*/
|
|
974
|
+
paState?: Record<string, any>;
|
|
950
975
|
/** Amount to be paid as commission */
|
|
951
976
|
commissionAmount?: CommissionAmount;
|
|
952
977
|
/** Recipient of the commission payment */
|
|
@@ -1136,10 +1161,14 @@ export interface CourseResponseEntity {
|
|
|
1136
1161
|
onlineCourseLabel?: OnlineCourseLabel;
|
|
1137
1162
|
/** Justifications for overridden course restrictions */
|
|
1138
1163
|
overwrittenJustification?: OverwrittenJustification;
|
|
1164
|
+
/** ID of the user who revoked the course */
|
|
1165
|
+
revokedByID?: RevokedByID;
|
|
1166
|
+
/** Display name of the user who revoked the course */
|
|
1167
|
+
revokedByName?: RevokedByName;
|
|
1139
1168
|
}
|
|
1140
1169
|
/** Label of the course enrolled (course version) */
|
|
1141
1170
|
export type OnlineCourseLabel = string;
|
|
1142
|
-
export interface
|
|
1171
|
+
export interface OutputA30Zrdq4Ou {
|
|
1143
1172
|
/**
|
|
1144
1173
|
* Signed URL for the course file
|
|
1145
1174
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
@@ -1157,7 +1186,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1157
1186
|
transactionID?: string | null;
|
|
1158
1187
|
}
|
|
1159
1188
|
/** Application Foreign Fill response type */
|
|
1160
|
-
export interface
|
|
1189
|
+
export interface OutputF702E2U459J {
|
|
1161
1190
|
items: {
|
|
1162
1191
|
userID: string;
|
|
1163
1192
|
createdOn?: number;
|
|
@@ -1304,6 +1333,11 @@ export interface CertificationProcessResponseEntity {
|
|
|
1304
1333
|
/** @example "OK" */
|
|
1305
1334
|
requestResult?: any;
|
|
1306
1335
|
}>;
|
|
1336
|
+
/**
|
|
1337
|
+
* Pending approval state per course. Keys are course spec IDs of courses in the certification, values are the approval state for that course (e.g. PENDING, APPROVED, REJECTED).
|
|
1338
|
+
* @example {"course001":"PENDING","course002":"APPROVED"}
|
|
1339
|
+
*/
|
|
1340
|
+
paState?: Record<string, any>;
|
|
1307
1341
|
/** @example 85 */
|
|
1308
1342
|
pointsAchieved?: number;
|
|
1309
1343
|
/** @example ["email1","email2"] */
|
|
@@ -1340,7 +1374,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1340
1374
|
applicationItems?: Record<string, any>[];
|
|
1341
1375
|
transactionID?: string | null;
|
|
1342
1376
|
}
|
|
1343
|
-
export interface
|
|
1377
|
+
export interface InputCbpydyfecl {
|
|
1344
1378
|
issuedOn?: number;
|
|
1345
1379
|
expiresOn?: number;
|
|
1346
1380
|
fileItems?: {
|
|
@@ -1349,21 +1383,21 @@ export interface Input69Xz46Fwmt {
|
|
|
1349
1383
|
}[];
|
|
1350
1384
|
additionalNotes?: string | null;
|
|
1351
1385
|
}
|
|
1352
|
-
export interface
|
|
1386
|
+
export interface InputI9Jj0Rnbnu {
|
|
1353
1387
|
/**
|
|
1354
1388
|
* Indicates whether the application is locked
|
|
1355
1389
|
* @example true
|
|
1356
1390
|
*/
|
|
1357
1391
|
isApplicationLocked: boolean;
|
|
1358
1392
|
}
|
|
1359
|
-
export interface
|
|
1393
|
+
export interface OutputQ33S4Fo2Ej {
|
|
1360
1394
|
/**
|
|
1361
1395
|
* Signed URL for the course file
|
|
1362
1396
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
1363
1397
|
*/
|
|
1364
1398
|
fileURL: string;
|
|
1365
1399
|
}
|
|
1366
|
-
export interface
|
|
1400
|
+
export interface InputKg4Xkqwj57 {
|
|
1367
1401
|
/**
|
|
1368
1402
|
* Indicates whether the waiver is approved
|
|
1369
1403
|
* @example true
|
|
@@ -1375,14 +1409,14 @@ export interface InputSucbklla9Yk {
|
|
|
1375
1409
|
*/
|
|
1376
1410
|
additionalNotes?: string | null;
|
|
1377
1411
|
}
|
|
1378
|
-
export interface
|
|
1412
|
+
export interface InputQ92Kr2Vptg {
|
|
1379
1413
|
/**
|
|
1380
1414
|
* Optional notes regarding the waiver
|
|
1381
1415
|
* @example "Waiver granted due to special circumstances."
|
|
1382
1416
|
*/
|
|
1383
1417
|
additionalNotes?: string | null;
|
|
1384
1418
|
}
|
|
1385
|
-
export interface
|
|
1419
|
+
export interface InputM6R3Wh6Pxz {
|
|
1386
1420
|
students: {
|
|
1387
1421
|
/**
|
|
1388
1422
|
* User ID of the student to redeem the course for
|
|
@@ -1416,7 +1450,7 @@ export interface InputDhlgnq7Qbrg {
|
|
|
1416
1450
|
*/
|
|
1417
1451
|
autoEnrolSessionID?: string;
|
|
1418
1452
|
}
|
|
1419
|
-
export interface
|
|
1453
|
+
export interface InputVsn945Yctpi {
|
|
1420
1454
|
invites: {
|
|
1421
1455
|
/**
|
|
1422
1456
|
* Email address of the user to invite
|
|
@@ -1445,7 +1479,7 @@ export interface Input9Fuob5H5Gu {
|
|
|
1445
1479
|
*/
|
|
1446
1480
|
isReservedSeat: boolean;
|
|
1447
1481
|
}
|
|
1448
|
-
export interface
|
|
1482
|
+
export interface Input3Zzy8W1Fuh {
|
|
1449
1483
|
/**
|
|
1450
1484
|
* Indicates whether to waive the certification process
|
|
1451
1485
|
* @example true
|
|
@@ -1458,7 +1492,7 @@ export interface InputHncfz63Fiwk {
|
|
|
1458
1492
|
comments?: string | null;
|
|
1459
1493
|
}
|
|
1460
1494
|
/** Certification move response schema */
|
|
1461
|
-
export interface
|
|
1495
|
+
export interface OutputAiche6Pi4W {
|
|
1462
1496
|
errors?: {
|
|
1463
1497
|
status: string;
|
|
1464
1498
|
object?: Record<string, any>;
|
|
@@ -1466,19 +1500,19 @@ export interface OutputQssne1Jk1X {
|
|
|
1466
1500
|
}[];
|
|
1467
1501
|
}
|
|
1468
1502
|
/** Schema for writing a certification trigger check. */
|
|
1469
|
-
export interface
|
|
1503
|
+
export interface Input1N2M6Fqym9 {
|
|
1470
1504
|
/**
|
|
1471
1505
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1472
1506
|
* @example "CHECKED"
|
|
1473
1507
|
*/
|
|
1474
|
-
value:
|
|
1508
|
+
value: Input1N2M6Fqym9ValueEnum;
|
|
1475
1509
|
/**
|
|
1476
1510
|
* List of course IDs that are blocked by this trigger check.
|
|
1477
1511
|
* @example ["course1","course2"]
|
|
1478
1512
|
*/
|
|
1479
1513
|
blockedCourses?: string[];
|
|
1480
1514
|
}
|
|
1481
|
-
export interface
|
|
1515
|
+
export interface InputT1Po2Bcy2H {
|
|
1482
1516
|
/**
|
|
1483
1517
|
* Indicates whether the application item is approved
|
|
1484
1518
|
* @example true
|
|
@@ -1504,7 +1538,7 @@ export interface InputH4M4Vr7Xm2L {
|
|
|
1504
1538
|
export interface StudentHistoryRequestSchema {
|
|
1505
1539
|
requirements: string[];
|
|
1506
1540
|
}
|
|
1507
|
-
export interface
|
|
1541
|
+
export interface InputIhqbjgfwmwf {
|
|
1508
1542
|
/**
|
|
1509
1543
|
* Optional activation key for the application
|
|
1510
1544
|
* @example "AK-123456"
|
|
@@ -1512,7 +1546,7 @@ export interface InputOzrwgtx1Z2 {
|
|
|
1512
1546
|
activationKey?: string;
|
|
1513
1547
|
}
|
|
1514
1548
|
/** Schema for course submission item details post request. */
|
|
1515
|
-
export interface
|
|
1549
|
+
export interface InputNkt1M0Sigg {
|
|
1516
1550
|
/**
|
|
1517
1551
|
* The ID of the file being submitted.
|
|
1518
1552
|
* @example "fileID123"
|
|
@@ -1525,7 +1559,7 @@ export interface InputRa49Ugtgj {
|
|
|
1525
1559
|
fileName: string;
|
|
1526
1560
|
}
|
|
1527
1561
|
/** Schema for the response to course submission item details post request. */
|
|
1528
|
-
export interface
|
|
1562
|
+
export interface OutputNkt1M0Sigg {
|
|
1529
1563
|
submissionItems: {
|
|
1530
1564
|
/**
|
|
1531
1565
|
* The ID of the file being submitted.
|
|
@@ -1540,7 +1574,7 @@ export interface OutputRa49Ugtgj {
|
|
|
1540
1574
|
}[];
|
|
1541
1575
|
}
|
|
1542
1576
|
/** Pending approval submission parameters */
|
|
1543
|
-
export interface
|
|
1577
|
+
export interface InputSkwo64Irm8 {
|
|
1544
1578
|
/**
|
|
1545
1579
|
* Type of pending approval
|
|
1546
1580
|
* @example "certification"
|
|
@@ -1560,7 +1594,7 @@ export interface Input7Xiplwv8Cr {
|
|
|
1560
1594
|
fileName: string;
|
|
1561
1595
|
}[];
|
|
1562
1596
|
}
|
|
1563
|
-
export interface
|
|
1597
|
+
export interface InputGjqi82Rf9D {
|
|
1564
1598
|
/**
|
|
1565
1599
|
* The ID of the course for which the license is being redeemed
|
|
1566
1600
|
* @example "courseID123"
|
|
@@ -1628,7 +1662,7 @@ export interface Input8Uqmgsj643 {
|
|
|
1628
1662
|
acknowledgement?: string | null;
|
|
1629
1663
|
}
|
|
1630
1664
|
/** Validate certification move response schema */
|
|
1631
|
-
export interface
|
|
1665
|
+
export interface OutputSrmupesvlu {
|
|
1632
1666
|
courses: {
|
|
1633
1667
|
name: string;
|
|
1634
1668
|
status: string;
|
|
@@ -1639,21 +1673,21 @@ export interface OutputFvqn0Re8M9 {
|
|
|
1639
1673
|
validated: boolean;
|
|
1640
1674
|
mustCreateCP: boolean;
|
|
1641
1675
|
}
|
|
1642
|
-
export interface
|
|
1676
|
+
export interface InputDuiiv3Zckw {
|
|
1643
1677
|
/**
|
|
1644
1678
|
* Comments regarding the end of the cooldown period
|
|
1645
1679
|
* @example "Cooldown period ended successfully."
|
|
1646
1680
|
*/
|
|
1647
1681
|
comments: string;
|
|
1648
1682
|
}
|
|
1649
|
-
export interface
|
|
1683
|
+
export interface OutputYlokx3Iwo7L {
|
|
1650
1684
|
/**
|
|
1651
1685
|
* Signed URL for the course file
|
|
1652
1686
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
1653
1687
|
*/
|
|
1654
1688
|
fileURL: string;
|
|
1655
1689
|
}
|
|
1656
|
-
export interface
|
|
1690
|
+
export interface InputL6Dd6Jvc4X {
|
|
1657
1691
|
/** @example true */
|
|
1658
1692
|
agreedWithCertTerms: boolean;
|
|
1659
1693
|
/** @example 1717230000000 */
|
|
@@ -1725,21 +1759,21 @@ export interface InputOtoghzqho4 {
|
|
|
1725
1759
|
/** @example "EXT#999" */
|
|
1726
1760
|
externalID2?: string | null;
|
|
1727
1761
|
}
|
|
1728
|
-
export interface
|
|
1762
|
+
export interface Input8Ibmfkvzzi {
|
|
1729
1763
|
/**
|
|
1730
1764
|
* Comments regarding the course unlock action
|
|
1731
1765
|
* @example "Course unlocked successfully."
|
|
1732
1766
|
*/
|
|
1733
1767
|
comments: string;
|
|
1734
1768
|
}
|
|
1735
|
-
export interface
|
|
1769
|
+
export interface InputF1Zhdx3Zvz {
|
|
1736
1770
|
/**
|
|
1737
1771
|
* ITA number to update for the user
|
|
1738
1772
|
* @example "ITA123456"
|
|
1739
1773
|
*/
|
|
1740
1774
|
itaNumber: string;
|
|
1741
1775
|
}
|
|
1742
|
-
export interface
|
|
1776
|
+
export interface InputZ1Gwnuie45 {
|
|
1743
1777
|
/** @example true */
|
|
1744
1778
|
agreedWithCertTerms: boolean;
|
|
1745
1779
|
/** @example 1717230000000 */
|
|
@@ -1811,7 +1845,7 @@ export interface Input6I1B04X05S {
|
|
|
1811
1845
|
/** @example "EXT#999" */
|
|
1812
1846
|
externalID2?: string | null;
|
|
1813
1847
|
}
|
|
1814
|
-
export interface
|
|
1848
|
+
export interface InputBdyz7Wbn8D {
|
|
1815
1849
|
/**
|
|
1816
1850
|
* The grade to override the course result with
|
|
1817
1851
|
* @example "A"
|
|
@@ -1819,7 +1853,7 @@ export interface Input7Li5D5Dgch {
|
|
|
1819
1853
|
resultGrade: string;
|
|
1820
1854
|
}
|
|
1821
1855
|
/** Pending approval review parameters */
|
|
1822
|
-
export interface
|
|
1856
|
+
export interface InputTl132Xl4De {
|
|
1823
1857
|
/**
|
|
1824
1858
|
* Notes provided by the reviewer for the pending approval
|
|
1825
1859
|
* @example "Please review the submitted documents."
|
|
@@ -1832,7 +1866,7 @@ export interface InputUn9Itok4S6 {
|
|
|
1832
1866
|
approved: boolean;
|
|
1833
1867
|
}
|
|
1834
1868
|
/** Schema for overriding course result dates. */
|
|
1835
|
-
export interface
|
|
1869
|
+
export interface InputRqs0Srazmv {
|
|
1836
1870
|
/**
|
|
1837
1871
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1838
1872
|
* @example 1735689600000
|
|
@@ -1844,14 +1878,14 @@ export interface Input552J2Xh4N9 {
|
|
|
1844
1878
|
*/
|
|
1845
1879
|
completionDate?: number;
|
|
1846
1880
|
}
|
|
1847
|
-
export interface
|
|
1881
|
+
export interface InputL2B6Xg1Hg8 {
|
|
1848
1882
|
filter: {
|
|
1849
1883
|
from?: number;
|
|
1850
1884
|
sortOrder?: string;
|
|
1851
1885
|
sortField?: string;
|
|
1852
1886
|
};
|
|
1853
1887
|
}
|
|
1854
|
-
export interface
|
|
1888
|
+
export interface OutputL2B6Xg1Hg8 {
|
|
1855
1889
|
users: {
|
|
1856
1890
|
firstName: string;
|
|
1857
1891
|
lastName: string;
|
|
@@ -1875,7 +1909,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
1875
1909
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1876
1910
|
* @example "CHECKED"
|
|
1877
1911
|
*/
|
|
1878
|
-
export declare enum
|
|
1912
|
+
export declare enum Input1N2M6Fqym9ValueEnum {
|
|
1879
1913
|
CHECKED = "CHECKED",
|
|
1880
1914
|
UNCHECKED = "UNCHECKED",
|
|
1881
1915
|
NOVALUE = "NOVALUE"
|
|
@@ -1968,7 +2002,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
1968
2002
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
1969
2003
|
export type CreateReportUsersSimpleData = any;
|
|
1970
2004
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
1971
|
-
export type CreateSearchUsersCountData =
|
|
2005
|
+
export type CreateSearchUsersCountData = Output5Av211Zxuf;
|
|
1972
2006
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
1973
2007
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
1974
2008
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -1992,7 +2026,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
1992
2026
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
1993
2027
|
export type DeleteCertificationCourseFileSignData = any;
|
|
1994
2028
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
1995
|
-
export type GetCertificationCourseFileSignData =
|
|
2029
|
+
export type GetCertificationCourseFileSignData = OutputA30Zrdq4Ou;
|
|
1996
2030
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
1997
2031
|
export interface CreateCertificationCourseFileSignParams {
|
|
1998
2032
|
/** @example "pdf" */
|
|
@@ -2006,11 +2040,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2006
2040
|
/** @example "fileID" */
|
|
2007
2041
|
fileId: string;
|
|
2008
2042
|
}
|
|
2009
|
-
export type CreateCertificationCourseFileSignData =
|
|
2043
|
+
export type CreateCertificationCourseFileSignData = OutputYlokx3Iwo7L;
|
|
2010
2044
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2011
2045
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2012
2046
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2013
|
-
export type CreateCertificationCourseDocumentData =
|
|
2047
|
+
export type CreateCertificationCourseDocumentData = OutputNkt1M0Sigg;
|
|
2014
2048
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2015
2049
|
export type DeleteUserData = any;
|
|
2016
2050
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2022,7 +2056,7 @@ export type UpdateUserData = any;
|
|
|
2022
2056
|
export type UpdateUserError = ErrorResponse;
|
|
2023
2057
|
export type DeleteCertificationCourseData = any;
|
|
2024
2058
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2025
|
-
export type GetCertificationApplicationItemFileData =
|
|
2059
|
+
export type GetCertificationApplicationItemFileData = OutputZok71Yo152;
|
|
2026
2060
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2027
2061
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2028
2062
|
/** @example "pdf" */
|
|
@@ -2036,9 +2070,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2036
2070
|
/** @example "fileVersion" */
|
|
2037
2071
|
fileVersion: string;
|
|
2038
2072
|
}
|
|
2039
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2073
|
+
export type CreateCertificationApplicationItemFileData = OutputQ33S4Fo2Ej;
|
|
2040
2074
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2041
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2075
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputLuus5Iz0Upf;
|
|
2042
2076
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2043
2077
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2044
2078
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2046,7 +2080,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2046
2080
|
export type GetCourseError = ErrorResponse;
|
|
2047
2081
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2048
2082
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2049
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2083
|
+
export type GetCertificationApplicationForeignFillData = OutputF702E2U459J;
|
|
2050
2084
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2051
2085
|
export type GetCertificationPrintData = any;
|
|
2052
2086
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2080,7 +2114,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2080
2114
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2081
2115
|
export type CreateCertificationWaiveData = any;
|
|
2082
2116
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2083
|
-
export type CreateCertificationMoveData =
|
|
2117
|
+
export type CreateCertificationMoveData = OutputAiche6Pi4W;
|
|
2084
2118
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2085
2119
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2086
2120
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2094,6 +2128,8 @@ export type CreateRefreshOrgMembershipData = any;
|
|
|
2094
2128
|
export type CreateRefreshOrgMembershipError = ErrorResponse;
|
|
2095
2129
|
export type CreateCertificationCourseRetakeData = any;
|
|
2096
2130
|
export type CreateCertificationCourseRetakeError = ErrorResponse;
|
|
2131
|
+
export type CreateCertificationCourseRevokeAllData = any;
|
|
2132
|
+
export type CreateCertificationCourseRevokeAllError = ErrorResponse;
|
|
2097
2133
|
export type CreateCertificationCourseRevokeData = any;
|
|
2098
2134
|
export type CreateCertificationCourseRevokeError = ErrorResponse;
|
|
2099
2135
|
export type CreateCertificationApplicationItemRemoveData = any;
|
|
@@ -2110,7 +2146,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2110
2146
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2111
2147
|
export type CreateCertificationCourseRedeemData = any;
|
|
2112
2148
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2113
|
-
export type CreateCertificationMoveValidateData =
|
|
2149
|
+
export type CreateCertificationMoveValidateData = OutputSrmupesvlu;
|
|
2114
2150
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2115
2151
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2116
2152
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2126,7 +2162,7 @@ export type CreateCertificationPublishInfoData = any;
|
|
|
2126
2162
|
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2127
2163
|
export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
2128
2164
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2129
|
-
export type CreateCertificationResult =
|
|
2165
|
+
export type CreateCertificationResult = OutputL2B6Xg1Hg8;
|
|
2130
2166
|
export type CreateCertificationFail = ErrorResponse;
|
|
2131
2167
|
export type CreateCertificationPublishInfoResult = any;
|
|
2132
2168
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2173,7 +2209,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2173
2209
|
}
|
|
2174
2210
|
/**
|
|
2175
2211
|
* @title BCCSA Program API
|
|
2176
|
-
* @version 3.0.
|
|
2212
|
+
* @version 3.0.25
|
|
2177
2213
|
* @baseUrl http://localhost:8080
|
|
2178
2214
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2179
2215
|
*/
|
|
@@ -2188,7 +2224,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2188
2224
|
* @request POST:/contactUs
|
|
2189
2225
|
* @secure
|
|
2190
2226
|
*/
|
|
2191
|
-
listContactUs: (data:
|
|
2227
|
+
listContactUs: (data: Input39Efkhxkou, params?: RequestParams) => Promise<any>;
|
|
2192
2228
|
};
|
|
2193
2229
|
customer: {
|
|
2194
2230
|
/**
|
|
@@ -2292,7 +2328,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2292
2328
|
* @request POST:/tenant/report/applicationExport
|
|
2293
2329
|
* @secure
|
|
2294
2330
|
*/
|
|
2295
|
-
createReportApplicationExport: (data:
|
|
2331
|
+
createReportApplicationExport: (data: InputL5Mafsqfat, params?: RequestParams) => Promise<any>;
|
|
2296
2332
|
/**
|
|
2297
2333
|
* @description Export a report of applications based on the provided filters.
|
|
2298
2334
|
*
|
|
@@ -2302,7 +2338,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2302
2338
|
* @request POST:/tenant/report/applicationStatus
|
|
2303
2339
|
* @secure
|
|
2304
2340
|
*/
|
|
2305
|
-
listReportApplicationStatus: (data:
|
|
2341
|
+
listReportApplicationStatus: (data: InputF4Q99Ghr8W, params?: RequestParams) => Promise<any>;
|
|
2306
2342
|
/**
|
|
2307
2343
|
* @description Export a report of applications based on the provided filters.
|
|
2308
2344
|
*
|
|
@@ -2312,7 +2348,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2312
2348
|
* @request POST:/tenant/report/applicationsReport
|
|
2313
2349
|
* @secure
|
|
2314
2350
|
*/
|
|
2315
|
-
createReportApplicationsReport: (data:
|
|
2351
|
+
createReportApplicationsReport: (data: Input51Kql6P0Xu, params?: RequestParams) => Promise<any>;
|
|
2316
2352
|
/**
|
|
2317
2353
|
* @description This route allows you to post certificates email for the tenant.
|
|
2318
2354
|
*
|
|
@@ -2322,7 +2358,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2322
2358
|
* @request POST:/tenant/certificates/email
|
|
2323
2359
|
* @secure
|
|
2324
2360
|
*/
|
|
2325
|
-
createCertificatesEmail: (data:
|
|
2361
|
+
createCertificatesEmail: (data: Input2T5Dq39Ke9, params?: RequestParams) => Promise<any>;
|
|
2326
2362
|
/**
|
|
2327
2363
|
* @description Generate a preview of the completed certifications report.
|
|
2328
2364
|
*
|
|
@@ -2352,7 +2388,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2352
2388
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2353
2389
|
* @secure
|
|
2354
2390
|
*/
|
|
2355
|
-
createLicenseRedeem: (userId: string, data:
|
|
2391
|
+
createLicenseRedeem: (userId: string, data: InputCryywuj0K5, params?: RequestParams) => Promise<any>;
|
|
2356
2392
|
/**
|
|
2357
2393
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2358
2394
|
*
|
|
@@ -2362,7 +2398,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2362
2398
|
* @request POST:/tenant/report/orglicenses/
|
|
2363
2399
|
* @secure
|
|
2364
2400
|
*/
|
|
2365
|
-
listReportOrglicenses: (data:
|
|
2401
|
+
listReportOrglicenses: (data: Input7Fm6Ar6Ikc, params?: RequestParams) => Promise<any>;
|
|
2366
2402
|
/**
|
|
2367
2403
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2368
2404
|
*
|
|
@@ -2372,7 +2408,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2372
2408
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2373
2409
|
* @secure
|
|
2374
2410
|
*/
|
|
2375
|
-
createReportOrglicensesPreview: (data:
|
|
2411
|
+
createReportOrglicensesPreview: (data: InputAeyuq9T9Ag, params?: RequestParams) => Promise<any>;
|
|
2376
2412
|
/**
|
|
2377
2413
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2378
2414
|
*
|
|
@@ -2402,7 +2438,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2402
2438
|
* @request POST:/tenant/report/users/advanced
|
|
2403
2439
|
* @secure
|
|
2404
2440
|
*/
|
|
2405
|
-
createReportUsersAdvanced: (data:
|
|
2441
|
+
createReportUsersAdvanced: (data: Input4O1N8Cqdn6J, params?: RequestParams) => Promise<any>;
|
|
2406
2442
|
/**
|
|
2407
2443
|
* @description Searches for users in the tenant by their IDs.
|
|
2408
2444
|
*
|
|
@@ -2412,7 +2448,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2412
2448
|
* @request POST:/tenant/search/users/ids
|
|
2413
2449
|
* @secure
|
|
2414
2450
|
*/
|
|
2415
|
-
listSearchUsersIds: (data:
|
|
2451
|
+
listSearchUsersIds: (data: InputEejfjazx8Gi, params?: RequestParams) => Promise<any>;
|
|
2416
2452
|
/**
|
|
2417
2453
|
* @description Searches for users in the tenant by term and filters.
|
|
2418
2454
|
*
|
|
@@ -2422,7 +2458,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2422
2458
|
* @request POST:/tenant/search/users/term
|
|
2423
2459
|
* @secure
|
|
2424
2460
|
*/
|
|
2425
|
-
createSearchUsersTerm: (data:
|
|
2461
|
+
createSearchUsersTerm: (data: Input4Bmr5Tztvtf, params?: RequestParams) => Promise<any>;
|
|
2426
2462
|
/**
|
|
2427
2463
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2428
2464
|
*
|
|
@@ -2432,7 +2468,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2432
2468
|
* @request POST:/tenant/report/users/simple
|
|
2433
2469
|
* @secure
|
|
2434
2470
|
*/
|
|
2435
|
-
createReportUsersSimple: (data:
|
|
2471
|
+
createReportUsersSimple: (data: Input14Wsadu67R, params?: RequestParams) => Promise<any>;
|
|
2436
2472
|
/**
|
|
2437
2473
|
* @description Retrieve user by ID.
|
|
2438
2474
|
*
|
|
@@ -2442,7 +2478,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2442
2478
|
* @request POST:/tenant/search/users/count
|
|
2443
2479
|
* @secure
|
|
2444
2480
|
*/
|
|
2445
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2481
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<Output5Av211Zxuf>;
|
|
2446
2482
|
};
|
|
2447
2483
|
user: {
|
|
2448
2484
|
/**
|
|
@@ -2474,7 +2510,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2474
2510
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2475
2511
|
* @secure
|
|
2476
2512
|
*/
|
|
2477
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2513
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: InputCbpydyfecl, params?: RequestParams) => Promise<any>;
|
|
2478
2514
|
/**
|
|
2479
2515
|
* @description Delete a certification process application by type.
|
|
2480
2516
|
*
|
|
@@ -2564,7 +2600,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2564
2600
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2565
2601
|
* @secure
|
|
2566
2602
|
*/
|
|
2567
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2603
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputA30Zrdq4Ou>;
|
|
2568
2604
|
/**
|
|
2569
2605
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2570
2606
|
*
|
|
@@ -2574,7 +2610,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2574
2610
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2575
2611
|
* @secure
|
|
2576
2612
|
*/
|
|
2577
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2613
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputYlokx3Iwo7L>;
|
|
2578
2614
|
/**
|
|
2579
2615
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2580
2616
|
*
|
|
@@ -2594,7 +2630,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2594
2630
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2595
2631
|
* @secure
|
|
2596
2632
|
*/
|
|
2597
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2633
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputNkt1M0Sigg, params?: RequestParams) => Promise<OutputNkt1M0Sigg>;
|
|
2598
2634
|
/**
|
|
2599
2635
|
* @description Delete user by ID.
|
|
2600
2636
|
*
|
|
@@ -2624,7 +2660,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2624
2660
|
* @request POST:/user/{userID}
|
|
2625
2661
|
* @secure
|
|
2626
2662
|
*/
|
|
2627
|
-
createUser: (userId: string, data:
|
|
2663
|
+
createUser: (userId: string, data: InputL6Dd6Jvc4X, params?: RequestParams) => Promise<any>;
|
|
2628
2664
|
/**
|
|
2629
2665
|
* @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.
|
|
2630
2666
|
*
|
|
@@ -2634,7 +2670,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2634
2670
|
* @request PUT:/user/{userID}
|
|
2635
2671
|
* @secure
|
|
2636
2672
|
*/
|
|
2637
|
-
updateUser: (userId: string, data:
|
|
2673
|
+
updateUser: (userId: string, data: InputZ1Gwnuie45, params?: RequestParams) => Promise<any>;
|
|
2638
2674
|
/**
|
|
2639
2675
|
* @description Delete course from user
|
|
2640
2676
|
*
|
|
@@ -2654,7 +2690,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2654
2690
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2655
2691
|
* @secure
|
|
2656
2692
|
*/
|
|
2657
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2693
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputZok71Yo152>;
|
|
2658
2694
|
/**
|
|
2659
2695
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2660
2696
|
*
|
|
@@ -2664,7 +2700,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2664
2700
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2665
2701
|
* @secure
|
|
2666
2702
|
*/
|
|
2667
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2703
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputQ33S4Fo2Ej>;
|
|
2668
2704
|
/**
|
|
2669
2705
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2670
2706
|
*
|
|
@@ -2674,7 +2710,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2674
2710
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2675
2711
|
* @secure
|
|
2676
2712
|
*/
|
|
2677
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2713
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputLuus5Iz0Upf>;
|
|
2678
2714
|
/**
|
|
2679
2715
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2680
2716
|
*
|
|
@@ -2714,7 +2750,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2714
2750
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2715
2751
|
* @secure
|
|
2716
2752
|
*/
|
|
2717
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2753
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputF702E2U459J>;
|
|
2718
2754
|
/**
|
|
2719
2755
|
* @description This endpoint will print certificate
|
|
2720
2756
|
*
|
|
@@ -2774,7 +2810,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2774
2810
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2775
2811
|
* @secure
|
|
2776
2812
|
*/
|
|
2777
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2813
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputI9Jj0Rnbnu, params?: RequestParams) => Promise<any>;
|
|
2778
2814
|
/**
|
|
2779
2815
|
* @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.
|
|
2780
2816
|
*
|
|
@@ -2804,7 +2840,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2804
2840
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2805
2841
|
* @secure
|
|
2806
2842
|
*/
|
|
2807
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2843
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputKg4Xkqwj57, params?: RequestParams) => Promise<any>;
|
|
2808
2844
|
/**
|
|
2809
2845
|
* @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.
|
|
2810
2846
|
*
|
|
@@ -2814,7 +2850,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2814
2850
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2815
2851
|
* @secure
|
|
2816
2852
|
*/
|
|
2817
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2853
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputQ92Kr2Vptg, params?: RequestParams) => Promise<any>;
|
|
2818
2854
|
/**
|
|
2819
2855
|
* @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.
|
|
2820
2856
|
*
|
|
@@ -2824,7 +2860,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2824
2860
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2825
2861
|
* @secure
|
|
2826
2862
|
*/
|
|
2827
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2863
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputM6R3Wh6Pxz, params?: RequestParams) => Promise<any>;
|
|
2828
2864
|
/**
|
|
2829
2865
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2830
2866
|
*
|
|
@@ -2834,7 +2870,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2834
2870
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2835
2871
|
* @secure
|
|
2836
2872
|
*/
|
|
2837
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2873
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputVsn945Yctpi, params?: RequestParams) => Promise<any>;
|
|
2838
2874
|
/**
|
|
2839
2875
|
* @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.
|
|
2840
2876
|
*
|
|
@@ -2874,7 +2910,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2874
2910
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2875
2911
|
* @secure
|
|
2876
2912
|
*/
|
|
2877
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2913
|
+
createCertificationWaive: (userId: string, certProcId: string, data: Input3Zzy8W1Fuh, params?: RequestParams) => Promise<any>;
|
|
2878
2914
|
/**
|
|
2879
2915
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
2880
2916
|
*
|
|
@@ -2884,7 +2920,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2884
2920
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2885
2921
|
* @secure
|
|
2886
2922
|
*/
|
|
2887
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2923
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputAiche6Pi4W>;
|
|
2888
2924
|
/**
|
|
2889
2925
|
* @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.
|
|
2890
2926
|
*
|
|
@@ -2924,7 +2960,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2924
2960
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2925
2961
|
* @secure
|
|
2926
2962
|
*/
|
|
2927
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
2963
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: Input1N2M6Fqym9, params?: RequestParams) => Promise<any>;
|
|
2928
2964
|
/**
|
|
2929
2965
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
2930
2966
|
*
|
|
@@ -2945,6 +2981,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2945
2981
|
* @secure
|
|
2946
2982
|
*/
|
|
2947
2983
|
createCertificationCourseRetake: (userId: string, certProcId: string, courseId: string, params?: RequestParams) => Promise<any>;
|
|
2984
|
+
/**
|
|
2985
|
+
* @description Batch-revokes all eligible courses on a certification process
|
|
2986
|
+
*
|
|
2987
|
+
* @tags Course
|
|
2988
|
+
* @name CreateCertificationCourseRevokeAll
|
|
2989
|
+
* @summary Revoke all eligible courses
|
|
2990
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/revokeAll
|
|
2991
|
+
* @secure
|
|
2992
|
+
*/
|
|
2993
|
+
createCertificationCourseRevokeAll: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
|
|
2948
2994
|
/**
|
|
2949
2995
|
* @description This route allows you to revoke a course for a certification process for a user in a specific course.
|
|
2950
2996
|
*
|
|
@@ -2974,7 +3020,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2974
3020
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
2975
3021
|
* @secure
|
|
2976
3022
|
*/
|
|
2977
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
3023
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: InputT1Po2Bcy2H, params?: RequestParams) => Promise<any>;
|
|
2978
3024
|
/**
|
|
2979
3025
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
2980
3026
|
*
|
|
@@ -2994,7 +3040,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2994
3040
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
2995
3041
|
* @secure
|
|
2996
3042
|
*/
|
|
2997
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3043
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputIhqbjgfwmwf, params?: RequestParams) => Promise<any>;
|
|
2998
3044
|
/**
|
|
2999
3045
|
* @description This route allows you to submit a pending approval.
|
|
3000
3046
|
*
|
|
@@ -3004,7 +3050,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3004
3050
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3005
3051
|
* @secure
|
|
3006
3052
|
*/
|
|
3007
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3053
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputSkwo64Irm8, params?: RequestParams) => Promise<any>;
|
|
3008
3054
|
/**
|
|
3009
3055
|
* @description This route allows you to review a pending approval.
|
|
3010
3056
|
*
|
|
@@ -3014,7 +3060,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3014
3060
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3015
3061
|
* @secure
|
|
3016
3062
|
*/
|
|
3017
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3063
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputTl132Xl4De, params?: RequestParams) => Promise<any>;
|
|
3018
3064
|
/**
|
|
3019
3065
|
* @description Redeems a license for a user by product ID.
|
|
3020
3066
|
*
|
|
@@ -3024,7 +3070,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3024
3070
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3025
3071
|
* @secure
|
|
3026
3072
|
*/
|
|
3027
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3073
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputGjqi82Rf9D, params?: RequestParams) => Promise<any>;
|
|
3028
3074
|
/**
|
|
3029
3075
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3030
3076
|
*
|
|
@@ -3034,7 +3080,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3034
3080
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3035
3081
|
* @secure
|
|
3036
3082
|
*/
|
|
3037
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3083
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputSrmupesvlu>;
|
|
3038
3084
|
/**
|
|
3039
3085
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3040
3086
|
*
|
|
@@ -3044,7 +3090,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3044
3090
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3045
3091
|
* @secure
|
|
3046
3092
|
*/
|
|
3047
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3093
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputDuiiv3Zckw, params?: RequestParams) => Promise<any>;
|
|
3048
3094
|
/**
|
|
3049
3095
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3050
3096
|
*
|
|
@@ -3054,7 +3100,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3054
3100
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3055
3101
|
* @secure
|
|
3056
3102
|
*/
|
|
3057
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3103
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input8Ibmfkvzzi, params?: RequestParams) => Promise<any>;
|
|
3058
3104
|
/**
|
|
3059
3105
|
* @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.
|
|
3060
3106
|
*
|
|
@@ -3064,7 +3110,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3064
3110
|
* @request POST:/user/{userID}/updateITA
|
|
3065
3111
|
* @secure
|
|
3066
3112
|
*/
|
|
3067
|
-
createUpdateIta: (userId: string, data:
|
|
3113
|
+
createUpdateIta: (userId: string, data: InputF1Zhdx3Zvz, params?: RequestParams) => Promise<any>;
|
|
3068
3114
|
/**
|
|
3069
3115
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3070
3116
|
*
|
|
@@ -3074,7 +3120,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3074
3120
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3075
3121
|
* @secure
|
|
3076
3122
|
*/
|
|
3077
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3123
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputBdyz7Wbn8D, params?: RequestParams) => Promise<any>;
|
|
3078
3124
|
/**
|
|
3079
3125
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3080
3126
|
*
|
|
@@ -3084,7 +3130,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3084
3130
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3085
3131
|
* @secure
|
|
3086
3132
|
*/
|
|
3087
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3133
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputRqs0Srazmv, params?: RequestParams) => Promise<any>;
|
|
3088
3134
|
/**
|
|
3089
3135
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3090
3136
|
*
|
|
@@ -3116,7 +3162,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3116
3162
|
* @request POST:/users/certification/{certSpecID}
|
|
3117
3163
|
* @secure
|
|
3118
3164
|
*/
|
|
3119
|
-
createCertification: (certSpecId: string, data:
|
|
3165
|
+
createCertification: (certSpecId: string, data: InputL2B6Xg1Hg8, params?: RequestParams) => Promise<OutputL2B6Xg1Hg8>;
|
|
3120
3166
|
/**
|
|
3121
3167
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3122
3168
|
*
|