@ikonintegration/bccsa-program-api 3.0.41 → 3.0.42
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 +143 -106
- package/dist/Api.d.ts +142 -112
- package/dist/Api.js +25 -8
- 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 InputMtdb53Vravl {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -329,7 +329,7 @@ export type RevokedByID = string;
|
|
|
329
329
|
/** Display name of the user who revoked the course */
|
|
330
330
|
export type RevokedByName = string;
|
|
331
331
|
/** Sponsorship approval parameters */
|
|
332
|
-
export interface
|
|
332
|
+
export interface Input6Cq7Uvmotn {
|
|
333
333
|
/**
|
|
334
334
|
* Employer first name
|
|
335
335
|
* @maxLength 255
|
|
@@ -543,7 +543,7 @@ export type SponsorshipRemindersStudent = string[];
|
|
|
543
543
|
export type SponsorshipRemindersSponsor = string[];
|
|
544
544
|
/** Timestamp when the current sponsorship reminder schedule started (set on create and on reset). Reminder dueness is measured from it; when absent, from createdOn. */
|
|
545
545
|
export type RemindersStartedOn = number;
|
|
546
|
-
export interface
|
|
546
|
+
export interface InputRevneeqe9I {
|
|
547
547
|
/**
|
|
548
548
|
* ID of the certification to filter applications by
|
|
549
549
|
* @example "certification123"
|
|
@@ -600,7 +600,7 @@ export interface InputD4Rprncvca {
|
|
|
600
600
|
*/
|
|
601
601
|
ignoreCompletedCertifications?: boolean | null;
|
|
602
602
|
}
|
|
603
|
-
export interface
|
|
603
|
+
export interface Input7864Bcispq {
|
|
604
604
|
/**
|
|
605
605
|
* ID of the certification to filter applications by
|
|
606
606
|
* @example "certification123"
|
|
@@ -657,7 +657,7 @@ export interface InputOdq90W7Fvd {
|
|
|
657
657
|
*/
|
|
658
658
|
ignoreCompletedCertifications?: boolean | null;
|
|
659
659
|
}
|
|
660
|
-
export interface
|
|
660
|
+
export interface InputEmcahhgo6O {
|
|
661
661
|
/**
|
|
662
662
|
* ID of the certification to filter applications by
|
|
663
663
|
* @example "certification123"
|
|
@@ -714,7 +714,7 @@ export interface InputKhw29Smbei {
|
|
|
714
714
|
*/
|
|
715
715
|
ignoreCompletedCertifications?: boolean | null;
|
|
716
716
|
}
|
|
717
|
-
export interface
|
|
717
|
+
export interface InputD7Rg1Jdq89J {
|
|
718
718
|
/**
|
|
719
719
|
* The ID of the certificate specifications to be used for the email
|
|
720
720
|
* @example "certSpecsID123"
|
|
@@ -755,7 +755,7 @@ export interface InputE4Gqi912J9 {
|
|
|
755
755
|
emailAddress: string;
|
|
756
756
|
}[];
|
|
757
757
|
}
|
|
758
|
-
export interface
|
|
758
|
+
export interface InputVp5Z3Zbs61 {
|
|
759
759
|
/**
|
|
760
760
|
* The ID of the product for which the license is being redeemed
|
|
761
761
|
* @example "productID123"
|
|
@@ -767,7 +767,7 @@ export interface InputQihsbffnta {
|
|
|
767
767
|
*/
|
|
768
768
|
sessionID?: string;
|
|
769
769
|
}
|
|
770
|
-
export interface
|
|
770
|
+
export interface InputTiuryi30F3 {
|
|
771
771
|
/**
|
|
772
772
|
* Search term to filter licenses
|
|
773
773
|
* @example "active"
|
|
@@ -784,7 +784,7 @@ export interface Input0Cdbeyihx9 {
|
|
|
784
784
|
*/
|
|
785
785
|
sortField?: any;
|
|
786
786
|
}
|
|
787
|
-
export interface
|
|
787
|
+
export interface InputG0Tiszrb8M {
|
|
788
788
|
/**
|
|
789
789
|
* Search term to filter licenses
|
|
790
790
|
* @example "active"
|
|
@@ -917,7 +917,7 @@ export interface SearchPendingApprovalsResponseSchema {
|
|
|
917
917
|
remindersStartedOn?: RemindersStartedOn;
|
|
918
918
|
}[];
|
|
919
919
|
}
|
|
920
|
-
export interface
|
|
920
|
+
export interface InputVz5Vg9G4Oqf {
|
|
921
921
|
/**
|
|
922
922
|
* Start date for the report
|
|
923
923
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -939,11 +939,11 @@ export interface InputX6Br1Bzszd {
|
|
|
939
939
|
*/
|
|
940
940
|
dateType?: string;
|
|
941
941
|
}
|
|
942
|
-
export interface
|
|
942
|
+
export interface InputJbzgj95Lkq {
|
|
943
943
|
/** List of user IDs to search for in the tenant. */
|
|
944
944
|
IDs: (string | null)[];
|
|
945
945
|
}
|
|
946
|
-
export interface
|
|
946
|
+
export interface InputA5S63Nipmm {
|
|
947
947
|
/** The term to search for in the user profiles. */
|
|
948
948
|
searchTerm?: string | null;
|
|
949
949
|
/** Filter criteria for the user search. */
|
|
@@ -983,7 +983,7 @@ export interface InputSnyycdllar {
|
|
|
983
983
|
};
|
|
984
984
|
};
|
|
985
985
|
}
|
|
986
|
-
export interface
|
|
986
|
+
export interface InputC5Nduciwehk {
|
|
987
987
|
/** The term to search for in the user profiles. */
|
|
988
988
|
searchTerm?: string | null;
|
|
989
989
|
/** Filter criteria for the user search. */
|
|
@@ -1023,14 +1023,14 @@ export interface InputV6Bi78Xqc6 {
|
|
|
1023
1023
|
};
|
|
1024
1024
|
};
|
|
1025
1025
|
}
|
|
1026
|
-
export interface
|
|
1026
|
+
export interface Output4Yo1T8Mg5H {
|
|
1027
1027
|
/** External system ID 2 */
|
|
1028
1028
|
userCount: ExternalID2;
|
|
1029
1029
|
transactionID?: string | null;
|
|
1030
1030
|
}
|
|
1031
1031
|
/** External system ID 2 */
|
|
1032
1032
|
export type ExternalID2 = number;
|
|
1033
|
-
export interface
|
|
1033
|
+
export interface InputHqsyyu5W0Jh {
|
|
1034
1034
|
/** Report filter */
|
|
1035
1035
|
filter: {
|
|
1036
1036
|
/**
|
|
@@ -1056,16 +1056,34 @@ export interface InputXc4U9K5Ew {
|
|
|
1056
1056
|
to?: number;
|
|
1057
1057
|
};
|
|
1058
1058
|
}
|
|
1059
|
+
export interface InputO95Wbehky7 {
|
|
1060
|
+
filter: {
|
|
1061
|
+
/**
|
|
1062
|
+
* Course specification identifiers to match (1-100 entries, each 1-128 characters).
|
|
1063
|
+
* @maxItems 100
|
|
1064
|
+
* @minItems 1
|
|
1065
|
+
* @example ["course-abc","course-def"]
|
|
1066
|
+
*/
|
|
1067
|
+
courseID: string[];
|
|
1068
|
+
/**
|
|
1069
|
+
* Mandatory positive integer count of days defining the forward-looking expiry window, measured from the current server time. Must be an integer in [1, 3650].
|
|
1070
|
+
* @min 1
|
|
1071
|
+
* @max 3650
|
|
1072
|
+
* @example 30
|
|
1073
|
+
*/
|
|
1074
|
+
expiringInDays: number;
|
|
1075
|
+
};
|
|
1076
|
+
}
|
|
1059
1077
|
/** This endpoint accepts no request body */
|
|
1060
1078
|
export type DeletePendingApprovalBody = object;
|
|
1061
|
-
export interface
|
|
1079
|
+
export interface OutputWbamsgwk0Ni {
|
|
1062
1080
|
/**
|
|
1063
1081
|
* Signed URL for the course file
|
|
1064
1082
|
* @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"
|
|
1065
1083
|
*/
|
|
1066
1084
|
fileURL: string;
|
|
1067
1085
|
}
|
|
1068
|
-
export interface
|
|
1086
|
+
export interface Output0Vdczlumsn {
|
|
1069
1087
|
/**
|
|
1070
1088
|
* Amount to be refunded for the cancellation
|
|
1071
1089
|
* @example 0
|
|
@@ -1365,7 +1383,7 @@ export interface CourseResponseEntity {
|
|
|
1365
1383
|
}
|
|
1366
1384
|
/** Label of the course enrolled (course version) */
|
|
1367
1385
|
export type OnlineCourseLabel = string;
|
|
1368
|
-
export interface
|
|
1386
|
+
export interface OutputPtlq1Xy1Xs {
|
|
1369
1387
|
/**
|
|
1370
1388
|
* Signed URL for the course file
|
|
1371
1389
|
* @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"
|
|
@@ -1383,7 +1401,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1383
1401
|
transactionID?: string | null;
|
|
1384
1402
|
}
|
|
1385
1403
|
/** Application Foreign Fill response type */
|
|
1386
|
-
export interface
|
|
1404
|
+
export interface OutputCfk1Obftos {
|
|
1387
1405
|
items: {
|
|
1388
1406
|
userID: string;
|
|
1389
1407
|
createdOn?: number;
|
|
@@ -1606,7 +1624,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1606
1624
|
applicationItems?: Record<string, any>[];
|
|
1607
1625
|
transactionID?: string | null;
|
|
1608
1626
|
}
|
|
1609
|
-
export interface
|
|
1627
|
+
export interface Input9O4Ljrmhog {
|
|
1610
1628
|
issuedOn?: number;
|
|
1611
1629
|
expiresOn?: number;
|
|
1612
1630
|
fileItems?: {
|
|
@@ -1615,21 +1633,21 @@ export interface InputDo34Iz9Dvd {
|
|
|
1615
1633
|
}[];
|
|
1616
1634
|
additionalNotes?: string | null;
|
|
1617
1635
|
}
|
|
1618
|
-
export interface
|
|
1636
|
+
export interface InputR1So32P4Q5K {
|
|
1619
1637
|
/**
|
|
1620
1638
|
* Indicates whether the application is locked
|
|
1621
1639
|
* @example true
|
|
1622
1640
|
*/
|
|
1623
1641
|
isApplicationLocked: boolean;
|
|
1624
1642
|
}
|
|
1625
|
-
export interface
|
|
1643
|
+
export interface OutputN5Huf9Qhuh {
|
|
1626
1644
|
/**
|
|
1627
1645
|
* Signed URL for the course file
|
|
1628
1646
|
* @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"
|
|
1629
1647
|
*/
|
|
1630
1648
|
fileURL: string;
|
|
1631
1649
|
}
|
|
1632
|
-
export interface
|
|
1650
|
+
export interface InputS7Tqlbmeknf {
|
|
1633
1651
|
/**
|
|
1634
1652
|
* Indicates whether the waiver is approved
|
|
1635
1653
|
* @example true
|
|
@@ -1641,14 +1659,14 @@ export interface InputFvtyzhspxlk {
|
|
|
1641
1659
|
*/
|
|
1642
1660
|
additionalNotes?: string | null;
|
|
1643
1661
|
}
|
|
1644
|
-
export interface
|
|
1662
|
+
export interface Input006Njyqh6D {
|
|
1645
1663
|
/**
|
|
1646
1664
|
* Optional notes regarding the waiver
|
|
1647
1665
|
* @example "Waiver granted due to special circumstances."
|
|
1648
1666
|
*/
|
|
1649
1667
|
additionalNotes?: string | null;
|
|
1650
1668
|
}
|
|
1651
|
-
export interface
|
|
1669
|
+
export interface InputZpa0Khrucq {
|
|
1652
1670
|
students: {
|
|
1653
1671
|
/**
|
|
1654
1672
|
* User ID of the student to redeem the course for
|
|
@@ -1682,7 +1700,7 @@ export interface InputSwpu5Vwre6 {
|
|
|
1682
1700
|
*/
|
|
1683
1701
|
autoEnrolSessionID?: string;
|
|
1684
1702
|
}
|
|
1685
|
-
export interface
|
|
1703
|
+
export interface InputPt95Kpvoys {
|
|
1686
1704
|
invites: {
|
|
1687
1705
|
/**
|
|
1688
1706
|
* Email address of the user to invite
|
|
@@ -1711,7 +1729,7 @@ export interface InputM3Vuv0N0Ko {
|
|
|
1711
1729
|
*/
|
|
1712
1730
|
isReservedSeat: boolean;
|
|
1713
1731
|
}
|
|
1714
|
-
export interface
|
|
1732
|
+
export interface Input12884Eu0F1 {
|
|
1715
1733
|
/**
|
|
1716
1734
|
* Indicates whether to waive the certification process
|
|
1717
1735
|
* @example true
|
|
@@ -1724,7 +1742,7 @@ export interface Input67Joiiq2Mlf {
|
|
|
1724
1742
|
comments?: string | null;
|
|
1725
1743
|
}
|
|
1726
1744
|
/** Certification move response schema */
|
|
1727
|
-
export interface
|
|
1745
|
+
export interface OutputCgvlltra8Rk {
|
|
1728
1746
|
errors?: {
|
|
1729
1747
|
status: string;
|
|
1730
1748
|
object?: Record<string, any>;
|
|
@@ -1732,19 +1750,19 @@ export interface OutputC6Swugv92O {
|
|
|
1732
1750
|
}[];
|
|
1733
1751
|
}
|
|
1734
1752
|
/** Schema for writing a certification trigger check. */
|
|
1735
|
-
export interface
|
|
1753
|
+
export interface InputV7Vsxcqhz2 {
|
|
1736
1754
|
/**
|
|
1737
1755
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1738
1756
|
* @example "CHECKED"
|
|
1739
1757
|
*/
|
|
1740
|
-
value:
|
|
1758
|
+
value: InputV7Vsxcqhz2ValueEnum;
|
|
1741
1759
|
/**
|
|
1742
1760
|
* List of course IDs that are blocked by this trigger check.
|
|
1743
1761
|
* @example ["course1","course2"]
|
|
1744
1762
|
*/
|
|
1745
1763
|
blockedCourses?: string[];
|
|
1746
1764
|
}
|
|
1747
|
-
export interface
|
|
1765
|
+
export interface InputFgf9Pnx6T6 {
|
|
1748
1766
|
/**
|
|
1749
1767
|
* Indicates whether the application item is approved
|
|
1750
1768
|
* @example true
|
|
@@ -1770,7 +1788,7 @@ export interface InputDvl5Dcmb96 {
|
|
|
1770
1788
|
export interface StudentHistoryRequestSchema {
|
|
1771
1789
|
requirements: string[];
|
|
1772
1790
|
}
|
|
1773
|
-
export interface
|
|
1791
|
+
export interface InputGpznvh1Ayn {
|
|
1774
1792
|
/**
|
|
1775
1793
|
* Optional activation key for the application
|
|
1776
1794
|
* @example "AK-123456"
|
|
@@ -1778,7 +1796,7 @@ export interface InputXgiq6Ooomw {
|
|
|
1778
1796
|
activationKey?: string;
|
|
1779
1797
|
}
|
|
1780
1798
|
/** Schema for course submission item details post request. */
|
|
1781
|
-
export interface
|
|
1799
|
+
export interface InputDwxbfmdjov {
|
|
1782
1800
|
/**
|
|
1783
1801
|
* The ID of the file being submitted.
|
|
1784
1802
|
* @example "fileID123"
|
|
@@ -1791,7 +1809,7 @@ export interface InputSj177Dwq6Q {
|
|
|
1791
1809
|
fileName: string;
|
|
1792
1810
|
}
|
|
1793
1811
|
/** Schema for the response to course submission item details post request. */
|
|
1794
|
-
export interface
|
|
1812
|
+
export interface OutputDwxbfmdjov {
|
|
1795
1813
|
submissionItems: {
|
|
1796
1814
|
/**
|
|
1797
1815
|
* The ID of the file being submitted.
|
|
@@ -1806,7 +1824,7 @@ export interface OutputSj177Dwq6Q {
|
|
|
1806
1824
|
}[];
|
|
1807
1825
|
}
|
|
1808
1826
|
/** Pending approval submission parameters */
|
|
1809
|
-
export interface
|
|
1827
|
+
export interface InputQ1Npqk2Ljf {
|
|
1810
1828
|
/**
|
|
1811
1829
|
* Type of pending approval
|
|
1812
1830
|
* @example "certification"
|
|
@@ -1826,7 +1844,7 @@ export interface InputOexr2Qxfau {
|
|
|
1826
1844
|
fileName: string;
|
|
1827
1845
|
}[];
|
|
1828
1846
|
}
|
|
1829
|
-
export interface
|
|
1847
|
+
export interface Input0K4Oe5Vt00H {
|
|
1830
1848
|
/**
|
|
1831
1849
|
* The ID of the course for which the license is being redeemed
|
|
1832
1850
|
* @example "courseID123"
|
|
@@ -1894,7 +1912,7 @@ export interface InputMsk4L6Y8T6 {
|
|
|
1894
1912
|
acknowledgement?: string | null;
|
|
1895
1913
|
}
|
|
1896
1914
|
/** Validate certification move response schema */
|
|
1897
|
-
export interface
|
|
1915
|
+
export interface OutputIyrhntucd3 {
|
|
1898
1916
|
courses: {
|
|
1899
1917
|
name: string;
|
|
1900
1918
|
status: string;
|
|
@@ -1905,21 +1923,21 @@ export interface OutputK50Eo4Le8G {
|
|
|
1905
1923
|
validated: boolean;
|
|
1906
1924
|
mustCreateCP: boolean;
|
|
1907
1925
|
}
|
|
1908
|
-
export interface
|
|
1926
|
+
export interface InputZ80Ge0Wuj6 {
|
|
1909
1927
|
/**
|
|
1910
1928
|
* Comments regarding the end of the cooldown period
|
|
1911
1929
|
* @example "Cooldown period ended successfully."
|
|
1912
1930
|
*/
|
|
1913
1931
|
comments: string;
|
|
1914
1932
|
}
|
|
1915
|
-
export interface
|
|
1933
|
+
export interface OutputNq9Hgt37Jd {
|
|
1916
1934
|
/**
|
|
1917
1935
|
* Signed URL for the course file
|
|
1918
1936
|
* @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"
|
|
1919
1937
|
*/
|
|
1920
1938
|
fileURL: string;
|
|
1921
1939
|
}
|
|
1922
|
-
export interface
|
|
1940
|
+
export interface Input8Pvcoifrsfj {
|
|
1923
1941
|
/** @example true */
|
|
1924
1942
|
agreedWithCertTerms: boolean;
|
|
1925
1943
|
/** @example 1717230000000 */
|
|
@@ -2004,21 +2022,21 @@ export interface Sponsor {
|
|
|
2004
2022
|
/** Title of the sponsor of the student in the tenant */
|
|
2005
2023
|
title?: Title;
|
|
2006
2024
|
}
|
|
2007
|
-
export interface
|
|
2025
|
+
export interface Input6Imn3Yi9Zl {
|
|
2008
2026
|
/**
|
|
2009
2027
|
* Comments regarding the course unlock action
|
|
2010
2028
|
* @example "Course unlocked successfully."
|
|
2011
2029
|
*/
|
|
2012
2030
|
comments: string;
|
|
2013
2031
|
}
|
|
2014
|
-
export interface
|
|
2032
|
+
export interface Input0V1Y0C4Gdm {
|
|
2015
2033
|
/**
|
|
2016
2034
|
* ITA number to update for the user
|
|
2017
2035
|
* @example "ITA123456"
|
|
2018
2036
|
*/
|
|
2019
2037
|
itaNumber: string;
|
|
2020
2038
|
}
|
|
2021
|
-
export interface
|
|
2039
|
+
export interface InputQ2Brw4Yx6Rg {
|
|
2022
2040
|
/** @example true */
|
|
2023
2041
|
agreedWithCertTerms: boolean;
|
|
2024
2042
|
/** @example 1717230000000 */
|
|
@@ -2092,7 +2110,7 @@ export interface InputBknn2Isn2Ll {
|
|
|
2092
2110
|
/** Sponsor information for a student in the tenant */
|
|
2093
2111
|
sponsor?: Sponsor;
|
|
2094
2112
|
}
|
|
2095
|
-
export interface
|
|
2113
|
+
export interface Input3Ypm4Sg0Kz {
|
|
2096
2114
|
/**
|
|
2097
2115
|
* The grade to override the course result with
|
|
2098
2116
|
* @example "A"
|
|
@@ -2100,7 +2118,7 @@ export interface Input2V0Cmpfq55G {
|
|
|
2100
2118
|
resultGrade: string;
|
|
2101
2119
|
}
|
|
2102
2120
|
/** Pending approval review parameters */
|
|
2103
|
-
export interface
|
|
2121
|
+
export interface Input2Hig6Mp1Z6 {
|
|
2104
2122
|
/**
|
|
2105
2123
|
* Notes provided by the reviewer for the pending approval
|
|
2106
2124
|
* @example "Please review the submitted documents."
|
|
@@ -2120,7 +2138,7 @@ export interface InputZauj6Kl3W2 {
|
|
|
2120
2138
|
reviewedOn?: number;
|
|
2121
2139
|
}
|
|
2122
2140
|
/** Schema for overriding course result dates. */
|
|
2123
|
-
export interface
|
|
2141
|
+
export interface InputLi65Qt1P4Xh {
|
|
2124
2142
|
/**
|
|
2125
2143
|
* The date when the course result expires, in milliseconds since epoch.
|
|
2126
2144
|
* @example 1735689600000
|
|
@@ -2205,7 +2223,7 @@ export interface WorkHoursWrite {
|
|
|
2205
2223
|
}[];
|
|
2206
2224
|
}
|
|
2207
2225
|
/** Work hours file response */
|
|
2208
|
-
export interface
|
|
2226
|
+
export interface OutputAeut9M788A {
|
|
2209
2227
|
/**
|
|
2210
2228
|
* Signed URL for the work hours file
|
|
2211
2229
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
|
|
@@ -2213,21 +2231,21 @@ export interface OutputDfi7Lgx5Y2 {
|
|
|
2213
2231
|
fileURL: string;
|
|
2214
2232
|
}
|
|
2215
2233
|
/** Work hours file response */
|
|
2216
|
-
export interface
|
|
2234
|
+
export interface Output9Z7Wdeis4U {
|
|
2217
2235
|
/**
|
|
2218
2236
|
* Signed URL for the work hours file
|
|
2219
2237
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
|
|
2220
2238
|
*/
|
|
2221
2239
|
fileURL: string;
|
|
2222
2240
|
}
|
|
2223
|
-
export interface
|
|
2241
|
+
export interface InputFlrsmcuwsq {
|
|
2224
2242
|
filter: {
|
|
2225
2243
|
from?: number;
|
|
2226
2244
|
sortOrder?: string;
|
|
2227
2245
|
sortField?: string;
|
|
2228
2246
|
};
|
|
2229
2247
|
}
|
|
2230
|
-
export interface
|
|
2248
|
+
export interface OutputFlrsmcuwsq {
|
|
2231
2249
|
users: {
|
|
2232
2250
|
firstName: string;
|
|
2233
2251
|
lastName: string;
|
|
@@ -2251,7 +2269,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
2251
2269
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
2252
2270
|
* @example "CHECKED"
|
|
2253
2271
|
*/
|
|
2254
|
-
export declare enum
|
|
2272
|
+
export declare enum InputV7Vsxcqhz2ValueEnum {
|
|
2255
2273
|
CHECKED = "CHECKED",
|
|
2256
2274
|
UNCHECKED = "UNCHECKED",
|
|
2257
2275
|
NOVALUE = "NOVALUE"
|
|
@@ -2352,10 +2370,12 @@ export type CreateSearchUsersTermData = any;
|
|
|
2352
2370
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2353
2371
|
export type CreateReportUsersSimpleData = any;
|
|
2354
2372
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2355
|
-
export type CreateSearchUsersCountData =
|
|
2373
|
+
export type CreateSearchUsersCountData = Output4Yo1T8Mg5H;
|
|
2356
2374
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2357
2375
|
export type CreateReportStudentsPaidIncompleteCourseData = any;
|
|
2358
2376
|
export type CreateReportStudentsPaidIncompleteCourseError = ErrorResponse;
|
|
2377
|
+
export type ListReportExpiringCoursesData = any;
|
|
2378
|
+
export type ListReportExpiringCoursesError = ErrorResponse;
|
|
2359
2379
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2360
2380
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
2361
2381
|
export type DeleteCertificationApplicationItemData = any;
|
|
@@ -2378,7 +2398,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2378
2398
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2379
2399
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2380
2400
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2381
|
-
export type GetCertificationCourseFileSignData =
|
|
2401
|
+
export type GetCertificationCourseFileSignData = OutputPtlq1Xy1Xs;
|
|
2382
2402
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2383
2403
|
export interface CreateCertificationCourseFileSignParams {
|
|
2384
2404
|
/** @example "pdf" */
|
|
@@ -2392,11 +2412,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2392
2412
|
/** @example "fileID" */
|
|
2393
2413
|
fileId: string;
|
|
2394
2414
|
}
|
|
2395
|
-
export type CreateCertificationCourseFileSignData =
|
|
2415
|
+
export type CreateCertificationCourseFileSignData = OutputNq9Hgt37Jd;
|
|
2396
2416
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2397
2417
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2398
2418
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2399
|
-
export type CreateCertificationCourseDocumentData =
|
|
2419
|
+
export type CreateCertificationCourseDocumentData = OutputDwxbfmdjov;
|
|
2400
2420
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2401
2421
|
export type DeleteSponsorshipPendingApprovalData = any;
|
|
2402
2422
|
export type DeleteSponsorshipPendingApprovalError = ErrorResponse;
|
|
@@ -2412,7 +2432,7 @@ export type UpdateUserData = any;
|
|
|
2412
2432
|
export type UpdateUserError = ErrorResponse;
|
|
2413
2433
|
export type DeleteCertificationCourseData = any;
|
|
2414
2434
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2415
|
-
export type GetCertificationApplicationItemFileData =
|
|
2435
|
+
export type GetCertificationApplicationItemFileData = OutputWbamsgwk0Ni;
|
|
2416
2436
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2417
2437
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2418
2438
|
/** @example "pdf" */
|
|
@@ -2426,9 +2446,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2426
2446
|
/** @example "fileVersion" */
|
|
2427
2447
|
fileVersion: string;
|
|
2428
2448
|
}
|
|
2429
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2449
|
+
export type CreateCertificationApplicationItemFileData = OutputN5Huf9Qhuh;
|
|
2430
2450
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2431
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2451
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = Output0Vdczlumsn;
|
|
2432
2452
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2433
2453
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2434
2454
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2436,7 +2456,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2436
2456
|
export type GetCourseError = ErrorResponse;
|
|
2437
2457
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2438
2458
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2439
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2459
|
+
export type GetCertificationApplicationForeignFillData = OutputCfk1Obftos;
|
|
2440
2460
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2441
2461
|
export type GetCertificationPrintData = any;
|
|
2442
2462
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2470,7 +2490,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2470
2490
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2471
2491
|
export type CreateCertificationWaiveData = any;
|
|
2472
2492
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2473
|
-
export type CreateCertificationMoveData =
|
|
2493
|
+
export type CreateCertificationMoveData = OutputCgvlltra8Rk;
|
|
2474
2494
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2475
2495
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2476
2496
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2502,7 +2522,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2502
2522
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2503
2523
|
export type CreateCertificationCourseRedeemData = any;
|
|
2504
2524
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2505
|
-
export type CreateCertificationMoveValidateData =
|
|
2525
|
+
export type CreateCertificationMoveValidateData = OutputIyrhntucd3;
|
|
2506
2526
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2507
2527
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2508
2528
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2540,13 +2560,13 @@ export interface CreateWorkHoursFileSignParams {
|
|
|
2540
2560
|
/** @example "fileID" */
|
|
2541
2561
|
fileId: string;
|
|
2542
2562
|
}
|
|
2543
|
-
export type CreateWorkHoursFileSignData =
|
|
2563
|
+
export type CreateWorkHoursFileSignData = OutputAeut9M788A;
|
|
2544
2564
|
export type CreateWorkHoursFileSignError = ErrorResponse;
|
|
2545
2565
|
export type DeleteWorkHoursFileSignData = any;
|
|
2546
2566
|
export type DeleteWorkHoursFileSignError = ErrorResponse;
|
|
2547
|
-
export type GetWorkHoursFileSignData =
|
|
2567
|
+
export type GetWorkHoursFileSignData = Output9Z7Wdeis4U;
|
|
2548
2568
|
export type GetWorkHoursFileSignError = ErrorResponse;
|
|
2549
|
-
export type CreateCertificationResult =
|
|
2569
|
+
export type CreateCertificationResult = OutputFlrsmcuwsq;
|
|
2550
2570
|
export type CreateCertificationFail = ErrorResponse;
|
|
2551
2571
|
export type CreateCertificationPublishInfoResult = any;
|
|
2552
2572
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2593,7 +2613,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2593
2613
|
}
|
|
2594
2614
|
/**
|
|
2595
2615
|
* @title BCCSA Program API
|
|
2596
|
-
* @version 3.0.
|
|
2616
|
+
* @version 3.0.42
|
|
2597
2617
|
* @baseUrl http://localhost:8080
|
|
2598
2618
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2599
2619
|
*/
|
|
@@ -2608,7 +2628,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2608
2628
|
* @request POST:/contactUs
|
|
2609
2629
|
* @secure
|
|
2610
2630
|
*/
|
|
2611
|
-
listContactUs: (data:
|
|
2631
|
+
listContactUs: (data: InputMtdb53Vravl, params?: RequestParams) => Promise<any>;
|
|
2612
2632
|
};
|
|
2613
2633
|
customer: {
|
|
2614
2634
|
/**
|
|
@@ -2652,7 +2672,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2652
2672
|
* @request PUT:/sponsorship/approve/{paID}
|
|
2653
2673
|
* @secure
|
|
2654
2674
|
*/
|
|
2655
|
-
updateApprove: (paId: string, data:
|
|
2675
|
+
updateApprove: (paId: string, data: Input6Cq7Uvmotn, params?: RequestParams) => Promise<any>;
|
|
2656
2676
|
};
|
|
2657
2677
|
tenant: {
|
|
2658
2678
|
/**
|
|
@@ -2724,7 +2744,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2724
2744
|
* @request POST:/tenant/report/applicationExport
|
|
2725
2745
|
* @secure
|
|
2726
2746
|
*/
|
|
2727
|
-
createReportApplicationExport: (data:
|
|
2747
|
+
createReportApplicationExport: (data: InputRevneeqe9I, params?: RequestParams) => Promise<any>;
|
|
2728
2748
|
/**
|
|
2729
2749
|
* @description Export a report of applications based on the provided filters.
|
|
2730
2750
|
*
|
|
@@ -2734,7 +2754,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2734
2754
|
* @request POST:/tenant/report/applicationStatus
|
|
2735
2755
|
* @secure
|
|
2736
2756
|
*/
|
|
2737
|
-
listReportApplicationStatus: (data:
|
|
2757
|
+
listReportApplicationStatus: (data: Input7864Bcispq, params?: RequestParams) => Promise<any>;
|
|
2738
2758
|
/**
|
|
2739
2759
|
* @description Export a report of applications based on the provided filters.
|
|
2740
2760
|
*
|
|
@@ -2744,7 +2764,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2744
2764
|
* @request POST:/tenant/report/applicationsReport
|
|
2745
2765
|
* @secure
|
|
2746
2766
|
*/
|
|
2747
|
-
createReportApplicationsReport: (data:
|
|
2767
|
+
createReportApplicationsReport: (data: InputEmcahhgo6O, params?: RequestParams) => Promise<any>;
|
|
2748
2768
|
/**
|
|
2749
2769
|
* @description This route allows you to post certificates email for the tenant.
|
|
2750
2770
|
*
|
|
@@ -2754,7 +2774,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2754
2774
|
* @request POST:/tenant/certificates/email
|
|
2755
2775
|
* @secure
|
|
2756
2776
|
*/
|
|
2757
|
-
createCertificatesEmail: (data:
|
|
2777
|
+
createCertificatesEmail: (data: InputD7Rg1Jdq89J, params?: RequestParams) => Promise<any>;
|
|
2758
2778
|
/**
|
|
2759
2779
|
* @description Generate a preview of the completed certifications report.
|
|
2760
2780
|
*
|
|
@@ -2784,7 +2804,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2784
2804
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2785
2805
|
* @secure
|
|
2786
2806
|
*/
|
|
2787
|
-
createLicenseRedeem: (userId: string, data:
|
|
2807
|
+
createLicenseRedeem: (userId: string, data: InputVp5Z3Zbs61, params?: RequestParams) => Promise<any>;
|
|
2788
2808
|
/**
|
|
2789
2809
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2790
2810
|
*
|
|
@@ -2794,7 +2814,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2794
2814
|
* @request POST:/tenant/report/orglicenses/
|
|
2795
2815
|
* @secure
|
|
2796
2816
|
*/
|
|
2797
|
-
listReportOrglicenses: (data:
|
|
2817
|
+
listReportOrglicenses: (data: InputTiuryi30F3, params?: RequestParams) => Promise<any>;
|
|
2798
2818
|
/**
|
|
2799
2819
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2800
2820
|
*
|
|
@@ -2804,7 +2824,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2804
2824
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2805
2825
|
* @secure
|
|
2806
2826
|
*/
|
|
2807
|
-
createReportOrglicensesPreview: (data:
|
|
2827
|
+
createReportOrglicensesPreview: (data: InputG0Tiszrb8M, params?: RequestParams) => Promise<any>;
|
|
2808
2828
|
/**
|
|
2809
2829
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2810
2830
|
*
|
|
@@ -2844,7 +2864,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2844
2864
|
* @request POST:/tenant/report/users/advanced
|
|
2845
2865
|
* @secure
|
|
2846
2866
|
*/
|
|
2847
|
-
createReportUsersAdvanced: (data:
|
|
2867
|
+
createReportUsersAdvanced: (data: InputVz5Vg9G4Oqf, params?: RequestParams) => Promise<any>;
|
|
2848
2868
|
/**
|
|
2849
2869
|
* @description Searches for users in the tenant by their IDs.
|
|
2850
2870
|
*
|
|
@@ -2854,7 +2874,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2854
2874
|
* @request POST:/tenant/search/users/ids
|
|
2855
2875
|
* @secure
|
|
2856
2876
|
*/
|
|
2857
|
-
listSearchUsersIds: (data:
|
|
2877
|
+
listSearchUsersIds: (data: InputJbzgj95Lkq, params?: RequestParams) => Promise<any>;
|
|
2858
2878
|
/**
|
|
2859
2879
|
* @description Searches for users in the tenant by term and filters.
|
|
2860
2880
|
*
|
|
@@ -2864,7 +2884,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2864
2884
|
* @request POST:/tenant/search/users/term
|
|
2865
2885
|
* @secure
|
|
2866
2886
|
*/
|
|
2867
|
-
createSearchUsersTerm: (data:
|
|
2887
|
+
createSearchUsersTerm: (data: InputA5S63Nipmm, params?: RequestParams) => Promise<any>;
|
|
2868
2888
|
/**
|
|
2869
2889
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2870
2890
|
*
|
|
@@ -2874,7 +2894,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2874
2894
|
* @request POST:/tenant/report/users/simple
|
|
2875
2895
|
* @secure
|
|
2876
2896
|
*/
|
|
2877
|
-
createReportUsersSimple: (data:
|
|
2897
|
+
createReportUsersSimple: (data: InputC5Nduciwehk, params?: RequestParams) => Promise<any>;
|
|
2878
2898
|
/**
|
|
2879
2899
|
* @description Retrieve user by ID.
|
|
2880
2900
|
*
|
|
@@ -2884,7 +2904,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2884
2904
|
* @request POST:/tenant/search/users/count
|
|
2885
2905
|
* @secure
|
|
2886
2906
|
*/
|
|
2887
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2907
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<Output4Yo1T8Mg5H>;
|
|
2888
2908
|
/**
|
|
2889
2909
|
* @description Returns the students of the current tenant with a PENDING enrolment in any of the given courses, optionally restricted to an enrolment date range.
|
|
2890
2910
|
*
|
|
@@ -2894,7 +2914,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2894
2914
|
* @request POST:/tenant/report/studentsPaidIncompleteCourse
|
|
2895
2915
|
* @secure
|
|
2896
2916
|
*/
|
|
2897
|
-
createReportStudentsPaidIncompleteCourse: (data:
|
|
2917
|
+
createReportStudentsPaidIncompleteCourse: (data: InputHqsyyu5W0Jh, params?: RequestParams) => Promise<any>;
|
|
2918
|
+
/**
|
|
2919
|
+
* @description Returns students in the current tenant who passed one or more of the given courses (course result status PASS) and whose course expiry date falls within the next expiringInDays days from the current server time.
|
|
2920
|
+
*
|
|
2921
|
+
* @tags Reports
|
|
2922
|
+
* @name ListReportExpiringCourses
|
|
2923
|
+
* @summary Expiring passed courses report
|
|
2924
|
+
* @request POST:/tenant/report/expiringCourses
|
|
2925
|
+
* @secure
|
|
2926
|
+
*/
|
|
2927
|
+
listReportExpiringCourses: (data: InputO95Wbehky7, params?: RequestParams) => Promise<any>;
|
|
2898
2928
|
};
|
|
2899
2929
|
user: {
|
|
2900
2930
|
/**
|
|
@@ -2926,7 +2956,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2926
2956
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2927
2957
|
* @secure
|
|
2928
2958
|
*/
|
|
2929
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2959
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: Input9O4Ljrmhog, params?: RequestParams) => Promise<any>;
|
|
2930
2960
|
/**
|
|
2931
2961
|
* @description Delete a certification process application by type.
|
|
2932
2962
|
*
|
|
@@ -3016,7 +3046,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3016
3046
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
3017
3047
|
* @secure
|
|
3018
3048
|
*/
|
|
3019
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
3049
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputPtlq1Xy1Xs>;
|
|
3020
3050
|
/**
|
|
3021
3051
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
3022
3052
|
*
|
|
@@ -3026,7 +3056,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3026
3056
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
3027
3057
|
* @secure
|
|
3028
3058
|
*/
|
|
3029
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
3059
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputNq9Hgt37Jd>;
|
|
3030
3060
|
/**
|
|
3031
3061
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
3032
3062
|
*
|
|
@@ -3046,7 +3076,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3046
3076
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
3047
3077
|
* @secure
|
|
3048
3078
|
*/
|
|
3049
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
3079
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputDwxbfmdjov, params?: RequestParams) => Promise<OutputDwxbfmdjov>;
|
|
3050
3080
|
/**
|
|
3051
3081
|
* @description Deletes (cancels) a PENDING sponsorship/attestation pending-approval request for the given user. Admin only. Completed (approved/rejected) requests cannot be deleted. No notification is sent.
|
|
3052
3082
|
*
|
|
@@ -3096,7 +3126,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3096
3126
|
* @request POST:/user/{userID}
|
|
3097
3127
|
* @secure
|
|
3098
3128
|
*/
|
|
3099
|
-
createUser: (userId: string, data:
|
|
3129
|
+
createUser: (userId: string, data: Input8Pvcoifrsfj, params?: RequestParams) => Promise<any>;
|
|
3100
3130
|
/**
|
|
3101
3131
|
* @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.
|
|
3102
3132
|
*
|
|
@@ -3106,7 +3136,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3106
3136
|
* @request PUT:/user/{userID}
|
|
3107
3137
|
* @secure
|
|
3108
3138
|
*/
|
|
3109
|
-
updateUser: (userId: string, data:
|
|
3139
|
+
updateUser: (userId: string, data: InputQ2Brw4Yx6Rg, params?: RequestParams) => Promise<any>;
|
|
3110
3140
|
/**
|
|
3111
3141
|
* @description Delete course from user
|
|
3112
3142
|
*
|
|
@@ -3126,7 +3156,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3126
3156
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
3127
3157
|
* @secure
|
|
3128
3158
|
*/
|
|
3129
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
3159
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputWbamsgwk0Ni>;
|
|
3130
3160
|
/**
|
|
3131
3161
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
3132
3162
|
*
|
|
@@ -3136,7 +3166,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3136
3166
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
3137
3167
|
* @secure
|
|
3138
3168
|
*/
|
|
3139
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
3169
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputN5Huf9Qhuh>;
|
|
3140
3170
|
/**
|
|
3141
3171
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
3142
3172
|
*
|
|
@@ -3146,7 +3176,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3146
3176
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
3147
3177
|
* @secure
|
|
3148
3178
|
*/
|
|
3149
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
3179
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<Output0Vdczlumsn>;
|
|
3150
3180
|
/**
|
|
3151
3181
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
3152
3182
|
*
|
|
@@ -3186,7 +3216,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3186
3216
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
3187
3217
|
* @secure
|
|
3188
3218
|
*/
|
|
3189
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
3219
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputCfk1Obftos>;
|
|
3190
3220
|
/**
|
|
3191
3221
|
* @description This endpoint will print certificate
|
|
3192
3222
|
*
|
|
@@ -3246,7 +3276,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3246
3276
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
3247
3277
|
* @secure
|
|
3248
3278
|
*/
|
|
3249
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
3279
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputR1So32P4Q5K, params?: RequestParams) => Promise<any>;
|
|
3250
3280
|
/**
|
|
3251
3281
|
* @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.
|
|
3252
3282
|
*
|
|
@@ -3276,7 +3306,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3276
3306
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
3277
3307
|
* @secure
|
|
3278
3308
|
*/
|
|
3279
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3309
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputS7Tqlbmeknf, params?: RequestParams) => Promise<any>;
|
|
3280
3310
|
/**
|
|
3281
3311
|
* @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.
|
|
3282
3312
|
*
|
|
@@ -3286,7 +3316,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3286
3316
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
3287
3317
|
* @secure
|
|
3288
3318
|
*/
|
|
3289
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3319
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: Input006Njyqh6D, params?: RequestParams) => Promise<any>;
|
|
3290
3320
|
/**
|
|
3291
3321
|
* @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.
|
|
3292
3322
|
*
|
|
@@ -3296,7 +3326,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3296
3326
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
3297
3327
|
* @secure
|
|
3298
3328
|
*/
|
|
3299
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
3329
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputZpa0Khrucq, params?: RequestParams) => Promise<any>;
|
|
3300
3330
|
/**
|
|
3301
3331
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
3302
3332
|
*
|
|
@@ -3306,7 +3336,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3306
3336
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
3307
3337
|
* @secure
|
|
3308
3338
|
*/
|
|
3309
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
3339
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputPt95Kpvoys, params?: RequestParams) => Promise<any>;
|
|
3310
3340
|
/**
|
|
3311
3341
|
* @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.
|
|
3312
3342
|
*
|
|
@@ -3346,7 +3376,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3346
3376
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
3347
3377
|
* @secure
|
|
3348
3378
|
*/
|
|
3349
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
3379
|
+
createCertificationWaive: (userId: string, certProcId: string, data: Input12884Eu0F1, params?: RequestParams) => Promise<any>;
|
|
3350
3380
|
/**
|
|
3351
3381
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
3352
3382
|
*
|
|
@@ -3356,7 +3386,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3356
3386
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
3357
3387
|
* @secure
|
|
3358
3388
|
*/
|
|
3359
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3389
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputCgvlltra8Rk>;
|
|
3360
3390
|
/**
|
|
3361
3391
|
* @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.
|
|
3362
3392
|
*
|
|
@@ -3396,7 +3426,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3396
3426
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
3397
3427
|
* @secure
|
|
3398
3428
|
*/
|
|
3399
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
3429
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputV7Vsxcqhz2, params?: RequestParams) => Promise<any>;
|
|
3400
3430
|
/**
|
|
3401
3431
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
3402
3432
|
*
|
|
@@ -3456,7 +3486,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3456
3486
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3457
3487
|
* @secure
|
|
3458
3488
|
*/
|
|
3459
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
3489
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: InputFgf9Pnx6T6, params?: RequestParams) => Promise<any>;
|
|
3460
3490
|
/**
|
|
3461
3491
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3462
3492
|
*
|
|
@@ -3476,7 +3506,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3476
3506
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3477
3507
|
* @secure
|
|
3478
3508
|
*/
|
|
3479
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3509
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputGpznvh1Ayn, params?: RequestParams) => Promise<any>;
|
|
3480
3510
|
/**
|
|
3481
3511
|
* @description This route allows you to submit a pending approval.
|
|
3482
3512
|
*
|
|
@@ -3486,7 +3516,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3486
3516
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3487
3517
|
* @secure
|
|
3488
3518
|
*/
|
|
3489
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3519
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputQ1Npqk2Ljf, params?: RequestParams) => Promise<any>;
|
|
3490
3520
|
/**
|
|
3491
3521
|
* @description This route allows you to review a pending approval.
|
|
3492
3522
|
*
|
|
@@ -3496,7 +3526,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3496
3526
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3497
3527
|
* @secure
|
|
3498
3528
|
*/
|
|
3499
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3529
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: Input2Hig6Mp1Z6, params?: RequestParams) => Promise<any>;
|
|
3500
3530
|
/**
|
|
3501
3531
|
* @description Redeems a license for a user by product ID.
|
|
3502
3532
|
*
|
|
@@ -3506,7 +3536,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3506
3536
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3507
3537
|
* @secure
|
|
3508
3538
|
*/
|
|
3509
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3539
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: Input0K4Oe5Vt00H, params?: RequestParams) => Promise<any>;
|
|
3510
3540
|
/**
|
|
3511
3541
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3512
3542
|
*
|
|
@@ -3516,7 +3546,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3516
3546
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3517
3547
|
* @secure
|
|
3518
3548
|
*/
|
|
3519
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3549
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputIyrhntucd3>;
|
|
3520
3550
|
/**
|
|
3521
3551
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3522
3552
|
*
|
|
@@ -3526,7 +3556,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3526
3556
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3527
3557
|
* @secure
|
|
3528
3558
|
*/
|
|
3529
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3559
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputZ80Ge0Wuj6, params?: RequestParams) => Promise<any>;
|
|
3530
3560
|
/**
|
|
3531
3561
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3532
3562
|
*
|
|
@@ -3536,7 +3566,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3536
3566
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3537
3567
|
* @secure
|
|
3538
3568
|
*/
|
|
3539
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3569
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input6Imn3Yi9Zl, params?: RequestParams) => Promise<any>;
|
|
3540
3570
|
/**
|
|
3541
3571
|
* @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.
|
|
3542
3572
|
*
|
|
@@ -3546,7 +3576,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3546
3576
|
* @request POST:/user/{userID}/updateITA
|
|
3547
3577
|
* @secure
|
|
3548
3578
|
*/
|
|
3549
|
-
createUpdateIta: (userId: string, data:
|
|
3579
|
+
createUpdateIta: (userId: string, data: Input0V1Y0C4Gdm, params?: RequestParams) => Promise<any>;
|
|
3550
3580
|
/**
|
|
3551
3581
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3552
3582
|
*
|
|
@@ -3556,7 +3586,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3556
3586
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3557
3587
|
* @secure
|
|
3558
3588
|
*/
|
|
3559
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3589
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: Input3Ypm4Sg0Kz, params?: RequestParams) => Promise<any>;
|
|
3560
3590
|
/**
|
|
3561
3591
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3562
3592
|
*
|
|
@@ -3566,7 +3596,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3566
3596
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3567
3597
|
* @secure
|
|
3568
3598
|
*/
|
|
3569
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3599
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputLi65Qt1P4Xh, params?: RequestParams) => Promise<any>;
|
|
3570
3600
|
/**
|
|
3571
3601
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3572
3602
|
*
|
|
@@ -3658,7 +3688,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3658
3688
|
* @request POST:/user/{userID}/workHours/{workHoursID}/fileSign/{fileID}
|
|
3659
3689
|
* @secure
|
|
3660
3690
|
*/
|
|
3661
|
-
createWorkHoursFileSign: ({ userId, workHoursId, fileId, ...query }: CreateWorkHoursFileSignParams, params?: RequestParams) => Promise<
|
|
3691
|
+
createWorkHoursFileSign: ({ userId, workHoursId, fileId, ...query }: CreateWorkHoursFileSignParams, params?: RequestParams) => Promise<OutputAeut9M788A>;
|
|
3662
3692
|
/**
|
|
3663
3693
|
* @description Delete a work hours file for a user.
|
|
3664
3694
|
*
|
|
@@ -3678,7 +3708,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3678
3708
|
* @request GET:/user/{userID}/workHours/{workHoursID}/fileSign/{fileID}
|
|
3679
3709
|
* @secure
|
|
3680
3710
|
*/
|
|
3681
|
-
getWorkHoursFileSign: (userId: string, workHoursId: string, fileId: string, params?: RequestParams) => Promise<
|
|
3711
|
+
getWorkHoursFileSign: (userId: string, workHoursId: string, fileId: string, params?: RequestParams) => Promise<Output9Z7Wdeis4U>;
|
|
3682
3712
|
};
|
|
3683
3713
|
users: {
|
|
3684
3714
|
/**
|
|
@@ -3690,7 +3720,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3690
3720
|
* @request POST:/users/certification/{certSpecID}
|
|
3691
3721
|
* @secure
|
|
3692
3722
|
*/
|
|
3693
|
-
createCertification: (certSpecId: string, data:
|
|
3723
|
+
createCertification: (certSpecId: string, data: InputFlrsmcuwsq, params?: RequestParams) => Promise<OutputFlrsmcuwsq>;
|
|
3694
3724
|
/**
|
|
3695
3725
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3696
3726
|
*
|