@ikonintegration/bccsa-program-api 3.0.33 → 3.0.35
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 +132 -94
- package/dist/Api.d.ts +123 -103
- package/dist/Api.js +26 -9
- package/dist/Api.js.map +1 -1
- package/package.json +1 -1
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 InputRr9Kp8P5Qu {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -445,6 +445,8 @@ export interface PendingApprovalResponseSchema {
|
|
|
445
445
|
sponsorshipRemindersStudent?: SponsorshipRemindersStudent;
|
|
446
446
|
/** Pending sponsorship request reminders sent to the sponsor (array with reminder IDs, where reminderID is template-numdays) */
|
|
447
447
|
sponsorshipRemindersSponsor?: SponsorshipRemindersSponsor;
|
|
448
|
+
/** Timestamp when the current sponsorship reminder schedule started (set on create and on reset). Reminder dueness is measured from it; when absent, from createdOn. */
|
|
449
|
+
remindersStartedOn?: RemindersStartedOn;
|
|
448
450
|
}[] | null;
|
|
449
451
|
}
|
|
450
452
|
/** Timestamp when the entry was last updated */
|
|
@@ -482,7 +484,9 @@ export type Title = string;
|
|
|
482
484
|
export type SponsorshipRemindersStudent = string[];
|
|
483
485
|
/** Pending sponsorship request reminders sent to the sponsor (array with reminder IDs, where reminderID is template-numdays) */
|
|
484
486
|
export type SponsorshipRemindersSponsor = string[];
|
|
485
|
-
|
|
487
|
+
/** Timestamp when the current sponsorship reminder schedule started (set on create and on reset). Reminder dueness is measured from it; when absent, from createdOn. */
|
|
488
|
+
export type RemindersStartedOn = number;
|
|
489
|
+
export interface InputHvh2Rhjuk6 {
|
|
486
490
|
/**
|
|
487
491
|
* ID of the certification to filter applications by
|
|
488
492
|
* @example "certification123"
|
|
@@ -539,7 +543,7 @@ export interface InputHtrrxf8Yp9K {
|
|
|
539
543
|
*/
|
|
540
544
|
ignoreCompletedCertifications?: boolean | null;
|
|
541
545
|
}
|
|
542
|
-
export interface
|
|
546
|
+
export interface Input5K8X950Ztg {
|
|
543
547
|
/**
|
|
544
548
|
* ID of the certification to filter applications by
|
|
545
549
|
* @example "certification123"
|
|
@@ -596,7 +600,7 @@ export interface InputTq7O0B5F3S {
|
|
|
596
600
|
*/
|
|
597
601
|
ignoreCompletedCertifications?: boolean | null;
|
|
598
602
|
}
|
|
599
|
-
export interface
|
|
603
|
+
export interface InputV73Gd5K2S3 {
|
|
600
604
|
/**
|
|
601
605
|
* ID of the certification to filter applications by
|
|
602
606
|
* @example "certification123"
|
|
@@ -653,7 +657,7 @@ export interface InputVeillj4Rt0L {
|
|
|
653
657
|
*/
|
|
654
658
|
ignoreCompletedCertifications?: boolean | null;
|
|
655
659
|
}
|
|
656
|
-
export interface
|
|
660
|
+
export interface InputYuucneuxkg {
|
|
657
661
|
/**
|
|
658
662
|
* The ID of the certificate specifications to be used for the email
|
|
659
663
|
* @example "certSpecsID123"
|
|
@@ -694,7 +698,7 @@ export interface InputOaldjlebnx {
|
|
|
694
698
|
emailAddress: string;
|
|
695
699
|
}[];
|
|
696
700
|
}
|
|
697
|
-
export interface
|
|
701
|
+
export interface InputIc5N9Ldrci {
|
|
698
702
|
/**
|
|
699
703
|
* The ID of the product for which the license is being redeemed
|
|
700
704
|
* @example "productID123"
|
|
@@ -706,7 +710,7 @@ export interface InputKkyamupnlt {
|
|
|
706
710
|
*/
|
|
707
711
|
sessionID?: string;
|
|
708
712
|
}
|
|
709
|
-
export interface
|
|
713
|
+
export interface InputJu8Q7Jd4Rm {
|
|
710
714
|
/**
|
|
711
715
|
* Search term to filter licenses
|
|
712
716
|
* @example "active"
|
|
@@ -723,7 +727,7 @@ export interface InputUkvmhdqu3Zh {
|
|
|
723
727
|
*/
|
|
724
728
|
sortField?: any;
|
|
725
729
|
}
|
|
726
|
-
export interface
|
|
730
|
+
export interface InputU8Srhwp84Ch {
|
|
727
731
|
/**
|
|
728
732
|
* Search term to filter licenses
|
|
729
733
|
* @example "active"
|
|
@@ -852,9 +856,11 @@ export interface SearchPendingApprovalsResponseSchema {
|
|
|
852
856
|
sponsorshipRemindersStudent?: SponsorshipRemindersStudent;
|
|
853
857
|
/** Pending sponsorship request reminders sent to the sponsor (array with reminder IDs, where reminderID is template-numdays) */
|
|
854
858
|
sponsorshipRemindersSponsor?: SponsorshipRemindersSponsor;
|
|
859
|
+
/** Timestamp when the current sponsorship reminder schedule started (set on create and on reset). Reminder dueness is measured from it; when absent, from createdOn. */
|
|
860
|
+
remindersStartedOn?: RemindersStartedOn;
|
|
855
861
|
}[];
|
|
856
862
|
}
|
|
857
|
-
export interface
|
|
863
|
+
export interface InputF5Jjnrfmt7I {
|
|
858
864
|
/**
|
|
859
865
|
* Start date for the report
|
|
860
866
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -876,11 +882,11 @@ export interface Input7Il0Lvxsvl {
|
|
|
876
882
|
*/
|
|
877
883
|
dateType?: string;
|
|
878
884
|
}
|
|
879
|
-
export interface
|
|
885
|
+
export interface Input5Nynw58Ws1 {
|
|
880
886
|
/** List of user IDs to search for in the tenant. */
|
|
881
887
|
IDs: (string | null)[];
|
|
882
888
|
}
|
|
883
|
-
export interface
|
|
889
|
+
export interface Input4H67Nuuo8P {
|
|
884
890
|
/** The term to search for in the user profiles. */
|
|
885
891
|
searchTerm?: string | null;
|
|
886
892
|
/** Filter criteria for the user search. */
|
|
@@ -920,7 +926,7 @@ export interface InputVawcwl0959 {
|
|
|
920
926
|
};
|
|
921
927
|
};
|
|
922
928
|
}
|
|
923
|
-
export interface
|
|
929
|
+
export interface Input2Mihdr2Tcif {
|
|
924
930
|
/** The term to search for in the user profiles. */
|
|
925
931
|
searchTerm?: string | null;
|
|
926
932
|
/** Filter criteria for the user search. */
|
|
@@ -960,21 +966,21 @@ export interface InputHlghz0Fmyni {
|
|
|
960
966
|
};
|
|
961
967
|
};
|
|
962
968
|
}
|
|
963
|
-
export interface
|
|
969
|
+
export interface OutputJqh0F2Rq94L {
|
|
964
970
|
/** External system ID 2 */
|
|
965
971
|
userCount: ExternalID2;
|
|
966
972
|
transactionID?: string | null;
|
|
967
973
|
}
|
|
968
974
|
/** External system ID 2 */
|
|
969
975
|
export type ExternalID2 = number;
|
|
970
|
-
export interface
|
|
976
|
+
export interface Output5Qmmfjb7J6 {
|
|
971
977
|
/**
|
|
972
978
|
* Signed URL for the course file
|
|
973
979
|
* @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"
|
|
974
980
|
*/
|
|
975
981
|
fileURL: string;
|
|
976
982
|
}
|
|
977
|
-
export interface
|
|
983
|
+
export interface Output7Jte254C0P {
|
|
978
984
|
/**
|
|
979
985
|
* Amount to be refunded for the cancellation
|
|
980
986
|
* @example 0
|
|
@@ -1274,7 +1280,7 @@ export interface CourseResponseEntity {
|
|
|
1274
1280
|
}
|
|
1275
1281
|
/** Label of the course enrolled (course version) */
|
|
1276
1282
|
export type OnlineCourseLabel = string;
|
|
1277
|
-
export interface
|
|
1283
|
+
export interface Output6Lxou5Wadvl {
|
|
1278
1284
|
/**
|
|
1279
1285
|
* Signed URL for the course file
|
|
1280
1286
|
* @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"
|
|
@@ -1292,7 +1298,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1292
1298
|
transactionID?: string | null;
|
|
1293
1299
|
}
|
|
1294
1300
|
/** Application Foreign Fill response type */
|
|
1295
|
-
export interface
|
|
1301
|
+
export interface OutputDrnp2Yirpi {
|
|
1296
1302
|
items: {
|
|
1297
1303
|
userID: string;
|
|
1298
1304
|
createdOn?: number;
|
|
@@ -1480,7 +1486,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1480
1486
|
applicationItems?: Record<string, any>[];
|
|
1481
1487
|
transactionID?: string | null;
|
|
1482
1488
|
}
|
|
1483
|
-
export interface
|
|
1489
|
+
export interface InputUdco8Yiz4U {
|
|
1484
1490
|
issuedOn?: number;
|
|
1485
1491
|
expiresOn?: number;
|
|
1486
1492
|
fileItems?: {
|
|
@@ -1489,21 +1495,21 @@ export interface InputZe9R08Tm0T {
|
|
|
1489
1495
|
}[];
|
|
1490
1496
|
additionalNotes?: string | null;
|
|
1491
1497
|
}
|
|
1492
|
-
export interface
|
|
1498
|
+
export interface InputWkff4Yaywy {
|
|
1493
1499
|
/**
|
|
1494
1500
|
* Indicates whether the application is locked
|
|
1495
1501
|
* @example true
|
|
1496
1502
|
*/
|
|
1497
1503
|
isApplicationLocked: boolean;
|
|
1498
1504
|
}
|
|
1499
|
-
export interface
|
|
1505
|
+
export interface Output6S8Rfzxiuf {
|
|
1500
1506
|
/**
|
|
1501
1507
|
* Signed URL for the course file
|
|
1502
1508
|
* @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"
|
|
1503
1509
|
*/
|
|
1504
1510
|
fileURL: string;
|
|
1505
1511
|
}
|
|
1506
|
-
export interface
|
|
1512
|
+
export interface InputKa30H4Ner6 {
|
|
1507
1513
|
/**
|
|
1508
1514
|
* Indicates whether the waiver is approved
|
|
1509
1515
|
* @example true
|
|
@@ -1515,14 +1521,14 @@ export interface InputKc1Ehdb5Ps {
|
|
|
1515
1521
|
*/
|
|
1516
1522
|
additionalNotes?: string | null;
|
|
1517
1523
|
}
|
|
1518
|
-
export interface
|
|
1524
|
+
export interface InputP7Rzxtpwwc {
|
|
1519
1525
|
/**
|
|
1520
1526
|
* Optional notes regarding the waiver
|
|
1521
1527
|
* @example "Waiver granted due to special circumstances."
|
|
1522
1528
|
*/
|
|
1523
1529
|
additionalNotes?: string | null;
|
|
1524
1530
|
}
|
|
1525
|
-
export interface
|
|
1531
|
+
export interface InputY2D9S4Qy4S {
|
|
1526
1532
|
students: {
|
|
1527
1533
|
/**
|
|
1528
1534
|
* User ID of the student to redeem the course for
|
|
@@ -1556,7 +1562,7 @@ export interface Input5L25G7Qxfo {
|
|
|
1556
1562
|
*/
|
|
1557
1563
|
autoEnrolSessionID?: string;
|
|
1558
1564
|
}
|
|
1559
|
-
export interface
|
|
1565
|
+
export interface Input62Nyiggonmh {
|
|
1560
1566
|
invites: {
|
|
1561
1567
|
/**
|
|
1562
1568
|
* Email address of the user to invite
|
|
@@ -1585,7 +1591,7 @@ export interface InputLkqgxr42Ux {
|
|
|
1585
1591
|
*/
|
|
1586
1592
|
isReservedSeat: boolean;
|
|
1587
1593
|
}
|
|
1588
|
-
export interface
|
|
1594
|
+
export interface InputXqdgr5Oa5Vh {
|
|
1589
1595
|
/**
|
|
1590
1596
|
* Indicates whether to waive the certification process
|
|
1591
1597
|
* @example true
|
|
@@ -1598,7 +1604,7 @@ export interface InputHvql6Tv30P {
|
|
|
1598
1604
|
comments?: string | null;
|
|
1599
1605
|
}
|
|
1600
1606
|
/** Certification move response schema */
|
|
1601
|
-
export interface
|
|
1607
|
+
export interface Output6D4Ct52Qpe {
|
|
1602
1608
|
errors?: {
|
|
1603
1609
|
status: string;
|
|
1604
1610
|
object?: Record<string, any>;
|
|
@@ -1606,19 +1612,19 @@ export interface OutputIpk3Gr4Jn2 {
|
|
|
1606
1612
|
}[];
|
|
1607
1613
|
}
|
|
1608
1614
|
/** Schema for writing a certification trigger check. */
|
|
1609
|
-
export interface
|
|
1615
|
+
export interface InputUysjux8Zp4 {
|
|
1610
1616
|
/**
|
|
1611
1617
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1612
1618
|
* @example "CHECKED"
|
|
1613
1619
|
*/
|
|
1614
|
-
value:
|
|
1620
|
+
value: InputUysjux8Zp4ValueEnum;
|
|
1615
1621
|
/**
|
|
1616
1622
|
* List of course IDs that are blocked by this trigger check.
|
|
1617
1623
|
* @example ["course1","course2"]
|
|
1618
1624
|
*/
|
|
1619
1625
|
blockedCourses?: string[];
|
|
1620
1626
|
}
|
|
1621
|
-
export interface
|
|
1627
|
+
export interface Input1Lghooas4I {
|
|
1622
1628
|
/**
|
|
1623
1629
|
* Indicates whether the application item is approved
|
|
1624
1630
|
* @example true
|
|
@@ -1644,7 +1650,7 @@ export interface InputWk711Xrjeq {
|
|
|
1644
1650
|
export interface StudentHistoryRequestSchema {
|
|
1645
1651
|
requirements: string[];
|
|
1646
1652
|
}
|
|
1647
|
-
export interface
|
|
1653
|
+
export interface InputCgletgibfvi {
|
|
1648
1654
|
/**
|
|
1649
1655
|
* Optional activation key for the application
|
|
1650
1656
|
* @example "AK-123456"
|
|
@@ -1652,7 +1658,7 @@ export interface InputTtdoeespbb {
|
|
|
1652
1658
|
activationKey?: string;
|
|
1653
1659
|
}
|
|
1654
1660
|
/** Schema for course submission item details post request. */
|
|
1655
|
-
export interface
|
|
1661
|
+
export interface InputOszbc2Lfht {
|
|
1656
1662
|
/**
|
|
1657
1663
|
* The ID of the file being submitted.
|
|
1658
1664
|
* @example "fileID123"
|
|
@@ -1665,7 +1671,7 @@ export interface InputCvqczxrsu6 {
|
|
|
1665
1671
|
fileName: string;
|
|
1666
1672
|
}
|
|
1667
1673
|
/** Schema for the response to course submission item details post request. */
|
|
1668
|
-
export interface
|
|
1674
|
+
export interface OutputOszbc2Lfht {
|
|
1669
1675
|
submissionItems: {
|
|
1670
1676
|
/**
|
|
1671
1677
|
* The ID of the file being submitted.
|
|
@@ -1680,7 +1686,7 @@ export interface OutputCvqczxrsu6 {
|
|
|
1680
1686
|
}[];
|
|
1681
1687
|
}
|
|
1682
1688
|
/** Pending approval submission parameters */
|
|
1683
|
-
export interface
|
|
1689
|
+
export interface InputDv9Ni3Aar5 {
|
|
1684
1690
|
/**
|
|
1685
1691
|
* Type of pending approval
|
|
1686
1692
|
* @example "certification"
|
|
@@ -1700,7 +1706,7 @@ export interface InputPmeud0A4Jo {
|
|
|
1700
1706
|
fileName: string;
|
|
1701
1707
|
}[];
|
|
1702
1708
|
}
|
|
1703
|
-
export interface
|
|
1709
|
+
export interface InputGhxoi4I6V8 {
|
|
1704
1710
|
/**
|
|
1705
1711
|
* The ID of the course for which the license is being redeemed
|
|
1706
1712
|
* @example "courseID123"
|
|
@@ -1768,7 +1774,7 @@ export interface Input92Ud3Ap8Ee {
|
|
|
1768
1774
|
acknowledgement?: string | null;
|
|
1769
1775
|
}
|
|
1770
1776
|
/** Validate certification move response schema */
|
|
1771
|
-
export interface
|
|
1777
|
+
export interface OutputMlk3Y0Sufr {
|
|
1772
1778
|
courses: {
|
|
1773
1779
|
name: string;
|
|
1774
1780
|
status: string;
|
|
@@ -1779,21 +1785,21 @@ export interface OutputZ780Quci3Tj {
|
|
|
1779
1785
|
validated: boolean;
|
|
1780
1786
|
mustCreateCP: boolean;
|
|
1781
1787
|
}
|
|
1782
|
-
export interface
|
|
1788
|
+
export interface InputHod6Xcmzr8 {
|
|
1783
1789
|
/**
|
|
1784
1790
|
* Comments regarding the end of the cooldown period
|
|
1785
1791
|
* @example "Cooldown period ended successfully."
|
|
1786
1792
|
*/
|
|
1787
1793
|
comments: string;
|
|
1788
1794
|
}
|
|
1789
|
-
export interface
|
|
1795
|
+
export interface OutputFn02Htoomy {
|
|
1790
1796
|
/**
|
|
1791
1797
|
* Signed URL for the course file
|
|
1792
1798
|
* @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"
|
|
1793
1799
|
*/
|
|
1794
1800
|
fileURL: string;
|
|
1795
1801
|
}
|
|
1796
|
-
export interface
|
|
1802
|
+
export interface Input4S9Bu0T1Ng {
|
|
1797
1803
|
/** @example true */
|
|
1798
1804
|
agreedWithCertTerms: boolean;
|
|
1799
1805
|
/** @example 1717230000000 */
|
|
@@ -1878,21 +1884,21 @@ export interface Sponsor {
|
|
|
1878
1884
|
/** Title of the sponsor of the student in the tenant */
|
|
1879
1885
|
title?: Title;
|
|
1880
1886
|
}
|
|
1881
|
-
export interface
|
|
1887
|
+
export interface InputX4U7C4Jq36 {
|
|
1882
1888
|
/**
|
|
1883
1889
|
* Comments regarding the course unlock action
|
|
1884
1890
|
* @example "Course unlocked successfully."
|
|
1885
1891
|
*/
|
|
1886
1892
|
comments: string;
|
|
1887
1893
|
}
|
|
1888
|
-
export interface
|
|
1894
|
+
export interface InputBmpgyhghyb {
|
|
1889
1895
|
/**
|
|
1890
1896
|
* ITA number to update for the user
|
|
1891
1897
|
* @example "ITA123456"
|
|
1892
1898
|
*/
|
|
1893
1899
|
itaNumber: string;
|
|
1894
1900
|
}
|
|
1895
|
-
export interface
|
|
1901
|
+
export interface Input3Q79Al8T06 {
|
|
1896
1902
|
/** @example true */
|
|
1897
1903
|
agreedWithCertTerms: boolean;
|
|
1898
1904
|
/** @example 1717230000000 */
|
|
@@ -1966,7 +1972,7 @@ export interface InputCe5785R8Zs {
|
|
|
1966
1972
|
/** Sponsor information for a student in the tenant */
|
|
1967
1973
|
sponsor?: Sponsor;
|
|
1968
1974
|
}
|
|
1969
|
-
export interface
|
|
1975
|
+
export interface InputW1Qz7Aegx2 {
|
|
1970
1976
|
/**
|
|
1971
1977
|
* The grade to override the course result with
|
|
1972
1978
|
* @example "A"
|
|
@@ -1974,7 +1980,7 @@ export interface InputFih2S2Mlabl {
|
|
|
1974
1980
|
resultGrade: string;
|
|
1975
1981
|
}
|
|
1976
1982
|
/** Pending approval review parameters */
|
|
1977
|
-
export interface
|
|
1983
|
+
export interface InputAihldyxydl {
|
|
1978
1984
|
/**
|
|
1979
1985
|
* Notes provided by the reviewer for the pending approval
|
|
1980
1986
|
* @example "Please review the submitted documents."
|
|
@@ -1987,7 +1993,7 @@ export interface Input711J32K5Lx {
|
|
|
1987
1993
|
approved: boolean;
|
|
1988
1994
|
}
|
|
1989
1995
|
/** Schema for overriding course result dates. */
|
|
1990
|
-
export interface
|
|
1996
|
+
export interface InputL5Uvh80Jwdh {
|
|
1991
1997
|
/**
|
|
1992
1998
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1993
1999
|
* @example 1735689600000
|
|
@@ -1999,14 +2005,16 @@ export interface InputLwd5Q9Dzkoi {
|
|
|
1999
2005
|
*/
|
|
2000
2006
|
completionDate?: number;
|
|
2001
2007
|
}
|
|
2002
|
-
|
|
2008
|
+
/** Reset sponsorship request takes no body */
|
|
2009
|
+
export type ResetSponsorshipBody = object;
|
|
2010
|
+
export interface InputWmysx72Yqg {
|
|
2003
2011
|
filter: {
|
|
2004
2012
|
from?: number;
|
|
2005
2013
|
sortOrder?: string;
|
|
2006
2014
|
sortField?: string;
|
|
2007
2015
|
};
|
|
2008
2016
|
}
|
|
2009
|
-
export interface
|
|
2017
|
+
export interface OutputWmysx72Yqg {
|
|
2010
2018
|
users: {
|
|
2011
2019
|
firstName: string;
|
|
2012
2020
|
lastName: string;
|
|
@@ -2030,7 +2038,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
2030
2038
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
2031
2039
|
* @example "CHECKED"
|
|
2032
2040
|
*/
|
|
2033
|
-
export declare enum
|
|
2041
|
+
export declare enum InputUysjux8Zp4ValueEnum {
|
|
2034
2042
|
CHECKED = "CHECKED",
|
|
2035
2043
|
UNCHECKED = "UNCHECKED",
|
|
2036
2044
|
NOVALUE = "NOVALUE"
|
|
@@ -2129,7 +2137,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2129
2137
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2130
2138
|
export type CreateReportUsersSimpleData = any;
|
|
2131
2139
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2132
|
-
export type CreateSearchUsersCountData =
|
|
2140
|
+
export type CreateSearchUsersCountData = OutputJqh0F2Rq94L;
|
|
2133
2141
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2134
2142
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2135
2143
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2153,7 +2161,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2153
2161
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2154
2162
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2155
2163
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2156
|
-
export type GetCertificationCourseFileSignData =
|
|
2164
|
+
export type GetCertificationCourseFileSignData = Output6Lxou5Wadvl;
|
|
2157
2165
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2158
2166
|
export interface CreateCertificationCourseFileSignParams {
|
|
2159
2167
|
/** @example "pdf" */
|
|
@@ -2167,11 +2175,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2167
2175
|
/** @example "fileID" */
|
|
2168
2176
|
fileId: string;
|
|
2169
2177
|
}
|
|
2170
|
-
export type CreateCertificationCourseFileSignData =
|
|
2178
|
+
export type CreateCertificationCourseFileSignData = OutputFn02Htoomy;
|
|
2171
2179
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2172
2180
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2173
2181
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2174
|
-
export type CreateCertificationCourseDocumentData =
|
|
2182
|
+
export type CreateCertificationCourseDocumentData = OutputOszbc2Lfht;
|
|
2175
2183
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2176
2184
|
export type DeleteUserData = any;
|
|
2177
2185
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2183,7 +2191,7 @@ export type UpdateUserData = any;
|
|
|
2183
2191
|
export type UpdateUserError = ErrorResponse;
|
|
2184
2192
|
export type DeleteCertificationCourseData = any;
|
|
2185
2193
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2186
|
-
export type GetCertificationApplicationItemFileData =
|
|
2194
|
+
export type GetCertificationApplicationItemFileData = Output5Qmmfjb7J6;
|
|
2187
2195
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2188
2196
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2189
2197
|
/** @example "pdf" */
|
|
@@ -2197,9 +2205,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2197
2205
|
/** @example "fileVersion" */
|
|
2198
2206
|
fileVersion: string;
|
|
2199
2207
|
}
|
|
2200
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2208
|
+
export type CreateCertificationApplicationItemFileData = Output6S8Rfzxiuf;
|
|
2201
2209
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2202
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2210
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = Output7Jte254C0P;
|
|
2203
2211
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2204
2212
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2205
2213
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2207,7 +2215,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2207
2215
|
export type GetCourseError = ErrorResponse;
|
|
2208
2216
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2209
2217
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2210
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2218
|
+
export type GetCertificationApplicationForeignFillData = OutputDrnp2Yirpi;
|
|
2211
2219
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2212
2220
|
export type GetCertificationPrintData = any;
|
|
2213
2221
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2241,7 +2249,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2241
2249
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2242
2250
|
export type CreateCertificationWaiveData = any;
|
|
2243
2251
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2244
|
-
export type CreateCertificationMoveData =
|
|
2252
|
+
export type CreateCertificationMoveData = Output6D4Ct52Qpe;
|
|
2245
2253
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2246
2254
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2247
2255
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2273,7 +2281,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2273
2281
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2274
2282
|
export type CreateCertificationCourseRedeemData = any;
|
|
2275
2283
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2276
|
-
export type CreateCertificationMoveValidateData =
|
|
2284
|
+
export type CreateCertificationMoveValidateData = OutputMlk3Y0Sufr;
|
|
2277
2285
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2278
2286
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2279
2287
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2289,7 +2297,9 @@ export type CreateCertificationPublishInfoData = any;
|
|
|
2289
2297
|
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2290
2298
|
export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
2291
2299
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2292
|
-
export type
|
|
2300
|
+
export type CreateSponsorshipResetData = any;
|
|
2301
|
+
export type CreateSponsorshipResetError = ErrorResponse;
|
|
2302
|
+
export type CreateCertificationResult = OutputWmysx72Yqg;
|
|
2293
2303
|
export type CreateCertificationFail = ErrorResponse;
|
|
2294
2304
|
export type CreateCertificationPublishInfoResult = any;
|
|
2295
2305
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2336,7 +2346,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2336
2346
|
}
|
|
2337
2347
|
/**
|
|
2338
2348
|
* @title BCCSA Program API
|
|
2339
|
-
* @version 3.0.
|
|
2349
|
+
* @version 3.0.35
|
|
2340
2350
|
* @baseUrl http://localhost:8080
|
|
2341
2351
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2342
2352
|
*/
|
|
@@ -2351,7 +2361,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2351
2361
|
* @request POST:/contactUs
|
|
2352
2362
|
* @secure
|
|
2353
2363
|
*/
|
|
2354
|
-
listContactUs: (data:
|
|
2364
|
+
listContactUs: (data: InputRr9Kp8P5Qu, params?: RequestParams) => Promise<any>;
|
|
2355
2365
|
};
|
|
2356
2366
|
customer: {
|
|
2357
2367
|
/**
|
|
@@ -2455,7 +2465,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2455
2465
|
* @request POST:/tenant/report/applicationExport
|
|
2456
2466
|
* @secure
|
|
2457
2467
|
*/
|
|
2458
|
-
createReportApplicationExport: (data:
|
|
2468
|
+
createReportApplicationExport: (data: InputHvh2Rhjuk6, params?: RequestParams) => Promise<any>;
|
|
2459
2469
|
/**
|
|
2460
2470
|
* @description Export a report of applications based on the provided filters.
|
|
2461
2471
|
*
|
|
@@ -2465,7 +2475,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2465
2475
|
* @request POST:/tenant/report/applicationStatus
|
|
2466
2476
|
* @secure
|
|
2467
2477
|
*/
|
|
2468
|
-
listReportApplicationStatus: (data:
|
|
2478
|
+
listReportApplicationStatus: (data: Input5K8X950Ztg, params?: RequestParams) => Promise<any>;
|
|
2469
2479
|
/**
|
|
2470
2480
|
* @description Export a report of applications based on the provided filters.
|
|
2471
2481
|
*
|
|
@@ -2475,7 +2485,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2475
2485
|
* @request POST:/tenant/report/applicationsReport
|
|
2476
2486
|
* @secure
|
|
2477
2487
|
*/
|
|
2478
|
-
createReportApplicationsReport: (data:
|
|
2488
|
+
createReportApplicationsReport: (data: InputV73Gd5K2S3, params?: RequestParams) => Promise<any>;
|
|
2479
2489
|
/**
|
|
2480
2490
|
* @description This route allows you to post certificates email for the tenant.
|
|
2481
2491
|
*
|
|
@@ -2485,7 +2495,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2485
2495
|
* @request POST:/tenant/certificates/email
|
|
2486
2496
|
* @secure
|
|
2487
2497
|
*/
|
|
2488
|
-
createCertificatesEmail: (data:
|
|
2498
|
+
createCertificatesEmail: (data: InputYuucneuxkg, params?: RequestParams) => Promise<any>;
|
|
2489
2499
|
/**
|
|
2490
2500
|
* @description Generate a preview of the completed certifications report.
|
|
2491
2501
|
*
|
|
@@ -2515,7 +2525,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2515
2525
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2516
2526
|
* @secure
|
|
2517
2527
|
*/
|
|
2518
|
-
createLicenseRedeem: (userId: string, data:
|
|
2528
|
+
createLicenseRedeem: (userId: string, data: InputIc5N9Ldrci, params?: RequestParams) => Promise<any>;
|
|
2519
2529
|
/**
|
|
2520
2530
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2521
2531
|
*
|
|
@@ -2525,7 +2535,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2525
2535
|
* @request POST:/tenant/report/orglicenses/
|
|
2526
2536
|
* @secure
|
|
2527
2537
|
*/
|
|
2528
|
-
listReportOrglicenses: (data:
|
|
2538
|
+
listReportOrglicenses: (data: InputJu8Q7Jd4Rm, params?: RequestParams) => Promise<any>;
|
|
2529
2539
|
/**
|
|
2530
2540
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2531
2541
|
*
|
|
@@ -2535,7 +2545,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2535
2545
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2536
2546
|
* @secure
|
|
2537
2547
|
*/
|
|
2538
|
-
createReportOrglicensesPreview: (data:
|
|
2548
|
+
createReportOrglicensesPreview: (data: InputU8Srhwp84Ch, params?: RequestParams) => Promise<any>;
|
|
2539
2549
|
/**
|
|
2540
2550
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2541
2551
|
*
|
|
@@ -2575,7 +2585,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2575
2585
|
* @request POST:/tenant/report/users/advanced
|
|
2576
2586
|
* @secure
|
|
2577
2587
|
*/
|
|
2578
|
-
createReportUsersAdvanced: (data:
|
|
2588
|
+
createReportUsersAdvanced: (data: InputF5Jjnrfmt7I, params?: RequestParams) => Promise<any>;
|
|
2579
2589
|
/**
|
|
2580
2590
|
* @description Searches for users in the tenant by their IDs.
|
|
2581
2591
|
*
|
|
@@ -2585,7 +2595,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2585
2595
|
* @request POST:/tenant/search/users/ids
|
|
2586
2596
|
* @secure
|
|
2587
2597
|
*/
|
|
2588
|
-
listSearchUsersIds: (data:
|
|
2598
|
+
listSearchUsersIds: (data: Input5Nynw58Ws1, params?: RequestParams) => Promise<any>;
|
|
2589
2599
|
/**
|
|
2590
2600
|
* @description Searches for users in the tenant by term and filters.
|
|
2591
2601
|
*
|
|
@@ -2595,7 +2605,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2595
2605
|
* @request POST:/tenant/search/users/term
|
|
2596
2606
|
* @secure
|
|
2597
2607
|
*/
|
|
2598
|
-
createSearchUsersTerm: (data:
|
|
2608
|
+
createSearchUsersTerm: (data: Input4H67Nuuo8P, params?: RequestParams) => Promise<any>;
|
|
2599
2609
|
/**
|
|
2600
2610
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2601
2611
|
*
|
|
@@ -2605,7 +2615,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2605
2615
|
* @request POST:/tenant/report/users/simple
|
|
2606
2616
|
* @secure
|
|
2607
2617
|
*/
|
|
2608
|
-
createReportUsersSimple: (data:
|
|
2618
|
+
createReportUsersSimple: (data: Input2Mihdr2Tcif, params?: RequestParams) => Promise<any>;
|
|
2609
2619
|
/**
|
|
2610
2620
|
* @description Retrieve user by ID.
|
|
2611
2621
|
*
|
|
@@ -2615,7 +2625,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2615
2625
|
* @request POST:/tenant/search/users/count
|
|
2616
2626
|
* @secure
|
|
2617
2627
|
*/
|
|
2618
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2628
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputJqh0F2Rq94L>;
|
|
2619
2629
|
};
|
|
2620
2630
|
user: {
|
|
2621
2631
|
/**
|
|
@@ -2647,7 +2657,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2647
2657
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2648
2658
|
* @secure
|
|
2649
2659
|
*/
|
|
2650
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2660
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: InputUdco8Yiz4U, params?: RequestParams) => Promise<any>;
|
|
2651
2661
|
/**
|
|
2652
2662
|
* @description Delete a certification process application by type.
|
|
2653
2663
|
*
|
|
@@ -2737,7 +2747,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2737
2747
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2738
2748
|
* @secure
|
|
2739
2749
|
*/
|
|
2740
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2750
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<Output6Lxou5Wadvl>;
|
|
2741
2751
|
/**
|
|
2742
2752
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2743
2753
|
*
|
|
@@ -2747,7 +2757,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2747
2757
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2748
2758
|
* @secure
|
|
2749
2759
|
*/
|
|
2750
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2760
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputFn02Htoomy>;
|
|
2751
2761
|
/**
|
|
2752
2762
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2753
2763
|
*
|
|
@@ -2767,7 +2777,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2767
2777
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2768
2778
|
* @secure
|
|
2769
2779
|
*/
|
|
2770
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2780
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputOszbc2Lfht, params?: RequestParams) => Promise<OutputOszbc2Lfht>;
|
|
2771
2781
|
/**
|
|
2772
2782
|
* @description Delete user by ID.
|
|
2773
2783
|
*
|
|
@@ -2797,9 +2807,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2797
2807
|
* @request POST:/user/{userID}
|
|
2798
2808
|
* @secure
|
|
2799
2809
|
*/
|
|
2800
|
-
createUser: (userId: string, data:
|
|
2810
|
+
createUser: (userId: string, data: Input4S9Bu0T1Ng, params?: RequestParams) => Promise<any>;
|
|
2801
2811
|
/**
|
|
2802
|
-
* @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.
|
|
2812
|
+
* @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. When provided, the sponsor is saved on the user only; this does not update the pending sponsorship request or email the sponsor. Use POST /user/{userID}/sponsorship/reset to refresh the pending request from the stored sponsor and re-send the request.
|
|
2803
2813
|
*
|
|
2804
2814
|
* @tags User
|
|
2805
2815
|
* @name UpdateUser
|
|
@@ -2807,7 +2817,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2807
2817
|
* @request PUT:/user/{userID}
|
|
2808
2818
|
* @secure
|
|
2809
2819
|
*/
|
|
2810
|
-
updateUser: (userId: string, data:
|
|
2820
|
+
updateUser: (userId: string, data: Input3Q79Al8T06, params?: RequestParams) => Promise<any>;
|
|
2811
2821
|
/**
|
|
2812
2822
|
* @description Delete course from user
|
|
2813
2823
|
*
|
|
@@ -2827,7 +2837,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2827
2837
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2828
2838
|
* @secure
|
|
2829
2839
|
*/
|
|
2830
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2840
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<Output5Qmmfjb7J6>;
|
|
2831
2841
|
/**
|
|
2832
2842
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2833
2843
|
*
|
|
@@ -2837,7 +2847,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2837
2847
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2838
2848
|
* @secure
|
|
2839
2849
|
*/
|
|
2840
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2850
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<Output6S8Rfzxiuf>;
|
|
2841
2851
|
/**
|
|
2842
2852
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2843
2853
|
*
|
|
@@ -2847,7 +2857,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2847
2857
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2848
2858
|
* @secure
|
|
2849
2859
|
*/
|
|
2850
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2860
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<Output7Jte254C0P>;
|
|
2851
2861
|
/**
|
|
2852
2862
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2853
2863
|
*
|
|
@@ -2887,7 +2897,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2887
2897
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2888
2898
|
* @secure
|
|
2889
2899
|
*/
|
|
2890
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2900
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputDrnp2Yirpi>;
|
|
2891
2901
|
/**
|
|
2892
2902
|
* @description This endpoint will print certificate
|
|
2893
2903
|
*
|
|
@@ -2947,7 +2957,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2947
2957
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2948
2958
|
* @secure
|
|
2949
2959
|
*/
|
|
2950
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2960
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputWkff4Yaywy, params?: RequestParams) => Promise<any>;
|
|
2951
2961
|
/**
|
|
2952
2962
|
* @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.
|
|
2953
2963
|
*
|
|
@@ -2977,7 +2987,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2977
2987
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2978
2988
|
* @secure
|
|
2979
2989
|
*/
|
|
2980
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2990
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputKa30H4Ner6, params?: RequestParams) => Promise<any>;
|
|
2981
2991
|
/**
|
|
2982
2992
|
* @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.
|
|
2983
2993
|
*
|
|
@@ -2987,7 +2997,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2987
2997
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2988
2998
|
* @secure
|
|
2989
2999
|
*/
|
|
2990
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3000
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputP7Rzxtpwwc, params?: RequestParams) => Promise<any>;
|
|
2991
3001
|
/**
|
|
2992
3002
|
* @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.
|
|
2993
3003
|
*
|
|
@@ -2997,7 +3007,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2997
3007
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2998
3008
|
* @secure
|
|
2999
3009
|
*/
|
|
3000
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
3010
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputY2D9S4Qy4S, params?: RequestParams) => Promise<any>;
|
|
3001
3011
|
/**
|
|
3002
3012
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
3003
3013
|
*
|
|
@@ -3007,7 +3017,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3007
3017
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
3008
3018
|
* @secure
|
|
3009
3019
|
*/
|
|
3010
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
3020
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: Input62Nyiggonmh, params?: RequestParams) => Promise<any>;
|
|
3011
3021
|
/**
|
|
3012
3022
|
* @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.
|
|
3013
3023
|
*
|
|
@@ -3047,7 +3057,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3047
3057
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
3048
3058
|
* @secure
|
|
3049
3059
|
*/
|
|
3050
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
3060
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputXqdgr5Oa5Vh, params?: RequestParams) => Promise<any>;
|
|
3051
3061
|
/**
|
|
3052
3062
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
3053
3063
|
*
|
|
@@ -3057,7 +3067,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3057
3067
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
3058
3068
|
* @secure
|
|
3059
3069
|
*/
|
|
3060
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3070
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<Output6D4Ct52Qpe>;
|
|
3061
3071
|
/**
|
|
3062
3072
|
* @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.
|
|
3063
3073
|
*
|
|
@@ -3097,7 +3107,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3097
3107
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
3098
3108
|
* @secure
|
|
3099
3109
|
*/
|
|
3100
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
3110
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputUysjux8Zp4, params?: RequestParams) => Promise<any>;
|
|
3101
3111
|
/**
|
|
3102
3112
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
3103
3113
|
*
|
|
@@ -3157,7 +3167,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3157
3167
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3158
3168
|
* @secure
|
|
3159
3169
|
*/
|
|
3160
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
3170
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: Input1Lghooas4I, params?: RequestParams) => Promise<any>;
|
|
3161
3171
|
/**
|
|
3162
3172
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3163
3173
|
*
|
|
@@ -3177,7 +3187,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3177
3187
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3178
3188
|
* @secure
|
|
3179
3189
|
*/
|
|
3180
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3190
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputCgletgibfvi, params?: RequestParams) => Promise<any>;
|
|
3181
3191
|
/**
|
|
3182
3192
|
* @description This route allows you to submit a pending approval.
|
|
3183
3193
|
*
|
|
@@ -3187,7 +3197,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3187
3197
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3188
3198
|
* @secure
|
|
3189
3199
|
*/
|
|
3190
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3200
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputDv9Ni3Aar5, params?: RequestParams) => Promise<any>;
|
|
3191
3201
|
/**
|
|
3192
3202
|
* @description This route allows you to review a pending approval.
|
|
3193
3203
|
*
|
|
@@ -3197,7 +3207,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3197
3207
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3198
3208
|
* @secure
|
|
3199
3209
|
*/
|
|
3200
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3210
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputAihldyxydl, params?: RequestParams) => Promise<any>;
|
|
3201
3211
|
/**
|
|
3202
3212
|
* @description Redeems a license for a user by product ID.
|
|
3203
3213
|
*
|
|
@@ -3207,7 +3217,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3207
3217
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3208
3218
|
* @secure
|
|
3209
3219
|
*/
|
|
3210
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3220
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputGhxoi4I6V8, params?: RequestParams) => Promise<any>;
|
|
3211
3221
|
/**
|
|
3212
3222
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3213
3223
|
*
|
|
@@ -3217,7 +3227,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3217
3227
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3218
3228
|
* @secure
|
|
3219
3229
|
*/
|
|
3220
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3230
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputMlk3Y0Sufr>;
|
|
3221
3231
|
/**
|
|
3222
3232
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3223
3233
|
*
|
|
@@ -3227,7 +3237,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3227
3237
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3228
3238
|
* @secure
|
|
3229
3239
|
*/
|
|
3230
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3240
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputHod6Xcmzr8, params?: RequestParams) => Promise<any>;
|
|
3231
3241
|
/**
|
|
3232
3242
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3233
3243
|
*
|
|
@@ -3237,7 +3247,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3237
3247
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3238
3248
|
* @secure
|
|
3239
3249
|
*/
|
|
3240
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3250
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputX4U7C4Jq36, params?: RequestParams) => Promise<any>;
|
|
3241
3251
|
/**
|
|
3242
3252
|
* @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.
|
|
3243
3253
|
*
|
|
@@ -3247,7 +3257,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3247
3257
|
* @request POST:/user/{userID}/updateITA
|
|
3248
3258
|
* @secure
|
|
3249
3259
|
*/
|
|
3250
|
-
createUpdateIta: (userId: string, data:
|
|
3260
|
+
createUpdateIta: (userId: string, data: InputBmpgyhghyb, params?: RequestParams) => Promise<any>;
|
|
3251
3261
|
/**
|
|
3252
3262
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3253
3263
|
*
|
|
@@ -3257,7 +3267,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3257
3267
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3258
3268
|
* @secure
|
|
3259
3269
|
*/
|
|
3260
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3270
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputW1Qz7Aegx2, params?: RequestParams) => Promise<any>;
|
|
3261
3271
|
/**
|
|
3262
3272
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3263
3273
|
*
|
|
@@ -3267,7 +3277,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3267
3277
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3268
3278
|
* @secure
|
|
3269
3279
|
*/
|
|
3270
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3280
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputL5Uvh80Jwdh, params?: RequestParams) => Promise<any>;
|
|
3271
3281
|
/**
|
|
3272
3282
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3273
3283
|
*
|
|
@@ -3288,6 +3298,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3288
3298
|
* @secure
|
|
3289
3299
|
*/
|
|
3290
3300
|
createCertificationCourseRequestEnrolment: (userId: string, certProcId: string, courseId: string, params?: RequestParams) => Promise<any>;
|
|
3301
|
+
/**
|
|
3302
|
+
* @description Restart a user sponsorship / attestation request from the user's currently stored sponsor data. Refreshes an existing pending request in place, or creates a new request when the previous one is completed or missing, and re-sends the sponsor request email.
|
|
3303
|
+
*
|
|
3304
|
+
* @tags Sponsorship
|
|
3305
|
+
* @name CreateSponsorshipReset
|
|
3306
|
+
* @summary ResetSponsorshipRequest
|
|
3307
|
+
* @request POST:/user/{userID}/sponsorship/reset
|
|
3308
|
+
* @secure
|
|
3309
|
+
*/
|
|
3310
|
+
createSponsorshipReset: (userId: string, data: ResetSponsorshipBody, params?: RequestParams) => Promise<any>;
|
|
3291
3311
|
};
|
|
3292
3312
|
users: {
|
|
3293
3313
|
/**
|
|
@@ -3299,7 +3319,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3299
3319
|
* @request POST:/users/certification/{certSpecID}
|
|
3300
3320
|
* @secure
|
|
3301
3321
|
*/
|
|
3302
|
-
createCertification: (certSpecId: string, data:
|
|
3322
|
+
createCertification: (certSpecId: string, data: InputWmysx72Yqg, params?: RequestParams) => Promise<OutputWmysx72Yqg>;
|
|
3303
3323
|
/**
|
|
3304
3324
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3305
3325
|
*
|