@ikonintegration/bccsa-program-api 3.0.39 → 3.0.41
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 +436 -95
- package/dist/Api.d.ts +336 -104
- package/dist/Api.js +158 -8
- package/dist/Api.js.map +1 -1
- package/package.json +2 -2
package/Api.ts
CHANGED
|
@@ -17,7 +17,7 @@ export interface ErrorResponse {
|
|
|
17
17
|
errCode: string
|
|
18
18
|
}
|
|
19
19
|
|
|
20
|
-
export interface
|
|
20
|
+
export interface InputIpmc99Otqdg {
|
|
21
21
|
/**
|
|
22
22
|
* Name of the person filling out the contact form
|
|
23
23
|
* @example "John Doe"
|
|
@@ -387,7 +387,7 @@ export type RevokedByID = string
|
|
|
387
387
|
export type RevokedByName = string
|
|
388
388
|
|
|
389
389
|
/** Sponsorship approval parameters */
|
|
390
|
-
export interface
|
|
390
|
+
export interface InputNdozkicip3 {
|
|
391
391
|
/**
|
|
392
392
|
* Employer first name
|
|
393
393
|
* @maxLength 255
|
|
@@ -628,7 +628,7 @@ export type SponsorshipRemindersSponsor = string[]
|
|
|
628
628
|
/** Timestamp when the current sponsorship reminder schedule started (set on create and on reset). Reminder dueness is measured from it; when absent, from createdOn. */
|
|
629
629
|
export type RemindersStartedOn = number
|
|
630
630
|
|
|
631
|
-
export interface
|
|
631
|
+
export interface InputD4Rprncvca {
|
|
632
632
|
/**
|
|
633
633
|
* ID of the certification to filter applications by
|
|
634
634
|
* @example "certification123"
|
|
@@ -686,7 +686,7 @@ export interface InputAo0Hmwpt3Z {
|
|
|
686
686
|
ignoreCompletedCertifications?: boolean | null
|
|
687
687
|
}
|
|
688
688
|
|
|
689
|
-
export interface
|
|
689
|
+
export interface InputOdq90W7Fvd {
|
|
690
690
|
/**
|
|
691
691
|
* ID of the certification to filter applications by
|
|
692
692
|
* @example "certification123"
|
|
@@ -744,7 +744,7 @@ export interface InputSf456Uwm0Y {
|
|
|
744
744
|
ignoreCompletedCertifications?: boolean | null
|
|
745
745
|
}
|
|
746
746
|
|
|
747
|
-
export interface
|
|
747
|
+
export interface InputKhw29Smbei {
|
|
748
748
|
/**
|
|
749
749
|
* ID of the certification to filter applications by
|
|
750
750
|
* @example "certification123"
|
|
@@ -802,7 +802,7 @@ export interface InputGk0V7Sd10D {
|
|
|
802
802
|
ignoreCompletedCertifications?: boolean | null
|
|
803
803
|
}
|
|
804
804
|
|
|
805
|
-
export interface
|
|
805
|
+
export interface InputE4Gqi912J9 {
|
|
806
806
|
/**
|
|
807
807
|
* The ID of the certificate specifications to be used for the email
|
|
808
808
|
* @example "certSpecsID123"
|
|
@@ -844,7 +844,7 @@ export interface InputRw5C352Zh1 {
|
|
|
844
844
|
}[]
|
|
845
845
|
}
|
|
846
846
|
|
|
847
|
-
export interface
|
|
847
|
+
export interface InputQihsbffnta {
|
|
848
848
|
/**
|
|
849
849
|
* The ID of the product for which the license is being redeemed
|
|
850
850
|
* @example "productID123"
|
|
@@ -857,7 +857,7 @@ export interface InputWq7Kc998Gu {
|
|
|
857
857
|
sessionID?: string
|
|
858
858
|
}
|
|
859
859
|
|
|
860
|
-
export interface
|
|
860
|
+
export interface Input0Cdbeyihx9 {
|
|
861
861
|
/**
|
|
862
862
|
* Search term to filter licenses
|
|
863
863
|
* @example "active"
|
|
@@ -875,7 +875,7 @@ export interface InputAohpyyjnf {
|
|
|
875
875
|
sortField?: any
|
|
876
876
|
}
|
|
877
877
|
|
|
878
|
-
export interface
|
|
878
|
+
export interface Input03993Y2Hmhg {
|
|
879
879
|
/**
|
|
880
880
|
* Search term to filter licenses
|
|
881
881
|
* @example "active"
|
|
@@ -1017,7 +1017,7 @@ export interface SearchPendingApprovalsResponseSchema {
|
|
|
1017
1017
|
}[]
|
|
1018
1018
|
}
|
|
1019
1019
|
|
|
1020
|
-
export interface
|
|
1020
|
+
export interface InputX6Br1Bzszd {
|
|
1021
1021
|
/**
|
|
1022
1022
|
* Start date for the report
|
|
1023
1023
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -1040,12 +1040,12 @@ export interface Input7U9Wc63O0Z {
|
|
|
1040
1040
|
dateType?: string
|
|
1041
1041
|
}
|
|
1042
1042
|
|
|
1043
|
-
export interface
|
|
1043
|
+
export interface InputAcb6Cb0Wc {
|
|
1044
1044
|
/** List of user IDs to search for in the tenant. */
|
|
1045
1045
|
IDs: (string | null)[]
|
|
1046
1046
|
}
|
|
1047
1047
|
|
|
1048
|
-
export interface
|
|
1048
|
+
export interface InputSnyycdllar {
|
|
1049
1049
|
/** The term to search for in the user profiles. */
|
|
1050
1050
|
searchTerm?: string | null
|
|
1051
1051
|
/** Filter criteria for the user search. */
|
|
@@ -1086,7 +1086,7 @@ export interface InputRx2Of25Z1S {
|
|
|
1086
1086
|
}
|
|
1087
1087
|
}
|
|
1088
1088
|
|
|
1089
|
-
export interface
|
|
1089
|
+
export interface InputV6Bi78Xqc6 {
|
|
1090
1090
|
/** The term to search for in the user profiles. */
|
|
1091
1091
|
searchTerm?: string | null
|
|
1092
1092
|
/** Filter criteria for the user search. */
|
|
@@ -1127,7 +1127,7 @@ export interface InputBwf6Vwqau4H {
|
|
|
1127
1127
|
}
|
|
1128
1128
|
}
|
|
1129
1129
|
|
|
1130
|
-
export interface
|
|
1130
|
+
export interface OutputSa87Chshb2 {
|
|
1131
1131
|
/** External system ID 2 */
|
|
1132
1132
|
userCount: ExternalID2
|
|
1133
1133
|
transactionID?: string | null
|
|
@@ -1136,10 +1136,37 @@ export interface Output5Bph624559 {
|
|
|
1136
1136
|
/** External system ID 2 */
|
|
1137
1137
|
export type ExternalID2 = number
|
|
1138
1138
|
|
|
1139
|
+
export interface InputXc4U9K5Ew {
|
|
1140
|
+
/** Report filter */
|
|
1141
|
+
filter: {
|
|
1142
|
+
/**
|
|
1143
|
+
* Course specification IDs to include (1 to 100 entries, required)
|
|
1144
|
+
* @maxItems 100
|
|
1145
|
+
* @minItems 1
|
|
1146
|
+
* @example ["course123"]
|
|
1147
|
+
*/
|
|
1148
|
+
courseID: string[]
|
|
1149
|
+
/**
|
|
1150
|
+
* Inclusive lower bound of the enrolment date (epoch milliseconds). Requires "to".
|
|
1151
|
+
* @min 0
|
|
1152
|
+
* @max 4102444800000
|
|
1153
|
+
* @example 1672531200000
|
|
1154
|
+
*/
|
|
1155
|
+
from?: number
|
|
1156
|
+
/**
|
|
1157
|
+
* Inclusive upper bound of the enrolment date (epoch milliseconds). Requires "from".
|
|
1158
|
+
* @min 0
|
|
1159
|
+
* @max 4102444800000
|
|
1160
|
+
* @example 1672617600000
|
|
1161
|
+
*/
|
|
1162
|
+
to?: number
|
|
1163
|
+
}
|
|
1164
|
+
}
|
|
1165
|
+
|
|
1139
1166
|
/** This endpoint accepts no request body */
|
|
1140
1167
|
export type DeletePendingApprovalBody = object
|
|
1141
1168
|
|
|
1142
|
-
export interface
|
|
1169
|
+
export interface Output5Wy4Ij5R2L {
|
|
1143
1170
|
/**
|
|
1144
1171
|
* Signed URL for the course file
|
|
1145
1172
|
* @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"
|
|
@@ -1147,7 +1174,7 @@ export interface Output0Mvvp8Ezlc {
|
|
|
1147
1174
|
fileURL: string
|
|
1148
1175
|
}
|
|
1149
1176
|
|
|
1150
|
-
export interface
|
|
1177
|
+
export interface Output93Vvrem4Cnj {
|
|
1151
1178
|
/**
|
|
1152
1179
|
* Amount to be refunded for the cancellation
|
|
1153
1180
|
* @example 0
|
|
@@ -1473,7 +1500,7 @@ export interface CourseResponseEntity {
|
|
|
1473
1500
|
/** Label of the course enrolled (course version) */
|
|
1474
1501
|
export type OnlineCourseLabel = string
|
|
1475
1502
|
|
|
1476
|
-
export interface
|
|
1503
|
+
export interface OutputMzn398Miqag {
|
|
1477
1504
|
/**
|
|
1478
1505
|
* Signed URL for the course file
|
|
1479
1506
|
* @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"
|
|
@@ -1493,7 +1520,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1493
1520
|
}
|
|
1494
1521
|
|
|
1495
1522
|
/** Application Foreign Fill response type */
|
|
1496
|
-
export interface
|
|
1523
|
+
export interface Output4R7Cihk7Va {
|
|
1497
1524
|
items: {
|
|
1498
1525
|
userID: string
|
|
1499
1526
|
createdOn?: number
|
|
@@ -1733,7 +1760,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1733
1760
|
transactionID?: string | null
|
|
1734
1761
|
}
|
|
1735
1762
|
|
|
1736
|
-
export interface
|
|
1763
|
+
export interface InputDo34Iz9Dvd {
|
|
1737
1764
|
issuedOn?: number
|
|
1738
1765
|
expiresOn?: number
|
|
1739
1766
|
fileItems?: {
|
|
@@ -1743,7 +1770,7 @@ export interface InputO6S14Hm8Ny {
|
|
|
1743
1770
|
additionalNotes?: string | null
|
|
1744
1771
|
}
|
|
1745
1772
|
|
|
1746
|
-
export interface
|
|
1773
|
+
export interface InputX6Wo72Dybzj {
|
|
1747
1774
|
/**
|
|
1748
1775
|
* Indicates whether the application is locked
|
|
1749
1776
|
* @example true
|
|
@@ -1751,7 +1778,7 @@ export interface InputA30Shinbjtk {
|
|
|
1751
1778
|
isApplicationLocked: boolean
|
|
1752
1779
|
}
|
|
1753
1780
|
|
|
1754
|
-
export interface
|
|
1781
|
+
export interface OutputO44Lmw18Hm {
|
|
1755
1782
|
/**
|
|
1756
1783
|
* Signed URL for the course file
|
|
1757
1784
|
* @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"
|
|
@@ -1759,7 +1786,7 @@ export interface OutputW7312H25Cc {
|
|
|
1759
1786
|
fileURL: string
|
|
1760
1787
|
}
|
|
1761
1788
|
|
|
1762
|
-
export interface
|
|
1789
|
+
export interface InputFvtyzhspxlk {
|
|
1763
1790
|
/**
|
|
1764
1791
|
* Indicates whether the waiver is approved
|
|
1765
1792
|
* @example true
|
|
@@ -1772,7 +1799,7 @@ export interface InputHttuep0Xaa {
|
|
|
1772
1799
|
additionalNotes?: string | null
|
|
1773
1800
|
}
|
|
1774
1801
|
|
|
1775
|
-
export interface
|
|
1802
|
+
export interface Input5R9Ud8Ixob {
|
|
1776
1803
|
/**
|
|
1777
1804
|
* Optional notes regarding the waiver
|
|
1778
1805
|
* @example "Waiver granted due to special circumstances."
|
|
@@ -1780,7 +1807,7 @@ export interface InputR89Sd266I6 {
|
|
|
1780
1807
|
additionalNotes?: string | null
|
|
1781
1808
|
}
|
|
1782
1809
|
|
|
1783
|
-
export interface
|
|
1810
|
+
export interface InputSwpu5Vwre6 {
|
|
1784
1811
|
students: {
|
|
1785
1812
|
/**
|
|
1786
1813
|
* User ID of the student to redeem the course for
|
|
@@ -1815,7 +1842,7 @@ export interface InputS523Pjmwoa {
|
|
|
1815
1842
|
autoEnrolSessionID?: string
|
|
1816
1843
|
}
|
|
1817
1844
|
|
|
1818
|
-
export interface
|
|
1845
|
+
export interface InputM3Vuv0N0Ko {
|
|
1819
1846
|
invites: {
|
|
1820
1847
|
/**
|
|
1821
1848
|
* Email address of the user to invite
|
|
@@ -1845,7 +1872,7 @@ export interface Input7Pkse4K1Q5 {
|
|
|
1845
1872
|
isReservedSeat: boolean
|
|
1846
1873
|
}
|
|
1847
1874
|
|
|
1848
|
-
export interface
|
|
1875
|
+
export interface Input67Joiiq2Mlf {
|
|
1849
1876
|
/**
|
|
1850
1877
|
* Indicates whether to waive the certification process
|
|
1851
1878
|
* @example true
|
|
@@ -1859,7 +1886,7 @@ export interface Input3Dqkxxnovwg {
|
|
|
1859
1886
|
}
|
|
1860
1887
|
|
|
1861
1888
|
/** Certification move response schema */
|
|
1862
|
-
export interface
|
|
1889
|
+
export interface OutputC6Swugv92O {
|
|
1863
1890
|
errors?: {
|
|
1864
1891
|
status: string
|
|
1865
1892
|
object?: Record<string, any>
|
|
@@ -1868,12 +1895,12 @@ export interface OutputLakap8U75H {
|
|
|
1868
1895
|
}
|
|
1869
1896
|
|
|
1870
1897
|
/** Schema for writing a certification trigger check. */
|
|
1871
|
-
export interface
|
|
1898
|
+
export interface Input8F9Tnd70S1 {
|
|
1872
1899
|
/**
|
|
1873
1900
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1874
1901
|
* @example "CHECKED"
|
|
1875
1902
|
*/
|
|
1876
|
-
value:
|
|
1903
|
+
value: Input8F9Tnd70S1ValueEnum
|
|
1877
1904
|
/**
|
|
1878
1905
|
* List of course IDs that are blocked by this trigger check.
|
|
1879
1906
|
* @example ["course1","course2"]
|
|
@@ -1881,7 +1908,7 @@ export interface InputO15Aanoemr {
|
|
|
1881
1908
|
blockedCourses?: string[]
|
|
1882
1909
|
}
|
|
1883
1910
|
|
|
1884
|
-
export interface
|
|
1911
|
+
export interface InputDvl5Dcmb96 {
|
|
1885
1912
|
/**
|
|
1886
1913
|
* Indicates whether the application item is approved
|
|
1887
1914
|
* @example true
|
|
@@ -1909,7 +1936,7 @@ export interface StudentHistoryRequestSchema {
|
|
|
1909
1936
|
requirements: string[]
|
|
1910
1937
|
}
|
|
1911
1938
|
|
|
1912
|
-
export interface
|
|
1939
|
+
export interface InputXgiq6Ooomw {
|
|
1913
1940
|
/**
|
|
1914
1941
|
* Optional activation key for the application
|
|
1915
1942
|
* @example "AK-123456"
|
|
@@ -1918,7 +1945,7 @@ export interface InputMzh8Dry519 {
|
|
|
1918
1945
|
}
|
|
1919
1946
|
|
|
1920
1947
|
/** Schema for course submission item details post request. */
|
|
1921
|
-
export interface
|
|
1948
|
+
export interface InputSj177Dwq6Q {
|
|
1922
1949
|
/**
|
|
1923
1950
|
* The ID of the file being submitted.
|
|
1924
1951
|
* @example "fileID123"
|
|
@@ -1932,7 +1959,7 @@ export interface Input907Bqms0Gd {
|
|
|
1932
1959
|
}
|
|
1933
1960
|
|
|
1934
1961
|
/** Schema for the response to course submission item details post request. */
|
|
1935
|
-
export interface
|
|
1962
|
+
export interface OutputSj177Dwq6Q {
|
|
1936
1963
|
submissionItems: {
|
|
1937
1964
|
/**
|
|
1938
1965
|
* The ID of the file being submitted.
|
|
@@ -1948,7 +1975,7 @@ export interface Output907Bqms0Gd {
|
|
|
1948
1975
|
}
|
|
1949
1976
|
|
|
1950
1977
|
/** Pending approval submission parameters */
|
|
1951
|
-
export interface
|
|
1978
|
+
export interface InputOexr2Qxfau {
|
|
1952
1979
|
/**
|
|
1953
1980
|
* Type of pending approval
|
|
1954
1981
|
* @example "certification"
|
|
@@ -1969,7 +1996,7 @@ export interface InputIw7Hk3Mq5M {
|
|
|
1969
1996
|
}[]
|
|
1970
1997
|
}
|
|
1971
1998
|
|
|
1972
|
-
export interface
|
|
1999
|
+
export interface InputMsk4L6Y8T6 {
|
|
1973
2000
|
/**
|
|
1974
2001
|
* The ID of the course for which the license is being redeemed
|
|
1975
2002
|
* @example "courseID123"
|
|
@@ -2038,7 +2065,7 @@ export interface InputLh0T8171Wqg {
|
|
|
2038
2065
|
}
|
|
2039
2066
|
|
|
2040
2067
|
/** Validate certification move response schema */
|
|
2041
|
-
export interface
|
|
2068
|
+
export interface OutputK50Eo4Le8G {
|
|
2042
2069
|
courses: {
|
|
2043
2070
|
name: string
|
|
2044
2071
|
status: string
|
|
@@ -2050,7 +2077,7 @@ export interface OutputHmffu9Hc2H {
|
|
|
2050
2077
|
mustCreateCP: boolean
|
|
2051
2078
|
}
|
|
2052
2079
|
|
|
2053
|
-
export interface
|
|
2080
|
+
export interface InputNbfoc0D7Fok {
|
|
2054
2081
|
/**
|
|
2055
2082
|
* Comments regarding the end of the cooldown period
|
|
2056
2083
|
* @example "Cooldown period ended successfully."
|
|
@@ -2058,7 +2085,7 @@ export interface InputLk5B7Priqt {
|
|
|
2058
2085
|
comments: string
|
|
2059
2086
|
}
|
|
2060
2087
|
|
|
2061
|
-
export interface
|
|
2088
|
+
export interface OutputO7Izub8Bxe {
|
|
2062
2089
|
/**
|
|
2063
2090
|
* Signed URL for the course file
|
|
2064
2091
|
* @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"
|
|
@@ -2066,7 +2093,7 @@ export interface OutputC61Yutxgkz {
|
|
|
2066
2093
|
fileURL: string
|
|
2067
2094
|
}
|
|
2068
2095
|
|
|
2069
|
-
export interface
|
|
2096
|
+
export interface InputGud41Drhmr {
|
|
2070
2097
|
/** @example true */
|
|
2071
2098
|
agreedWithCertTerms: boolean
|
|
2072
2099
|
/** @example 1717230000000 */
|
|
@@ -2153,7 +2180,7 @@ export interface Sponsor {
|
|
|
2153
2180
|
title?: Title
|
|
2154
2181
|
}
|
|
2155
2182
|
|
|
2156
|
-
export interface
|
|
2183
|
+
export interface InputH27O516961 {
|
|
2157
2184
|
/**
|
|
2158
2185
|
* Comments regarding the course unlock action
|
|
2159
2186
|
* @example "Course unlocked successfully."
|
|
@@ -2161,7 +2188,7 @@ export interface Input90Jd0Xyanx {
|
|
|
2161
2188
|
comments: string
|
|
2162
2189
|
}
|
|
2163
2190
|
|
|
2164
|
-
export interface
|
|
2191
|
+
export interface Input1Slvu9Z87P {
|
|
2165
2192
|
/**
|
|
2166
2193
|
* ITA number to update for the user
|
|
2167
2194
|
* @example "ITA123456"
|
|
@@ -2169,7 +2196,7 @@ export interface InputC9Nvfilwnd {
|
|
|
2169
2196
|
itaNumber: string
|
|
2170
2197
|
}
|
|
2171
2198
|
|
|
2172
|
-
export interface
|
|
2199
|
+
export interface InputBknn2Isn2Ll {
|
|
2173
2200
|
/** @example true */
|
|
2174
2201
|
agreedWithCertTerms: boolean
|
|
2175
2202
|
/** @example 1717230000000 */
|
|
@@ -2244,7 +2271,7 @@ export interface InputVynk4V82Hlf {
|
|
|
2244
2271
|
sponsor?: Sponsor
|
|
2245
2272
|
}
|
|
2246
2273
|
|
|
2247
|
-
export interface
|
|
2274
|
+
export interface Input2V0Cmpfq55G {
|
|
2248
2275
|
/**
|
|
2249
2276
|
* The grade to override the course result with
|
|
2250
2277
|
* @example "A"
|
|
@@ -2253,7 +2280,7 @@ export interface InputSzdt1Ehw1F {
|
|
|
2253
2280
|
}
|
|
2254
2281
|
|
|
2255
2282
|
/** Pending approval review parameters */
|
|
2256
|
-
export interface
|
|
2283
|
+
export interface InputZauj6Kl3W2 {
|
|
2257
2284
|
/**
|
|
2258
2285
|
* Notes provided by the reviewer for the pending approval
|
|
2259
2286
|
* @example "Please review the submitted documents."
|
|
@@ -2274,7 +2301,7 @@ export interface InputRaggvf9Tdaf {
|
|
|
2274
2301
|
}
|
|
2275
2302
|
|
|
2276
2303
|
/** Schema for overriding course result dates. */
|
|
2277
|
-
export interface
|
|
2304
|
+
export interface InputL7Diqqlzdq {
|
|
2278
2305
|
/**
|
|
2279
2306
|
* The date when the course result expires, in milliseconds since epoch.
|
|
2280
2307
|
* @example 1735689600000
|
|
@@ -2290,7 +2317,103 @@ export interface Input504Pqmq2W3 {
|
|
|
2290
2317
|
/** Reset sponsorship request takes no body */
|
|
2291
2318
|
export type ResetSponsorshipBody = object
|
|
2292
2319
|
|
|
2293
|
-
|
|
2320
|
+
/** List of work hours records for a user */
|
|
2321
|
+
export type WorkHoursListResponse = WorkHoursResponseEntity[]
|
|
2322
|
+
|
|
2323
|
+
/** Single work hours object */
|
|
2324
|
+
export interface WorkHoursResponseEntity {
|
|
2325
|
+
/** User who created the record */
|
|
2326
|
+
createdBy?: CreatedBy
|
|
2327
|
+
/** Timestamp when the record was created */
|
|
2328
|
+
createdOn?: CreatedOn
|
|
2329
|
+
/** User who last updated the record */
|
|
2330
|
+
updatedBy?: UpdatedBy
|
|
2331
|
+
/** Timestamp of last update */
|
|
2332
|
+
updatedOn?: UpdatedOn
|
|
2333
|
+
/** Entity identifier for work hours */
|
|
2334
|
+
dbEntity?: DbEntity
|
|
2335
|
+
/** Unique identifier of the work hours record */
|
|
2336
|
+
id: Id
|
|
2337
|
+
/** Tenant ID associated with the work hours record */
|
|
2338
|
+
tenantID: TenantID
|
|
2339
|
+
/** User ID related with this work hours record */
|
|
2340
|
+
userID: UserID
|
|
2341
|
+
/** Number of hours entered for a specific period */
|
|
2342
|
+
hours?: Hours
|
|
2343
|
+
/** Initial date of the work period (timestamp) */
|
|
2344
|
+
initDate: InitDate
|
|
2345
|
+
/** End date of the work period (timestamp) */
|
|
2346
|
+
endDate?: EndDate
|
|
2347
|
+
/** Concrete pump categories the user selected to enter hours */
|
|
2348
|
+
categories?: Categories
|
|
2349
|
+
/** Array of documents that prove the hours worked */
|
|
2350
|
+
attachments?: Attachments
|
|
2351
|
+
}
|
|
2352
|
+
|
|
2353
|
+
/** Number of hours entered for a specific period */
|
|
2354
|
+
export type Hours = number
|
|
2355
|
+
|
|
2356
|
+
/** Initial date of the work period (timestamp) */
|
|
2357
|
+
export type InitDate = number
|
|
2358
|
+
|
|
2359
|
+
/** End date of the work period (timestamp) */
|
|
2360
|
+
export type EndDate = number
|
|
2361
|
+
|
|
2362
|
+
/** Concrete pump categories the user selected to enter hours */
|
|
2363
|
+
export type Categories = string[]
|
|
2364
|
+
|
|
2365
|
+
/** Array of documents that prove the hours worked */
|
|
2366
|
+
export type Attachments = {
|
|
2367
|
+
/** Identifier of the attachment file */
|
|
2368
|
+
fileID: string
|
|
2369
|
+
/** Name of the attachment file */
|
|
2370
|
+
fileName: string
|
|
2371
|
+
}[]
|
|
2372
|
+
|
|
2373
|
+
/** Payload to create or update a work hours record */
|
|
2374
|
+
export interface WorkHoursWrite {
|
|
2375
|
+
/** @example 40 */
|
|
2376
|
+
hours?: number
|
|
2377
|
+
/** @example 1717230000000 */
|
|
2378
|
+
initDate: number
|
|
2379
|
+
/** @example 1717830000000 */
|
|
2380
|
+
endDate?: number
|
|
2381
|
+
/** @example ["boom","line"] */
|
|
2382
|
+
categories?: string[]
|
|
2383
|
+
/** @example [{"fileID":"fileID","fileName":"proof.pdf"}] */
|
|
2384
|
+
attachments?: {
|
|
2385
|
+
/**
|
|
2386
|
+
* @minLength 1
|
|
2387
|
+
* @example "fileID"
|
|
2388
|
+
*/
|
|
2389
|
+
fileID: string
|
|
2390
|
+
/**
|
|
2391
|
+
* @minLength 1
|
|
2392
|
+
* @example "proof.pdf"
|
|
2393
|
+
*/
|
|
2394
|
+
fileName: string
|
|
2395
|
+
}[]
|
|
2396
|
+
}
|
|
2397
|
+
|
|
2398
|
+
/** Work hours file response */
|
|
2399
|
+
export interface OutputDfi7Lgx5Y2 {
|
|
2400
|
+
/**
|
|
2401
|
+
* Signed URL for the work hours file
|
|
2402
|
+
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
|
|
2403
|
+
*/
|
|
2404
|
+
fileURL: string
|
|
2405
|
+
}
|
|
2406
|
+
|
|
2407
|
+
/** Work hours file response */
|
|
2408
|
+
export interface OutputG0Ygvys9Tfl {
|
|
2409
|
+
/**
|
|
2410
|
+
* Signed URL for the work hours file
|
|
2411
|
+
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
|
|
2412
|
+
*/
|
|
2413
|
+
fileURL: string
|
|
2414
|
+
}
|
|
2415
|
+
|
|
2416
|
+
export interface InputVn7Imocp5P {
|
|
2294
2417
|
filter: {
|
|
2295
2418
|
from?: number
|
|
2296
2419
|
sortOrder?: string
|
|
@@ -2298,7 +2421,7 @@ export interface InputE48N2Qyfcu {
|
|
|
2298
2421
|
}
|
|
2299
2422
|
}
|
|
2300
2423
|
|
|
2301
|
-
export interface
|
|
2424
|
+
export interface OutputVn7Imocp5P {
|
|
2302
2425
|
users: {
|
|
2303
2426
|
firstName: string
|
|
2304
2427
|
lastName: string
|
|
@@ -2324,7 +2447,7 @@ export enum ReportXlsxSchemaContentTypeEnum {
|
|
|
2324
2447
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
2325
2448
|
* @example "CHECKED"
|
|
2326
2449
|
*/
|
|
2327
|
-
export enum
|
|
2450
|
+
export enum Input8F9Tnd70S1ValueEnum {
|
|
2328
2451
|
CHECKED = 'CHECKED',
|
|
2329
2452
|
UNCHECKED = 'UNCHECKED',
|
|
2330
2453
|
NOVALUE = 'NOVALUE',
|
|
@@ -2486,10 +2609,14 @@ export type CreateReportUsersSimpleData = any
|
|
|
2486
2609
|
|
|
2487
2610
|
export type CreateReportUsersSimpleError = ErrorResponse
|
|
2488
2611
|
|
|
2489
|
-
export type CreateSearchUsersCountData =
|
|
2612
|
+
export type CreateSearchUsersCountData = OutputSa87Chshb2
|
|
2490
2613
|
|
|
2491
2614
|
export type CreateSearchUsersCountError = ErrorResponse
|
|
2492
2615
|
|
|
2616
|
+
export type CreateReportStudentsPaidIncompleteCourseData = any
|
|
2617
|
+
|
|
2618
|
+
export type CreateReportStudentsPaidIncompleteCourseError = ErrorResponse
|
|
2619
|
+
|
|
2493
2620
|
export type CreateCertificationApplicationAcknowledgeData = any
|
|
2494
2621
|
|
|
2495
2622
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse
|
|
@@ -2534,7 +2661,7 @@ export type DeleteCertificationCourseFileSignData = any
|
|
|
2534
2661
|
|
|
2535
2662
|
export type DeleteCertificationCourseFileSignError = ErrorResponse
|
|
2536
2663
|
|
|
2537
|
-
export type GetCertificationCourseFileSignData =
|
|
2664
|
+
export type GetCertificationCourseFileSignData = OutputMzn398Miqag
|
|
2538
2665
|
|
|
2539
2666
|
export type GetCertificationCourseFileSignError = ErrorResponse
|
|
2540
2667
|
|
|
@@ -2551,7 +2678,7 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2551
2678
|
fileId: string
|
|
2552
2679
|
}
|
|
2553
2680
|
|
|
2554
|
-
export type CreateCertificationCourseFileSignData =
|
|
2681
|
+
export type CreateCertificationCourseFileSignData = OutputO7Izub8Bxe
|
|
2555
2682
|
|
|
2556
2683
|
export type CreateCertificationCourseFileSignError = ErrorResponse
|
|
2557
2684
|
|
|
@@ -2559,7 +2686,7 @@ export type DeleteCertificationCourseDocumentData = any
|
|
|
2559
2686
|
|
|
2560
2687
|
export type DeleteCertificationCourseDocumentError = ErrorResponse
|
|
2561
2688
|
|
|
2562
|
-
export type CreateCertificationCourseDocumentData =
|
|
2689
|
+
export type CreateCertificationCourseDocumentData = OutputSj177Dwq6Q
|
|
2563
2690
|
|
|
2564
2691
|
export type CreateCertificationCourseDocumentError = ErrorResponse
|
|
2565
2692
|
|
|
@@ -2591,7 +2718,7 @@ export type DeleteCertificationCourseData = any
|
|
|
2591
2718
|
|
|
2592
2719
|
export type DeleteCertificationCourseError = ErrorResponse
|
|
2593
2720
|
|
|
2594
|
-
export type GetCertificationApplicationItemFileData =
|
|
2721
|
+
export type GetCertificationApplicationItemFileData = Output5Wy4Ij5R2L
|
|
2595
2722
|
|
|
2596
2723
|
export type GetCertificationApplicationItemFileError = ErrorResponse
|
|
2597
2724
|
|
|
@@ -2608,11 +2735,11 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2608
2735
|
fileVersion: string
|
|
2609
2736
|
}
|
|
2610
2737
|
|
|
2611
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2738
|
+
export type CreateCertificationApplicationItemFileData = OutputO44Lmw18Hm
|
|
2612
2739
|
|
|
2613
2740
|
export type CreateCertificationApplicationItemFileError = ErrorResponse
|
|
2614
2741
|
|
|
2615
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2742
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = Output93Vvrem4Cnj
|
|
2616
2743
|
|
|
2617
2744
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse
|
|
2618
2745
|
|
|
@@ -2628,7 +2755,7 @@ export type GetCertificationsExpandedData = UserExpandedCPResponseSchema
|
|
|
2628
2755
|
|
|
2629
2756
|
export type GetCertificationsExpandedError = ErrorResponse
|
|
2630
2757
|
|
|
2631
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2758
|
+
export type GetCertificationApplicationForeignFillData = Output4R7Cihk7Va
|
|
2632
2759
|
|
|
2633
2760
|
export type GetCertificationApplicationForeignFillError = ErrorResponse
|
|
2634
2761
|
|
|
@@ -2696,7 +2823,7 @@ export type CreateCertificationWaiveData = any
|
|
|
2696
2823
|
|
|
2697
2824
|
export type CreateCertificationWaiveError = ErrorResponse
|
|
2698
2825
|
|
|
2699
|
-
export type CreateCertificationMoveData =
|
|
2826
|
+
export type CreateCertificationMoveData = OutputC6Swugv92O
|
|
2700
2827
|
|
|
2701
2828
|
export type CreateCertificationMoveError = ErrorResponse
|
|
2702
2829
|
|
|
@@ -2760,7 +2887,7 @@ export type CreateCertificationCourseRedeemData = any
|
|
|
2760
2887
|
|
|
2761
2888
|
export type CreateCertificationCourseRedeemError = ErrorResponse
|
|
2762
2889
|
|
|
2763
|
-
export type CreateCertificationMoveValidateData =
|
|
2890
|
+
export type CreateCertificationMoveValidateData = OutputK50Eo4Le8G
|
|
2764
2891
|
|
|
2765
2892
|
export type CreateCertificationMoveValidateError = ErrorResponse
|
|
2766
2893
|
|
|
@@ -2796,7 +2923,50 @@ export type CreateSponsorshipResetData = any
|
|
|
2796
2923
|
|
|
2797
2924
|
export type CreateSponsorshipResetError = ErrorResponse
|
|
2798
2925
|
|
|
2799
|
-
export type
|
|
2926
|
+
export type GetWorkHoursData = WorkHoursListResponse
|
|
2927
|
+
|
|
2928
|
+
export type GetWorkHoursError = ErrorResponse
|
|
2929
|
+
|
|
2930
|
+
export type GetWorkHours2Data = WorkHoursResponseEntity
|
|
2931
|
+
|
|
2932
|
+
export type GetWorkHours2Error = ErrorResponse
|
|
2933
|
+
|
|
2934
|
+
export type ListWorkHoursData = WorkHoursResponseEntity
|
|
2935
|
+
|
|
2936
|
+
export type ListWorkHoursError = ErrorResponse
|
|
2937
|
+
|
|
2938
|
+
export type UpdateWorkHoursData = WorkHoursResponseEntity
|
|
2939
|
+
|
|
2940
|
+
export type UpdateWorkHoursError = ErrorResponse
|
|
2941
|
+
|
|
2942
|
+
export type DeleteWorkHoursData = any
|
|
2943
|
+
|
|
2944
|
+
export type DeleteWorkHoursError = ErrorResponse
|
|
2945
|
+
|
|
2946
|
+
export interface CreateWorkHoursFileSignParams {
|
|
2947
|
+
/** @example "pdf" */
|
|
2948
|
+
fileType: string
|
|
2949
|
+
/** @example "userID" */
|
|
2950
|
+
userId: string
|
|
2951
|
+
/** @example "workHoursID" */
|
|
2952
|
+
workHoursId: string
|
|
2953
|
+
/** @example "fileID" */
|
|
2954
|
+
fileId: string
|
|
2955
|
+
}
|
|
2956
|
+
|
|
2957
|
+
export type CreateWorkHoursFileSignData = OutputDfi7Lgx5Y2
|
|
2958
|
+
|
|
2959
|
+
export type CreateWorkHoursFileSignError = ErrorResponse
|
|
2960
|
+
|
|
2961
|
+
export type DeleteWorkHoursFileSignData = any
|
|
2962
|
+
|
|
2963
|
+
export type DeleteWorkHoursFileSignError = ErrorResponse
|
|
2964
|
+
|
|
2965
|
+
export type GetWorkHoursFileSignData = OutputG0Ygvys9Tfl
|
|
2966
|
+
|
|
2967
|
+
export type GetWorkHoursFileSignError = ErrorResponse
|
|
2968
|
+
|
|
2969
|
+
export type CreateCertificationResult = OutputVn7Imocp5P
|
|
2800
2970
|
|
|
2801
2971
|
export type CreateCertificationFail = ErrorResponse
|
|
2802
2972
|
|
|
@@ -2942,7 +3112,7 @@ export class HttpClient<SecurityDataType = unknown> {
|
|
|
2942
3112
|
|
|
2943
3113
|
/**
|
|
2944
3114
|
* @title BCCSA Program API
|
|
2945
|
-
* @version 3.0.
|
|
3115
|
+
* @version 3.0.41
|
|
2946
3116
|
* @baseUrl http://localhost:8080
|
|
2947
3117
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2948
3118
|
*/
|
|
@@ -2957,7 +3127,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
2957
3127
|
* @request POST:/contactUs
|
|
2958
3128
|
* @secure
|
|
2959
3129
|
*/
|
|
2960
|
-
listContactUs: (data:
|
|
3130
|
+
listContactUs: (data: InputIpmc99Otqdg, params: RequestParams = {}) =>
|
|
2961
3131
|
this.request<ListContactUsData, ListContactUsError>({
|
|
2962
3132
|
path: `/contactUs`,
|
|
2963
3133
|
method: 'POST',
|
|
@@ -3032,7 +3202,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3032
3202
|
* @request PUT:/sponsorship/approve/{paID}
|
|
3033
3203
|
* @secure
|
|
3034
3204
|
*/
|
|
3035
|
-
updateApprove: (paId: string, data:
|
|
3205
|
+
updateApprove: (paId: string, data: InputNdozkicip3, params: RequestParams = {}) =>
|
|
3036
3206
|
this.request<UpdateApproveData, UpdateApproveError>({
|
|
3037
3207
|
path: `/sponsorship/approve/${paId}`,
|
|
3038
3208
|
method: 'PUT',
|
|
@@ -3158,7 +3328,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3158
3328
|
* @request POST:/tenant/report/applicationExport
|
|
3159
3329
|
* @secure
|
|
3160
3330
|
*/
|
|
3161
|
-
createReportApplicationExport: (data:
|
|
3331
|
+
createReportApplicationExport: (data: InputD4Rprncvca, params: RequestParams = {}) =>
|
|
3162
3332
|
this.request<CreateReportApplicationExportData, CreateReportApplicationExportError>({
|
|
3163
3333
|
path: `/tenant/report/applicationExport`,
|
|
3164
3334
|
method: 'POST',
|
|
@@ -3177,7 +3347,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3177
3347
|
* @request POST:/tenant/report/applicationStatus
|
|
3178
3348
|
* @secure
|
|
3179
3349
|
*/
|
|
3180
|
-
listReportApplicationStatus: (data:
|
|
3350
|
+
listReportApplicationStatus: (data: InputOdq90W7Fvd, params: RequestParams = {}) =>
|
|
3181
3351
|
this.request<ListReportApplicationStatusData, ListReportApplicationStatusError>({
|
|
3182
3352
|
path: `/tenant/report/applicationStatus`,
|
|
3183
3353
|
method: 'POST',
|
|
@@ -3196,7 +3366,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3196
3366
|
* @request POST:/tenant/report/applicationsReport
|
|
3197
3367
|
* @secure
|
|
3198
3368
|
*/
|
|
3199
|
-
createReportApplicationsReport: (data:
|
|
3369
|
+
createReportApplicationsReport: (data: InputKhw29Smbei, params: RequestParams = {}) =>
|
|
3200
3370
|
this.request<CreateReportApplicationsReportData, CreateReportApplicationsReportError>({
|
|
3201
3371
|
path: `/tenant/report/applicationsReport`,
|
|
3202
3372
|
method: 'POST',
|
|
@@ -3215,7 +3385,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3215
3385
|
* @request POST:/tenant/certificates/email
|
|
3216
3386
|
* @secure
|
|
3217
3387
|
*/
|
|
3218
|
-
createCertificatesEmail: (data:
|
|
3388
|
+
createCertificatesEmail: (data: InputE4Gqi912J9, params: RequestParams = {}) =>
|
|
3219
3389
|
this.request<CreateCertificatesEmailData, CreateCertificatesEmailError>({
|
|
3220
3390
|
path: `/tenant/certificates/email`,
|
|
3221
3391
|
method: 'POST',
|
|
@@ -3273,7 +3443,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3273
3443
|
* @request POST:/tenant/license/redeem/{userID}
|
|
3274
3444
|
* @secure
|
|
3275
3445
|
*/
|
|
3276
|
-
createLicenseRedeem: (userId: string, data:
|
|
3446
|
+
createLicenseRedeem: (userId: string, data: InputQihsbffnta, params: RequestParams = {}) =>
|
|
3277
3447
|
this.request<CreateLicenseRedeemData, CreateLicenseRedeemError>({
|
|
3278
3448
|
path: `/tenant/license/redeem/${userId}`,
|
|
3279
3449
|
method: 'POST',
|
|
@@ -3292,7 +3462,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3292
3462
|
* @request POST:/tenant/report/orglicenses/
|
|
3293
3463
|
* @secure
|
|
3294
3464
|
*/
|
|
3295
|
-
listReportOrglicenses: (data:
|
|
3465
|
+
listReportOrglicenses: (data: Input0Cdbeyihx9, params: RequestParams = {}) =>
|
|
3296
3466
|
this.request<ListReportOrglicensesData, ListReportOrglicensesError>({
|
|
3297
3467
|
path: `/tenant/report/orglicenses/`,
|
|
3298
3468
|
method: 'POST',
|
|
@@ -3311,7 +3481,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3311
3481
|
* @request POST:/tenant/report/orglicenses/preview
|
|
3312
3482
|
* @secure
|
|
3313
3483
|
*/
|
|
3314
|
-
createReportOrglicensesPreview: (data:
|
|
3484
|
+
createReportOrglicensesPreview: (data: Input03993Y2Hmhg, params: RequestParams = {}) =>
|
|
3315
3485
|
this.request<CreateReportOrglicensesPreviewData, CreateReportOrglicensesPreviewError>({
|
|
3316
3486
|
path: `/tenant/report/orglicenses/preview`,
|
|
3317
3487
|
method: 'POST',
|
|
@@ -3390,7 +3560,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3390
3560
|
* @request POST:/tenant/report/users/advanced
|
|
3391
3561
|
* @secure
|
|
3392
3562
|
*/
|
|
3393
|
-
createReportUsersAdvanced: (data:
|
|
3563
|
+
createReportUsersAdvanced: (data: InputX6Br1Bzszd, params: RequestParams = {}) =>
|
|
3394
3564
|
this.request<CreateReportUsersAdvancedData, CreateReportUsersAdvancedError>({
|
|
3395
3565
|
path: `/tenant/report/users/advanced`,
|
|
3396
3566
|
method: 'POST',
|
|
@@ -3409,7 +3579,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3409
3579
|
* @request POST:/tenant/search/users/ids
|
|
3410
3580
|
* @secure
|
|
3411
3581
|
*/
|
|
3412
|
-
listSearchUsersIds: (data:
|
|
3582
|
+
listSearchUsersIds: (data: InputAcb6Cb0Wc, params: RequestParams = {}) =>
|
|
3413
3583
|
this.request<ListSearchUsersIdsData, ListSearchUsersIdsError>({
|
|
3414
3584
|
path: `/tenant/search/users/ids`,
|
|
3415
3585
|
method: 'POST',
|
|
@@ -3428,7 +3598,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3428
3598
|
* @request POST:/tenant/search/users/term
|
|
3429
3599
|
* @secure
|
|
3430
3600
|
*/
|
|
3431
|
-
createSearchUsersTerm: (data:
|
|
3601
|
+
createSearchUsersTerm: (data: InputSnyycdllar, params: RequestParams = {}) =>
|
|
3432
3602
|
this.request<CreateSearchUsersTermData, CreateSearchUsersTermError>({
|
|
3433
3603
|
path: `/tenant/search/users/term`,
|
|
3434
3604
|
method: 'POST',
|
|
@@ -3447,7 +3617,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3447
3617
|
* @request POST:/tenant/report/users/simple
|
|
3448
3618
|
* @secure
|
|
3449
3619
|
*/
|
|
3450
|
-
createReportUsersSimple: (data:
|
|
3620
|
+
createReportUsersSimple: (data: InputV6Bi78Xqc6, params: RequestParams = {}) =>
|
|
3451
3621
|
this.request<CreateReportUsersSimpleData, CreateReportUsersSimpleError>({
|
|
3452
3622
|
path: `/tenant/report/users/simple`,
|
|
3453
3623
|
method: 'POST',
|
|
@@ -3474,6 +3644,25 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3474
3644
|
format: 'json',
|
|
3475
3645
|
...params,
|
|
3476
3646
|
}),
|
|
3647
|
+
|
|
3648
|
+
/**
|
|
3649
|
+
* @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.
|
|
3650
|
+
*
|
|
3651
|
+
* @tags Reports
|
|
3652
|
+
* @name CreateReportStudentsPaidIncompleteCourse
|
|
3653
|
+
* @summary Students who paid for a course but have not completed it
|
|
3654
|
+
* @request POST:/tenant/report/studentsPaidIncompleteCourse
|
|
3655
|
+
* @secure
|
|
3656
|
+
*/
|
|
3657
|
+
createReportStudentsPaidIncompleteCourse: (data: InputXc4U9K5Ew, params: RequestParams = {}) =>
|
|
3658
|
+
this.request<CreateReportStudentsPaidIncompleteCourseData, CreateReportStudentsPaidIncompleteCourseError>({
|
|
3659
|
+
path: `/tenant/report/studentsPaidIncompleteCourse`,
|
|
3660
|
+
method: 'POST',
|
|
3661
|
+
body: data,
|
|
3662
|
+
secure: true,
|
|
3663
|
+
type: ContentType.Json,
|
|
3664
|
+
...params,
|
|
3665
|
+
}),
|
|
3477
3666
|
}
|
|
3478
3667
|
user = {
|
|
3479
3668
|
/**
|
|
@@ -3535,7 +3724,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3535
3724
|
certProcId: string,
|
|
3536
3725
|
applicationType: string,
|
|
3537
3726
|
sourceId: string,
|
|
3538
|
-
data:
|
|
3727
|
+
data: InputDo34Iz9Dvd,
|
|
3539
3728
|
params: RequestParams = {}
|
|
3540
3729
|
) =>
|
|
3541
3730
|
this.request<CreateCertificationApplicationItemData, CreateCertificationApplicationItemError>({
|
|
@@ -3795,7 +3984,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3795
3984
|
certProcId: string,
|
|
3796
3985
|
courseId: string,
|
|
3797
3986
|
fileId: string,
|
|
3798
|
-
data:
|
|
3987
|
+
data: InputSj177Dwq6Q,
|
|
3799
3988
|
params: RequestParams = {}
|
|
3800
3989
|
) =>
|
|
3801
3990
|
this.request<CreateCertificationCourseDocumentData, CreateCertificationCourseDocumentError>({
|
|
@@ -3894,7 +4083,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3894
4083
|
* @request POST:/user/{userID}
|
|
3895
4084
|
* @secure
|
|
3896
4085
|
*/
|
|
3897
|
-
createUser: (userId: string, data:
|
|
4086
|
+
createUser: (userId: string, data: InputGud41Drhmr, params: RequestParams = {}) =>
|
|
3898
4087
|
this.request<CreateUserData, CreateUserError>({
|
|
3899
4088
|
path: `/user/${userId}`,
|
|
3900
4089
|
method: 'POST',
|
|
@@ -3913,7 +4102,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3913
4102
|
* @request PUT:/user/{userID}
|
|
3914
4103
|
* @secure
|
|
3915
4104
|
*/
|
|
3916
|
-
updateUser: (userId: string, data:
|
|
4105
|
+
updateUser: (userId: string, data: InputBknn2Isn2Ll, params: RequestParams = {}) =>
|
|
3917
4106
|
this.request<UpdateUserData, UpdateUserError>({
|
|
3918
4107
|
path: `/user/${userId}`,
|
|
3919
4108
|
method: 'PUT',
|
|
@@ -4191,7 +4380,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4191
4380
|
userId: string,
|
|
4192
4381
|
certProcId: string,
|
|
4193
4382
|
applicationType: string,
|
|
4194
|
-
data:
|
|
4383
|
+
data: InputX6Wo72Dybzj,
|
|
4195
4384
|
params: RequestParams = {}
|
|
4196
4385
|
) =>
|
|
4197
4386
|
this.request<CreateCertificationApplicationLockData, CreateCertificationApplicationLockError>({
|
|
@@ -4255,7 +4444,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4255
4444
|
userId: string,
|
|
4256
4445
|
certProcId: string,
|
|
4257
4446
|
applicationType: string,
|
|
4258
|
-
data:
|
|
4447
|
+
data: InputFvtyzhspxlk,
|
|
4259
4448
|
params: RequestParams = {}
|
|
4260
4449
|
) =>
|
|
4261
4450
|
this.request<CreateCertificationApplicationReviewData, CreateCertificationApplicationReviewError>({
|
|
@@ -4280,7 +4469,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4280
4469
|
userId: string,
|
|
4281
4470
|
certProcId: string,
|
|
4282
4471
|
applicationType: string,
|
|
4283
|
-
data:
|
|
4472
|
+
data: Input5R9Ud8Ixob,
|
|
4284
4473
|
params: RequestParams = {}
|
|
4285
4474
|
) =>
|
|
4286
4475
|
this.request<
|
|
@@ -4304,7 +4493,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4304
4493
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
4305
4494
|
* @secure
|
|
4306
4495
|
*/
|
|
4307
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
4496
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputSwpu5Vwre6, params: RequestParams = {}) =>
|
|
4308
4497
|
this.request<CreateCertificationCourseBatchRedeemData, CreateCertificationCourseBatchRedeemError>({
|
|
4309
4498
|
path: `/user/certification/${certSpecId}/course/batchRedeem`,
|
|
4310
4499
|
method: 'POST',
|
|
@@ -4323,7 +4512,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4323
4512
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
4324
4513
|
* @secure
|
|
4325
4514
|
*/
|
|
4326
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
4515
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputM3Vuv0N0Ko, params: RequestParams = {}) =>
|
|
4327
4516
|
this.request<CreateCertificationCourseBatchInviteData, CreateCertificationCourseBatchInviteError>({
|
|
4328
4517
|
path: `/user/certification/${certSpecId}/course/batchInvite`,
|
|
4329
4518
|
method: 'POST',
|
|
@@ -4402,7 +4591,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4402
4591
|
createCertificationWaive: (
|
|
4403
4592
|
userId: string,
|
|
4404
4593
|
certProcId: string,
|
|
4405
|
-
data:
|
|
4594
|
+
data: Input67Joiiq2Mlf,
|
|
4406
4595
|
params: RequestParams = {}
|
|
4407
4596
|
) =>
|
|
4408
4597
|
this.request<CreateCertificationWaiveData, CreateCertificationWaiveError>({
|
|
@@ -4509,7 +4698,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4509
4698
|
createCertificationTriggerSet: (
|
|
4510
4699
|
userId: string,
|
|
4511
4700
|
certProcId: string,
|
|
4512
|
-
data:
|
|
4701
|
+
data: Input8F9Tnd70S1,
|
|
4513
4702
|
params: RequestParams = {}
|
|
4514
4703
|
) =>
|
|
4515
4704
|
this.request<CreateCertificationTriggerSetData, CreateCertificationTriggerSetError>({
|
|
@@ -4636,7 +4825,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4636
4825
|
certProcId: string,
|
|
4637
4826
|
sourceId: string,
|
|
4638
4827
|
itemVersion: string,
|
|
4639
|
-
data:
|
|
4828
|
+
data: InputDvl5Dcmb96,
|
|
4640
4829
|
params: RequestParams = {}
|
|
4641
4830
|
) =>
|
|
4642
4831
|
this.request<CreateCertificationApplicationItemReviewData, CreateCertificationApplicationItemReviewError>({
|
|
@@ -4681,7 +4870,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4681
4870
|
userId: string,
|
|
4682
4871
|
certProcId: string,
|
|
4683
4872
|
applicationType: string,
|
|
4684
|
-
data:
|
|
4873
|
+
data: InputXgiq6Ooomw,
|
|
4685
4874
|
params: RequestParams = {}
|
|
4686
4875
|
) =>
|
|
4687
4876
|
this.request<CreateCertificationApplicationSubmitData, CreateCertificationApplicationSubmitError>({
|
|
@@ -4707,7 +4896,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4707
4896
|
certProcId: string,
|
|
4708
4897
|
courseId: string,
|
|
4709
4898
|
paId: string,
|
|
4710
|
-
data:
|
|
4899
|
+
data: InputOexr2Qxfau,
|
|
4711
4900
|
params: RequestParams = {}
|
|
4712
4901
|
) =>
|
|
4713
4902
|
this.request<CreateCertificationCoursePendingApprovalData, CreateCertificationCoursePendingApprovalError>({
|
|
@@ -4733,7 +4922,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4733
4922
|
certProcId: string,
|
|
4734
4923
|
courseId: string,
|
|
4735
4924
|
paId: string,
|
|
4736
|
-
data:
|
|
4925
|
+
data: InputZauj6Kl3W2,
|
|
4737
4926
|
params: RequestParams = {}
|
|
4738
4927
|
) =>
|
|
4739
4928
|
this.request<UpdateCertificationCoursePendingApprovalData, UpdateCertificationCoursePendingApprovalError>({
|
|
@@ -4757,7 +4946,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4757
4946
|
createCertificationCourseRedeem: (
|
|
4758
4947
|
userId: string,
|
|
4759
4948
|
certProcId: string,
|
|
4760
|
-
data:
|
|
4949
|
+
data: InputMsk4L6Y8T6,
|
|
4761
4950
|
params: RequestParams = {}
|
|
4762
4951
|
) =>
|
|
4763
4952
|
this.request<CreateCertificationCourseRedeemData, CreateCertificationCourseRedeemError>({
|
|
@@ -4805,7 +4994,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4805
4994
|
userId: string,
|
|
4806
4995
|
certProcId: string,
|
|
4807
4996
|
courseId: string,
|
|
4808
|
-
data:
|
|
4997
|
+
data: InputNbfoc0D7Fok,
|
|
4809
4998
|
params: RequestParams = {}
|
|
4810
4999
|
) =>
|
|
4811
5000
|
this.request<CreateCertificationCourseEndCooldownData, CreateCertificationCourseEndCooldownError>({
|
|
@@ -4830,7 +5019,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4830
5019
|
userId: string,
|
|
4831
5020
|
certProcId: string,
|
|
4832
5021
|
courseId: string,
|
|
4833
|
-
data:
|
|
5022
|
+
data: InputH27O516961,
|
|
4834
5023
|
params: RequestParams = {}
|
|
4835
5024
|
) =>
|
|
4836
5025
|
this.request<CreateCertificationCourseUnlockCourseData, CreateCertificationCourseUnlockCourseError>({
|
|
@@ -4851,7 +5040,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4851
5040
|
* @request POST:/user/{userID}/updateITA
|
|
4852
5041
|
* @secure
|
|
4853
5042
|
*/
|
|
4854
|
-
createUpdateIta: (userId: string, data:
|
|
5043
|
+
createUpdateIta: (userId: string, data: Input1Slvu9Z87P, params: RequestParams = {}) =>
|
|
4855
5044
|
this.request<CreateUpdateItaData, CreateUpdateItaError>({
|
|
4856
5045
|
path: `/user/${userId}/updateITA`,
|
|
4857
5046
|
method: 'POST',
|
|
@@ -4874,7 +5063,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4874
5063
|
userId: string,
|
|
4875
5064
|
certProcId: string,
|
|
4876
5065
|
courseId: string,
|
|
4877
|
-
data:
|
|
5066
|
+
data: Input2V0Cmpfq55G,
|
|
4878
5067
|
params: RequestParams = {}
|
|
4879
5068
|
) =>
|
|
4880
5069
|
this.request<UpdateCertificationCourseOverrideResultData, UpdateCertificationCourseOverrideResultError>({
|
|
@@ -4898,7 +5087,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4898
5087
|
updateCertificationSetDates: (
|
|
4899
5088
|
userId: string,
|
|
4900
5089
|
certProcId: string,
|
|
4901
|
-
data:
|
|
5090
|
+
data: InputL7Diqqlzdq,
|
|
4902
5091
|
params: RequestParams = {}
|
|
4903
5092
|
) =>
|
|
4904
5093
|
this.request<UpdateCertificationSetDatesData, UpdateCertificationSetDatesError>({
|
|
@@ -4967,6 +5156,158 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4967
5156
|
type: ContentType.Json,
|
|
4968
5157
|
...params,
|
|
4969
5158
|
}),
|
|
5159
|
+
|
|
5160
|
+
/**
|
|
5161
|
+
* @description Retrieve all work hours records (proof of experience) for a user.
|
|
5162
|
+
*
|
|
5163
|
+
* @tags WorkHours
|
|
5164
|
+
* @name GetWorkHours
|
|
5165
|
+
* @summary List User Work Hours
|
|
5166
|
+
* @request GET:/user/{userID}/workHours
|
|
5167
|
+
* @secure
|
|
5168
|
+
*/
|
|
5169
|
+
getWorkHours: (userId: string, params: RequestParams = {}) =>
|
|
5170
|
+
this.request<GetWorkHoursData, GetWorkHoursError>({
|
|
5171
|
+
path: `/user/${userId}/workHours`,
|
|
5172
|
+
method: 'GET',
|
|
5173
|
+
secure: true,
|
|
5174
|
+
format: 'json',
|
|
5175
|
+
...params,
|
|
5176
|
+
}),
|
|
5177
|
+
|
|
5178
|
+
/**
|
|
5179
|
+
* @description Retrieve a single work hours record (proof of experience) for a user by its ID.
|
|
5180
|
+
*
|
|
5181
|
+
* @tags WorkHours
|
|
5182
|
+
* @name GetWorkHours2
|
|
5183
|
+
* @summary Get User Work Hours
|
|
5184
|
+
* @request GET:/user/{userID}/workHours/{workHoursID}
|
|
5185
|
+
* @originalName getWorkHours
|
|
5186
|
+
* @duplicate
|
|
5187
|
+
* @secure
|
|
5188
|
+
*/
|
|
5189
|
+
getWorkHours2: (userId: string, workHoursId: string, params: RequestParams = {}) =>
|
|
5190
|
+
this.request<GetWorkHours2Data, GetWorkHours2Error>({
|
|
5191
|
+
path: `/user/${userId}/workHours/${workHoursId}`,
|
|
5192
|
+
method: 'GET',
|
|
5193
|
+
secure: true,
|
|
5194
|
+
format: 'json',
|
|
5195
|
+
...params,
|
|
5196
|
+
}),
|
|
5197
|
+
|
|
5198
|
+
/**
|
|
5199
|
+
* @description Create a new work hours record (proof of experience) for a user. Use "new" as the workHoursID path parameter to create a new entry.
|
|
5200
|
+
*
|
|
5201
|
+
* @tags WorkHours
|
|
5202
|
+
* @name ListWorkHours
|
|
5203
|
+
* @summary Create User Work Hours
|
|
5204
|
+
* @request POST:/user/{userID}/workHours/{workHoursID}
|
|
5205
|
+
* @secure
|
|
5206
|
+
*/
|
|
5207
|
+
listWorkHours: (userId: string, workHoursId: string, data: WorkHoursWrite, params: RequestParams = {}) =>
|
|
5208
|
+
this.request<ListWorkHoursData, ListWorkHoursError>({
|
|
5209
|
+
path: `/user/${userId}/workHours/${workHoursId}`,
|
|
5210
|
+
method: 'POST',
|
|
5211
|
+
body: data,
|
|
5212
|
+
secure: true,
|
|
5213
|
+
type: ContentType.Json,
|
|
5214
|
+
format: 'json',
|
|
5215
|
+
...params,
|
|
5216
|
+
}),
|
|
5217
|
+
|
|
5218
|
+
/**
|
|
5219
|
+
* @description Update an existing work hours record (proof of experience) for a user.
|
|
5220
|
+
*
|
|
5221
|
+
* @tags WorkHours
|
|
5222
|
+
* @name UpdateWorkHours
|
|
5223
|
+
* @summary Update User Work Hours
|
|
5224
|
+
* @request PUT:/user/{userID}/workHours/{workHoursID}
|
|
5225
|
+
* @secure
|
|
5226
|
+
*/
|
|
5227
|
+
updateWorkHours: (userId: string, workHoursId: string, data: WorkHoursWrite, params: RequestParams = {}) =>
|
|
5228
|
+
this.request<UpdateWorkHoursData, UpdateWorkHoursError>({
|
|
5229
|
+
path: `/user/${userId}/workHours/${workHoursId}`,
|
|
5230
|
+
method: 'PUT',
|
|
5231
|
+
body: data,
|
|
5232
|
+
secure: true,
|
|
5233
|
+
type: ContentType.Json,
|
|
5234
|
+
format: 'json',
|
|
5235
|
+
...params,
|
|
5236
|
+
}),
|
|
5237
|
+
|
|
5238
|
+
/**
|
|
5239
|
+
* @description Delete a work hours record (proof of experience) for a user by its ID.
|
|
5240
|
+
*
|
|
5241
|
+
* @tags WorkHours
|
|
5242
|
+
* @name DeleteWorkHours
|
|
5243
|
+
* @summary Delete User Work Hours
|
|
5244
|
+
* @request DELETE:/user/{userID}/workHours/{workHoursID}
|
|
5245
|
+
* @secure
|
|
5246
|
+
*/
|
|
5247
|
+
deleteWorkHours: (userId: string, workHoursId: string, params: RequestParams = {}) =>
|
|
5248
|
+
this.request<DeleteWorkHoursData, DeleteWorkHoursError>({
|
|
5249
|
+
path: `/user/${userId}/workHours/${workHoursId}`,
|
|
5250
|
+
method: 'DELETE',
|
|
5251
|
+
secure: true,
|
|
5252
|
+
...params,
|
|
5253
|
+
}),
|
|
5254
|
+
|
|
5255
|
+
/**
|
|
5256
|
+
* @description This route allows you to create a signed URL to upload a work hours file for a user.
|
|
5257
|
+
*
|
|
5258
|
+
* @tags WorkHours
|
|
5259
|
+
* @name CreateWorkHoursFileSign
|
|
5260
|
+
* @summary Work hours file
|
|
5261
|
+
* @request POST:/user/{userID}/workHours/{workHoursID}/fileSign/{fileID}
|
|
5262
|
+
* @secure
|
|
5263
|
+
*/
|
|
5264
|
+
createWorkHoursFileSign: (
|
|
5265
|
+
{ userId, workHoursId, fileId, ...query }: CreateWorkHoursFileSignParams,
|
|
5266
|
+
params: RequestParams = {}
|
|
5267
|
+
) =>
|
|
5268
|
+
this.request<CreateWorkHoursFileSignData, CreateWorkHoursFileSignError>({
|
|
5269
|
+
path: `/user/${userId}/workHours/${workHoursId}/fileSign/${fileId}`,
|
|
5270
|
+
method: 'POST',
|
|
5271
|
+
query: query,
|
|
5272
|
+
secure: true,
|
|
5273
|
+
format: 'json',
|
|
5274
|
+
...params,
|
|
5275
|
+
}),
|
|
5276
|
+
|
|
5277
|
+
/**
|
|
5278
|
+
* @description Delete a work hours file for a user.
|
|
5279
|
+
*
|
|
5280
|
+
* @tags WorkHours
|
|
5281
|
+
* @name DeleteWorkHoursFileSign
|
|
5282
|
+
* @summary Delete Work Hours File
|
|
5283
|
+
* @request DELETE:/user/{userID}/workHours/{workHoursID}/fileSign/{fileID}
|
|
5284
|
+
* @secure
|
|
5285
|
+
*/
|
|
5286
|
+
deleteWorkHoursFileSign: (userId: string, workHoursId: string, fileId: string, params: RequestParams = {}) =>
|
|
5287
|
+
this.request<DeleteWorkHoursFileSignData, DeleteWorkHoursFileSignError>({
|
|
5288
|
+
path: `/user/${userId}/workHours/${workHoursId}/fileSign/${fileId}`,
|
|
5289
|
+
method: 'DELETE',
|
|
5290
|
+
secure: true,
|
|
5291
|
+
...params,
|
|
5292
|
+
}),
|
|
5293
|
+
|
|
5294
|
+
/**
|
|
5295
|
+
* @description Retrieve a signed URL to download a work hours file for a user.
|
|
5296
|
+
*
|
|
5297
|
+
* @tags WorkHours
|
|
5298
|
+
* @name GetWorkHoursFileSign
|
|
5299
|
+
* @summary Get Work Hours File
|
|
5300
|
+
* @request GET:/user/{userID}/workHours/{workHoursID}/fileSign/{fileID}
|
|
5301
|
+
* @secure
|
|
5302
|
+
*/
|
|
5303
|
+
getWorkHoursFileSign: (userId: string, workHoursId: string, fileId: string, params: RequestParams = {}) =>
|
|
5304
|
+
this.request<GetWorkHoursFileSignData, GetWorkHoursFileSignError>({
|
|
5305
|
+
path: `/user/${userId}/workHours/${workHoursId}/fileSign/${fileId}`,
|
|
5306
|
+
method: 'GET',
|
|
5307
|
+
secure: true,
|
|
5308
|
+
format: 'json',
|
|
5309
|
+
...params,
|
|
5310
|
+
}),
|
|
4970
5311
|
}
|
|
4971
5312
|
users = {
|
|
4972
5313
|
/**
|
|
@@ -4978,7 +5319,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4978
5319
|
* @request POST:/users/certification/{certSpecID}
|
|
4979
5320
|
* @secure
|
|
4980
5321
|
*/
|
|
4981
|
-
createCertification: (certSpecId: string, data:
|
|
5322
|
+
createCertification: (certSpecId: string, data: InputVn7Imocp5P, params: RequestParams = {}) =>
|
|
4982
5323
|
this.request<CreateCertificationResult, CreateCertificationFail>({
|
|
4983
5324
|
path: `/users/certification/${certSpecId}`,
|
|
4984
5325
|
method: 'POST',
|