@ikonintegration/bccsa-program-api 3.0.40 → 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 +191 -104
- package/dist/Api.d.ts +178 -110
- package/dist/Api.js +42 -8
- package/dist/Api.js.map +1 -1
- package/package.json +2 -2
package/dist/Api.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ export interface ErrorResponse {
|
|
|
5
5
|
/** Error code */
|
|
6
6
|
errCode: string;
|
|
7
7
|
}
|
|
8
|
-
export interface
|
|
8
|
+
export interface 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 Input7Vmuwipays {
|
|
|
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 Input2Aq4Pyagkd {
|
|
|
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 Input8Klnphf8Bc {
|
|
|
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 Input3Nox52Otw6 {
|
|
|
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 Input6Hyaakdeqh {
|
|
|
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 Input97Kt0K1U4M {
|
|
|
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 InputP41Mwrllc3J {
|
|
|
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 Input0Vk0Eax6Wa {
|
|
|
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,23 +1023,67 @@ export interface InputC8Zwd7Q8U9 {
|
|
|
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 InputHqsyyu5W0Jh {
|
|
1034
|
+
/** Report filter */
|
|
1035
|
+
filter: {
|
|
1036
|
+
/**
|
|
1037
|
+
* Course specification IDs to include (1 to 100 entries, required)
|
|
1038
|
+
* @maxItems 100
|
|
1039
|
+
* @minItems 1
|
|
1040
|
+
* @example ["course123"]
|
|
1041
|
+
*/
|
|
1042
|
+
courseID: string[];
|
|
1043
|
+
/**
|
|
1044
|
+
* Inclusive lower bound of the enrolment date (epoch milliseconds). Requires "to".
|
|
1045
|
+
* @min 0
|
|
1046
|
+
* @max 4102444800000
|
|
1047
|
+
* @example 1672531200000
|
|
1048
|
+
*/
|
|
1049
|
+
from?: number;
|
|
1050
|
+
/**
|
|
1051
|
+
* Inclusive upper bound of the enrolment date (epoch milliseconds). Requires "from".
|
|
1052
|
+
* @min 0
|
|
1053
|
+
* @max 4102444800000
|
|
1054
|
+
* @example 1672617600000
|
|
1055
|
+
*/
|
|
1056
|
+
to?: number;
|
|
1057
|
+
};
|
|
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
|
+
}
|
|
1033
1077
|
/** This endpoint accepts no request body */
|
|
1034
1078
|
export type DeletePendingApprovalBody = object;
|
|
1035
|
-
export interface
|
|
1079
|
+
export interface OutputWbamsgwk0Ni {
|
|
1036
1080
|
/**
|
|
1037
1081
|
* Signed URL for the course file
|
|
1038
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"
|
|
1039
1083
|
*/
|
|
1040
1084
|
fileURL: string;
|
|
1041
1085
|
}
|
|
1042
|
-
export interface
|
|
1086
|
+
export interface Output0Vdczlumsn {
|
|
1043
1087
|
/**
|
|
1044
1088
|
* Amount to be refunded for the cancellation
|
|
1045
1089
|
* @example 0
|
|
@@ -1339,7 +1383,7 @@ export interface CourseResponseEntity {
|
|
|
1339
1383
|
}
|
|
1340
1384
|
/** Label of the course enrolled (course version) */
|
|
1341
1385
|
export type OnlineCourseLabel = string;
|
|
1342
|
-
export interface
|
|
1386
|
+
export interface OutputPtlq1Xy1Xs {
|
|
1343
1387
|
/**
|
|
1344
1388
|
* Signed URL for the course file
|
|
1345
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"
|
|
@@ -1357,7 +1401,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1357
1401
|
transactionID?: string | null;
|
|
1358
1402
|
}
|
|
1359
1403
|
/** Application Foreign Fill response type */
|
|
1360
|
-
export interface
|
|
1404
|
+
export interface OutputCfk1Obftos {
|
|
1361
1405
|
items: {
|
|
1362
1406
|
userID: string;
|
|
1363
1407
|
createdOn?: number;
|
|
@@ -1580,7 +1624,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1580
1624
|
applicationItems?: Record<string, any>[];
|
|
1581
1625
|
transactionID?: string | null;
|
|
1582
1626
|
}
|
|
1583
|
-
export interface
|
|
1627
|
+
export interface Input9O4Ljrmhog {
|
|
1584
1628
|
issuedOn?: number;
|
|
1585
1629
|
expiresOn?: number;
|
|
1586
1630
|
fileItems?: {
|
|
@@ -1589,21 +1633,21 @@ export interface Input6Xov0Uhvug {
|
|
|
1589
1633
|
}[];
|
|
1590
1634
|
additionalNotes?: string | null;
|
|
1591
1635
|
}
|
|
1592
|
-
export interface
|
|
1636
|
+
export interface InputR1So32P4Q5K {
|
|
1593
1637
|
/**
|
|
1594
1638
|
* Indicates whether the application is locked
|
|
1595
1639
|
* @example true
|
|
1596
1640
|
*/
|
|
1597
1641
|
isApplicationLocked: boolean;
|
|
1598
1642
|
}
|
|
1599
|
-
export interface
|
|
1643
|
+
export interface OutputN5Huf9Qhuh {
|
|
1600
1644
|
/**
|
|
1601
1645
|
* Signed URL for the course file
|
|
1602
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"
|
|
1603
1647
|
*/
|
|
1604
1648
|
fileURL: string;
|
|
1605
1649
|
}
|
|
1606
|
-
export interface
|
|
1650
|
+
export interface InputS7Tqlbmeknf {
|
|
1607
1651
|
/**
|
|
1608
1652
|
* Indicates whether the waiver is approved
|
|
1609
1653
|
* @example true
|
|
@@ -1615,14 +1659,14 @@ export interface InputAkthwncsqzg {
|
|
|
1615
1659
|
*/
|
|
1616
1660
|
additionalNotes?: string | null;
|
|
1617
1661
|
}
|
|
1618
|
-
export interface
|
|
1662
|
+
export interface Input006Njyqh6D {
|
|
1619
1663
|
/**
|
|
1620
1664
|
* Optional notes regarding the waiver
|
|
1621
1665
|
* @example "Waiver granted due to special circumstances."
|
|
1622
1666
|
*/
|
|
1623
1667
|
additionalNotes?: string | null;
|
|
1624
1668
|
}
|
|
1625
|
-
export interface
|
|
1669
|
+
export interface InputZpa0Khrucq {
|
|
1626
1670
|
students: {
|
|
1627
1671
|
/**
|
|
1628
1672
|
* User ID of the student to redeem the course for
|
|
@@ -1656,7 +1700,7 @@ export interface Input5Sm698V54Kl {
|
|
|
1656
1700
|
*/
|
|
1657
1701
|
autoEnrolSessionID?: string;
|
|
1658
1702
|
}
|
|
1659
|
-
export interface
|
|
1703
|
+
export interface InputPt95Kpvoys {
|
|
1660
1704
|
invites: {
|
|
1661
1705
|
/**
|
|
1662
1706
|
* Email address of the user to invite
|
|
@@ -1685,7 +1729,7 @@ export interface Input00Cup216Sw {
|
|
|
1685
1729
|
*/
|
|
1686
1730
|
isReservedSeat: boolean;
|
|
1687
1731
|
}
|
|
1688
|
-
export interface
|
|
1732
|
+
export interface Input12884Eu0F1 {
|
|
1689
1733
|
/**
|
|
1690
1734
|
* Indicates whether to waive the certification process
|
|
1691
1735
|
* @example true
|
|
@@ -1698,7 +1742,7 @@ export interface InputRiihigs1Zdi {
|
|
|
1698
1742
|
comments?: string | null;
|
|
1699
1743
|
}
|
|
1700
1744
|
/** Certification move response schema */
|
|
1701
|
-
export interface
|
|
1745
|
+
export interface OutputCgvlltra8Rk {
|
|
1702
1746
|
errors?: {
|
|
1703
1747
|
status: string;
|
|
1704
1748
|
object?: Record<string, any>;
|
|
@@ -1706,19 +1750,19 @@ export interface OutputRt315Aaaee {
|
|
|
1706
1750
|
}[];
|
|
1707
1751
|
}
|
|
1708
1752
|
/** Schema for writing a certification trigger check. */
|
|
1709
|
-
export interface
|
|
1753
|
+
export interface InputV7Vsxcqhz2 {
|
|
1710
1754
|
/**
|
|
1711
1755
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1712
1756
|
* @example "CHECKED"
|
|
1713
1757
|
*/
|
|
1714
|
-
value:
|
|
1758
|
+
value: InputV7Vsxcqhz2ValueEnum;
|
|
1715
1759
|
/**
|
|
1716
1760
|
* List of course IDs that are blocked by this trigger check.
|
|
1717
1761
|
* @example ["course1","course2"]
|
|
1718
1762
|
*/
|
|
1719
1763
|
blockedCourses?: string[];
|
|
1720
1764
|
}
|
|
1721
|
-
export interface
|
|
1765
|
+
export interface InputFgf9Pnx6T6 {
|
|
1722
1766
|
/**
|
|
1723
1767
|
* Indicates whether the application item is approved
|
|
1724
1768
|
* @example true
|
|
@@ -1744,7 +1788,7 @@ export interface InputCc03755Grj {
|
|
|
1744
1788
|
export interface StudentHistoryRequestSchema {
|
|
1745
1789
|
requirements: string[];
|
|
1746
1790
|
}
|
|
1747
|
-
export interface
|
|
1791
|
+
export interface InputGpznvh1Ayn {
|
|
1748
1792
|
/**
|
|
1749
1793
|
* Optional activation key for the application
|
|
1750
1794
|
* @example "AK-123456"
|
|
@@ -1752,7 +1796,7 @@ export interface InputQr67F4X9Qz {
|
|
|
1752
1796
|
activationKey?: string;
|
|
1753
1797
|
}
|
|
1754
1798
|
/** Schema for course submission item details post request. */
|
|
1755
|
-
export interface
|
|
1799
|
+
export interface InputDwxbfmdjov {
|
|
1756
1800
|
/**
|
|
1757
1801
|
* The ID of the file being submitted.
|
|
1758
1802
|
* @example "fileID123"
|
|
@@ -1765,7 +1809,7 @@ export interface Input1Gepy2Er06 {
|
|
|
1765
1809
|
fileName: string;
|
|
1766
1810
|
}
|
|
1767
1811
|
/** Schema for the response to course submission item details post request. */
|
|
1768
|
-
export interface
|
|
1812
|
+
export interface OutputDwxbfmdjov {
|
|
1769
1813
|
submissionItems: {
|
|
1770
1814
|
/**
|
|
1771
1815
|
* The ID of the file being submitted.
|
|
@@ -1780,7 +1824,7 @@ export interface Output1Gepy2Er06 {
|
|
|
1780
1824
|
}[];
|
|
1781
1825
|
}
|
|
1782
1826
|
/** Pending approval submission parameters */
|
|
1783
|
-
export interface
|
|
1827
|
+
export interface InputQ1Npqk2Ljf {
|
|
1784
1828
|
/**
|
|
1785
1829
|
* Type of pending approval
|
|
1786
1830
|
* @example "certification"
|
|
@@ -1800,7 +1844,7 @@ export interface Input2Ypeat3Q15H {
|
|
|
1800
1844
|
fileName: string;
|
|
1801
1845
|
}[];
|
|
1802
1846
|
}
|
|
1803
|
-
export interface
|
|
1847
|
+
export interface Input0K4Oe5Vt00H {
|
|
1804
1848
|
/**
|
|
1805
1849
|
* The ID of the course for which the license is being redeemed
|
|
1806
1850
|
* @example "courseID123"
|
|
@@ -1868,7 +1912,7 @@ export interface Input250S74Bjft {
|
|
|
1868
1912
|
acknowledgement?: string | null;
|
|
1869
1913
|
}
|
|
1870
1914
|
/** Validate certification move response schema */
|
|
1871
|
-
export interface
|
|
1915
|
+
export interface OutputIyrhntucd3 {
|
|
1872
1916
|
courses: {
|
|
1873
1917
|
name: string;
|
|
1874
1918
|
status: string;
|
|
@@ -1879,21 +1923,21 @@ export interface OutputApyuuj0P1 {
|
|
|
1879
1923
|
validated: boolean;
|
|
1880
1924
|
mustCreateCP: boolean;
|
|
1881
1925
|
}
|
|
1882
|
-
export interface
|
|
1926
|
+
export interface InputZ80Ge0Wuj6 {
|
|
1883
1927
|
/**
|
|
1884
1928
|
* Comments regarding the end of the cooldown period
|
|
1885
1929
|
* @example "Cooldown period ended successfully."
|
|
1886
1930
|
*/
|
|
1887
1931
|
comments: string;
|
|
1888
1932
|
}
|
|
1889
|
-
export interface
|
|
1933
|
+
export interface OutputNq9Hgt37Jd {
|
|
1890
1934
|
/**
|
|
1891
1935
|
* Signed URL for the course file
|
|
1892
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"
|
|
1893
1937
|
*/
|
|
1894
1938
|
fileURL: string;
|
|
1895
1939
|
}
|
|
1896
|
-
export interface
|
|
1940
|
+
export interface Input8Pvcoifrsfj {
|
|
1897
1941
|
/** @example true */
|
|
1898
1942
|
agreedWithCertTerms: boolean;
|
|
1899
1943
|
/** @example 1717230000000 */
|
|
@@ -1978,21 +2022,21 @@ export interface Sponsor {
|
|
|
1978
2022
|
/** Title of the sponsor of the student in the tenant */
|
|
1979
2023
|
title?: Title;
|
|
1980
2024
|
}
|
|
1981
|
-
export interface
|
|
2025
|
+
export interface Input6Imn3Yi9Zl {
|
|
1982
2026
|
/**
|
|
1983
2027
|
* Comments regarding the course unlock action
|
|
1984
2028
|
* @example "Course unlocked successfully."
|
|
1985
2029
|
*/
|
|
1986
2030
|
comments: string;
|
|
1987
2031
|
}
|
|
1988
|
-
export interface
|
|
2032
|
+
export interface Input0V1Y0C4Gdm {
|
|
1989
2033
|
/**
|
|
1990
2034
|
* ITA number to update for the user
|
|
1991
2035
|
* @example "ITA123456"
|
|
1992
2036
|
*/
|
|
1993
2037
|
itaNumber: string;
|
|
1994
2038
|
}
|
|
1995
|
-
export interface
|
|
2039
|
+
export interface InputQ2Brw4Yx6Rg {
|
|
1996
2040
|
/** @example true */
|
|
1997
2041
|
agreedWithCertTerms: boolean;
|
|
1998
2042
|
/** @example 1717230000000 */
|
|
@@ -2066,7 +2110,7 @@ export interface Input5Num6Uwu17K {
|
|
|
2066
2110
|
/** Sponsor information for a student in the tenant */
|
|
2067
2111
|
sponsor?: Sponsor;
|
|
2068
2112
|
}
|
|
2069
|
-
export interface
|
|
2113
|
+
export interface Input3Ypm4Sg0Kz {
|
|
2070
2114
|
/**
|
|
2071
2115
|
* The grade to override the course result with
|
|
2072
2116
|
* @example "A"
|
|
@@ -2074,7 +2118,7 @@ export interface InputV0Qo4M776D {
|
|
|
2074
2118
|
resultGrade: string;
|
|
2075
2119
|
}
|
|
2076
2120
|
/** Pending approval review parameters */
|
|
2077
|
-
export interface
|
|
2121
|
+
export interface Input2Hig6Mp1Z6 {
|
|
2078
2122
|
/**
|
|
2079
2123
|
* Notes provided by the reviewer for the pending approval
|
|
2080
2124
|
* @example "Please review the submitted documents."
|
|
@@ -2094,7 +2138,7 @@ export interface InputGzpcnkmsxo {
|
|
|
2094
2138
|
reviewedOn?: number;
|
|
2095
2139
|
}
|
|
2096
2140
|
/** Schema for overriding course result dates. */
|
|
2097
|
-
export interface
|
|
2141
|
+
export interface InputLi65Qt1P4Xh {
|
|
2098
2142
|
/**
|
|
2099
2143
|
* The date when the course result expires, in milliseconds since epoch.
|
|
2100
2144
|
* @example 1735689600000
|
|
@@ -2179,7 +2223,7 @@ export interface WorkHoursWrite {
|
|
|
2179
2223
|
}[];
|
|
2180
2224
|
}
|
|
2181
2225
|
/** Work hours file response */
|
|
2182
|
-
export interface
|
|
2226
|
+
export interface OutputAeut9M788A {
|
|
2183
2227
|
/**
|
|
2184
2228
|
* Signed URL for the work hours file
|
|
2185
2229
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
|
|
@@ -2187,21 +2231,21 @@ export interface OutputEhwsfr213Q {
|
|
|
2187
2231
|
fileURL: string;
|
|
2188
2232
|
}
|
|
2189
2233
|
/** Work hours file response */
|
|
2190
|
-
export interface
|
|
2234
|
+
export interface Output9Z7Wdeis4U {
|
|
2191
2235
|
/**
|
|
2192
2236
|
* Signed URL for the work hours file
|
|
2193
2237
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
|
|
2194
2238
|
*/
|
|
2195
2239
|
fileURL: string;
|
|
2196
2240
|
}
|
|
2197
|
-
export interface
|
|
2241
|
+
export interface InputFlrsmcuwsq {
|
|
2198
2242
|
filter: {
|
|
2199
2243
|
from?: number;
|
|
2200
2244
|
sortOrder?: string;
|
|
2201
2245
|
sortField?: string;
|
|
2202
2246
|
};
|
|
2203
2247
|
}
|
|
2204
|
-
export interface
|
|
2248
|
+
export interface OutputFlrsmcuwsq {
|
|
2205
2249
|
users: {
|
|
2206
2250
|
firstName: string;
|
|
2207
2251
|
lastName: string;
|
|
@@ -2225,7 +2269,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
2225
2269
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
2226
2270
|
* @example "CHECKED"
|
|
2227
2271
|
*/
|
|
2228
|
-
export declare enum
|
|
2272
|
+
export declare enum InputV7Vsxcqhz2ValueEnum {
|
|
2229
2273
|
CHECKED = "CHECKED",
|
|
2230
2274
|
UNCHECKED = "UNCHECKED",
|
|
2231
2275
|
NOVALUE = "NOVALUE"
|
|
@@ -2326,8 +2370,12 @@ export type CreateSearchUsersTermData = any;
|
|
|
2326
2370
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2327
2371
|
export type CreateReportUsersSimpleData = any;
|
|
2328
2372
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2329
|
-
export type CreateSearchUsersCountData =
|
|
2373
|
+
export type CreateSearchUsersCountData = Output4Yo1T8Mg5H;
|
|
2330
2374
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2375
|
+
export type CreateReportStudentsPaidIncompleteCourseData = any;
|
|
2376
|
+
export type CreateReportStudentsPaidIncompleteCourseError = ErrorResponse;
|
|
2377
|
+
export type ListReportExpiringCoursesData = any;
|
|
2378
|
+
export type ListReportExpiringCoursesError = ErrorResponse;
|
|
2331
2379
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2332
2380
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
2333
2381
|
export type DeleteCertificationApplicationItemData = any;
|
|
@@ -2350,7 +2398,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2350
2398
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2351
2399
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2352
2400
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2353
|
-
export type GetCertificationCourseFileSignData =
|
|
2401
|
+
export type GetCertificationCourseFileSignData = OutputPtlq1Xy1Xs;
|
|
2354
2402
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2355
2403
|
export interface CreateCertificationCourseFileSignParams {
|
|
2356
2404
|
/** @example "pdf" */
|
|
@@ -2364,11 +2412,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2364
2412
|
/** @example "fileID" */
|
|
2365
2413
|
fileId: string;
|
|
2366
2414
|
}
|
|
2367
|
-
export type CreateCertificationCourseFileSignData =
|
|
2415
|
+
export type CreateCertificationCourseFileSignData = OutputNq9Hgt37Jd;
|
|
2368
2416
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2369
2417
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2370
2418
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2371
|
-
export type CreateCertificationCourseDocumentData =
|
|
2419
|
+
export type CreateCertificationCourseDocumentData = OutputDwxbfmdjov;
|
|
2372
2420
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2373
2421
|
export type DeleteSponsorshipPendingApprovalData = any;
|
|
2374
2422
|
export type DeleteSponsorshipPendingApprovalError = ErrorResponse;
|
|
@@ -2384,7 +2432,7 @@ export type UpdateUserData = any;
|
|
|
2384
2432
|
export type UpdateUserError = ErrorResponse;
|
|
2385
2433
|
export type DeleteCertificationCourseData = any;
|
|
2386
2434
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2387
|
-
export type GetCertificationApplicationItemFileData =
|
|
2435
|
+
export type GetCertificationApplicationItemFileData = OutputWbamsgwk0Ni;
|
|
2388
2436
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2389
2437
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2390
2438
|
/** @example "pdf" */
|
|
@@ -2398,9 +2446,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2398
2446
|
/** @example "fileVersion" */
|
|
2399
2447
|
fileVersion: string;
|
|
2400
2448
|
}
|
|
2401
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2449
|
+
export type CreateCertificationApplicationItemFileData = OutputN5Huf9Qhuh;
|
|
2402
2450
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2403
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2451
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = Output0Vdczlumsn;
|
|
2404
2452
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2405
2453
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2406
2454
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2408,7 +2456,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2408
2456
|
export type GetCourseError = ErrorResponse;
|
|
2409
2457
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2410
2458
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2411
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2459
|
+
export type GetCertificationApplicationForeignFillData = OutputCfk1Obftos;
|
|
2412
2460
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2413
2461
|
export type GetCertificationPrintData = any;
|
|
2414
2462
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2442,7 +2490,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2442
2490
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2443
2491
|
export type CreateCertificationWaiveData = any;
|
|
2444
2492
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2445
|
-
export type CreateCertificationMoveData =
|
|
2493
|
+
export type CreateCertificationMoveData = OutputCgvlltra8Rk;
|
|
2446
2494
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2447
2495
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2448
2496
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2474,7 +2522,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2474
2522
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2475
2523
|
export type CreateCertificationCourseRedeemData = any;
|
|
2476
2524
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2477
|
-
export type CreateCertificationMoveValidateData =
|
|
2525
|
+
export type CreateCertificationMoveValidateData = OutputIyrhntucd3;
|
|
2478
2526
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2479
2527
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2480
2528
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2512,13 +2560,13 @@ export interface CreateWorkHoursFileSignParams {
|
|
|
2512
2560
|
/** @example "fileID" */
|
|
2513
2561
|
fileId: string;
|
|
2514
2562
|
}
|
|
2515
|
-
export type CreateWorkHoursFileSignData =
|
|
2563
|
+
export type CreateWorkHoursFileSignData = OutputAeut9M788A;
|
|
2516
2564
|
export type CreateWorkHoursFileSignError = ErrorResponse;
|
|
2517
2565
|
export type DeleteWorkHoursFileSignData = any;
|
|
2518
2566
|
export type DeleteWorkHoursFileSignError = ErrorResponse;
|
|
2519
|
-
export type GetWorkHoursFileSignData =
|
|
2567
|
+
export type GetWorkHoursFileSignData = Output9Z7Wdeis4U;
|
|
2520
2568
|
export type GetWorkHoursFileSignError = ErrorResponse;
|
|
2521
|
-
export type CreateCertificationResult =
|
|
2569
|
+
export type CreateCertificationResult = OutputFlrsmcuwsq;
|
|
2522
2570
|
export type CreateCertificationFail = ErrorResponse;
|
|
2523
2571
|
export type CreateCertificationPublishInfoResult = any;
|
|
2524
2572
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2565,7 +2613,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2565
2613
|
}
|
|
2566
2614
|
/**
|
|
2567
2615
|
* @title BCCSA Program API
|
|
2568
|
-
* @version 3.0.
|
|
2616
|
+
* @version 3.0.42
|
|
2569
2617
|
* @baseUrl http://localhost:8080
|
|
2570
2618
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2571
2619
|
*/
|
|
@@ -2580,7 +2628,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2580
2628
|
* @request POST:/contactUs
|
|
2581
2629
|
* @secure
|
|
2582
2630
|
*/
|
|
2583
|
-
listContactUs: (data:
|
|
2631
|
+
listContactUs: (data: InputMtdb53Vravl, params?: RequestParams) => Promise<any>;
|
|
2584
2632
|
};
|
|
2585
2633
|
customer: {
|
|
2586
2634
|
/**
|
|
@@ -2624,7 +2672,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2624
2672
|
* @request PUT:/sponsorship/approve/{paID}
|
|
2625
2673
|
* @secure
|
|
2626
2674
|
*/
|
|
2627
|
-
updateApprove: (paId: string, data:
|
|
2675
|
+
updateApprove: (paId: string, data: Input6Cq7Uvmotn, params?: RequestParams) => Promise<any>;
|
|
2628
2676
|
};
|
|
2629
2677
|
tenant: {
|
|
2630
2678
|
/**
|
|
@@ -2696,7 +2744,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2696
2744
|
* @request POST:/tenant/report/applicationExport
|
|
2697
2745
|
* @secure
|
|
2698
2746
|
*/
|
|
2699
|
-
createReportApplicationExport: (data:
|
|
2747
|
+
createReportApplicationExport: (data: InputRevneeqe9I, params?: RequestParams) => Promise<any>;
|
|
2700
2748
|
/**
|
|
2701
2749
|
* @description Export a report of applications based on the provided filters.
|
|
2702
2750
|
*
|
|
@@ -2706,7 +2754,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2706
2754
|
* @request POST:/tenant/report/applicationStatus
|
|
2707
2755
|
* @secure
|
|
2708
2756
|
*/
|
|
2709
|
-
listReportApplicationStatus: (data:
|
|
2757
|
+
listReportApplicationStatus: (data: Input7864Bcispq, params?: RequestParams) => Promise<any>;
|
|
2710
2758
|
/**
|
|
2711
2759
|
* @description Export a report of applications based on the provided filters.
|
|
2712
2760
|
*
|
|
@@ -2716,7 +2764,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2716
2764
|
* @request POST:/tenant/report/applicationsReport
|
|
2717
2765
|
* @secure
|
|
2718
2766
|
*/
|
|
2719
|
-
createReportApplicationsReport: (data:
|
|
2767
|
+
createReportApplicationsReport: (data: InputEmcahhgo6O, params?: RequestParams) => Promise<any>;
|
|
2720
2768
|
/**
|
|
2721
2769
|
* @description This route allows you to post certificates email for the tenant.
|
|
2722
2770
|
*
|
|
@@ -2726,7 +2774,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2726
2774
|
* @request POST:/tenant/certificates/email
|
|
2727
2775
|
* @secure
|
|
2728
2776
|
*/
|
|
2729
|
-
createCertificatesEmail: (data:
|
|
2777
|
+
createCertificatesEmail: (data: InputD7Rg1Jdq89J, params?: RequestParams) => Promise<any>;
|
|
2730
2778
|
/**
|
|
2731
2779
|
* @description Generate a preview of the completed certifications report.
|
|
2732
2780
|
*
|
|
@@ -2756,7 +2804,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2756
2804
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2757
2805
|
* @secure
|
|
2758
2806
|
*/
|
|
2759
|
-
createLicenseRedeem: (userId: string, data:
|
|
2807
|
+
createLicenseRedeem: (userId: string, data: InputVp5Z3Zbs61, params?: RequestParams) => Promise<any>;
|
|
2760
2808
|
/**
|
|
2761
2809
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2762
2810
|
*
|
|
@@ -2766,7 +2814,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2766
2814
|
* @request POST:/tenant/report/orglicenses/
|
|
2767
2815
|
* @secure
|
|
2768
2816
|
*/
|
|
2769
|
-
listReportOrglicenses: (data:
|
|
2817
|
+
listReportOrglicenses: (data: InputTiuryi30F3, params?: RequestParams) => Promise<any>;
|
|
2770
2818
|
/**
|
|
2771
2819
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2772
2820
|
*
|
|
@@ -2776,7 +2824,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2776
2824
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2777
2825
|
* @secure
|
|
2778
2826
|
*/
|
|
2779
|
-
createReportOrglicensesPreview: (data:
|
|
2827
|
+
createReportOrglicensesPreview: (data: InputG0Tiszrb8M, params?: RequestParams) => Promise<any>;
|
|
2780
2828
|
/**
|
|
2781
2829
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2782
2830
|
*
|
|
@@ -2816,7 +2864,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2816
2864
|
* @request POST:/tenant/report/users/advanced
|
|
2817
2865
|
* @secure
|
|
2818
2866
|
*/
|
|
2819
|
-
createReportUsersAdvanced: (data:
|
|
2867
|
+
createReportUsersAdvanced: (data: InputVz5Vg9G4Oqf, params?: RequestParams) => Promise<any>;
|
|
2820
2868
|
/**
|
|
2821
2869
|
* @description Searches for users in the tenant by their IDs.
|
|
2822
2870
|
*
|
|
@@ -2826,7 +2874,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2826
2874
|
* @request POST:/tenant/search/users/ids
|
|
2827
2875
|
* @secure
|
|
2828
2876
|
*/
|
|
2829
|
-
listSearchUsersIds: (data:
|
|
2877
|
+
listSearchUsersIds: (data: InputJbzgj95Lkq, params?: RequestParams) => Promise<any>;
|
|
2830
2878
|
/**
|
|
2831
2879
|
* @description Searches for users in the tenant by term and filters.
|
|
2832
2880
|
*
|
|
@@ -2836,7 +2884,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2836
2884
|
* @request POST:/tenant/search/users/term
|
|
2837
2885
|
* @secure
|
|
2838
2886
|
*/
|
|
2839
|
-
createSearchUsersTerm: (data:
|
|
2887
|
+
createSearchUsersTerm: (data: InputA5S63Nipmm, params?: RequestParams) => Promise<any>;
|
|
2840
2888
|
/**
|
|
2841
2889
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2842
2890
|
*
|
|
@@ -2846,7 +2894,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2846
2894
|
* @request POST:/tenant/report/users/simple
|
|
2847
2895
|
* @secure
|
|
2848
2896
|
*/
|
|
2849
|
-
createReportUsersSimple: (data:
|
|
2897
|
+
createReportUsersSimple: (data: InputC5Nduciwehk, params?: RequestParams) => Promise<any>;
|
|
2850
2898
|
/**
|
|
2851
2899
|
* @description Retrieve user by ID.
|
|
2852
2900
|
*
|
|
@@ -2856,7 +2904,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2856
2904
|
* @request POST:/tenant/search/users/count
|
|
2857
2905
|
* @secure
|
|
2858
2906
|
*/
|
|
2859
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2907
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<Output4Yo1T8Mg5H>;
|
|
2908
|
+
/**
|
|
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.
|
|
2910
|
+
*
|
|
2911
|
+
* @tags Reports
|
|
2912
|
+
* @name CreateReportStudentsPaidIncompleteCourse
|
|
2913
|
+
* @summary Students who paid for a course but have not completed it
|
|
2914
|
+
* @request POST:/tenant/report/studentsPaidIncompleteCourse
|
|
2915
|
+
* @secure
|
|
2916
|
+
*/
|
|
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>;
|
|
2860
2928
|
};
|
|
2861
2929
|
user: {
|
|
2862
2930
|
/**
|
|
@@ -2888,7 +2956,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2888
2956
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2889
2957
|
* @secure
|
|
2890
2958
|
*/
|
|
2891
|
-
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>;
|
|
2892
2960
|
/**
|
|
2893
2961
|
* @description Delete a certification process application by type.
|
|
2894
2962
|
*
|
|
@@ -2978,7 +3046,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2978
3046
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2979
3047
|
* @secure
|
|
2980
3048
|
*/
|
|
2981
|
-
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>;
|
|
2982
3050
|
/**
|
|
2983
3051
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2984
3052
|
*
|
|
@@ -2988,7 +3056,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2988
3056
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2989
3057
|
* @secure
|
|
2990
3058
|
*/
|
|
2991
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
3059
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputNq9Hgt37Jd>;
|
|
2992
3060
|
/**
|
|
2993
3061
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2994
3062
|
*
|
|
@@ -3008,7 +3076,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3008
3076
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
3009
3077
|
* @secure
|
|
3010
3078
|
*/
|
|
3011
|
-
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>;
|
|
3012
3080
|
/**
|
|
3013
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.
|
|
3014
3082
|
*
|
|
@@ -3058,7 +3126,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3058
3126
|
* @request POST:/user/{userID}
|
|
3059
3127
|
* @secure
|
|
3060
3128
|
*/
|
|
3061
|
-
createUser: (userId: string, data:
|
|
3129
|
+
createUser: (userId: string, data: Input8Pvcoifrsfj, params?: RequestParams) => Promise<any>;
|
|
3062
3130
|
/**
|
|
3063
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.
|
|
3064
3132
|
*
|
|
@@ -3068,7 +3136,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3068
3136
|
* @request PUT:/user/{userID}
|
|
3069
3137
|
* @secure
|
|
3070
3138
|
*/
|
|
3071
|
-
updateUser: (userId: string, data:
|
|
3139
|
+
updateUser: (userId: string, data: InputQ2Brw4Yx6Rg, params?: RequestParams) => Promise<any>;
|
|
3072
3140
|
/**
|
|
3073
3141
|
* @description Delete course from user
|
|
3074
3142
|
*
|
|
@@ -3088,7 +3156,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3088
3156
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
3089
3157
|
* @secure
|
|
3090
3158
|
*/
|
|
3091
|
-
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>;
|
|
3092
3160
|
/**
|
|
3093
3161
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
3094
3162
|
*
|
|
@@ -3098,7 +3166,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3098
3166
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
3099
3167
|
* @secure
|
|
3100
3168
|
*/
|
|
3101
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
3169
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputN5Huf9Qhuh>;
|
|
3102
3170
|
/**
|
|
3103
3171
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
3104
3172
|
*
|
|
@@ -3108,7 +3176,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3108
3176
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
3109
3177
|
* @secure
|
|
3110
3178
|
*/
|
|
3111
|
-
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>;
|
|
3112
3180
|
/**
|
|
3113
3181
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
3114
3182
|
*
|
|
@@ -3148,7 +3216,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3148
3216
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
3149
3217
|
* @secure
|
|
3150
3218
|
*/
|
|
3151
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
3219
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputCfk1Obftos>;
|
|
3152
3220
|
/**
|
|
3153
3221
|
* @description This endpoint will print certificate
|
|
3154
3222
|
*
|
|
@@ -3208,7 +3276,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3208
3276
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
3209
3277
|
* @secure
|
|
3210
3278
|
*/
|
|
3211
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
3279
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputR1So32P4Q5K, params?: RequestParams) => Promise<any>;
|
|
3212
3280
|
/**
|
|
3213
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.
|
|
3214
3282
|
*
|
|
@@ -3238,7 +3306,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3238
3306
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
3239
3307
|
* @secure
|
|
3240
3308
|
*/
|
|
3241
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3309
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputS7Tqlbmeknf, params?: RequestParams) => Promise<any>;
|
|
3242
3310
|
/**
|
|
3243
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.
|
|
3244
3312
|
*
|
|
@@ -3248,7 +3316,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3248
3316
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
3249
3317
|
* @secure
|
|
3250
3318
|
*/
|
|
3251
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3319
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: Input006Njyqh6D, params?: RequestParams) => Promise<any>;
|
|
3252
3320
|
/**
|
|
3253
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.
|
|
3254
3322
|
*
|
|
@@ -3258,7 +3326,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3258
3326
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
3259
3327
|
* @secure
|
|
3260
3328
|
*/
|
|
3261
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
3329
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputZpa0Khrucq, params?: RequestParams) => Promise<any>;
|
|
3262
3330
|
/**
|
|
3263
3331
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
3264
3332
|
*
|
|
@@ -3268,7 +3336,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3268
3336
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
3269
3337
|
* @secure
|
|
3270
3338
|
*/
|
|
3271
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
3339
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputPt95Kpvoys, params?: RequestParams) => Promise<any>;
|
|
3272
3340
|
/**
|
|
3273
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.
|
|
3274
3342
|
*
|
|
@@ -3308,7 +3376,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3308
3376
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
3309
3377
|
* @secure
|
|
3310
3378
|
*/
|
|
3311
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
3379
|
+
createCertificationWaive: (userId: string, certProcId: string, data: Input12884Eu0F1, params?: RequestParams) => Promise<any>;
|
|
3312
3380
|
/**
|
|
3313
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.
|
|
3314
3382
|
*
|
|
@@ -3318,7 +3386,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3318
3386
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
3319
3387
|
* @secure
|
|
3320
3388
|
*/
|
|
3321
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3389
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputCgvlltra8Rk>;
|
|
3322
3390
|
/**
|
|
3323
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.
|
|
3324
3392
|
*
|
|
@@ -3358,7 +3426,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3358
3426
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
3359
3427
|
* @secure
|
|
3360
3428
|
*/
|
|
3361
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
3429
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputV7Vsxcqhz2, params?: RequestParams) => Promise<any>;
|
|
3362
3430
|
/**
|
|
3363
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.
|
|
3364
3432
|
*
|
|
@@ -3418,7 +3486,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3418
3486
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3419
3487
|
* @secure
|
|
3420
3488
|
*/
|
|
3421
|
-
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>;
|
|
3422
3490
|
/**
|
|
3423
3491
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3424
3492
|
*
|
|
@@ -3438,7 +3506,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3438
3506
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3439
3507
|
* @secure
|
|
3440
3508
|
*/
|
|
3441
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3509
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputGpznvh1Ayn, params?: RequestParams) => Promise<any>;
|
|
3442
3510
|
/**
|
|
3443
3511
|
* @description This route allows you to submit a pending approval.
|
|
3444
3512
|
*
|
|
@@ -3448,7 +3516,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3448
3516
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3449
3517
|
* @secure
|
|
3450
3518
|
*/
|
|
3451
|
-
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>;
|
|
3452
3520
|
/**
|
|
3453
3521
|
* @description This route allows you to review a pending approval.
|
|
3454
3522
|
*
|
|
@@ -3458,7 +3526,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3458
3526
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3459
3527
|
* @secure
|
|
3460
3528
|
*/
|
|
3461
|
-
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>;
|
|
3462
3530
|
/**
|
|
3463
3531
|
* @description Redeems a license for a user by product ID.
|
|
3464
3532
|
*
|
|
@@ -3468,7 +3536,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3468
3536
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3469
3537
|
* @secure
|
|
3470
3538
|
*/
|
|
3471
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3539
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: Input0K4Oe5Vt00H, params?: RequestParams) => Promise<any>;
|
|
3472
3540
|
/**
|
|
3473
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.
|
|
3474
3542
|
*
|
|
@@ -3478,7 +3546,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3478
3546
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3479
3547
|
* @secure
|
|
3480
3548
|
*/
|
|
3481
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3549
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputIyrhntucd3>;
|
|
3482
3550
|
/**
|
|
3483
3551
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3484
3552
|
*
|
|
@@ -3488,7 +3556,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3488
3556
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3489
3557
|
* @secure
|
|
3490
3558
|
*/
|
|
3491
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3559
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputZ80Ge0Wuj6, params?: RequestParams) => Promise<any>;
|
|
3492
3560
|
/**
|
|
3493
3561
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3494
3562
|
*
|
|
@@ -3498,7 +3566,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3498
3566
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3499
3567
|
* @secure
|
|
3500
3568
|
*/
|
|
3501
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3569
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input6Imn3Yi9Zl, params?: RequestParams) => Promise<any>;
|
|
3502
3570
|
/**
|
|
3503
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.
|
|
3504
3572
|
*
|
|
@@ -3508,7 +3576,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3508
3576
|
* @request POST:/user/{userID}/updateITA
|
|
3509
3577
|
* @secure
|
|
3510
3578
|
*/
|
|
3511
|
-
createUpdateIta: (userId: string, data:
|
|
3579
|
+
createUpdateIta: (userId: string, data: Input0V1Y0C4Gdm, params?: RequestParams) => Promise<any>;
|
|
3512
3580
|
/**
|
|
3513
3581
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3514
3582
|
*
|
|
@@ -3518,7 +3586,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3518
3586
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3519
3587
|
* @secure
|
|
3520
3588
|
*/
|
|
3521
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3589
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: Input3Ypm4Sg0Kz, params?: RequestParams) => Promise<any>;
|
|
3522
3590
|
/**
|
|
3523
3591
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3524
3592
|
*
|
|
@@ -3528,7 +3596,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3528
3596
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3529
3597
|
* @secure
|
|
3530
3598
|
*/
|
|
3531
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3599
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputLi65Qt1P4Xh, params?: RequestParams) => Promise<any>;
|
|
3532
3600
|
/**
|
|
3533
3601
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3534
3602
|
*
|
|
@@ -3620,7 +3688,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3620
3688
|
* @request POST:/user/{userID}/workHours/{workHoursID}/fileSign/{fileID}
|
|
3621
3689
|
* @secure
|
|
3622
3690
|
*/
|
|
3623
|
-
createWorkHoursFileSign: ({ userId, workHoursId, fileId, ...query }: CreateWorkHoursFileSignParams, params?: RequestParams) => Promise<
|
|
3691
|
+
createWorkHoursFileSign: ({ userId, workHoursId, fileId, ...query }: CreateWorkHoursFileSignParams, params?: RequestParams) => Promise<OutputAeut9M788A>;
|
|
3624
3692
|
/**
|
|
3625
3693
|
* @description Delete a work hours file for a user.
|
|
3626
3694
|
*
|
|
@@ -3640,7 +3708,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3640
3708
|
* @request GET:/user/{userID}/workHours/{workHoursID}/fileSign/{fileID}
|
|
3641
3709
|
* @secure
|
|
3642
3710
|
*/
|
|
3643
|
-
getWorkHoursFileSign: (userId: string, workHoursId: string, fileId: string, params?: RequestParams) => Promise<
|
|
3711
|
+
getWorkHoursFileSign: (userId: string, workHoursId: string, fileId: string, params?: RequestParams) => Promise<Output9Z7Wdeis4U>;
|
|
3644
3712
|
};
|
|
3645
3713
|
users: {
|
|
3646
3714
|
/**
|
|
@@ -3652,7 +3720,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3652
3720
|
* @request POST:/users/certification/{certSpecID}
|
|
3653
3721
|
* @secure
|
|
3654
3722
|
*/
|
|
3655
|
-
createCertification: (certSpecId: string, data:
|
|
3723
|
+
createCertification: (certSpecId: string, data: InputFlrsmcuwsq, params?: RequestParams) => Promise<OutputFlrsmcuwsq>;
|
|
3656
3724
|
/**
|
|
3657
3725
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3658
3726
|
*
|