@ikonintegration/bccsa-program-api 3.0.8 → 3.0.10
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 +183 -144
- package/dist/Api.d.ts +169 -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 Input9Woi2G563Uh {
|
|
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 InputYu80Od690X {
|
|
453
453
|
/**
|
|
454
454
|
* ID of the certification to filter applications by
|
|
455
455
|
* @example "certification123"
|
|
@@ -506,7 +506,7 @@ export interface InputXpq62Ascd0K {
|
|
|
506
506
|
*/
|
|
507
507
|
ignoreCompletedCertifications?: boolean | null;
|
|
508
508
|
}
|
|
509
|
-
export interface
|
|
509
|
+
export interface InputYgpe7B8Ron {
|
|
510
510
|
/**
|
|
511
511
|
* ID of the certification to filter applications by
|
|
512
512
|
* @example "certification123"
|
|
@@ -563,7 +563,7 @@ export interface InputXe2F8Lrpl3 {
|
|
|
563
563
|
*/
|
|
564
564
|
ignoreCompletedCertifications?: boolean | null;
|
|
565
565
|
}
|
|
566
|
-
export interface
|
|
566
|
+
export interface InputT26Yt60F95 {
|
|
567
567
|
/**
|
|
568
568
|
* ID of the certification to filter applications by
|
|
569
569
|
* @example "certification123"
|
|
@@ -620,7 +620,7 @@ export interface InputZ5Zaihx1N8 {
|
|
|
620
620
|
*/
|
|
621
621
|
ignoreCompletedCertifications?: boolean | null;
|
|
622
622
|
}
|
|
623
|
-
export interface
|
|
623
|
+
export interface InputEr5N2L91Fj {
|
|
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 Input7Dzemgbd5M {
|
|
|
661
661
|
emailAddress: string;
|
|
662
662
|
}[];
|
|
663
663
|
}
|
|
664
|
-
export interface
|
|
664
|
+
export interface InputKamfat7578H {
|
|
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 InputLcxw15F7Bp {
|
|
|
673
673
|
*/
|
|
674
674
|
sessionID?: string;
|
|
675
675
|
}
|
|
676
|
-
export interface
|
|
676
|
+
export interface InputMm8O6Y3Lfzi {
|
|
677
677
|
/**
|
|
678
678
|
* Search term to filter licenses
|
|
679
679
|
* @example "active"
|
|
@@ -690,7 +690,7 @@ export interface InputO43S8Hm8Eqj {
|
|
|
690
690
|
*/
|
|
691
691
|
sortField?: any;
|
|
692
692
|
}
|
|
693
|
-
export interface
|
|
693
|
+
export interface InputOncu76660X {
|
|
694
694
|
/**
|
|
695
695
|
* Search term to filter licenses
|
|
696
696
|
* @example "active"
|
|
@@ -745,7 +745,7 @@ export interface ReportXLSXSchema {
|
|
|
745
745
|
xlsxStream: any;
|
|
746
746
|
contentType: ReportXlsxSchemaContentTypeEnum;
|
|
747
747
|
}
|
|
748
|
-
export interface
|
|
748
|
+
export interface Input9Yu1X2Ojm9J {
|
|
749
749
|
/**
|
|
750
750
|
* Start date for the report
|
|
751
751
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -767,11 +767,11 @@ export interface InputBv0Jn7Awf6 {
|
|
|
767
767
|
*/
|
|
768
768
|
dateType?: string;
|
|
769
769
|
}
|
|
770
|
-
export interface
|
|
770
|
+
export interface Input667M231Hdb {
|
|
771
771
|
/** List of user IDs to search for in the tenant. */
|
|
772
772
|
IDs: (string | null)[];
|
|
773
773
|
}
|
|
774
|
-
export interface
|
|
774
|
+
export interface Input7Yeqbhu8Y0F {
|
|
775
775
|
/** The term to search for in the user profiles. */
|
|
776
776
|
searchTerm?: string | null;
|
|
777
777
|
/** Filter criteria for the user search. */
|
|
@@ -811,7 +811,7 @@ export interface Input3Ysqkyuvrdk {
|
|
|
811
811
|
};
|
|
812
812
|
};
|
|
813
813
|
}
|
|
814
|
-
export interface
|
|
814
|
+
export interface Input9Rp6Ctkysij {
|
|
815
815
|
/** The term to search for in the user profiles. */
|
|
816
816
|
searchTerm?: string | null;
|
|
817
817
|
/** Filter criteria for the user search. */
|
|
@@ -853,19 +853,19 @@ export interface Input2Vykd1Irlu {
|
|
|
853
853
|
}
|
|
854
854
|
/** External system ID 2 */
|
|
855
855
|
export type ExternalID2 = number;
|
|
856
|
-
export interface
|
|
856
|
+
export interface OutputE817H1Gv6Kj {
|
|
857
857
|
/** External system ID 2 */
|
|
858
858
|
userCount: ExternalID2;
|
|
859
859
|
transactionID?: string | null;
|
|
860
860
|
}
|
|
861
|
-
export interface
|
|
861
|
+
export interface OutputKqxv2E077 {
|
|
862
862
|
/**
|
|
863
863
|
* Signed URL for the course file
|
|
864
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"
|
|
865
865
|
*/
|
|
866
866
|
fileURL: string;
|
|
867
867
|
}
|
|
868
|
-
export interface
|
|
868
|
+
export interface OutputOogxtgcw97 {
|
|
869
869
|
/**
|
|
870
870
|
* Amount to be refunded for the cancellation
|
|
871
871
|
* @example 0
|
|
@@ -1015,60 +1015,57 @@ export interface CertificationProcessResponseSchema {
|
|
|
1015
1015
|
}
|
|
1016
1016
|
/** Response schema for certification application data */
|
|
1017
1017
|
export interface CertificationApplicationResponseEntity {
|
|
1018
|
-
/**
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
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;
|
|
1058
1062
|
/** @example 1 */
|
|
1059
|
-
|
|
1060
|
-
/** @example
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
version?: number;
|
|
1066
|
-
/** @example "doc" */
|
|
1067
|
-
type?: string;
|
|
1068
|
-
}[];
|
|
1069
|
-
/** @example ["ITEM#2"] */
|
|
1070
|
-
blacklistedItems?: string[];
|
|
1071
|
-
};
|
|
1063
|
+
version?: number;
|
|
1064
|
+
/** @example "doc" */
|
|
1065
|
+
type?: string;
|
|
1066
|
+
}[];
|
|
1067
|
+
/** @example ["ITEM#2"] */
|
|
1068
|
+
blacklistedItems?: string[];
|
|
1072
1069
|
}
|
|
1073
1070
|
/** Label of the course enrolled (course version) */
|
|
1074
1071
|
export type OnlineCourseLabel = string;
|
|
@@ -1155,7 +1152,7 @@ export interface CourseResponseEntity {
|
|
|
1155
1152
|
/** Justifications for overridden course restrictions */
|
|
1156
1153
|
overwrittenJustification?: OverwrittenJustification;
|
|
1157
1154
|
}
|
|
1158
|
-
export interface
|
|
1155
|
+
export interface Output1Lgg3Xa8Ey {
|
|
1159
1156
|
/**
|
|
1160
1157
|
* Signed URL for the course file
|
|
1161
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"
|
|
@@ -1173,7 +1170,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1173
1170
|
transactionID?: string | null;
|
|
1174
1171
|
}
|
|
1175
1172
|
/** Application Foreign Fill response type */
|
|
1176
|
-
export interface
|
|
1173
|
+
export interface OutputCq8M46Vkdy {
|
|
1177
1174
|
items: {
|
|
1178
1175
|
userID: string;
|
|
1179
1176
|
createdOn?: number;
|
|
@@ -1394,7 +1391,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1394
1391
|
applicationItems?: Record<string, any>[];
|
|
1395
1392
|
transactionID?: string | null;
|
|
1396
1393
|
}
|
|
1397
|
-
export interface
|
|
1394
|
+
export interface InputDymh5Dtqbzi {
|
|
1398
1395
|
issuedOn?: number;
|
|
1399
1396
|
expiresOn?: number;
|
|
1400
1397
|
fileItems?: {
|
|
@@ -1403,14 +1400,21 @@ export interface Input5L747Svtte {
|
|
|
1403
1400
|
}[];
|
|
1404
1401
|
additionalNotes?: string | null;
|
|
1405
1402
|
}
|
|
1406
|
-
export interface
|
|
1403
|
+
export interface InputWd8Rxio4Nk {
|
|
1404
|
+
/**
|
|
1405
|
+
* Indicates whether the application is locked
|
|
1406
|
+
* @example true
|
|
1407
|
+
*/
|
|
1408
|
+
isApplicationLocked: boolean;
|
|
1409
|
+
}
|
|
1410
|
+
export interface Output9Sdk8V07Bx {
|
|
1407
1411
|
/**
|
|
1408
1412
|
* Signed URL for the course file
|
|
1409
1413
|
* @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"
|
|
1410
1414
|
*/
|
|
1411
1415
|
fileURL: string;
|
|
1412
1416
|
}
|
|
1413
|
-
export interface
|
|
1417
|
+
export interface InputErp6R9Lb76H {
|
|
1414
1418
|
/**
|
|
1415
1419
|
* Indicates whether the waiver is approved
|
|
1416
1420
|
* @example true
|
|
@@ -1422,14 +1426,14 @@ export interface InputHf5E0Y3H7A {
|
|
|
1422
1426
|
*/
|
|
1423
1427
|
additionalNotes?: string | null;
|
|
1424
1428
|
}
|
|
1425
|
-
export interface
|
|
1429
|
+
export interface InputDlkphh7I85 {
|
|
1426
1430
|
/**
|
|
1427
1431
|
* Optional notes regarding the waiver
|
|
1428
1432
|
* @example "Waiver granted due to special circumstances."
|
|
1429
1433
|
*/
|
|
1430
1434
|
additionalNotes?: string | null;
|
|
1431
1435
|
}
|
|
1432
|
-
export interface
|
|
1436
|
+
export interface Input6Ungdr7M1G {
|
|
1433
1437
|
students: {
|
|
1434
1438
|
/**
|
|
1435
1439
|
* User ID of the student to redeem the course for
|
|
@@ -1463,7 +1467,7 @@ export interface Input5N925Aol5U {
|
|
|
1463
1467
|
*/
|
|
1464
1468
|
autoEnrolSessionID?: string;
|
|
1465
1469
|
}
|
|
1466
|
-
export interface
|
|
1470
|
+
export interface InputWoyxyec215 {
|
|
1467
1471
|
invites: {
|
|
1468
1472
|
/**
|
|
1469
1473
|
* Email address of the user to invite
|
|
@@ -1492,7 +1496,7 @@ export interface InputW9T5S0Qkc1 {
|
|
|
1492
1496
|
*/
|
|
1493
1497
|
isReservedSeat: boolean;
|
|
1494
1498
|
}
|
|
1495
|
-
export interface
|
|
1499
|
+
export interface Input24Hnrp97Etj {
|
|
1496
1500
|
/**
|
|
1497
1501
|
* Indicates whether to waive the certification process
|
|
1498
1502
|
* @example true
|
|
@@ -1505,7 +1509,7 @@ export interface InputQoeh3Z4Mri {
|
|
|
1505
1509
|
comments?: string | null;
|
|
1506
1510
|
}
|
|
1507
1511
|
/** Certification move response schema */
|
|
1508
|
-
export interface
|
|
1512
|
+
export interface Output8Vfmpvd1Fpk {
|
|
1509
1513
|
errors?: {
|
|
1510
1514
|
status: string;
|
|
1511
1515
|
object?: Record<string, any>;
|
|
@@ -1513,19 +1517,19 @@ export interface OutputC1R9Inz389 {
|
|
|
1513
1517
|
}[];
|
|
1514
1518
|
}
|
|
1515
1519
|
/** Schema for writing a certification trigger check. */
|
|
1516
|
-
export interface
|
|
1520
|
+
export interface InputA7Yj5Dm2Sr {
|
|
1517
1521
|
/**
|
|
1518
1522
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1519
1523
|
* @example "CHECKED"
|
|
1520
1524
|
*/
|
|
1521
|
-
value:
|
|
1525
|
+
value: InputA7Yj5Dm2SrValueEnum;
|
|
1522
1526
|
/**
|
|
1523
1527
|
* List of course IDs that are blocked by this trigger check.
|
|
1524
1528
|
* @example ["course1","course2"]
|
|
1525
1529
|
*/
|
|
1526
1530
|
blockedCourses?: string[];
|
|
1527
1531
|
}
|
|
1528
|
-
export interface
|
|
1532
|
+
export interface InputIis91Oru0W {
|
|
1529
1533
|
/**
|
|
1530
1534
|
* Indicates whether the application item is approved
|
|
1531
1535
|
* @example true
|
|
@@ -1551,7 +1555,7 @@ export interface Input808Hbk2Ee1 {
|
|
|
1551
1555
|
export interface StudentHistoryRequestSchema {
|
|
1552
1556
|
requirements: string[];
|
|
1553
1557
|
}
|
|
1554
|
-
export interface
|
|
1558
|
+
export interface InputHv4X9A8Ecqi {
|
|
1555
1559
|
/**
|
|
1556
1560
|
* Optional activation key for the application
|
|
1557
1561
|
* @example "AK-123456"
|
|
@@ -1559,7 +1563,7 @@ export interface Input5Urxlaw1Pb {
|
|
|
1559
1563
|
activationKey?: string;
|
|
1560
1564
|
}
|
|
1561
1565
|
/** Schema for course submission item details post request. */
|
|
1562
|
-
export interface
|
|
1566
|
+
export interface InputVgu2P0752G {
|
|
1563
1567
|
/**
|
|
1564
1568
|
* The ID of the file being submitted.
|
|
1565
1569
|
* @example "fileID123"
|
|
@@ -1572,7 +1576,7 @@ export interface InputI7O1Gt3Hlt {
|
|
|
1572
1576
|
fileName: string;
|
|
1573
1577
|
}
|
|
1574
1578
|
/** Schema for the response to course submission item details post request. */
|
|
1575
|
-
export interface
|
|
1579
|
+
export interface OutputVgu2P0752G {
|
|
1576
1580
|
submissionItems: {
|
|
1577
1581
|
/**
|
|
1578
1582
|
* The ID of the file being submitted.
|
|
@@ -1587,7 +1591,7 @@ export interface OutputI7O1Gt3Hlt {
|
|
|
1587
1591
|
}[];
|
|
1588
1592
|
}
|
|
1589
1593
|
/** Pending approval submission parameters */
|
|
1590
|
-
export interface
|
|
1594
|
+
export interface InputMis0Xsifif {
|
|
1591
1595
|
/**
|
|
1592
1596
|
* Type of pending approval
|
|
1593
1597
|
* @example "certification"
|
|
@@ -1607,7 +1611,7 @@ export interface Input5Zby244H2U {
|
|
|
1607
1611
|
fileName: string;
|
|
1608
1612
|
}[];
|
|
1609
1613
|
}
|
|
1610
|
-
export interface
|
|
1614
|
+
export interface InputF9Cmteudse {
|
|
1611
1615
|
/**
|
|
1612
1616
|
* The ID of the course for which the license is being redeemed
|
|
1613
1617
|
* @example "courseID123"
|
|
@@ -1675,7 +1679,7 @@ export interface InputFa9Yplrbpd {
|
|
|
1675
1679
|
acknowledgement?: string | null;
|
|
1676
1680
|
}
|
|
1677
1681
|
/** Validate certification move response schema */
|
|
1678
|
-
export interface
|
|
1682
|
+
export interface OutputC81Tjz8Ikr {
|
|
1679
1683
|
courses: {
|
|
1680
1684
|
name: string;
|
|
1681
1685
|
status: string;
|
|
@@ -1686,21 +1690,21 @@ export interface Output2Fdgzhhdak {
|
|
|
1686
1690
|
validated: boolean;
|
|
1687
1691
|
mustCreateCP: boolean;
|
|
1688
1692
|
}
|
|
1689
|
-
export interface
|
|
1693
|
+
export interface InputHlirowo04Z {
|
|
1690
1694
|
/**
|
|
1691
1695
|
* Comments regarding the end of the cooldown period
|
|
1692
1696
|
* @example "Cooldown period ended successfully."
|
|
1693
1697
|
*/
|
|
1694
1698
|
comments: string;
|
|
1695
1699
|
}
|
|
1696
|
-
export interface
|
|
1700
|
+
export interface Output4Tq4Qwuyqk {
|
|
1697
1701
|
/**
|
|
1698
1702
|
* Signed URL for the course file
|
|
1699
1703
|
* @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"
|
|
1700
1704
|
*/
|
|
1701
1705
|
fileURL: string;
|
|
1702
1706
|
}
|
|
1703
|
-
export interface
|
|
1707
|
+
export interface InputEw00Q9Xaswf {
|
|
1704
1708
|
/** @example true */
|
|
1705
1709
|
agreedWithCertTerms: boolean;
|
|
1706
1710
|
/** @example 1717230000000 */
|
|
@@ -1772,21 +1776,21 @@ export interface Input3Gjuw93Sdm {
|
|
|
1772
1776
|
/** @example "EXT#999" */
|
|
1773
1777
|
externalID2?: string | null;
|
|
1774
1778
|
}
|
|
1775
|
-
export interface
|
|
1779
|
+
export interface InputD1D7I6Ddp9 {
|
|
1776
1780
|
/**
|
|
1777
1781
|
* Comments regarding the course unlock action
|
|
1778
1782
|
* @example "Course unlocked successfully."
|
|
1779
1783
|
*/
|
|
1780
1784
|
comments: string;
|
|
1781
1785
|
}
|
|
1782
|
-
export interface
|
|
1786
|
+
export interface InputNnlj4Lz1A8 {
|
|
1783
1787
|
/**
|
|
1784
1788
|
* ITA number to update for the user
|
|
1785
1789
|
* @example "ITA123456"
|
|
1786
1790
|
*/
|
|
1787
1791
|
itaNumber: string;
|
|
1788
1792
|
}
|
|
1789
|
-
export interface
|
|
1793
|
+
export interface InputUnw384K18D {
|
|
1790
1794
|
/** @example true */
|
|
1791
1795
|
agreedWithCertTerms: boolean;
|
|
1792
1796
|
/** @example 1717230000000 */
|
|
@@ -1858,7 +1862,7 @@ export interface InputSrvk5Bs97F {
|
|
|
1858
1862
|
/** @example "EXT#999" */
|
|
1859
1863
|
externalID2?: string | null;
|
|
1860
1864
|
}
|
|
1861
|
-
export interface
|
|
1865
|
+
export interface Input5Bax3Oggrc {
|
|
1862
1866
|
/**
|
|
1863
1867
|
* The grade to override the course result with
|
|
1864
1868
|
* @example "A"
|
|
@@ -1866,7 +1870,7 @@ export interface InputOc4Neuy2Al {
|
|
|
1866
1870
|
resultGrade: string;
|
|
1867
1871
|
}
|
|
1868
1872
|
/** Pending approval review parameters */
|
|
1869
|
-
export interface
|
|
1873
|
+
export interface Input9N2Ph4Wwh6 {
|
|
1870
1874
|
/**
|
|
1871
1875
|
* Notes provided by the reviewer for the pending approval
|
|
1872
1876
|
* @example "Please review the submitted documents."
|
|
@@ -1879,7 +1883,7 @@ export interface InputStkzst7Ygo {
|
|
|
1879
1883
|
approved: boolean;
|
|
1880
1884
|
}
|
|
1881
1885
|
/** Schema for overriding course result dates. */
|
|
1882
|
-
export interface
|
|
1886
|
+
export interface Input8Nuiwqqism {
|
|
1883
1887
|
/**
|
|
1884
1888
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1885
1889
|
* @example 1735689600000
|
|
@@ -1891,14 +1895,14 @@ export interface InputO567Nhdlpk {
|
|
|
1891
1895
|
*/
|
|
1892
1896
|
completionDate?: number;
|
|
1893
1897
|
}
|
|
1894
|
-
export interface
|
|
1898
|
+
export interface InputLn0Wp5Yy9Z {
|
|
1895
1899
|
filter: {
|
|
1896
1900
|
from?: number;
|
|
1897
1901
|
sortOrder?: string;
|
|
1898
1902
|
sortField?: string;
|
|
1899
1903
|
};
|
|
1900
1904
|
}
|
|
1901
|
-
export interface
|
|
1905
|
+
export interface OutputLn0Wp5Yy9Z {
|
|
1902
1906
|
users: {
|
|
1903
1907
|
firstName: string;
|
|
1904
1908
|
lastName: string;
|
|
@@ -1918,7 +1922,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
1918
1922
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1919
1923
|
* @example "CHECKED"
|
|
1920
1924
|
*/
|
|
1921
|
-
export declare enum
|
|
1925
|
+
export declare enum InputA7Yj5Dm2SrValueEnum {
|
|
1922
1926
|
CHECKED = "CHECKED",
|
|
1923
1927
|
UNCHECKED = "UNCHECKED",
|
|
1924
1928
|
NOVALUE = "NOVALUE"
|
|
@@ -2011,7 +2015,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2011
2015
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2012
2016
|
export type CreateReportUsersSimpleData = any;
|
|
2013
2017
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2014
|
-
export type CreateSearchUsersCountData =
|
|
2018
|
+
export type CreateSearchUsersCountData = OutputE817H1Gv6Kj;
|
|
2015
2019
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2016
2020
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2017
2021
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2029,7 +2033,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2029
2033
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2030
2034
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2031
2035
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2032
|
-
export type GetCertificationCourseFileSignData =
|
|
2036
|
+
export type GetCertificationCourseFileSignData = Output1Lgg3Xa8Ey;
|
|
2033
2037
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2034
2038
|
export interface CreateCertificationCourseFileSignParams {
|
|
2035
2039
|
/** @example "pdf" */
|
|
@@ -2043,11 +2047,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2043
2047
|
/** @example "fileID" */
|
|
2044
2048
|
fileId: string;
|
|
2045
2049
|
}
|
|
2046
|
-
export type CreateCertificationCourseFileSignData =
|
|
2050
|
+
export type CreateCertificationCourseFileSignData = Output4Tq4Qwuyqk;
|
|
2047
2051
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2048
2052
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2049
2053
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2050
|
-
export type CreateCertificationCourseDocumentData =
|
|
2054
|
+
export type CreateCertificationCourseDocumentData = OutputVgu2P0752G;
|
|
2051
2055
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2052
2056
|
export type DeleteUserData = any;
|
|
2053
2057
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2059,7 +2063,7 @@ export type UpdateUserData = any;
|
|
|
2059
2063
|
export type UpdateUserError = ErrorResponse;
|
|
2060
2064
|
export type DeleteCertificationCourseData = any;
|
|
2061
2065
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2062
|
-
export type GetCertificationApplicationItemFileData =
|
|
2066
|
+
export type GetCertificationApplicationItemFileData = OutputKqxv2E077;
|
|
2063
2067
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2064
2068
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2065
2069
|
/** @example "pdf" */
|
|
@@ -2073,9 +2077,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2073
2077
|
/** @example "fileVersion" */
|
|
2074
2078
|
fileVersion: string;
|
|
2075
2079
|
}
|
|
2076
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2080
|
+
export type CreateCertificationApplicationItemFileData = Output9Sdk8V07Bx;
|
|
2077
2081
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2078
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2082
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputOogxtgcw97;
|
|
2079
2083
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2080
2084
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2081
2085
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2083,7 +2087,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2083
2087
|
export type GetCourseError = ErrorResponse;
|
|
2084
2088
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2085
2089
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2086
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2090
|
+
export type GetCertificationApplicationForeignFillData = OutputCq8M46Vkdy;
|
|
2087
2091
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2088
2092
|
export type GetCertificationPrintData = any;
|
|
2089
2093
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2097,6 +2101,8 @@ export type GetCertificationData = CertificationProcessResponseEntity;
|
|
|
2097
2101
|
export type GetCertificationError = ErrorResponse;
|
|
2098
2102
|
export type CreateCertificationData = any;
|
|
2099
2103
|
export type CreateCertificationError = ErrorResponse;
|
|
2104
|
+
export type CreateCertificationApplicationLockData = any;
|
|
2105
|
+
export type CreateCertificationApplicationLockError = ErrorResponse;
|
|
2100
2106
|
export type CreateSessionAddData = any;
|
|
2101
2107
|
export type CreateSessionAddError = ErrorResponse;
|
|
2102
2108
|
export type CreateCertificationApplicationPreApprovalData = any;
|
|
@@ -2117,7 +2123,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2117
2123
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2118
2124
|
export type CreateCertificationWaiveData = any;
|
|
2119
2125
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2120
|
-
export type CreateCertificationMoveData =
|
|
2126
|
+
export type CreateCertificationMoveData = Output8Vfmpvd1Fpk;
|
|
2121
2127
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2122
2128
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2123
2129
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2145,7 +2151,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2145
2151
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2146
2152
|
export type CreateCertificationCourseRedeemData = any;
|
|
2147
2153
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2148
|
-
export type CreateCertificationMoveValidateData =
|
|
2154
|
+
export type CreateCertificationMoveValidateData = OutputC81Tjz8Ikr;
|
|
2149
2155
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2150
2156
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2151
2157
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2157,7 +2163,7 @@ export type UpdateCertificationCourseOverrideResultData = any;
|
|
|
2157
2163
|
export type UpdateCertificationCourseOverrideResultError = ErrorResponse;
|
|
2158
2164
|
export type UpdateCertificationSetDatesData = any;
|
|
2159
2165
|
export type UpdateCertificationSetDatesError = ErrorResponse;
|
|
2160
|
-
export type CreateCertificationResult =
|
|
2166
|
+
export type CreateCertificationResult = OutputLn0Wp5Yy9Z;
|
|
2161
2167
|
export type CreateCertificationFail = ErrorResponse;
|
|
2162
2168
|
import type { AxiosInstance, AxiosRequestConfig, ResponseType } from 'axios';
|
|
2163
2169
|
export type QueryParamsType = Record<string | number, any>;
|
|
@@ -2202,7 +2208,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2202
2208
|
}
|
|
2203
2209
|
/**
|
|
2204
2210
|
* @title BCCSA Program API
|
|
2205
|
-
* @version 3.0.
|
|
2211
|
+
* @version 3.0.10
|
|
2206
2212
|
* @baseUrl http://localhost:8080
|
|
2207
2213
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2208
2214
|
*/
|
|
@@ -2217,7 +2223,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2217
2223
|
* @request POST:/contactUs
|
|
2218
2224
|
* @secure
|
|
2219
2225
|
*/
|
|
2220
|
-
listContactUs: (data:
|
|
2226
|
+
listContactUs: (data: Input9Woi2G563Uh, params?: RequestParams) => Promise<any>;
|
|
2221
2227
|
};
|
|
2222
2228
|
customer: {
|
|
2223
2229
|
/**
|
|
@@ -2321,7 +2327,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2321
2327
|
* @request POST:/tenant/report/applicationExport
|
|
2322
2328
|
* @secure
|
|
2323
2329
|
*/
|
|
2324
|
-
createReportApplicationExport: (data:
|
|
2330
|
+
createReportApplicationExport: (data: InputYu80Od690X, params?: RequestParams) => Promise<any>;
|
|
2325
2331
|
/**
|
|
2326
2332
|
* @description Export a report of applications based on the provided filters.
|
|
2327
2333
|
*
|
|
@@ -2331,7 +2337,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2331
2337
|
* @request POST:/tenant/report/applicationStatus
|
|
2332
2338
|
* @secure
|
|
2333
2339
|
*/
|
|
2334
|
-
listReportApplicationStatus: (data:
|
|
2340
|
+
listReportApplicationStatus: (data: InputYgpe7B8Ron, params?: RequestParams) => Promise<any>;
|
|
2335
2341
|
/**
|
|
2336
2342
|
* @description Export a report of applications based on the provided filters.
|
|
2337
2343
|
*
|
|
@@ -2341,7 +2347,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2341
2347
|
* @request POST:/tenant/report/applicationsReport
|
|
2342
2348
|
* @secure
|
|
2343
2349
|
*/
|
|
2344
|
-
createReportApplicationsReport: (data:
|
|
2350
|
+
createReportApplicationsReport: (data: InputT26Yt60F95, params?: RequestParams) => Promise<any>;
|
|
2345
2351
|
/**
|
|
2346
2352
|
* @description This route allows you to post certificates email for the tenant.
|
|
2347
2353
|
*
|
|
@@ -2351,7 +2357,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2351
2357
|
* @request POST:/tenant/certificates/email
|
|
2352
2358
|
* @secure
|
|
2353
2359
|
*/
|
|
2354
|
-
createCertificatesEmail: (data:
|
|
2360
|
+
createCertificatesEmail: (data: InputEr5N2L91Fj, params?: RequestParams) => Promise<any>;
|
|
2355
2361
|
/**
|
|
2356
2362
|
* @description Generate a preview of the completed certifications report.
|
|
2357
2363
|
*
|
|
@@ -2381,7 +2387,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2381
2387
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2382
2388
|
* @secure
|
|
2383
2389
|
*/
|
|
2384
|
-
createLicenseRedeem: (userId: string, data:
|
|
2390
|
+
createLicenseRedeem: (userId: string, data: InputKamfat7578H, params?: RequestParams) => Promise<any>;
|
|
2385
2391
|
/**
|
|
2386
2392
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2387
2393
|
*
|
|
@@ -2391,7 +2397,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2391
2397
|
* @request POST:/tenant/report/orglicenses/
|
|
2392
2398
|
* @secure
|
|
2393
2399
|
*/
|
|
2394
|
-
listReportOrglicenses: (data:
|
|
2400
|
+
listReportOrglicenses: (data: InputMm8O6Y3Lfzi, params?: RequestParams) => Promise<any>;
|
|
2395
2401
|
/**
|
|
2396
2402
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2397
2403
|
*
|
|
@@ -2401,7 +2407,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2401
2407
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2402
2408
|
* @secure
|
|
2403
2409
|
*/
|
|
2404
|
-
createReportOrglicensesPreview: (data:
|
|
2410
|
+
createReportOrglicensesPreview: (data: InputOncu76660X, params?: RequestParams) => Promise<any>;
|
|
2405
2411
|
/**
|
|
2406
2412
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2407
2413
|
*
|
|
@@ -2431,7 +2437,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2431
2437
|
* @request POST:/tenant/report/users/advanced
|
|
2432
2438
|
* @secure
|
|
2433
2439
|
*/
|
|
2434
|
-
createReportUsersAdvanced: (data:
|
|
2440
|
+
createReportUsersAdvanced: (data: Input9Yu1X2Ojm9J, params?: RequestParams) => Promise<any>;
|
|
2435
2441
|
/**
|
|
2436
2442
|
* @description Searches for users in the tenant by their IDs.
|
|
2437
2443
|
*
|
|
@@ -2441,7 +2447,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2441
2447
|
* @request POST:/tenant/search/users/ids
|
|
2442
2448
|
* @secure
|
|
2443
2449
|
*/
|
|
2444
|
-
listSearchUsersIds: (data:
|
|
2450
|
+
listSearchUsersIds: (data: Input667M231Hdb, params?: RequestParams) => Promise<any>;
|
|
2445
2451
|
/**
|
|
2446
2452
|
* @description Searches for users in the tenant by term and filters.
|
|
2447
2453
|
*
|
|
@@ -2451,7 +2457,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2451
2457
|
* @request POST:/tenant/search/users/term
|
|
2452
2458
|
* @secure
|
|
2453
2459
|
*/
|
|
2454
|
-
createSearchUsersTerm: (data:
|
|
2460
|
+
createSearchUsersTerm: (data: Input7Yeqbhu8Y0F, params?: RequestParams) => Promise<any>;
|
|
2455
2461
|
/**
|
|
2456
2462
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2457
2463
|
*
|
|
@@ -2461,7 +2467,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2461
2467
|
* @request POST:/tenant/report/users/simple
|
|
2462
2468
|
* @secure
|
|
2463
2469
|
*/
|
|
2464
|
-
createReportUsersSimple: (data:
|
|
2470
|
+
createReportUsersSimple: (data: Input9Rp6Ctkysij, params?: RequestParams) => Promise<any>;
|
|
2465
2471
|
/**
|
|
2466
2472
|
* @description Retrieve user by ID.
|
|
2467
2473
|
*
|
|
@@ -2471,7 +2477,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2471
2477
|
* @request POST:/tenant/search/users/count
|
|
2472
2478
|
* @secure
|
|
2473
2479
|
*/
|
|
2474
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2480
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputE817H1Gv6Kj>;
|
|
2475
2481
|
};
|
|
2476
2482
|
user: {
|
|
2477
2483
|
/**
|
|
@@ -2503,7 +2509,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2503
2509
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2504
2510
|
* @secure
|
|
2505
2511
|
*/
|
|
2506
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2512
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: InputDymh5Dtqbzi, params?: RequestParams) => Promise<any>;
|
|
2507
2513
|
/**
|
|
2508
2514
|
* @description Delete a certification process application by type.
|
|
2509
2515
|
*
|
|
@@ -2563,7 +2569,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2563
2569
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2564
2570
|
* @secure
|
|
2565
2571
|
*/
|
|
2566
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2572
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<Output1Lgg3Xa8Ey>;
|
|
2567
2573
|
/**
|
|
2568
2574
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2569
2575
|
*
|
|
@@ -2573,7 +2579,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2573
2579
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2574
2580
|
* @secure
|
|
2575
2581
|
*/
|
|
2576
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2582
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<Output4Tq4Qwuyqk>;
|
|
2577
2583
|
/**
|
|
2578
2584
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2579
2585
|
*
|
|
@@ -2593,7 +2599,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2593
2599
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2594
2600
|
* @secure
|
|
2595
2601
|
*/
|
|
2596
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2602
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputVgu2P0752G, params?: RequestParams) => Promise<OutputVgu2P0752G>;
|
|
2597
2603
|
/**
|
|
2598
2604
|
* @description Delete user by ID.
|
|
2599
2605
|
*
|
|
@@ -2623,7 +2629,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2623
2629
|
* @request POST:/user/{userID}
|
|
2624
2630
|
* @secure
|
|
2625
2631
|
*/
|
|
2626
|
-
createUser: (userId: string, data:
|
|
2632
|
+
createUser: (userId: string, data: InputEw00Q9Xaswf, params?: RequestParams) => Promise<any>;
|
|
2627
2633
|
/**
|
|
2628
2634
|
* @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.
|
|
2629
2635
|
*
|
|
@@ -2633,7 +2639,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2633
2639
|
* @request PUT:/user/{userID}
|
|
2634
2640
|
* @secure
|
|
2635
2641
|
*/
|
|
2636
|
-
updateUser: (userId: string, data:
|
|
2642
|
+
updateUser: (userId: string, data: InputUnw384K18D, params?: RequestParams) => Promise<any>;
|
|
2637
2643
|
/**
|
|
2638
2644
|
* @description Delete course from user
|
|
2639
2645
|
*
|
|
@@ -2653,7 +2659,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2653
2659
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2654
2660
|
* @secure
|
|
2655
2661
|
*/
|
|
2656
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2662
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputKqxv2E077>;
|
|
2657
2663
|
/**
|
|
2658
2664
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2659
2665
|
*
|
|
@@ -2663,7 +2669,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2663
2669
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2664
2670
|
* @secure
|
|
2665
2671
|
*/
|
|
2666
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2672
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<Output9Sdk8V07Bx>;
|
|
2667
2673
|
/**
|
|
2668
2674
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2669
2675
|
*
|
|
@@ -2673,7 +2679,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2673
2679
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2674
2680
|
* @secure
|
|
2675
2681
|
*/
|
|
2676
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2682
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputOogxtgcw97>;
|
|
2677
2683
|
/**
|
|
2678
2684
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2679
2685
|
*
|
|
@@ -2713,7 +2719,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2713
2719
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2714
2720
|
* @secure
|
|
2715
2721
|
*/
|
|
2716
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2722
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputCq8M46Vkdy>;
|
|
2717
2723
|
/**
|
|
2718
2724
|
* @description This endpoint will print certificate
|
|
2719
2725
|
*
|
|
@@ -2774,6 +2780,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2774
2780
|
* @secure
|
|
2775
2781
|
*/
|
|
2776
2782
|
createCertification: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
|
|
2783
|
+
/**
|
|
2784
|
+
* @description This route indicates users should not be able to advance or make changes to applications in this certification.
|
|
2785
|
+
*
|
|
2786
|
+
* @tags Application
|
|
2787
|
+
* @name CreateCertificationApplicationLock
|
|
2788
|
+
* @summary Lock Certification Application
|
|
2789
|
+
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2790
|
+
* @secure
|
|
2791
|
+
*/
|
|
2792
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputWd8Rxio4Nk, params?: RequestParams) => Promise<any>;
|
|
2777
2793
|
/**
|
|
2778
2794
|
* @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.
|
|
2779
2795
|
*
|
|
@@ -2803,7 +2819,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2803
2819
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2804
2820
|
* @secure
|
|
2805
2821
|
*/
|
|
2806
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2822
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputErp6R9Lb76H, params?: RequestParams) => Promise<any>;
|
|
2807
2823
|
/**
|
|
2808
2824
|
* @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.
|
|
2809
2825
|
*
|
|
@@ -2813,7 +2829,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2813
2829
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2814
2830
|
* @secure
|
|
2815
2831
|
*/
|
|
2816
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2832
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputDlkphh7I85, params?: RequestParams) => Promise<any>;
|
|
2817
2833
|
/**
|
|
2818
2834
|
* @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.
|
|
2819
2835
|
*
|
|
@@ -2823,7 +2839,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2823
2839
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2824
2840
|
* @secure
|
|
2825
2841
|
*/
|
|
2826
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2842
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: Input6Ungdr7M1G, params?: RequestParams) => Promise<any>;
|
|
2827
2843
|
/**
|
|
2828
2844
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2829
2845
|
*
|
|
@@ -2833,7 +2849,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2833
2849
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2834
2850
|
* @secure
|
|
2835
2851
|
*/
|
|
2836
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2852
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputWoyxyec215, params?: RequestParams) => Promise<any>;
|
|
2837
2853
|
/**
|
|
2838
2854
|
* @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.
|
|
2839
2855
|
*
|
|
@@ -2873,7 +2889,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2873
2889
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2874
2890
|
* @secure
|
|
2875
2891
|
*/
|
|
2876
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2892
|
+
createCertificationWaive: (userId: string, certProcId: string, data: Input24Hnrp97Etj, params?: RequestParams) => Promise<any>;
|
|
2877
2893
|
/**
|
|
2878
2894
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
2879
2895
|
*
|
|
@@ -2883,7 +2899,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2883
2899
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2884
2900
|
* @secure
|
|
2885
2901
|
*/
|
|
2886
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2902
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<Output8Vfmpvd1Fpk>;
|
|
2887
2903
|
/**
|
|
2888
2904
|
* @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.
|
|
2889
2905
|
*
|
|
@@ -2913,7 +2929,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2913
2929
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2914
2930
|
* @secure
|
|
2915
2931
|
*/
|
|
2916
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
2932
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputA7Yj5Dm2Sr, params?: RequestParams) => Promise<any>;
|
|
2917
2933
|
/**
|
|
2918
2934
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
2919
2935
|
*
|
|
@@ -2963,7 +2979,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2963
2979
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
2964
2980
|
* @secure
|
|
2965
2981
|
*/
|
|
2966
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
2982
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: InputIis91Oru0W, params?: RequestParams) => Promise<any>;
|
|
2967
2983
|
/**
|
|
2968
2984
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
2969
2985
|
*
|
|
@@ -2983,7 +2999,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2983
2999
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
2984
3000
|
* @secure
|
|
2985
3001
|
*/
|
|
2986
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3002
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputHv4X9A8Ecqi, params?: RequestParams) => Promise<any>;
|
|
2987
3003
|
/**
|
|
2988
3004
|
* @description This route allows you to submit a pending approval.
|
|
2989
3005
|
*
|
|
@@ -2993,7 +3009,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2993
3009
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
2994
3010
|
* @secure
|
|
2995
3011
|
*/
|
|
2996
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3012
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputMis0Xsifif, params?: RequestParams) => Promise<any>;
|
|
2997
3013
|
/**
|
|
2998
3014
|
* @description This route allows you to review a pending approval.
|
|
2999
3015
|
*
|
|
@@ -3003,7 +3019,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3003
3019
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3004
3020
|
* @secure
|
|
3005
3021
|
*/
|
|
3006
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3022
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: Input9N2Ph4Wwh6, params?: RequestParams) => Promise<any>;
|
|
3007
3023
|
/**
|
|
3008
3024
|
* @description Redeems a license for a user by product ID.
|
|
3009
3025
|
*
|
|
@@ -3013,7 +3029,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3013
3029
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3014
3030
|
* @secure
|
|
3015
3031
|
*/
|
|
3016
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3032
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputF9Cmteudse, params?: RequestParams) => Promise<any>;
|
|
3017
3033
|
/**
|
|
3018
3034
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3019
3035
|
*
|
|
@@ -3023,7 +3039,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3023
3039
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3024
3040
|
* @secure
|
|
3025
3041
|
*/
|
|
3026
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3042
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputC81Tjz8Ikr>;
|
|
3027
3043
|
/**
|
|
3028
3044
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3029
3045
|
*
|
|
@@ -3033,7 +3049,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3033
3049
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3034
3050
|
* @secure
|
|
3035
3051
|
*/
|
|
3036
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3052
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputHlirowo04Z, params?: RequestParams) => Promise<any>;
|
|
3037
3053
|
/**
|
|
3038
3054
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3039
3055
|
*
|
|
@@ -3043,7 +3059,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3043
3059
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3044
3060
|
* @secure
|
|
3045
3061
|
*/
|
|
3046
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3062
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputD1D7I6Ddp9, params?: RequestParams) => Promise<any>;
|
|
3047
3063
|
/**
|
|
3048
3064
|
* @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.
|
|
3049
3065
|
*
|
|
@@ -3053,7 +3069,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3053
3069
|
* @request POST:/user/{userID}/updateITA
|
|
3054
3070
|
* @secure
|
|
3055
3071
|
*/
|
|
3056
|
-
createUpdateIta: (userId: string, data:
|
|
3072
|
+
createUpdateIta: (userId: string, data: InputNnlj4Lz1A8, params?: RequestParams) => Promise<any>;
|
|
3057
3073
|
/**
|
|
3058
3074
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3059
3075
|
*
|
|
@@ -3063,7 +3079,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3063
3079
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3064
3080
|
* @secure
|
|
3065
3081
|
*/
|
|
3066
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3082
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: Input5Bax3Oggrc, params?: RequestParams) => Promise<any>;
|
|
3067
3083
|
/**
|
|
3068
3084
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3069
3085
|
*
|
|
@@ -3073,7 +3089,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3073
3089
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3074
3090
|
* @secure
|
|
3075
3091
|
*/
|
|
3076
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3092
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: Input8Nuiwqqism, params?: RequestParams) => Promise<any>;
|
|
3077
3093
|
};
|
|
3078
3094
|
users: {
|
|
3079
3095
|
/**
|
|
@@ -3085,6 +3101,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3085
3101
|
* @request POST:/users/certification/{certSpecID}
|
|
3086
3102
|
* @secure
|
|
3087
3103
|
*/
|
|
3088
|
-
createCertification: (certSpecId: string, data:
|
|
3104
|
+
createCertification: (certSpecId: string, data: InputLn0Wp5Yy9Z, params?: RequestParams) => Promise<OutputLn0Wp5Yy9Z>;
|
|
3089
3105
|
};
|
|
3090
3106
|
}
|