@ikonintegration/bccsa-program-api 3.0.5 → 3.0.9
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 +190 -144
- package/dist/Api.d.ts +180 -153
- package/dist/Api.js +21 -8
- package/dist/Api.js.map +1 -1
- package/package.json +2 -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 InputM2C55Bd8Tz {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -449,7 +449,7 @@ export interface PendingApprovalResponseSchema {
|
|
|
449
449
|
}[];
|
|
450
450
|
}[] | null;
|
|
451
451
|
}
|
|
452
|
-
export interface
|
|
452
|
+
export interface InputAcronryug2 {
|
|
453
453
|
/**
|
|
454
454
|
* ID of the certification to filter applications by
|
|
455
455
|
* @example "certification123"
|
|
@@ -506,7 +506,7 @@ export interface Input58N3R9D0Hlk {
|
|
|
506
506
|
*/
|
|
507
507
|
ignoreCompletedCertifications?: boolean | null;
|
|
508
508
|
}
|
|
509
|
-
export interface
|
|
509
|
+
export interface InputHcpt0Eg8Rw {
|
|
510
510
|
/**
|
|
511
511
|
* ID of the certification to filter applications by
|
|
512
512
|
* @example "certification123"
|
|
@@ -563,7 +563,7 @@ export interface Input2Zvokn7Zsc {
|
|
|
563
563
|
*/
|
|
564
564
|
ignoreCompletedCertifications?: boolean | null;
|
|
565
565
|
}
|
|
566
|
-
export interface
|
|
566
|
+
export interface InputWc6Eh9Ziyxj {
|
|
567
567
|
/**
|
|
568
568
|
* ID of the certification to filter applications by
|
|
569
569
|
* @example "certification123"
|
|
@@ -620,7 +620,7 @@ export interface InputMibedikiflf {
|
|
|
620
620
|
*/
|
|
621
621
|
ignoreCompletedCertifications?: boolean | null;
|
|
622
622
|
}
|
|
623
|
-
export interface
|
|
623
|
+
export interface Input0Vvobhlytb {
|
|
624
624
|
/**
|
|
625
625
|
* The ID of the certificate specifications to be used for the email
|
|
626
626
|
* @example "certSpecsID123"
|
|
@@ -661,7 +661,7 @@ export interface Input4Jtrsbxrdn {
|
|
|
661
661
|
emailAddress: string;
|
|
662
662
|
}[];
|
|
663
663
|
}
|
|
664
|
-
export interface
|
|
664
|
+
export interface InputQ6H7C6Fxfc {
|
|
665
665
|
/**
|
|
666
666
|
* The ID of the product for which the license is being redeemed
|
|
667
667
|
* @example "productID123"
|
|
@@ -673,7 +673,7 @@ export interface InputG8Iry71He2G {
|
|
|
673
673
|
*/
|
|
674
674
|
sessionID?: string;
|
|
675
675
|
}
|
|
676
|
-
export interface
|
|
676
|
+
export interface InputFyxk6Ticie {
|
|
677
677
|
/**
|
|
678
678
|
* Search term to filter licenses
|
|
679
679
|
* @example "active"
|
|
@@ -690,7 +690,7 @@ export interface InputQe1Swbpk8M {
|
|
|
690
690
|
*/
|
|
691
691
|
sortField?: any;
|
|
692
692
|
}
|
|
693
|
-
export interface
|
|
693
|
+
export interface InputAcyg29Xjkzj {
|
|
694
694
|
/**
|
|
695
695
|
* Search term to filter licenses
|
|
696
696
|
* @example "active"
|
|
@@ -724,12 +724,28 @@ export interface NcsoReportRequestSchema {
|
|
|
724
724
|
hideExpired?: boolean;
|
|
725
725
|
};
|
|
726
726
|
}
|
|
727
|
+
/** Filters offered for NCSO export report */
|
|
728
|
+
export interface NcsoReportExportRequestSchema {
|
|
729
|
+
certifications: {
|
|
730
|
+
name: string;
|
|
731
|
+
email?: string;
|
|
732
|
+
city?: string;
|
|
733
|
+
phone?: string;
|
|
734
|
+
originalCompletionDate?: number;
|
|
735
|
+
completionDate?: number;
|
|
736
|
+
expiryDate?: number;
|
|
737
|
+
status?: string;
|
|
738
|
+
hasOtherCertifications?: boolean;
|
|
739
|
+
notes?: string;
|
|
740
|
+
listedOnWebsite?: boolean;
|
|
741
|
+
}[];
|
|
742
|
+
}
|
|
727
743
|
/** Report export as xlsx */
|
|
728
744
|
export interface ReportXLSXSchema {
|
|
729
745
|
xlsxStream: any;
|
|
730
746
|
contentType: ReportXlsxSchemaContentTypeEnum;
|
|
731
747
|
}
|
|
732
|
-
export interface
|
|
748
|
+
export interface InputUpehhj9C6W {
|
|
733
749
|
/**
|
|
734
750
|
* Start date for the report
|
|
735
751
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -751,11 +767,11 @@ export interface InputC01M49Qi3N {
|
|
|
751
767
|
*/
|
|
752
768
|
dateType?: string;
|
|
753
769
|
}
|
|
754
|
-
export interface
|
|
770
|
+
export interface InputQbv906Ts61 {
|
|
755
771
|
/** List of user IDs to search for in the tenant. */
|
|
756
772
|
IDs: (string | null)[];
|
|
757
773
|
}
|
|
758
|
-
export interface
|
|
774
|
+
export interface InputCg0P4Kyfnx {
|
|
759
775
|
/** The term to search for in the user profiles. */
|
|
760
776
|
searchTerm?: string | null;
|
|
761
777
|
/** Filter criteria for the user search. */
|
|
@@ -795,7 +811,7 @@ export interface InputMltabt6Bdi {
|
|
|
795
811
|
};
|
|
796
812
|
};
|
|
797
813
|
}
|
|
798
|
-
export interface
|
|
814
|
+
export interface InputJu5Xefnams {
|
|
799
815
|
/** The term to search for in the user profiles. */
|
|
800
816
|
searchTerm?: string | null;
|
|
801
817
|
/** Filter criteria for the user search. */
|
|
@@ -837,19 +853,19 @@ export interface InputP86L56U2Wu {
|
|
|
837
853
|
}
|
|
838
854
|
/** External system ID 2 */
|
|
839
855
|
export type ExternalID2 = number;
|
|
840
|
-
export interface
|
|
856
|
+
export interface OutputZ1Kgayshxs {
|
|
841
857
|
/** External system ID 2 */
|
|
842
858
|
userCount: ExternalID2;
|
|
843
859
|
transactionID?: string | null;
|
|
844
860
|
}
|
|
845
|
-
export interface
|
|
861
|
+
export interface Output2Z07K72Yvch {
|
|
846
862
|
/**
|
|
847
863
|
* Signed URL for the course file
|
|
848
864
|
* @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"
|
|
849
865
|
*/
|
|
850
866
|
fileURL: string;
|
|
851
867
|
}
|
|
852
|
-
export interface
|
|
868
|
+
export interface OutputN6Q838Yzlz {
|
|
853
869
|
/**
|
|
854
870
|
* Amount to be refunded for the cancellation
|
|
855
871
|
* @example 0
|
|
@@ -999,60 +1015,57 @@ export interface CertificationProcessResponseSchema {
|
|
|
999
1015
|
}
|
|
1000
1016
|
/** Response schema for certification application data */
|
|
1001
1017
|
export interface CertificationApplicationResponseEntity {
|
|
1002
|
-
/**
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1018
|
+
/** @example 1717230000000 */
|
|
1019
|
+
createdOn?: number;
|
|
1020
|
+
/** @example "USR#abc" */
|
|
1021
|
+
createdBy?: string;
|
|
1022
|
+
/** @example "USR#xyz" */
|
|
1023
|
+
updatedBy?: string;
|
|
1024
|
+
/** @example 1717230000000 */
|
|
1025
|
+
updatedOn?: number;
|
|
1026
|
+
/** @example "prgCertificationApplication" */
|
|
1027
|
+
dbEntity?: string;
|
|
1028
|
+
/** @example "CUST#123" */
|
|
1029
|
+
customerID: string;
|
|
1030
|
+
/** @example "TEN#456" */
|
|
1031
|
+
tenantID: string;
|
|
1032
|
+
/** @example "USR#789" */
|
|
1033
|
+
userID: string;
|
|
1034
|
+
/** @example "CP#0001" */
|
|
1035
|
+
certProcID: string;
|
|
1036
|
+
/** @example "CERT#01" */
|
|
1037
|
+
certificationID?: string;
|
|
1038
|
+
/** @example "initial" */
|
|
1039
|
+
type: string;
|
|
1040
|
+
/** @example "LIC#999" */
|
|
1041
|
+
licenseID?: string;
|
|
1042
|
+
/** @example "LICINV#555" */
|
|
1043
|
+
licenseInvalidateID?: string;
|
|
1044
|
+
/** @example "submitted" */
|
|
1045
|
+
state?: string;
|
|
1046
|
+
/** @example 1717231111111 */
|
|
1047
|
+
submittedOn?: number;
|
|
1048
|
+
/** @example "USR#sub" */
|
|
1049
|
+
submittedBy?: string;
|
|
1050
|
+
/** @example "USR#rev" */
|
|
1051
|
+
reviewedBy?: string;
|
|
1052
|
+
/** @example 1717232222222 */
|
|
1053
|
+
reviewedOn?: number;
|
|
1054
|
+
/** @example "Everything looks good." */
|
|
1055
|
+
reviewNotes?: string;
|
|
1056
|
+
/** @example 1 */
|
|
1057
|
+
reviewAcknowledge?: number;
|
|
1058
|
+
/** @example [{"id":"ITEM#1","version":1,"type":"doc"}] */
|
|
1059
|
+
submissionItems?: {
|
|
1060
|
+
/** @example "ITEM#1" */
|
|
1061
|
+
id?: string;
|
|
1042
1062
|
/** @example 1 */
|
|
1043
|
-
|
|
1044
|
-
/** @example
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
version?: number;
|
|
1050
|
-
/** @example "doc" */
|
|
1051
|
-
type?: string;
|
|
1052
|
-
}[];
|
|
1053
|
-
/** @example ["ITEM#2"] */
|
|
1054
|
-
blacklistedItems?: string[];
|
|
1055
|
-
};
|
|
1063
|
+
version?: number;
|
|
1064
|
+
/** @example "doc" */
|
|
1065
|
+
type?: string;
|
|
1066
|
+
}[];
|
|
1067
|
+
/** @example ["ITEM#2"] */
|
|
1068
|
+
blacklistedItems?: string[];
|
|
1056
1069
|
}
|
|
1057
1070
|
/** Label of the course enrolled (course version) */
|
|
1058
1071
|
export type OnlineCourseLabel = string;
|
|
@@ -1139,7 +1152,7 @@ export interface CourseResponseEntity {
|
|
|
1139
1152
|
/** Justifications for overridden course restrictions */
|
|
1140
1153
|
overwrittenJustification?: OverwrittenJustification;
|
|
1141
1154
|
}
|
|
1142
|
-
export interface
|
|
1155
|
+
export interface OutputPgfarqya86K {
|
|
1143
1156
|
/**
|
|
1144
1157
|
* Signed URL for the course file
|
|
1145
1158
|
* @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 +1170,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1157
1170
|
transactionID?: string | null;
|
|
1158
1171
|
}
|
|
1159
1172
|
/** Application Foreign Fill response type */
|
|
1160
|
-
export interface
|
|
1173
|
+
export interface OutputDgabev9Kax {
|
|
1161
1174
|
items: {
|
|
1162
1175
|
userID: string;
|
|
1163
1176
|
createdOn?: number;
|
|
@@ -1296,6 +1309,8 @@ export type PendingInvitations = string[];
|
|
|
1296
1309
|
export type IsSponsored = boolean;
|
|
1297
1310
|
/** External system ID 1 */
|
|
1298
1311
|
export type ExternalID = string;
|
|
1312
|
+
/** Whether the user is enabled */
|
|
1313
|
+
export type IsEnabled = boolean;
|
|
1299
1314
|
/** Response schema for certification process data */
|
|
1300
1315
|
export interface CertificationProcessResponseEntity {
|
|
1301
1316
|
/** @example "abc123" */
|
|
@@ -1376,7 +1391,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1376
1391
|
applicationItems?: Record<string, any>[];
|
|
1377
1392
|
transactionID?: string | null;
|
|
1378
1393
|
}
|
|
1379
|
-
export interface
|
|
1394
|
+
export interface InputOp11Qfftdd {
|
|
1380
1395
|
issuedOn?: number;
|
|
1381
1396
|
expiresOn?: number;
|
|
1382
1397
|
fileItems?: {
|
|
@@ -1385,14 +1400,14 @@ export interface Input910Qqt41Uy {
|
|
|
1385
1400
|
}[];
|
|
1386
1401
|
additionalNotes?: string | null;
|
|
1387
1402
|
}
|
|
1388
|
-
export interface
|
|
1403
|
+
export interface OutputZsip40Wffg {
|
|
1389
1404
|
/**
|
|
1390
1405
|
* Signed URL for the course file
|
|
1391
1406
|
* @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"
|
|
1392
1407
|
*/
|
|
1393
1408
|
fileURL: string;
|
|
1394
1409
|
}
|
|
1395
|
-
export interface
|
|
1410
|
+
export interface InputWybxjqd6Yu {
|
|
1396
1411
|
/**
|
|
1397
1412
|
* Indicates whether the waiver is approved
|
|
1398
1413
|
* @example true
|
|
@@ -1404,14 +1419,14 @@ export interface InputHrl12Mqk8D {
|
|
|
1404
1419
|
*/
|
|
1405
1420
|
additionalNotes?: string | null;
|
|
1406
1421
|
}
|
|
1407
|
-
export interface
|
|
1422
|
+
export interface Input69K9K0A74Y {
|
|
1408
1423
|
/**
|
|
1409
1424
|
* Optional notes regarding the waiver
|
|
1410
1425
|
* @example "Waiver granted due to special circumstances."
|
|
1411
1426
|
*/
|
|
1412
1427
|
additionalNotes?: string | null;
|
|
1413
1428
|
}
|
|
1414
|
-
export interface
|
|
1429
|
+
export interface InputXe1Lwafo99 {
|
|
1415
1430
|
students: {
|
|
1416
1431
|
/**
|
|
1417
1432
|
* User ID of the student to redeem the course for
|
|
@@ -1445,7 +1460,7 @@ export interface InputKhen4Tc17I {
|
|
|
1445
1460
|
*/
|
|
1446
1461
|
autoEnrolSessionID?: string;
|
|
1447
1462
|
}
|
|
1448
|
-
export interface
|
|
1463
|
+
export interface Input9Db8K7Kogs {
|
|
1449
1464
|
invites: {
|
|
1450
1465
|
/**
|
|
1451
1466
|
* Email address of the user to invite
|
|
@@ -1474,7 +1489,7 @@ export interface InputCdlvkv26J5 {
|
|
|
1474
1489
|
*/
|
|
1475
1490
|
isReservedSeat: boolean;
|
|
1476
1491
|
}
|
|
1477
|
-
export interface
|
|
1492
|
+
export interface InputErmwz24W5Ch {
|
|
1478
1493
|
/**
|
|
1479
1494
|
* Indicates whether to waive the certification process
|
|
1480
1495
|
* @example true
|
|
@@ -1487,7 +1502,7 @@ export interface InputEw6Kdi4Rw5 {
|
|
|
1487
1502
|
comments?: string | null;
|
|
1488
1503
|
}
|
|
1489
1504
|
/** Certification move response schema */
|
|
1490
|
-
export interface
|
|
1505
|
+
export interface OutputAkgx4Tma9M {
|
|
1491
1506
|
errors?: {
|
|
1492
1507
|
status: string;
|
|
1493
1508
|
object?: Record<string, any>;
|
|
@@ -1495,19 +1510,19 @@ export interface OutputPqbr8Nb69N {
|
|
|
1495
1510
|
}[];
|
|
1496
1511
|
}
|
|
1497
1512
|
/** Schema for writing a certification trigger check. */
|
|
1498
|
-
export interface
|
|
1513
|
+
export interface Input2Vk8Ylncvk {
|
|
1499
1514
|
/**
|
|
1500
1515
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1501
1516
|
* @example "CHECKED"
|
|
1502
1517
|
*/
|
|
1503
|
-
value:
|
|
1518
|
+
value: Input2Vk8YlncvkValueEnum;
|
|
1504
1519
|
/**
|
|
1505
1520
|
* List of course IDs that are blocked by this trigger check.
|
|
1506
1521
|
* @example ["course1","course2"]
|
|
1507
1522
|
*/
|
|
1508
1523
|
blockedCourses?: string[];
|
|
1509
1524
|
}
|
|
1510
|
-
export interface
|
|
1525
|
+
export interface InputI0T7Paej3Q {
|
|
1511
1526
|
/**
|
|
1512
1527
|
* Indicates whether the application item is approved
|
|
1513
1528
|
* @example true
|
|
@@ -1533,7 +1548,7 @@ export interface InputWhhy0Y04T4 {
|
|
|
1533
1548
|
export interface StudentHistoryRequestSchema {
|
|
1534
1549
|
requirements: string[];
|
|
1535
1550
|
}
|
|
1536
|
-
export interface
|
|
1551
|
+
export interface Input83K36Afucr {
|
|
1537
1552
|
/**
|
|
1538
1553
|
* Optional activation key for the application
|
|
1539
1554
|
* @example "AK-123456"
|
|
@@ -1541,7 +1556,7 @@ export interface Input45Mtt5Uufu {
|
|
|
1541
1556
|
activationKey?: string;
|
|
1542
1557
|
}
|
|
1543
1558
|
/** Schema for course submission item details post request. */
|
|
1544
|
-
export interface
|
|
1559
|
+
export interface InputRyux0X1Wfxi {
|
|
1545
1560
|
/**
|
|
1546
1561
|
* The ID of the file being submitted.
|
|
1547
1562
|
* @example "fileID123"
|
|
@@ -1554,7 +1569,7 @@ export interface InputKs6L7Xdq9Sj {
|
|
|
1554
1569
|
fileName: string;
|
|
1555
1570
|
}
|
|
1556
1571
|
/** Schema for the response to course submission item details post request. */
|
|
1557
|
-
export interface
|
|
1572
|
+
export interface OutputRyux0X1Wfxi {
|
|
1558
1573
|
submissionItems: {
|
|
1559
1574
|
/**
|
|
1560
1575
|
* The ID of the file being submitted.
|
|
@@ -1569,7 +1584,7 @@ export interface OutputKs6L7Xdq9Sj {
|
|
|
1569
1584
|
}[];
|
|
1570
1585
|
}
|
|
1571
1586
|
/** Pending approval submission parameters */
|
|
1572
|
-
export interface
|
|
1587
|
+
export interface InputZfuxynsisq {
|
|
1573
1588
|
/**
|
|
1574
1589
|
* Type of pending approval
|
|
1575
1590
|
* @example "certification"
|
|
@@ -1589,7 +1604,7 @@ export interface InputOf3Htunvpd {
|
|
|
1589
1604
|
fileName: string;
|
|
1590
1605
|
}[];
|
|
1591
1606
|
}
|
|
1592
|
-
export interface
|
|
1607
|
+
export interface Input2H227M24Bm {
|
|
1593
1608
|
/**
|
|
1594
1609
|
* The ID of the course for which the license is being redeemed
|
|
1595
1610
|
* @example "courseID123"
|
|
@@ -1657,7 +1672,7 @@ export interface InputDvfjpfaioq {
|
|
|
1657
1672
|
acknowledgement?: string | null;
|
|
1658
1673
|
}
|
|
1659
1674
|
/** Validate certification move response schema */
|
|
1660
|
-
export interface
|
|
1675
|
+
export interface OutputOyrwu59B71J {
|
|
1661
1676
|
courses: {
|
|
1662
1677
|
name: string;
|
|
1663
1678
|
status: string;
|
|
@@ -1668,21 +1683,21 @@ export interface Output00U8E0Orpf {
|
|
|
1668
1683
|
validated: boolean;
|
|
1669
1684
|
mustCreateCP: boolean;
|
|
1670
1685
|
}
|
|
1671
|
-
export interface
|
|
1686
|
+
export interface InputD0B3Xqs3Ayh {
|
|
1672
1687
|
/**
|
|
1673
1688
|
* Comments regarding the end of the cooldown period
|
|
1674
1689
|
* @example "Cooldown period ended successfully."
|
|
1675
1690
|
*/
|
|
1676
1691
|
comments: string;
|
|
1677
1692
|
}
|
|
1678
|
-
export interface
|
|
1693
|
+
export interface OutputU2Wjcszn90J {
|
|
1679
1694
|
/**
|
|
1680
1695
|
* Signed URL for the course file
|
|
1681
1696
|
* @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"
|
|
1682
1697
|
*/
|
|
1683
1698
|
fileURL: string;
|
|
1684
1699
|
}
|
|
1685
|
-
export interface
|
|
1700
|
+
export interface InputMogrhd7Thd {
|
|
1686
1701
|
/** @example true */
|
|
1687
1702
|
agreedWithCertTerms: boolean;
|
|
1688
1703
|
/** @example 1717230000000 */
|
|
@@ -1754,21 +1769,21 @@ export interface InputIeabvj9Veq {
|
|
|
1754
1769
|
/** @example "EXT#999" */
|
|
1755
1770
|
externalID2?: string | null;
|
|
1756
1771
|
}
|
|
1757
|
-
export interface
|
|
1772
|
+
export interface InputPcpc2Q4E8Q {
|
|
1758
1773
|
/**
|
|
1759
1774
|
* Comments regarding the course unlock action
|
|
1760
1775
|
* @example "Course unlocked successfully."
|
|
1761
1776
|
*/
|
|
1762
1777
|
comments: string;
|
|
1763
1778
|
}
|
|
1764
|
-
export interface
|
|
1779
|
+
export interface InputPc0Mnbhd0R {
|
|
1765
1780
|
/**
|
|
1766
1781
|
* ITA number to update for the user
|
|
1767
1782
|
* @example "ITA123456"
|
|
1768
1783
|
*/
|
|
1769
1784
|
itaNumber: string;
|
|
1770
1785
|
}
|
|
1771
|
-
export interface
|
|
1786
|
+
export interface InputAwqkjccycs {
|
|
1772
1787
|
/** @example true */
|
|
1773
1788
|
agreedWithCertTerms: boolean;
|
|
1774
1789
|
/** @example 1717230000000 */
|
|
@@ -1840,7 +1855,7 @@ export interface Input1Gx25Yczit {
|
|
|
1840
1855
|
/** @example "EXT#999" */
|
|
1841
1856
|
externalID2?: string | null;
|
|
1842
1857
|
}
|
|
1843
|
-
export interface
|
|
1858
|
+
export interface InputA4Jxm83Nud {
|
|
1844
1859
|
/**
|
|
1845
1860
|
* The grade to override the course result with
|
|
1846
1861
|
* @example "A"
|
|
@@ -1848,7 +1863,7 @@ export interface InputCombt1Tfcq {
|
|
|
1848
1863
|
resultGrade: string;
|
|
1849
1864
|
}
|
|
1850
1865
|
/** Pending approval review parameters */
|
|
1851
|
-
export interface
|
|
1866
|
+
export interface InputQjtcoqo3Kv {
|
|
1852
1867
|
/**
|
|
1853
1868
|
* Notes provided by the reviewer for the pending approval
|
|
1854
1869
|
* @example "Please review the submitted documents."
|
|
@@ -1861,7 +1876,7 @@ export interface InputQ55Qauxwcw {
|
|
|
1861
1876
|
approved: boolean;
|
|
1862
1877
|
}
|
|
1863
1878
|
/** Schema for overriding course result dates. */
|
|
1864
|
-
export interface
|
|
1879
|
+
export interface InputUcd4Rnc1Lv {
|
|
1865
1880
|
/**
|
|
1866
1881
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1867
1882
|
* @example 1735689600000
|
|
@@ -1873,14 +1888,14 @@ export interface InputToiyqfdk2I {
|
|
|
1873
1888
|
*/
|
|
1874
1889
|
completionDate?: number;
|
|
1875
1890
|
}
|
|
1876
|
-
export interface
|
|
1891
|
+
export interface Input2Ljsft5K7R {
|
|
1877
1892
|
filter: {
|
|
1878
1893
|
from?: number;
|
|
1879
1894
|
sortOrder?: string;
|
|
1880
1895
|
sortField?: string;
|
|
1881
1896
|
};
|
|
1882
1897
|
}
|
|
1883
|
-
export interface
|
|
1898
|
+
export interface Output2Ljsft5K7R {
|
|
1884
1899
|
users: {
|
|
1885
1900
|
firstName: string;
|
|
1886
1901
|
lastName: string;
|
|
@@ -1900,7 +1915,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
1900
1915
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1901
1916
|
* @example "CHECKED"
|
|
1902
1917
|
*/
|
|
1903
|
-
export declare enum
|
|
1918
|
+
export declare enum Input2Vk8YlncvkValueEnum {
|
|
1904
1919
|
CHECKED = "CHECKED",
|
|
1905
1920
|
UNCHECKED = "UNCHECKED",
|
|
1906
1921
|
NOVALUE = "NOVALUE"
|
|
@@ -1981,6 +1996,8 @@ export type ListReportOrglicensesData = any;
|
|
|
1981
1996
|
export type ListReportOrglicensesError = ErrorResponse;
|
|
1982
1997
|
export type CreateReportOrglicensesPreviewData = any;
|
|
1983
1998
|
export type CreateReportOrglicensesPreviewError = ErrorResponse;
|
|
1999
|
+
export type CreateReportNcsoReportExportData = NcsoReportExportRequestSchema;
|
|
2000
|
+
export type CreateReportNcsoReportExportError = ErrorResponse;
|
|
1984
2001
|
export type CreateReportNcsoReportData = ReportXLSXSchema;
|
|
1985
2002
|
export type CreateReportNcsoReportError = ErrorResponse;
|
|
1986
2003
|
export type CreateReportUsersAdvancedData = any;
|
|
@@ -1991,7 +2008,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
1991
2008
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
1992
2009
|
export type CreateReportUsersSimpleData = any;
|
|
1993
2010
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
1994
|
-
export type CreateSearchUsersCountData =
|
|
2011
|
+
export type CreateSearchUsersCountData = OutputZ1Kgayshxs;
|
|
1995
2012
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
1996
2013
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
1997
2014
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2009,7 +2026,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2009
2026
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2010
2027
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2011
2028
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2012
|
-
export type GetCertificationCourseFileSignData =
|
|
2029
|
+
export type GetCertificationCourseFileSignData = OutputPgfarqya86K;
|
|
2013
2030
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2014
2031
|
export interface CreateCertificationCourseFileSignParams {
|
|
2015
2032
|
/** @example "pdf" */
|
|
@@ -2023,11 +2040,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2023
2040
|
/** @example "fileID" */
|
|
2024
2041
|
fileId: string;
|
|
2025
2042
|
}
|
|
2026
|
-
export type CreateCertificationCourseFileSignData =
|
|
2043
|
+
export type CreateCertificationCourseFileSignData = OutputU2Wjcszn90J;
|
|
2027
2044
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2028
2045
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2029
2046
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2030
|
-
export type CreateCertificationCourseDocumentData =
|
|
2047
|
+
export type CreateCertificationCourseDocumentData = OutputRyux0X1Wfxi;
|
|
2031
2048
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2032
2049
|
export type DeleteUserData = any;
|
|
2033
2050
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2039,7 +2056,7 @@ export type UpdateUserData = any;
|
|
|
2039
2056
|
export type UpdateUserError = ErrorResponse;
|
|
2040
2057
|
export type DeleteCertificationCourseData = any;
|
|
2041
2058
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2042
|
-
export type GetCertificationApplicationItemFileData =
|
|
2059
|
+
export type GetCertificationApplicationItemFileData = Output2Z07K72Yvch;
|
|
2043
2060
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2044
2061
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2045
2062
|
/** @example "pdf" */
|
|
@@ -2053,9 +2070,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2053
2070
|
/** @example "fileVersion" */
|
|
2054
2071
|
fileVersion: string;
|
|
2055
2072
|
}
|
|
2056
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2073
|
+
export type CreateCertificationApplicationItemFileData = OutputZsip40Wffg;
|
|
2057
2074
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2058
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2075
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputN6Q838Yzlz;
|
|
2059
2076
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2060
2077
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2061
2078
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2063,7 +2080,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2063
2080
|
export type GetCourseError = ErrorResponse;
|
|
2064
2081
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2065
2082
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2066
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2083
|
+
export type GetCertificationApplicationForeignFillData = OutputDgabev9Kax;
|
|
2067
2084
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2068
2085
|
export type GetCertificationPrintData = any;
|
|
2069
2086
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2097,7 +2114,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2097
2114
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2098
2115
|
export type CreateCertificationWaiveData = any;
|
|
2099
2116
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2100
|
-
export type CreateCertificationMoveData =
|
|
2117
|
+
export type CreateCertificationMoveData = OutputAkgx4Tma9M;
|
|
2101
2118
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2102
2119
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2103
2120
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2125,7 +2142,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2125
2142
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2126
2143
|
export type CreateCertificationCourseRedeemData = any;
|
|
2127
2144
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2128
|
-
export type CreateCertificationMoveValidateData =
|
|
2145
|
+
export type CreateCertificationMoveValidateData = OutputOyrwu59B71J;
|
|
2129
2146
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2130
2147
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2131
2148
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2137,7 +2154,7 @@ export type UpdateCertificationCourseOverrideResultData = any;
|
|
|
2137
2154
|
export type UpdateCertificationCourseOverrideResultError = ErrorResponse;
|
|
2138
2155
|
export type UpdateCertificationSetDatesData = any;
|
|
2139
2156
|
export type UpdateCertificationSetDatesError = ErrorResponse;
|
|
2140
|
-
export type CreateCertificationResult =
|
|
2157
|
+
export type CreateCertificationResult = Output2Ljsft5K7R;
|
|
2141
2158
|
export type CreateCertificationFail = ErrorResponse;
|
|
2142
2159
|
import type { AxiosInstance, AxiosRequestConfig, ResponseType } from 'axios';
|
|
2143
2160
|
export type QueryParamsType = Record<string | number, any>;
|
|
@@ -2182,7 +2199,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2182
2199
|
}
|
|
2183
2200
|
/**
|
|
2184
2201
|
* @title BCCSA Program API
|
|
2185
|
-
* @version 3.0.
|
|
2202
|
+
* @version 3.0.9
|
|
2186
2203
|
* @baseUrl http://localhost:8080
|
|
2187
2204
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2188
2205
|
*/
|
|
@@ -2197,7 +2214,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2197
2214
|
* @request POST:/contactUs
|
|
2198
2215
|
* @secure
|
|
2199
2216
|
*/
|
|
2200
|
-
listContactUs: (data:
|
|
2217
|
+
listContactUs: (data: InputM2C55Bd8Tz, params?: RequestParams) => Promise<any>;
|
|
2201
2218
|
};
|
|
2202
2219
|
customer: {
|
|
2203
2220
|
/**
|
|
@@ -2301,7 +2318,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2301
2318
|
* @request POST:/tenant/report/applicationExport
|
|
2302
2319
|
* @secure
|
|
2303
2320
|
*/
|
|
2304
|
-
createReportApplicationExport: (data:
|
|
2321
|
+
createReportApplicationExport: (data: InputAcronryug2, params?: RequestParams) => Promise<any>;
|
|
2305
2322
|
/**
|
|
2306
2323
|
* @description Export a report of applications based on the provided filters.
|
|
2307
2324
|
*
|
|
@@ -2311,7 +2328,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2311
2328
|
* @request POST:/tenant/report/applicationStatus
|
|
2312
2329
|
* @secure
|
|
2313
2330
|
*/
|
|
2314
|
-
listReportApplicationStatus: (data:
|
|
2331
|
+
listReportApplicationStatus: (data: InputHcpt0Eg8Rw, params?: RequestParams) => Promise<any>;
|
|
2315
2332
|
/**
|
|
2316
2333
|
* @description Export a report of applications based on the provided filters.
|
|
2317
2334
|
*
|
|
@@ -2321,7 +2338,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2321
2338
|
* @request POST:/tenant/report/applicationsReport
|
|
2322
2339
|
* @secure
|
|
2323
2340
|
*/
|
|
2324
|
-
createReportApplicationsReport: (data:
|
|
2341
|
+
createReportApplicationsReport: (data: InputWc6Eh9Ziyxj, params?: RequestParams) => Promise<any>;
|
|
2325
2342
|
/**
|
|
2326
2343
|
* @description This route allows you to post certificates email for the tenant.
|
|
2327
2344
|
*
|
|
@@ -2331,7 +2348,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2331
2348
|
* @request POST:/tenant/certificates/email
|
|
2332
2349
|
* @secure
|
|
2333
2350
|
*/
|
|
2334
|
-
createCertificatesEmail: (data:
|
|
2351
|
+
createCertificatesEmail: (data: Input0Vvobhlytb, params?: RequestParams) => Promise<any>;
|
|
2335
2352
|
/**
|
|
2336
2353
|
* @description Generate a preview of the completed certifications report.
|
|
2337
2354
|
*
|
|
@@ -2361,7 +2378,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2361
2378
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2362
2379
|
* @secure
|
|
2363
2380
|
*/
|
|
2364
|
-
createLicenseRedeem: (userId: string, data:
|
|
2381
|
+
createLicenseRedeem: (userId: string, data: InputQ6H7C6Fxfc, params?: RequestParams) => Promise<any>;
|
|
2365
2382
|
/**
|
|
2366
2383
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2367
2384
|
*
|
|
@@ -2371,7 +2388,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2371
2388
|
* @request POST:/tenant/report/orglicenses/
|
|
2372
2389
|
* @secure
|
|
2373
2390
|
*/
|
|
2374
|
-
listReportOrglicenses: (data:
|
|
2391
|
+
listReportOrglicenses: (data: InputFyxk6Ticie, params?: RequestParams) => Promise<any>;
|
|
2375
2392
|
/**
|
|
2376
2393
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2377
2394
|
*
|
|
@@ -2381,7 +2398,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2381
2398
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2382
2399
|
* @secure
|
|
2383
2400
|
*/
|
|
2384
|
-
createReportOrglicensesPreview: (data:
|
|
2401
|
+
createReportOrglicensesPreview: (data: InputAcyg29Xjkzj, params?: RequestParams) => Promise<any>;
|
|
2402
|
+
/**
|
|
2403
|
+
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2404
|
+
*
|
|
2405
|
+
* @tags Reports
|
|
2406
|
+
* @name CreateReportNcsoReportExport
|
|
2407
|
+
* @summary NCSO Export report
|
|
2408
|
+
* @request POST:/tenant/report/ncsoReport/export
|
|
2409
|
+
* @secure
|
|
2410
|
+
*/
|
|
2411
|
+
createReportNcsoReportExport: (data: NcsoReportRequestSchema, params?: RequestParams) => Promise<NcsoReportExportRequestSchema>;
|
|
2385
2412
|
/**
|
|
2386
2413
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2387
2414
|
*
|
|
@@ -2401,7 +2428,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2401
2428
|
* @request POST:/tenant/report/users/advanced
|
|
2402
2429
|
* @secure
|
|
2403
2430
|
*/
|
|
2404
|
-
createReportUsersAdvanced: (data:
|
|
2431
|
+
createReportUsersAdvanced: (data: InputUpehhj9C6W, params?: RequestParams) => Promise<any>;
|
|
2405
2432
|
/**
|
|
2406
2433
|
* @description Searches for users in the tenant by their IDs.
|
|
2407
2434
|
*
|
|
@@ -2411,7 +2438,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2411
2438
|
* @request POST:/tenant/search/users/ids
|
|
2412
2439
|
* @secure
|
|
2413
2440
|
*/
|
|
2414
|
-
listSearchUsersIds: (data:
|
|
2441
|
+
listSearchUsersIds: (data: InputQbv906Ts61, params?: RequestParams) => Promise<any>;
|
|
2415
2442
|
/**
|
|
2416
2443
|
* @description Searches for users in the tenant by term and filters.
|
|
2417
2444
|
*
|
|
@@ -2421,7 +2448,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2421
2448
|
* @request POST:/tenant/search/users/term
|
|
2422
2449
|
* @secure
|
|
2423
2450
|
*/
|
|
2424
|
-
createSearchUsersTerm: (data:
|
|
2451
|
+
createSearchUsersTerm: (data: InputCg0P4Kyfnx, params?: RequestParams) => Promise<any>;
|
|
2425
2452
|
/**
|
|
2426
2453
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2427
2454
|
*
|
|
@@ -2431,7 +2458,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2431
2458
|
* @request POST:/tenant/report/users/simple
|
|
2432
2459
|
* @secure
|
|
2433
2460
|
*/
|
|
2434
|
-
createReportUsersSimple: (data:
|
|
2461
|
+
createReportUsersSimple: (data: InputJu5Xefnams, params?: RequestParams) => Promise<any>;
|
|
2435
2462
|
/**
|
|
2436
2463
|
* @description Retrieve user by ID.
|
|
2437
2464
|
*
|
|
@@ -2441,7 +2468,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2441
2468
|
* @request POST:/tenant/search/users/count
|
|
2442
2469
|
* @secure
|
|
2443
2470
|
*/
|
|
2444
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2471
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputZ1Kgayshxs>;
|
|
2445
2472
|
};
|
|
2446
2473
|
user: {
|
|
2447
2474
|
/**
|
|
@@ -2473,7 +2500,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2473
2500
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2474
2501
|
* @secure
|
|
2475
2502
|
*/
|
|
2476
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2503
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: InputOp11Qfftdd, params?: RequestParams) => Promise<any>;
|
|
2477
2504
|
/**
|
|
2478
2505
|
* @description Delete a certification process application by type.
|
|
2479
2506
|
*
|
|
@@ -2533,7 +2560,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2533
2560
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2534
2561
|
* @secure
|
|
2535
2562
|
*/
|
|
2536
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2563
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputPgfarqya86K>;
|
|
2537
2564
|
/**
|
|
2538
2565
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2539
2566
|
*
|
|
@@ -2543,7 +2570,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2543
2570
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2544
2571
|
* @secure
|
|
2545
2572
|
*/
|
|
2546
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2573
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputU2Wjcszn90J>;
|
|
2547
2574
|
/**
|
|
2548
2575
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2549
2576
|
*
|
|
@@ -2563,7 +2590,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2563
2590
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2564
2591
|
* @secure
|
|
2565
2592
|
*/
|
|
2566
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2593
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputRyux0X1Wfxi, params?: RequestParams) => Promise<OutputRyux0X1Wfxi>;
|
|
2567
2594
|
/**
|
|
2568
2595
|
* @description Delete user by ID.
|
|
2569
2596
|
*
|
|
@@ -2593,7 +2620,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2593
2620
|
* @request POST:/user/{userID}
|
|
2594
2621
|
* @secure
|
|
2595
2622
|
*/
|
|
2596
|
-
createUser: (userId: string, data:
|
|
2623
|
+
createUser: (userId: string, data: InputMogrhd7Thd, params?: RequestParams) => Promise<any>;
|
|
2597
2624
|
/**
|
|
2598
2625
|
* @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.
|
|
2599
2626
|
*
|
|
@@ -2603,7 +2630,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2603
2630
|
* @request PUT:/user/{userID}
|
|
2604
2631
|
* @secure
|
|
2605
2632
|
*/
|
|
2606
|
-
updateUser: (userId: string, data:
|
|
2633
|
+
updateUser: (userId: string, data: InputAwqkjccycs, params?: RequestParams) => Promise<any>;
|
|
2607
2634
|
/**
|
|
2608
2635
|
* @description Delete course from user
|
|
2609
2636
|
*
|
|
@@ -2623,7 +2650,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2623
2650
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2624
2651
|
* @secure
|
|
2625
2652
|
*/
|
|
2626
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2653
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<Output2Z07K72Yvch>;
|
|
2627
2654
|
/**
|
|
2628
2655
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2629
2656
|
*
|
|
@@ -2633,7 +2660,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2633
2660
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2634
2661
|
* @secure
|
|
2635
2662
|
*/
|
|
2636
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2663
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputZsip40Wffg>;
|
|
2637
2664
|
/**
|
|
2638
2665
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2639
2666
|
*
|
|
@@ -2643,7 +2670,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2643
2670
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2644
2671
|
* @secure
|
|
2645
2672
|
*/
|
|
2646
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2673
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputN6Q838Yzlz>;
|
|
2647
2674
|
/**
|
|
2648
2675
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2649
2676
|
*
|
|
@@ -2683,7 +2710,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2683
2710
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2684
2711
|
* @secure
|
|
2685
2712
|
*/
|
|
2686
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2713
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputDgabev9Kax>;
|
|
2687
2714
|
/**
|
|
2688
2715
|
* @description This endpoint will print certificate
|
|
2689
2716
|
*
|
|
@@ -2773,7 +2800,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2773
2800
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2774
2801
|
* @secure
|
|
2775
2802
|
*/
|
|
2776
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2803
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputWybxjqd6Yu, params?: RequestParams) => Promise<any>;
|
|
2777
2804
|
/**
|
|
2778
2805
|
* @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.
|
|
2779
2806
|
*
|
|
@@ -2783,7 +2810,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2783
2810
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2784
2811
|
* @secure
|
|
2785
2812
|
*/
|
|
2786
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2813
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: Input69K9K0A74Y, params?: RequestParams) => Promise<any>;
|
|
2787
2814
|
/**
|
|
2788
2815
|
* @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.
|
|
2789
2816
|
*
|
|
@@ -2793,7 +2820,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2793
2820
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2794
2821
|
* @secure
|
|
2795
2822
|
*/
|
|
2796
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2823
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputXe1Lwafo99, params?: RequestParams) => Promise<any>;
|
|
2797
2824
|
/**
|
|
2798
2825
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2799
2826
|
*
|
|
@@ -2803,7 +2830,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2803
2830
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2804
2831
|
* @secure
|
|
2805
2832
|
*/
|
|
2806
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2833
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: Input9Db8K7Kogs, params?: RequestParams) => Promise<any>;
|
|
2807
2834
|
/**
|
|
2808
2835
|
* @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.
|
|
2809
2836
|
*
|
|
@@ -2843,7 +2870,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2843
2870
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2844
2871
|
* @secure
|
|
2845
2872
|
*/
|
|
2846
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2873
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputErmwz24W5Ch, params?: RequestParams) => Promise<any>;
|
|
2847
2874
|
/**
|
|
2848
2875
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
2849
2876
|
*
|
|
@@ -2853,7 +2880,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2853
2880
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2854
2881
|
* @secure
|
|
2855
2882
|
*/
|
|
2856
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2883
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputAkgx4Tma9M>;
|
|
2857
2884
|
/**
|
|
2858
2885
|
* @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.
|
|
2859
2886
|
*
|
|
@@ -2883,7 +2910,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2883
2910
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2884
2911
|
* @secure
|
|
2885
2912
|
*/
|
|
2886
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
2913
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: Input2Vk8Ylncvk, params?: RequestParams) => Promise<any>;
|
|
2887
2914
|
/**
|
|
2888
2915
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
2889
2916
|
*
|
|
@@ -2933,7 +2960,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2933
2960
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
2934
2961
|
* @secure
|
|
2935
2962
|
*/
|
|
2936
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
2963
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: InputI0T7Paej3Q, params?: RequestParams) => Promise<any>;
|
|
2937
2964
|
/**
|
|
2938
2965
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
2939
2966
|
*
|
|
@@ -2953,7 +2980,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2953
2980
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
2954
2981
|
* @secure
|
|
2955
2982
|
*/
|
|
2956
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
2983
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: Input83K36Afucr, params?: RequestParams) => Promise<any>;
|
|
2957
2984
|
/**
|
|
2958
2985
|
* @description This route allows you to submit a pending approval.
|
|
2959
2986
|
*
|
|
@@ -2963,7 +2990,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2963
2990
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
2964
2991
|
* @secure
|
|
2965
2992
|
*/
|
|
2966
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
2993
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputZfuxynsisq, params?: RequestParams) => Promise<any>;
|
|
2967
2994
|
/**
|
|
2968
2995
|
* @description This route allows you to review a pending approval.
|
|
2969
2996
|
*
|
|
@@ -2973,7 +3000,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2973
3000
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
2974
3001
|
* @secure
|
|
2975
3002
|
*/
|
|
2976
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3003
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputQjtcoqo3Kv, params?: RequestParams) => Promise<any>;
|
|
2977
3004
|
/**
|
|
2978
3005
|
* @description Redeems a license for a user by product ID.
|
|
2979
3006
|
*
|
|
@@ -2983,7 +3010,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2983
3010
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
2984
3011
|
* @secure
|
|
2985
3012
|
*/
|
|
2986
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3013
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: Input2H227M24Bm, params?: RequestParams) => Promise<any>;
|
|
2987
3014
|
/**
|
|
2988
3015
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
2989
3016
|
*
|
|
@@ -2993,7 +3020,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2993
3020
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
2994
3021
|
* @secure
|
|
2995
3022
|
*/
|
|
2996
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3023
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputOyrwu59B71J>;
|
|
2997
3024
|
/**
|
|
2998
3025
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
2999
3026
|
*
|
|
@@ -3003,7 +3030,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3003
3030
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3004
3031
|
* @secure
|
|
3005
3032
|
*/
|
|
3006
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3033
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputD0B3Xqs3Ayh, params?: RequestParams) => Promise<any>;
|
|
3007
3034
|
/**
|
|
3008
3035
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3009
3036
|
*
|
|
@@ -3013,7 +3040,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3013
3040
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3014
3041
|
* @secure
|
|
3015
3042
|
*/
|
|
3016
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3043
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputPcpc2Q4E8Q, params?: RequestParams) => Promise<any>;
|
|
3017
3044
|
/**
|
|
3018
3045
|
* @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.
|
|
3019
3046
|
*
|
|
@@ -3023,7 +3050,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3023
3050
|
* @request POST:/user/{userID}/updateITA
|
|
3024
3051
|
* @secure
|
|
3025
3052
|
*/
|
|
3026
|
-
createUpdateIta: (userId: string, data:
|
|
3053
|
+
createUpdateIta: (userId: string, data: InputPc0Mnbhd0R, params?: RequestParams) => Promise<any>;
|
|
3027
3054
|
/**
|
|
3028
3055
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3029
3056
|
*
|
|
@@ -3033,7 +3060,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3033
3060
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3034
3061
|
* @secure
|
|
3035
3062
|
*/
|
|
3036
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3063
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputA4Jxm83Nud, params?: RequestParams) => Promise<any>;
|
|
3037
3064
|
/**
|
|
3038
3065
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3039
3066
|
*
|
|
@@ -3043,7 +3070,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3043
3070
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3044
3071
|
* @secure
|
|
3045
3072
|
*/
|
|
3046
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3073
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputUcd4Rnc1Lv, params?: RequestParams) => Promise<any>;
|
|
3047
3074
|
};
|
|
3048
3075
|
users: {
|
|
3049
3076
|
/**
|
|
@@ -3055,6 +3082,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3055
3082
|
* @request POST:/users/certification/{certSpecID}
|
|
3056
3083
|
* @secure
|
|
3057
3084
|
*/
|
|
3058
|
-
createCertification: (certSpecId: string, data:
|
|
3085
|
+
createCertification: (certSpecId: string, data: Input2Ljsft5K7R, params?: RequestParams) => Promise<Output2Ljsft5K7R>;
|
|
3059
3086
|
};
|
|
3060
3087
|
}
|