@ikonintegration/bccsa-program-api 3.0.21 → 3.0.23
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 +152 -93
- package/dist/Api.d.ts +126 -102
- package/dist/Api.js +38 -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 InputEfljkqzkrw {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -431,7 +431,7 @@ export type Name = string;
|
|
|
431
431
|
export type CertTitle = string;
|
|
432
432
|
/** User display name */
|
|
433
433
|
export type DisplayName = string;
|
|
434
|
-
export interface
|
|
434
|
+
export interface InputU4C3V4De8Hg {
|
|
435
435
|
/**
|
|
436
436
|
* ID of the certification to filter applications by
|
|
437
437
|
* @example "certification123"
|
|
@@ -488,7 +488,7 @@ export interface InputFkhhceghyzl {
|
|
|
488
488
|
*/
|
|
489
489
|
ignoreCompletedCertifications?: boolean | null;
|
|
490
490
|
}
|
|
491
|
-
export interface
|
|
491
|
+
export interface InputVsl3M1Bf02 {
|
|
492
492
|
/**
|
|
493
493
|
* ID of the certification to filter applications by
|
|
494
494
|
* @example "certification123"
|
|
@@ -545,7 +545,7 @@ export interface InputTqw0Engz1K {
|
|
|
545
545
|
*/
|
|
546
546
|
ignoreCompletedCertifications?: boolean | null;
|
|
547
547
|
}
|
|
548
|
-
export interface
|
|
548
|
+
export interface InputQtxygdy6Sp {
|
|
549
549
|
/**
|
|
550
550
|
* ID of the certification to filter applications by
|
|
551
551
|
* @example "certification123"
|
|
@@ -602,7 +602,7 @@ export interface InputW6Ogy13Eka {
|
|
|
602
602
|
*/
|
|
603
603
|
ignoreCompletedCertifications?: boolean | null;
|
|
604
604
|
}
|
|
605
|
-
export interface
|
|
605
|
+
export interface InputW7Byz2Y6Du {
|
|
606
606
|
/**
|
|
607
607
|
* The ID of the certificate specifications to be used for the email
|
|
608
608
|
* @example "certSpecsID123"
|
|
@@ -643,7 +643,7 @@ export interface InputPv1T1Jl6F2 {
|
|
|
643
643
|
emailAddress: string;
|
|
644
644
|
}[];
|
|
645
645
|
}
|
|
646
|
-
export interface
|
|
646
|
+
export interface Input72I12Ohjlb {
|
|
647
647
|
/**
|
|
648
648
|
* The ID of the product for which the license is being redeemed
|
|
649
649
|
* @example "productID123"
|
|
@@ -655,7 +655,7 @@ export interface Input8Cpolmn5Gd {
|
|
|
655
655
|
*/
|
|
656
656
|
sessionID?: string;
|
|
657
657
|
}
|
|
658
|
-
export interface
|
|
658
|
+
export interface Input9X53Pc16Nx {
|
|
659
659
|
/**
|
|
660
660
|
* Search term to filter licenses
|
|
661
661
|
* @example "active"
|
|
@@ -672,7 +672,7 @@ export interface Input9Majdwna3Q {
|
|
|
672
672
|
*/
|
|
673
673
|
sortField?: any;
|
|
674
674
|
}
|
|
675
|
-
export interface
|
|
675
|
+
export interface InputGlah2T7Jz6 {
|
|
676
676
|
/**
|
|
677
677
|
* Search term to filter licenses
|
|
678
678
|
* @example "active"
|
|
@@ -728,7 +728,7 @@ export interface ReportXLSXSchema {
|
|
|
728
728
|
xlsxStream: File;
|
|
729
729
|
contentType: ReportXlsxSchemaContentTypeEnum;
|
|
730
730
|
}
|
|
731
|
-
export interface
|
|
731
|
+
export interface InputF7Vlnyefnb {
|
|
732
732
|
/**
|
|
733
733
|
* Start date for the report
|
|
734
734
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -750,11 +750,11 @@ export interface Input7Edbrvo147 {
|
|
|
750
750
|
*/
|
|
751
751
|
dateType?: string;
|
|
752
752
|
}
|
|
753
|
-
export interface
|
|
753
|
+
export interface InputOju7Ip0Ji8 {
|
|
754
754
|
/** List of user IDs to search for in the tenant. */
|
|
755
755
|
IDs: (string | null)[];
|
|
756
756
|
}
|
|
757
|
-
export interface
|
|
757
|
+
export interface Input6Eq5Uhd3Vt {
|
|
758
758
|
/** The term to search for in the user profiles. */
|
|
759
759
|
searchTerm?: string | null;
|
|
760
760
|
/** Filter criteria for the user search. */
|
|
@@ -794,7 +794,7 @@ export interface Input5Me4Tjplpx {
|
|
|
794
794
|
};
|
|
795
795
|
};
|
|
796
796
|
}
|
|
797
|
-
export interface
|
|
797
|
+
export interface InputMwks4Uarfm {
|
|
798
798
|
/** The term to search for in the user profiles. */
|
|
799
799
|
searchTerm?: string | null;
|
|
800
800
|
/** Filter criteria for the user search. */
|
|
@@ -834,21 +834,21 @@ export interface InputWn5Qm2Uk5Fg {
|
|
|
834
834
|
};
|
|
835
835
|
};
|
|
836
836
|
}
|
|
837
|
-
export interface
|
|
837
|
+
export interface Output05U2N2Mzx7 {
|
|
838
838
|
/** External system ID 2 */
|
|
839
839
|
userCount: ExternalID2;
|
|
840
840
|
transactionID?: string | null;
|
|
841
841
|
}
|
|
842
842
|
/** External system ID 2 */
|
|
843
843
|
export type ExternalID2 = number;
|
|
844
|
-
export interface
|
|
844
|
+
export interface OutputQa6Exvrof4 {
|
|
845
845
|
/**
|
|
846
846
|
* Signed URL for the course file
|
|
847
847
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
848
848
|
*/
|
|
849
849
|
fileURL: string;
|
|
850
850
|
}
|
|
851
|
-
export interface
|
|
851
|
+
export interface OutputYec4No63M9 {
|
|
852
852
|
/**
|
|
853
853
|
* Amount to be refunded for the cancellation
|
|
854
854
|
* @example 0
|
|
@@ -1139,7 +1139,7 @@ export interface CourseResponseEntity {
|
|
|
1139
1139
|
}
|
|
1140
1140
|
/** Label of the course enrolled (course version) */
|
|
1141
1141
|
export type OnlineCourseLabel = string;
|
|
1142
|
-
export interface
|
|
1142
|
+
export interface OutputDex7Yz6Ahvl {
|
|
1143
1143
|
/**
|
|
1144
1144
|
* Signed URL for the course file
|
|
1145
1145
|
* @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 +1157,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1157
1157
|
transactionID?: string | null;
|
|
1158
1158
|
}
|
|
1159
1159
|
/** Application Foreign Fill response type */
|
|
1160
|
-
export interface
|
|
1160
|
+
export interface OutputB1Xkxknewy {
|
|
1161
1161
|
items: {
|
|
1162
1162
|
userID: string;
|
|
1163
1163
|
createdOn?: number;
|
|
@@ -1340,7 +1340,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1340
1340
|
applicationItems?: Record<string, any>[];
|
|
1341
1341
|
transactionID?: string | null;
|
|
1342
1342
|
}
|
|
1343
|
-
export interface
|
|
1343
|
+
export interface Input69Xz46Fwmt {
|
|
1344
1344
|
issuedOn?: number;
|
|
1345
1345
|
expiresOn?: number;
|
|
1346
1346
|
fileItems?: {
|
|
@@ -1349,21 +1349,21 @@ export interface Input99Zaw9Tk82 {
|
|
|
1349
1349
|
}[];
|
|
1350
1350
|
additionalNotes?: string | null;
|
|
1351
1351
|
}
|
|
1352
|
-
export interface
|
|
1352
|
+
export interface InputGb0Q4Ecdub {
|
|
1353
1353
|
/**
|
|
1354
1354
|
* Indicates whether the application is locked
|
|
1355
1355
|
* @example true
|
|
1356
1356
|
*/
|
|
1357
1357
|
isApplicationLocked: boolean;
|
|
1358
1358
|
}
|
|
1359
|
-
export interface
|
|
1359
|
+
export interface Output9Msmhb15Pcj {
|
|
1360
1360
|
/**
|
|
1361
1361
|
* Signed URL for the course file
|
|
1362
1362
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
1363
1363
|
*/
|
|
1364
1364
|
fileURL: string;
|
|
1365
1365
|
}
|
|
1366
|
-
export interface
|
|
1366
|
+
export interface InputSucbklla9Yk {
|
|
1367
1367
|
/**
|
|
1368
1368
|
* Indicates whether the waiver is approved
|
|
1369
1369
|
* @example true
|
|
@@ -1375,14 +1375,14 @@ export interface InputXnsxgjvb1H {
|
|
|
1375
1375
|
*/
|
|
1376
1376
|
additionalNotes?: string | null;
|
|
1377
1377
|
}
|
|
1378
|
-
export interface
|
|
1378
|
+
export interface InputOfpxc949G {
|
|
1379
1379
|
/**
|
|
1380
1380
|
* Optional notes regarding the waiver
|
|
1381
1381
|
* @example "Waiver granted due to special circumstances."
|
|
1382
1382
|
*/
|
|
1383
1383
|
additionalNotes?: string | null;
|
|
1384
1384
|
}
|
|
1385
|
-
export interface
|
|
1385
|
+
export interface InputDhlgnq7Qbrg {
|
|
1386
1386
|
students: {
|
|
1387
1387
|
/**
|
|
1388
1388
|
* User ID of the student to redeem the course for
|
|
@@ -1416,7 +1416,7 @@ export interface InputSroppfojv6K {
|
|
|
1416
1416
|
*/
|
|
1417
1417
|
autoEnrolSessionID?: string;
|
|
1418
1418
|
}
|
|
1419
|
-
export interface
|
|
1419
|
+
export interface Input9Fuob5H5Gu {
|
|
1420
1420
|
invites: {
|
|
1421
1421
|
/**
|
|
1422
1422
|
* Email address of the user to invite
|
|
@@ -1445,7 +1445,7 @@ export interface Input5Ugfzw40C7 {
|
|
|
1445
1445
|
*/
|
|
1446
1446
|
isReservedSeat: boolean;
|
|
1447
1447
|
}
|
|
1448
|
-
export interface
|
|
1448
|
+
export interface InputHncfz63Fiwk {
|
|
1449
1449
|
/**
|
|
1450
1450
|
* Indicates whether to waive the certification process
|
|
1451
1451
|
* @example true
|
|
@@ -1458,7 +1458,7 @@ export interface InputFslpxre9K5 {
|
|
|
1458
1458
|
comments?: string | null;
|
|
1459
1459
|
}
|
|
1460
1460
|
/** Certification move response schema */
|
|
1461
|
-
export interface
|
|
1461
|
+
export interface OutputQssne1Jk1X {
|
|
1462
1462
|
errors?: {
|
|
1463
1463
|
status: string;
|
|
1464
1464
|
object?: Record<string, any>;
|
|
@@ -1466,19 +1466,19 @@ export interface OutputOznnc1Tiod {
|
|
|
1466
1466
|
}[];
|
|
1467
1467
|
}
|
|
1468
1468
|
/** Schema for writing a certification trigger check. */
|
|
1469
|
-
export interface
|
|
1469
|
+
export interface InputYyxeia6211 {
|
|
1470
1470
|
/**
|
|
1471
1471
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1472
1472
|
* @example "CHECKED"
|
|
1473
1473
|
*/
|
|
1474
|
-
value:
|
|
1474
|
+
value: InputYyxeia6211ValueEnum;
|
|
1475
1475
|
/**
|
|
1476
1476
|
* List of course IDs that are blocked by this trigger check.
|
|
1477
1477
|
* @example ["course1","course2"]
|
|
1478
1478
|
*/
|
|
1479
1479
|
blockedCourses?: string[];
|
|
1480
1480
|
}
|
|
1481
|
-
export interface
|
|
1481
|
+
export interface InputH4M4Vr7Xm2L {
|
|
1482
1482
|
/**
|
|
1483
1483
|
* Indicates whether the application item is approved
|
|
1484
1484
|
* @example true
|
|
@@ -1504,7 +1504,7 @@ export interface Input2Gs17Nd76T {
|
|
|
1504
1504
|
export interface StudentHistoryRequestSchema {
|
|
1505
1505
|
requirements: string[];
|
|
1506
1506
|
}
|
|
1507
|
-
export interface
|
|
1507
|
+
export interface InputOzrwgtx1Z2 {
|
|
1508
1508
|
/**
|
|
1509
1509
|
* Optional activation key for the application
|
|
1510
1510
|
* @example "AK-123456"
|
|
@@ -1512,7 +1512,7 @@ export interface InputLujyu5Wksr {
|
|
|
1512
1512
|
activationKey?: string;
|
|
1513
1513
|
}
|
|
1514
1514
|
/** Schema for course submission item details post request. */
|
|
1515
|
-
export interface
|
|
1515
|
+
export interface InputRa49Ugtgj {
|
|
1516
1516
|
/**
|
|
1517
1517
|
* The ID of the file being submitted.
|
|
1518
1518
|
* @example "fileID123"
|
|
@@ -1525,7 +1525,7 @@ export interface Input6I1Bxs84H3L {
|
|
|
1525
1525
|
fileName: string;
|
|
1526
1526
|
}
|
|
1527
1527
|
/** Schema for the response to course submission item details post request. */
|
|
1528
|
-
export interface
|
|
1528
|
+
export interface OutputRa49Ugtgj {
|
|
1529
1529
|
submissionItems: {
|
|
1530
1530
|
/**
|
|
1531
1531
|
* The ID of the file being submitted.
|
|
@@ -1540,7 +1540,7 @@ export interface Output6I1Bxs84H3L {
|
|
|
1540
1540
|
}[];
|
|
1541
1541
|
}
|
|
1542
1542
|
/** Pending approval submission parameters */
|
|
1543
|
-
export interface
|
|
1543
|
+
export interface Input7Xiplwv8Cr {
|
|
1544
1544
|
/**
|
|
1545
1545
|
* Type of pending approval
|
|
1546
1546
|
* @example "certification"
|
|
@@ -1560,7 +1560,7 @@ export interface Input3Rcv6Yb00R {
|
|
|
1560
1560
|
fileName: string;
|
|
1561
1561
|
}[];
|
|
1562
1562
|
}
|
|
1563
|
-
export interface
|
|
1563
|
+
export interface Input8Uqmgsj643 {
|
|
1564
1564
|
/**
|
|
1565
1565
|
* The ID of the course for which the license is being redeemed
|
|
1566
1566
|
* @example "courseID123"
|
|
@@ -1628,7 +1628,7 @@ export interface InputGlc2E59Kk9L {
|
|
|
1628
1628
|
acknowledgement?: string | null;
|
|
1629
1629
|
}
|
|
1630
1630
|
/** Validate certification move response schema */
|
|
1631
|
-
export interface
|
|
1631
|
+
export interface OutputFvqn0Re8M9 {
|
|
1632
1632
|
courses: {
|
|
1633
1633
|
name: string;
|
|
1634
1634
|
status: string;
|
|
@@ -1639,21 +1639,21 @@ export interface Output76O169Co6C {
|
|
|
1639
1639
|
validated: boolean;
|
|
1640
1640
|
mustCreateCP: boolean;
|
|
1641
1641
|
}
|
|
1642
|
-
export interface
|
|
1642
|
+
export interface InputXpac0T46Wdi {
|
|
1643
1643
|
/**
|
|
1644
1644
|
* Comments regarding the end of the cooldown period
|
|
1645
1645
|
* @example "Cooldown period ended successfully."
|
|
1646
1646
|
*/
|
|
1647
1647
|
comments: string;
|
|
1648
1648
|
}
|
|
1649
|
-
export interface
|
|
1649
|
+
export interface OutputPjjjcscj2V {
|
|
1650
1650
|
/**
|
|
1651
1651
|
* Signed URL for the course file
|
|
1652
1652
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
1653
1653
|
*/
|
|
1654
1654
|
fileURL: string;
|
|
1655
1655
|
}
|
|
1656
|
-
export interface
|
|
1656
|
+
export interface InputOtoghzqho4 {
|
|
1657
1657
|
/** @example true */
|
|
1658
1658
|
agreedWithCertTerms: boolean;
|
|
1659
1659
|
/** @example 1717230000000 */
|
|
@@ -1725,21 +1725,21 @@ export interface InputL85Rf6Yu4S {
|
|
|
1725
1725
|
/** @example "EXT#999" */
|
|
1726
1726
|
externalID2?: string | null;
|
|
1727
1727
|
}
|
|
1728
|
-
export interface
|
|
1728
|
+
export interface InputDhsa5O7Zbd {
|
|
1729
1729
|
/**
|
|
1730
1730
|
* Comments regarding the course unlock action
|
|
1731
1731
|
* @example "Course unlocked successfully."
|
|
1732
1732
|
*/
|
|
1733
1733
|
comments: string;
|
|
1734
1734
|
}
|
|
1735
|
-
export interface
|
|
1735
|
+
export interface InputZ4R85Bn4Dy {
|
|
1736
1736
|
/**
|
|
1737
1737
|
* ITA number to update for the user
|
|
1738
1738
|
* @example "ITA123456"
|
|
1739
1739
|
*/
|
|
1740
1740
|
itaNumber: string;
|
|
1741
1741
|
}
|
|
1742
|
-
export interface
|
|
1742
|
+
export interface Input6I1B04X05S {
|
|
1743
1743
|
/** @example true */
|
|
1744
1744
|
agreedWithCertTerms: boolean;
|
|
1745
1745
|
/** @example 1717230000000 */
|
|
@@ -1811,7 +1811,7 @@ export interface InputHsvokuuejrk {
|
|
|
1811
1811
|
/** @example "EXT#999" */
|
|
1812
1812
|
externalID2?: string | null;
|
|
1813
1813
|
}
|
|
1814
|
-
export interface
|
|
1814
|
+
export interface Input7Li5D5Dgch {
|
|
1815
1815
|
/**
|
|
1816
1816
|
* The grade to override the course result with
|
|
1817
1817
|
* @example "A"
|
|
@@ -1819,7 +1819,7 @@ export interface InputHk2P73692C {
|
|
|
1819
1819
|
resultGrade: string;
|
|
1820
1820
|
}
|
|
1821
1821
|
/** Pending approval review parameters */
|
|
1822
|
-
export interface
|
|
1822
|
+
export interface InputUn9Itok4S6 {
|
|
1823
1823
|
/**
|
|
1824
1824
|
* Notes provided by the reviewer for the pending approval
|
|
1825
1825
|
* @example "Please review the submitted documents."
|
|
@@ -1832,7 +1832,7 @@ export interface InputW84Bczs916 {
|
|
|
1832
1832
|
approved: boolean;
|
|
1833
1833
|
}
|
|
1834
1834
|
/** Schema for overriding course result dates. */
|
|
1835
|
-
export interface
|
|
1835
|
+
export interface Input552J2Xh4N9 {
|
|
1836
1836
|
/**
|
|
1837
1837
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1838
1838
|
* @example 1735689600000
|
|
@@ -1844,14 +1844,14 @@ export interface InputWzlofwtvg7 {
|
|
|
1844
1844
|
*/
|
|
1845
1845
|
completionDate?: number;
|
|
1846
1846
|
}
|
|
1847
|
-
export interface
|
|
1847
|
+
export interface Input6C8Ca2Faej {
|
|
1848
1848
|
filter: {
|
|
1849
1849
|
from?: number;
|
|
1850
1850
|
sortOrder?: string;
|
|
1851
1851
|
sortField?: string;
|
|
1852
1852
|
};
|
|
1853
1853
|
}
|
|
1854
|
-
export interface
|
|
1854
|
+
export interface Output6C8Ca2Faej {
|
|
1855
1855
|
users: {
|
|
1856
1856
|
firstName: string;
|
|
1857
1857
|
lastName: string;
|
|
@@ -1875,7 +1875,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
1875
1875
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1876
1876
|
* @example "CHECKED"
|
|
1877
1877
|
*/
|
|
1878
|
-
export declare enum
|
|
1878
|
+
export declare enum InputYyxeia6211ValueEnum {
|
|
1879
1879
|
CHECKED = "CHECKED",
|
|
1880
1880
|
UNCHECKED = "UNCHECKED",
|
|
1881
1881
|
NOVALUE = "NOVALUE"
|
|
@@ -1968,7 +1968,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
1968
1968
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
1969
1969
|
export type CreateReportUsersSimpleData = any;
|
|
1970
1970
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
1971
|
-
export type CreateSearchUsersCountData =
|
|
1971
|
+
export type CreateSearchUsersCountData = Output05U2N2Mzx7;
|
|
1972
1972
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
1973
1973
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
1974
1974
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -1992,7 +1992,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
1992
1992
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
1993
1993
|
export type DeleteCertificationCourseFileSignData = any;
|
|
1994
1994
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
1995
|
-
export type GetCertificationCourseFileSignData =
|
|
1995
|
+
export type GetCertificationCourseFileSignData = OutputDex7Yz6Ahvl;
|
|
1996
1996
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
1997
1997
|
export interface CreateCertificationCourseFileSignParams {
|
|
1998
1998
|
/** @example "pdf" */
|
|
@@ -2006,11 +2006,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2006
2006
|
/** @example "fileID" */
|
|
2007
2007
|
fileId: string;
|
|
2008
2008
|
}
|
|
2009
|
-
export type CreateCertificationCourseFileSignData =
|
|
2009
|
+
export type CreateCertificationCourseFileSignData = OutputPjjjcscj2V;
|
|
2010
2010
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2011
2011
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2012
2012
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2013
|
-
export type CreateCertificationCourseDocumentData =
|
|
2013
|
+
export type CreateCertificationCourseDocumentData = OutputRa49Ugtgj;
|
|
2014
2014
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2015
2015
|
export type DeleteUserData = any;
|
|
2016
2016
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2022,7 +2022,7 @@ export type UpdateUserData = any;
|
|
|
2022
2022
|
export type UpdateUserError = ErrorResponse;
|
|
2023
2023
|
export type DeleteCertificationCourseData = any;
|
|
2024
2024
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2025
|
-
export type GetCertificationApplicationItemFileData =
|
|
2025
|
+
export type GetCertificationApplicationItemFileData = OutputQa6Exvrof4;
|
|
2026
2026
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2027
2027
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2028
2028
|
/** @example "pdf" */
|
|
@@ -2036,9 +2036,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2036
2036
|
/** @example "fileVersion" */
|
|
2037
2037
|
fileVersion: string;
|
|
2038
2038
|
}
|
|
2039
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2039
|
+
export type CreateCertificationApplicationItemFileData = Output9Msmhb15Pcj;
|
|
2040
2040
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2041
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2041
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputYec4No63M9;
|
|
2042
2042
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2043
2043
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2044
2044
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2046,7 +2046,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2046
2046
|
export type GetCourseError = ErrorResponse;
|
|
2047
2047
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2048
2048
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2049
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2049
|
+
export type GetCertificationApplicationForeignFillData = OutputB1Xkxknewy;
|
|
2050
2050
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2051
2051
|
export type GetCertificationPrintData = any;
|
|
2052
2052
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2080,10 +2080,12 @@ export type CreateCertificationRestartData = any;
|
|
|
2080
2080
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2081
2081
|
export type CreateCertificationWaiveData = any;
|
|
2082
2082
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2083
|
-
export type CreateCertificationMoveData =
|
|
2083
|
+
export type CreateCertificationMoveData = OutputQssne1Jk1X;
|
|
2084
2084
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2085
2085
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2086
2086
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
2087
|
+
export type CreateCertificationCourseSessionMoveStudentData = any;
|
|
2088
|
+
export type CreateCertificationCourseSessionMoveStudentError = ErrorResponse;
|
|
2087
2089
|
export type CreateCertificationTriggerCheckData = any;
|
|
2088
2090
|
export type CreateCertificationTriggerCheckError = ErrorResponse;
|
|
2089
2091
|
export type CreateCertificationTriggerSetData = any;
|
|
@@ -2108,7 +2110,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2108
2110
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2109
2111
|
export type CreateCertificationCourseRedeemData = any;
|
|
2110
2112
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2111
|
-
export type CreateCertificationMoveValidateData =
|
|
2113
|
+
export type CreateCertificationMoveValidateData = OutputFvqn0Re8M9;
|
|
2112
2114
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2113
2115
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2114
2116
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2122,7 +2124,9 @@ export type UpdateCertificationSetDatesData = any;
|
|
|
2122
2124
|
export type UpdateCertificationSetDatesError = ErrorResponse;
|
|
2123
2125
|
export type CreateCertificationPublishInfoData = any;
|
|
2124
2126
|
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2125
|
-
export type
|
|
2127
|
+
export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
2128
|
+
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2129
|
+
export type CreateCertificationResult = Output6C8Ca2Faej;
|
|
2126
2130
|
export type CreateCertificationFail = ErrorResponse;
|
|
2127
2131
|
export type CreateCertificationPublishInfoResult = any;
|
|
2128
2132
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2169,7 +2173,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2169
2173
|
}
|
|
2170
2174
|
/**
|
|
2171
2175
|
* @title BCCSA Program API
|
|
2172
|
-
* @version 3.0.
|
|
2176
|
+
* @version 3.0.23
|
|
2173
2177
|
* @baseUrl http://localhost:8080
|
|
2174
2178
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2175
2179
|
*/
|
|
@@ -2184,7 +2188,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2184
2188
|
* @request POST:/contactUs
|
|
2185
2189
|
* @secure
|
|
2186
2190
|
*/
|
|
2187
|
-
listContactUs: (data:
|
|
2191
|
+
listContactUs: (data: InputEfljkqzkrw, params?: RequestParams) => Promise<any>;
|
|
2188
2192
|
};
|
|
2189
2193
|
customer: {
|
|
2190
2194
|
/**
|
|
@@ -2288,7 +2292,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2288
2292
|
* @request POST:/tenant/report/applicationExport
|
|
2289
2293
|
* @secure
|
|
2290
2294
|
*/
|
|
2291
|
-
createReportApplicationExport: (data:
|
|
2295
|
+
createReportApplicationExport: (data: InputU4C3V4De8Hg, params?: RequestParams) => Promise<any>;
|
|
2292
2296
|
/**
|
|
2293
2297
|
* @description Export a report of applications based on the provided filters.
|
|
2294
2298
|
*
|
|
@@ -2298,7 +2302,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2298
2302
|
* @request POST:/tenant/report/applicationStatus
|
|
2299
2303
|
* @secure
|
|
2300
2304
|
*/
|
|
2301
|
-
listReportApplicationStatus: (data:
|
|
2305
|
+
listReportApplicationStatus: (data: InputVsl3M1Bf02, params?: RequestParams) => Promise<any>;
|
|
2302
2306
|
/**
|
|
2303
2307
|
* @description Export a report of applications based on the provided filters.
|
|
2304
2308
|
*
|
|
@@ -2308,7 +2312,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2308
2312
|
* @request POST:/tenant/report/applicationsReport
|
|
2309
2313
|
* @secure
|
|
2310
2314
|
*/
|
|
2311
|
-
createReportApplicationsReport: (data:
|
|
2315
|
+
createReportApplicationsReport: (data: InputQtxygdy6Sp, params?: RequestParams) => Promise<any>;
|
|
2312
2316
|
/**
|
|
2313
2317
|
* @description This route allows you to post certificates email for the tenant.
|
|
2314
2318
|
*
|
|
@@ -2318,7 +2322,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2318
2322
|
* @request POST:/tenant/certificates/email
|
|
2319
2323
|
* @secure
|
|
2320
2324
|
*/
|
|
2321
|
-
createCertificatesEmail: (data:
|
|
2325
|
+
createCertificatesEmail: (data: InputW7Byz2Y6Du, params?: RequestParams) => Promise<any>;
|
|
2322
2326
|
/**
|
|
2323
2327
|
* @description Generate a preview of the completed certifications report.
|
|
2324
2328
|
*
|
|
@@ -2348,7 +2352,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2348
2352
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2349
2353
|
* @secure
|
|
2350
2354
|
*/
|
|
2351
|
-
createLicenseRedeem: (userId: string, data:
|
|
2355
|
+
createLicenseRedeem: (userId: string, data: Input72I12Ohjlb, params?: RequestParams) => Promise<any>;
|
|
2352
2356
|
/**
|
|
2353
2357
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2354
2358
|
*
|
|
@@ -2358,7 +2362,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2358
2362
|
* @request POST:/tenant/report/orglicenses/
|
|
2359
2363
|
* @secure
|
|
2360
2364
|
*/
|
|
2361
|
-
listReportOrglicenses: (data:
|
|
2365
|
+
listReportOrglicenses: (data: Input9X53Pc16Nx, params?: RequestParams) => Promise<any>;
|
|
2362
2366
|
/**
|
|
2363
2367
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2364
2368
|
*
|
|
@@ -2368,7 +2372,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2368
2372
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2369
2373
|
* @secure
|
|
2370
2374
|
*/
|
|
2371
|
-
createReportOrglicensesPreview: (data:
|
|
2375
|
+
createReportOrglicensesPreview: (data: InputGlah2T7Jz6, params?: RequestParams) => Promise<any>;
|
|
2372
2376
|
/**
|
|
2373
2377
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2374
2378
|
*
|
|
@@ -2398,7 +2402,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2398
2402
|
* @request POST:/tenant/report/users/advanced
|
|
2399
2403
|
* @secure
|
|
2400
2404
|
*/
|
|
2401
|
-
createReportUsersAdvanced: (data:
|
|
2405
|
+
createReportUsersAdvanced: (data: InputF7Vlnyefnb, params?: RequestParams) => Promise<any>;
|
|
2402
2406
|
/**
|
|
2403
2407
|
* @description Searches for users in the tenant by their IDs.
|
|
2404
2408
|
*
|
|
@@ -2408,7 +2412,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2408
2412
|
* @request POST:/tenant/search/users/ids
|
|
2409
2413
|
* @secure
|
|
2410
2414
|
*/
|
|
2411
|
-
listSearchUsersIds: (data:
|
|
2415
|
+
listSearchUsersIds: (data: InputOju7Ip0Ji8, params?: RequestParams) => Promise<any>;
|
|
2412
2416
|
/**
|
|
2413
2417
|
* @description Searches for users in the tenant by term and filters.
|
|
2414
2418
|
*
|
|
@@ -2418,7 +2422,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2418
2422
|
* @request POST:/tenant/search/users/term
|
|
2419
2423
|
* @secure
|
|
2420
2424
|
*/
|
|
2421
|
-
createSearchUsersTerm: (data:
|
|
2425
|
+
createSearchUsersTerm: (data: Input6Eq5Uhd3Vt, params?: RequestParams) => Promise<any>;
|
|
2422
2426
|
/**
|
|
2423
2427
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2424
2428
|
*
|
|
@@ -2428,7 +2432,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2428
2432
|
* @request POST:/tenant/report/users/simple
|
|
2429
2433
|
* @secure
|
|
2430
2434
|
*/
|
|
2431
|
-
createReportUsersSimple: (data:
|
|
2435
|
+
createReportUsersSimple: (data: InputMwks4Uarfm, params?: RequestParams) => Promise<any>;
|
|
2432
2436
|
/**
|
|
2433
2437
|
* @description Retrieve user by ID.
|
|
2434
2438
|
*
|
|
@@ -2438,7 +2442,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2438
2442
|
* @request POST:/tenant/search/users/count
|
|
2439
2443
|
* @secure
|
|
2440
2444
|
*/
|
|
2441
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2445
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<Output05U2N2Mzx7>;
|
|
2442
2446
|
};
|
|
2443
2447
|
user: {
|
|
2444
2448
|
/**
|
|
@@ -2470,7 +2474,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2470
2474
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2471
2475
|
* @secure
|
|
2472
2476
|
*/
|
|
2473
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2477
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: Input69Xz46Fwmt, params?: RequestParams) => Promise<any>;
|
|
2474
2478
|
/**
|
|
2475
2479
|
* @description Delete a certification process application by type.
|
|
2476
2480
|
*
|
|
@@ -2560,7 +2564,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2560
2564
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2561
2565
|
* @secure
|
|
2562
2566
|
*/
|
|
2563
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2567
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputDex7Yz6Ahvl>;
|
|
2564
2568
|
/**
|
|
2565
2569
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2566
2570
|
*
|
|
@@ -2570,7 +2574,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2570
2574
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2571
2575
|
* @secure
|
|
2572
2576
|
*/
|
|
2573
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2577
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputPjjjcscj2V>;
|
|
2574
2578
|
/**
|
|
2575
2579
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2576
2580
|
*
|
|
@@ -2590,7 +2594,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2590
2594
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2591
2595
|
* @secure
|
|
2592
2596
|
*/
|
|
2593
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2597
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputRa49Ugtgj, params?: RequestParams) => Promise<OutputRa49Ugtgj>;
|
|
2594
2598
|
/**
|
|
2595
2599
|
* @description Delete user by ID.
|
|
2596
2600
|
*
|
|
@@ -2620,7 +2624,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2620
2624
|
* @request POST:/user/{userID}
|
|
2621
2625
|
* @secure
|
|
2622
2626
|
*/
|
|
2623
|
-
createUser: (userId: string, data:
|
|
2627
|
+
createUser: (userId: string, data: InputOtoghzqho4, params?: RequestParams) => Promise<any>;
|
|
2624
2628
|
/**
|
|
2625
2629
|
* @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.
|
|
2626
2630
|
*
|
|
@@ -2630,7 +2634,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2630
2634
|
* @request PUT:/user/{userID}
|
|
2631
2635
|
* @secure
|
|
2632
2636
|
*/
|
|
2633
|
-
updateUser: (userId: string, data:
|
|
2637
|
+
updateUser: (userId: string, data: Input6I1B04X05S, params?: RequestParams) => Promise<any>;
|
|
2634
2638
|
/**
|
|
2635
2639
|
* @description Delete course from user
|
|
2636
2640
|
*
|
|
@@ -2650,7 +2654,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2650
2654
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2651
2655
|
* @secure
|
|
2652
2656
|
*/
|
|
2653
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2657
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputQa6Exvrof4>;
|
|
2654
2658
|
/**
|
|
2655
2659
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2656
2660
|
*
|
|
@@ -2660,7 +2664,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2660
2664
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2661
2665
|
* @secure
|
|
2662
2666
|
*/
|
|
2663
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2667
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<Output9Msmhb15Pcj>;
|
|
2664
2668
|
/**
|
|
2665
2669
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2666
2670
|
*
|
|
@@ -2670,7 +2674,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2670
2674
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2671
2675
|
* @secure
|
|
2672
2676
|
*/
|
|
2673
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2677
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputYec4No63M9>;
|
|
2674
2678
|
/**
|
|
2675
2679
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2676
2680
|
*
|
|
@@ -2710,7 +2714,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2710
2714
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2711
2715
|
* @secure
|
|
2712
2716
|
*/
|
|
2713
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2717
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputB1Xkxknewy>;
|
|
2714
2718
|
/**
|
|
2715
2719
|
* @description This endpoint will print certificate
|
|
2716
2720
|
*
|
|
@@ -2770,7 +2774,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2770
2774
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2771
2775
|
* @secure
|
|
2772
2776
|
*/
|
|
2773
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2777
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputGb0Q4Ecdub, params?: RequestParams) => Promise<any>;
|
|
2774
2778
|
/**
|
|
2775
2779
|
* @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.
|
|
2776
2780
|
*
|
|
@@ -2800,7 +2804,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2800
2804
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2801
2805
|
* @secure
|
|
2802
2806
|
*/
|
|
2803
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2807
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputSucbklla9Yk, params?: RequestParams) => Promise<any>;
|
|
2804
2808
|
/**
|
|
2805
2809
|
* @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.
|
|
2806
2810
|
*
|
|
@@ -2810,7 +2814,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2810
2814
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2811
2815
|
* @secure
|
|
2812
2816
|
*/
|
|
2813
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2817
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputOfpxc949G, params?: RequestParams) => Promise<any>;
|
|
2814
2818
|
/**
|
|
2815
2819
|
* @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.
|
|
2816
2820
|
*
|
|
@@ -2820,7 +2824,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2820
2824
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2821
2825
|
* @secure
|
|
2822
2826
|
*/
|
|
2823
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2827
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputDhlgnq7Qbrg, params?: RequestParams) => Promise<any>;
|
|
2824
2828
|
/**
|
|
2825
2829
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2826
2830
|
*
|
|
@@ -2830,7 +2834,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2830
2834
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2831
2835
|
* @secure
|
|
2832
2836
|
*/
|
|
2833
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2837
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: Input9Fuob5H5Gu, params?: RequestParams) => Promise<any>;
|
|
2834
2838
|
/**
|
|
2835
2839
|
* @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.
|
|
2836
2840
|
*
|
|
@@ -2870,7 +2874,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2870
2874
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2871
2875
|
* @secure
|
|
2872
2876
|
*/
|
|
2873
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2877
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputHncfz63Fiwk, params?: RequestParams) => Promise<any>;
|
|
2874
2878
|
/**
|
|
2875
2879
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
2876
2880
|
*
|
|
@@ -2880,7 +2884,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2880
2884
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2881
2885
|
* @secure
|
|
2882
2886
|
*/
|
|
2883
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2887
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputQssne1Jk1X>;
|
|
2884
2888
|
/**
|
|
2885
2889
|
* @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.
|
|
2886
2890
|
*
|
|
@@ -2891,6 +2895,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2891
2895
|
* @secure
|
|
2892
2896
|
*/
|
|
2893
2897
|
createCertificationCourseSessionReplace: (userId: string, certProcId: string, courseId: string, sessionId: string, secUserId: string, params?: RequestParams) => Promise<any>;
|
|
2898
|
+
/**
|
|
2899
|
+
* @description This endpoint allows you to move a student from one course session to another within the same certification process. It requires the user ID, certification process ID, course ID, current session ID, and new session ID as path parameters.
|
|
2900
|
+
*
|
|
2901
|
+
* @tags Certification
|
|
2902
|
+
* @name CreateCertificationCourseSessionMoveStudent
|
|
2903
|
+
* @summary Reschedule Session Enrolment
|
|
2904
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/moveStudent/{newSessionID}
|
|
2905
|
+
* @secure
|
|
2906
|
+
*/
|
|
2907
|
+
createCertificationCourseSessionMoveStudent: (userId: string, certProcId: string, courseId: string, sessionId: string, newSessionId: string, params?: RequestParams) => Promise<any>;
|
|
2894
2908
|
/**
|
|
2895
2909
|
* @description This route allows you to set a trigger check for a certification process, such as blocking courses.
|
|
2896
2910
|
*
|
|
@@ -2910,7 +2924,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2910
2924
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2911
2925
|
* @secure
|
|
2912
2926
|
*/
|
|
2913
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
2927
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputYyxeia6211, params?: RequestParams) => Promise<any>;
|
|
2914
2928
|
/**
|
|
2915
2929
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
2916
2930
|
*
|
|
@@ -2960,7 +2974,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2960
2974
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
2961
2975
|
* @secure
|
|
2962
2976
|
*/
|
|
2963
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
2977
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: InputH4M4Vr7Xm2L, params?: RequestParams) => Promise<any>;
|
|
2964
2978
|
/**
|
|
2965
2979
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
2966
2980
|
*
|
|
@@ -2980,7 +2994,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2980
2994
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
2981
2995
|
* @secure
|
|
2982
2996
|
*/
|
|
2983
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
2997
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputOzrwgtx1Z2, params?: RequestParams) => Promise<any>;
|
|
2984
2998
|
/**
|
|
2985
2999
|
* @description This route allows you to submit a pending approval.
|
|
2986
3000
|
*
|
|
@@ -2990,7 +3004,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2990
3004
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
2991
3005
|
* @secure
|
|
2992
3006
|
*/
|
|
2993
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3007
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: Input7Xiplwv8Cr, params?: RequestParams) => Promise<any>;
|
|
2994
3008
|
/**
|
|
2995
3009
|
* @description This route allows you to review a pending approval.
|
|
2996
3010
|
*
|
|
@@ -3000,7 +3014,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3000
3014
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3001
3015
|
* @secure
|
|
3002
3016
|
*/
|
|
3003
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3017
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputUn9Itok4S6, params?: RequestParams) => Promise<any>;
|
|
3004
3018
|
/**
|
|
3005
3019
|
* @description Redeems a license for a user by product ID.
|
|
3006
3020
|
*
|
|
@@ -3010,7 +3024,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3010
3024
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3011
3025
|
* @secure
|
|
3012
3026
|
*/
|
|
3013
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3027
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: Input8Uqmgsj643, params?: RequestParams) => Promise<any>;
|
|
3014
3028
|
/**
|
|
3015
3029
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3016
3030
|
*
|
|
@@ -3020,7 +3034,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3020
3034
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3021
3035
|
* @secure
|
|
3022
3036
|
*/
|
|
3023
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3037
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputFvqn0Re8M9>;
|
|
3024
3038
|
/**
|
|
3025
3039
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3026
3040
|
*
|
|
@@ -3030,7 +3044,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3030
3044
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3031
3045
|
* @secure
|
|
3032
3046
|
*/
|
|
3033
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3047
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputXpac0T46Wdi, params?: RequestParams) => Promise<any>;
|
|
3034
3048
|
/**
|
|
3035
3049
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3036
3050
|
*
|
|
@@ -3040,7 +3054,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3040
3054
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3041
3055
|
* @secure
|
|
3042
3056
|
*/
|
|
3043
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3057
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputDhsa5O7Zbd, params?: RequestParams) => Promise<any>;
|
|
3044
3058
|
/**
|
|
3045
3059
|
* @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.
|
|
3046
3060
|
*
|
|
@@ -3050,7 +3064,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3050
3064
|
* @request POST:/user/{userID}/updateITA
|
|
3051
3065
|
* @secure
|
|
3052
3066
|
*/
|
|
3053
|
-
createUpdateIta: (userId: string, data:
|
|
3067
|
+
createUpdateIta: (userId: string, data: InputZ4R85Bn4Dy, params?: RequestParams) => Promise<any>;
|
|
3054
3068
|
/**
|
|
3055
3069
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3056
3070
|
*
|
|
@@ -3060,7 +3074,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3060
3074
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3061
3075
|
* @secure
|
|
3062
3076
|
*/
|
|
3063
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3077
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: Input7Li5D5Dgch, params?: RequestParams) => Promise<any>;
|
|
3064
3078
|
/**
|
|
3065
3079
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3066
3080
|
*
|
|
@@ -3070,7 +3084,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3070
3084
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3071
3085
|
* @secure
|
|
3072
3086
|
*/
|
|
3073
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3087
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: Input552J2Xh4N9, params?: RequestParams) => Promise<any>;
|
|
3074
3088
|
/**
|
|
3075
3089
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3076
3090
|
*
|
|
@@ -3081,6 +3095,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3081
3095
|
* @secure
|
|
3082
3096
|
*/
|
|
3083
3097
|
createCertificationPublishInfo: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
|
|
3098
|
+
/**
|
|
3099
|
+
* @description This route allows you to request enrolment for a course in a certification process.
|
|
3100
|
+
*
|
|
3101
|
+
* @tags Course
|
|
3102
|
+
* @name CreateCertificationCourseRequestEnrolment
|
|
3103
|
+
* @summary Request Course Enrolment
|
|
3104
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/requestEnrolment
|
|
3105
|
+
* @secure
|
|
3106
|
+
*/
|
|
3107
|
+
createCertificationCourseRequestEnrolment: (userId: string, certProcId: string, courseId: string, params?: RequestParams) => Promise<any>;
|
|
3084
3108
|
};
|
|
3085
3109
|
users: {
|
|
3086
3110
|
/**
|
|
@@ -3092,7 +3116,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3092
3116
|
* @request POST:/users/certification/{certSpecID}
|
|
3093
3117
|
* @secure
|
|
3094
3118
|
*/
|
|
3095
|
-
createCertification: (certSpecId: string, data:
|
|
3119
|
+
createCertification: (certSpecId: string, data: Input6C8Ca2Faej, params?: RequestParams) => Promise<Output6C8Ca2Faej>;
|
|
3096
3120
|
/**
|
|
3097
3121
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3098
3122
|
*
|