@ikonintegration/bccsa-program-api 3.0.38 → 3.0.40
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 +471 -93
- package/dist/Api.d.ts +367 -102
- package/dist/Api.js +160 -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 InputPayanh5Rg7 {
|
|
21
21
|
/**
|
|
22
22
|
* Name of the person filling out the contact form
|
|
23
23
|
* @example "John Doe"
|
|
@@ -386,6 +386,64 @@ export type RevokedByID = string
|
|
|
386
386
|
/** Display name of the user who revoked the course */
|
|
387
387
|
export type RevokedByName = string
|
|
388
388
|
|
|
389
|
+
/** Sponsorship approval parameters */
|
|
390
|
+
export interface InputLuf22Qfjwd {
|
|
391
|
+
/**
|
|
392
|
+
* Employer first name
|
|
393
|
+
* @maxLength 255
|
|
394
|
+
* @example "John"
|
|
395
|
+
*/
|
|
396
|
+
firstName?: string
|
|
397
|
+
/**
|
|
398
|
+
* Employer last name
|
|
399
|
+
* @maxLength 255
|
|
400
|
+
* @example "Doe"
|
|
401
|
+
*/
|
|
402
|
+
lastName?: string
|
|
403
|
+
/**
|
|
404
|
+
* Employer title
|
|
405
|
+
* @maxLength 255
|
|
406
|
+
* @example "Safety Manager"
|
|
407
|
+
*/
|
|
408
|
+
title?: string
|
|
409
|
+
/**
|
|
410
|
+
* Employer email address
|
|
411
|
+
* @maxLength 255
|
|
412
|
+
* @example "john.doe@example.com"
|
|
413
|
+
*/
|
|
414
|
+
email?: string
|
|
415
|
+
/**
|
|
416
|
+
* Employer phone number
|
|
417
|
+
* @maxLength 255
|
|
418
|
+
* @example "+1 604 555 0100"
|
|
419
|
+
*/
|
|
420
|
+
phone?: string
|
|
421
|
+
/**
|
|
422
|
+
* Organization name
|
|
423
|
+
* @maxLength 255
|
|
424
|
+
* @example "Acme Construction Ltd."
|
|
425
|
+
*/
|
|
426
|
+
orgName?: string
|
|
427
|
+
/**
|
|
428
|
+
* WorkSafeBC number
|
|
429
|
+
* @maxLength 255
|
|
430
|
+
* @example "123456"
|
|
431
|
+
*/
|
|
432
|
+
worksafeBCNumber?: string
|
|
433
|
+
/**
|
|
434
|
+
* Employee name
|
|
435
|
+
* @maxLength 255
|
|
436
|
+
* @example "Jane Smith"
|
|
437
|
+
*/
|
|
438
|
+
employeeName?: string
|
|
439
|
+
/**
|
|
440
|
+
* Employee title
|
|
441
|
+
* @maxLength 255
|
|
442
|
+
* @example "Labourer"
|
|
443
|
+
*/
|
|
444
|
+
employeeTitle?: string
|
|
445
|
+
}
|
|
446
|
+
|
|
389
447
|
/** Response schema for applications */
|
|
390
448
|
export interface ApplicationResponseSchema {
|
|
391
449
|
applications:
|
|
@@ -570,7 +628,7 @@ export type SponsorshipRemindersSponsor = string[]
|
|
|
570
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. */
|
|
571
629
|
export type RemindersStartedOn = number
|
|
572
630
|
|
|
573
|
-
export interface
|
|
631
|
+
export interface Input7Vmuwipays {
|
|
574
632
|
/**
|
|
575
633
|
* ID of the certification to filter applications by
|
|
576
634
|
* @example "certification123"
|
|
@@ -628,7 +686,7 @@ export interface InputI92Gs480Wi {
|
|
|
628
686
|
ignoreCompletedCertifications?: boolean | null
|
|
629
687
|
}
|
|
630
688
|
|
|
631
|
-
export interface
|
|
689
|
+
export interface Input2Aq4Pyagkd {
|
|
632
690
|
/**
|
|
633
691
|
* ID of the certification to filter applications by
|
|
634
692
|
* @example "certification123"
|
|
@@ -686,7 +744,7 @@ export interface InputRhw4W336M4 {
|
|
|
686
744
|
ignoreCompletedCertifications?: boolean | null
|
|
687
745
|
}
|
|
688
746
|
|
|
689
|
-
export interface
|
|
747
|
+
export interface Input8Klnphf8Bc {
|
|
690
748
|
/**
|
|
691
749
|
* ID of the certification to filter applications by
|
|
692
750
|
* @example "certification123"
|
|
@@ -744,7 +802,7 @@ export interface InputDwl6Jshl2T {
|
|
|
744
802
|
ignoreCompletedCertifications?: boolean | null
|
|
745
803
|
}
|
|
746
804
|
|
|
747
|
-
export interface
|
|
805
|
+
export interface Input3Nox52Otw6 {
|
|
748
806
|
/**
|
|
749
807
|
* The ID of the certificate specifications to be used for the email
|
|
750
808
|
* @example "certSpecsID123"
|
|
@@ -786,7 +844,7 @@ export interface InputAadskx0R66 {
|
|
|
786
844
|
}[]
|
|
787
845
|
}
|
|
788
846
|
|
|
789
|
-
export interface
|
|
847
|
+
export interface Input6Hyaakdeqh {
|
|
790
848
|
/**
|
|
791
849
|
* The ID of the product for which the license is being redeemed
|
|
792
850
|
* @example "productID123"
|
|
@@ -799,7 +857,7 @@ export interface InputFzsxnr61Gz {
|
|
|
799
857
|
sessionID?: string
|
|
800
858
|
}
|
|
801
859
|
|
|
802
|
-
export interface
|
|
860
|
+
export interface Input97Kt0K1U4M {
|
|
803
861
|
/**
|
|
804
862
|
* Search term to filter licenses
|
|
805
863
|
* @example "active"
|
|
@@ -817,7 +875,7 @@ export interface InputWb2Lmb2Fy7 {
|
|
|
817
875
|
sortField?: any
|
|
818
876
|
}
|
|
819
877
|
|
|
820
|
-
export interface
|
|
878
|
+
export interface Input0Spjg5T0Z6L {
|
|
821
879
|
/**
|
|
822
880
|
* Search term to filter licenses
|
|
823
881
|
* @example "active"
|
|
@@ -959,7 +1017,7 @@ export interface SearchPendingApprovalsResponseSchema {
|
|
|
959
1017
|
}[]
|
|
960
1018
|
}
|
|
961
1019
|
|
|
962
|
-
export interface
|
|
1020
|
+
export interface InputP41Mwrllc3J {
|
|
963
1021
|
/**
|
|
964
1022
|
* Start date for the report
|
|
965
1023
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -982,12 +1040,12 @@ export interface Input1Ohda2Wgsh {
|
|
|
982
1040
|
dateType?: string
|
|
983
1041
|
}
|
|
984
1042
|
|
|
985
|
-
export interface
|
|
1043
|
+
export interface InputXoh70L5Ehi {
|
|
986
1044
|
/** List of user IDs to search for in the tenant. */
|
|
987
1045
|
IDs: (string | null)[]
|
|
988
1046
|
}
|
|
989
1047
|
|
|
990
|
-
export interface
|
|
1048
|
+
export interface Input0Vk0Eax6Wa {
|
|
991
1049
|
/** The term to search for in the user profiles. */
|
|
992
1050
|
searchTerm?: string | null
|
|
993
1051
|
/** Filter criteria for the user search. */
|
|
@@ -1028,7 +1086,7 @@ export interface InputRalyzixy0A {
|
|
|
1028
1086
|
}
|
|
1029
1087
|
}
|
|
1030
1088
|
|
|
1031
|
-
export interface
|
|
1089
|
+
export interface InputC8Zwd7Q8U9 {
|
|
1032
1090
|
/** The term to search for in the user profiles. */
|
|
1033
1091
|
searchTerm?: string | null
|
|
1034
1092
|
/** Filter criteria for the user search. */
|
|
@@ -1069,7 +1127,7 @@ export interface InputVll5Y8N7Fs {
|
|
|
1069
1127
|
}
|
|
1070
1128
|
}
|
|
1071
1129
|
|
|
1072
|
-
export interface
|
|
1130
|
+
export interface Output8Atvagu67T {
|
|
1073
1131
|
/** External system ID 2 */
|
|
1074
1132
|
userCount: ExternalID2
|
|
1075
1133
|
transactionID?: string | null
|
|
@@ -1081,7 +1139,7 @@ export type ExternalID2 = number
|
|
|
1081
1139
|
/** This endpoint accepts no request body */
|
|
1082
1140
|
export type DeletePendingApprovalBody = object
|
|
1083
1141
|
|
|
1084
|
-
export interface
|
|
1142
|
+
export interface OutputYasax7Adi6 {
|
|
1085
1143
|
/**
|
|
1086
1144
|
* Signed URL for the course file
|
|
1087
1145
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
@@ -1089,7 +1147,7 @@ export interface OutputXmylm4Chhv {
|
|
|
1089
1147
|
fileURL: string
|
|
1090
1148
|
}
|
|
1091
1149
|
|
|
1092
|
-
export interface
|
|
1150
|
+
export interface OutputEro394Udh7 {
|
|
1093
1151
|
/**
|
|
1094
1152
|
* Amount to be refunded for the cancellation
|
|
1095
1153
|
* @example 0
|
|
@@ -1415,7 +1473,7 @@ export interface CourseResponseEntity {
|
|
|
1415
1473
|
/** Label of the course enrolled (course version) */
|
|
1416
1474
|
export type OnlineCourseLabel = string
|
|
1417
1475
|
|
|
1418
|
-
export interface
|
|
1476
|
+
export interface OutputWxu6Mostsg {
|
|
1419
1477
|
/**
|
|
1420
1478
|
* Signed URL for the course file
|
|
1421
1479
|
* @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"
|
|
@@ -1435,7 +1493,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1435
1493
|
}
|
|
1436
1494
|
|
|
1437
1495
|
/** Application Foreign Fill response type */
|
|
1438
|
-
export interface
|
|
1496
|
+
export interface OutputG6Fp4O6Jqs {
|
|
1439
1497
|
items: {
|
|
1440
1498
|
userID: string
|
|
1441
1499
|
createdOn?: number
|
|
@@ -1675,7 +1733,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1675
1733
|
transactionID?: string | null
|
|
1676
1734
|
}
|
|
1677
1735
|
|
|
1678
|
-
export interface
|
|
1736
|
+
export interface Input6Xov0Uhvug {
|
|
1679
1737
|
issuedOn?: number
|
|
1680
1738
|
expiresOn?: number
|
|
1681
1739
|
fileItems?: {
|
|
@@ -1685,7 +1743,7 @@ export interface InputZnx3Yaudw0L {
|
|
|
1685
1743
|
additionalNotes?: string | null
|
|
1686
1744
|
}
|
|
1687
1745
|
|
|
1688
|
-
export interface
|
|
1746
|
+
export interface InputS2I3Ncfw06I {
|
|
1689
1747
|
/**
|
|
1690
1748
|
* Indicates whether the application is locked
|
|
1691
1749
|
* @example true
|
|
@@ -1693,7 +1751,7 @@ export interface InputE24P17Anqn {
|
|
|
1693
1751
|
isApplicationLocked: boolean
|
|
1694
1752
|
}
|
|
1695
1753
|
|
|
1696
|
-
export interface
|
|
1754
|
+
export interface OutputDvz4Kpu7Qqf {
|
|
1697
1755
|
/**
|
|
1698
1756
|
* Signed URL for the course file
|
|
1699
1757
|
* @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"
|
|
@@ -1701,7 +1759,7 @@ export interface Output42Odz333Xq {
|
|
|
1701
1759
|
fileURL: string
|
|
1702
1760
|
}
|
|
1703
1761
|
|
|
1704
|
-
export interface
|
|
1762
|
+
export interface InputAkthwncsqzg {
|
|
1705
1763
|
/**
|
|
1706
1764
|
* Indicates whether the waiver is approved
|
|
1707
1765
|
* @example true
|
|
@@ -1714,7 +1772,7 @@ export interface InputOke7Fx73Wa {
|
|
|
1714
1772
|
additionalNotes?: string | null
|
|
1715
1773
|
}
|
|
1716
1774
|
|
|
1717
|
-
export interface
|
|
1775
|
+
export interface InputYuieq8467B {
|
|
1718
1776
|
/**
|
|
1719
1777
|
* Optional notes regarding the waiver
|
|
1720
1778
|
* @example "Waiver granted due to special circumstances."
|
|
@@ -1722,7 +1780,7 @@ export interface InputMyxld51Ils {
|
|
|
1722
1780
|
additionalNotes?: string | null
|
|
1723
1781
|
}
|
|
1724
1782
|
|
|
1725
|
-
export interface
|
|
1783
|
+
export interface Input5Sm698V54Kl {
|
|
1726
1784
|
students: {
|
|
1727
1785
|
/**
|
|
1728
1786
|
* User ID of the student to redeem the course for
|
|
@@ -1757,7 +1815,7 @@ export interface Input78Oq3Ogocp {
|
|
|
1757
1815
|
autoEnrolSessionID?: string
|
|
1758
1816
|
}
|
|
1759
1817
|
|
|
1760
|
-
export interface
|
|
1818
|
+
export interface Input00Cup216Sw {
|
|
1761
1819
|
invites: {
|
|
1762
1820
|
/**
|
|
1763
1821
|
* Email address of the user to invite
|
|
@@ -1787,7 +1845,7 @@ export interface InputI19Hnqwxd9 {
|
|
|
1787
1845
|
isReservedSeat: boolean
|
|
1788
1846
|
}
|
|
1789
1847
|
|
|
1790
|
-
export interface
|
|
1848
|
+
export interface InputRiihigs1Zdi {
|
|
1791
1849
|
/**
|
|
1792
1850
|
* Indicates whether to waive the certification process
|
|
1793
1851
|
* @example true
|
|
@@ -1801,7 +1859,7 @@ export interface Input0Rf8Rir2Wi {
|
|
|
1801
1859
|
}
|
|
1802
1860
|
|
|
1803
1861
|
/** Certification move response schema */
|
|
1804
|
-
export interface
|
|
1862
|
+
export interface OutputRt315Aaaee {
|
|
1805
1863
|
errors?: {
|
|
1806
1864
|
status: string
|
|
1807
1865
|
object?: Record<string, any>
|
|
@@ -1810,12 +1868,12 @@ export interface OutputCunolmrmg2 {
|
|
|
1810
1868
|
}
|
|
1811
1869
|
|
|
1812
1870
|
/** Schema for writing a certification trigger check. */
|
|
1813
|
-
export interface
|
|
1871
|
+
export interface Input9S37F7Gzue {
|
|
1814
1872
|
/**
|
|
1815
1873
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1816
1874
|
* @example "CHECKED"
|
|
1817
1875
|
*/
|
|
1818
|
-
value:
|
|
1876
|
+
value: Input9S37F7GzueValueEnum
|
|
1819
1877
|
/**
|
|
1820
1878
|
* List of course IDs that are blocked by this trigger check.
|
|
1821
1879
|
* @example ["course1","course2"]
|
|
@@ -1823,7 +1881,7 @@ export interface InputFsr7Mbfjl2 {
|
|
|
1823
1881
|
blockedCourses?: string[]
|
|
1824
1882
|
}
|
|
1825
1883
|
|
|
1826
|
-
export interface
|
|
1884
|
+
export interface InputCc03755Grj {
|
|
1827
1885
|
/**
|
|
1828
1886
|
* Indicates whether the application item is approved
|
|
1829
1887
|
* @example true
|
|
@@ -1851,7 +1909,7 @@ export interface StudentHistoryRequestSchema {
|
|
|
1851
1909
|
requirements: string[]
|
|
1852
1910
|
}
|
|
1853
1911
|
|
|
1854
|
-
export interface
|
|
1912
|
+
export interface InputQr67F4X9Qz {
|
|
1855
1913
|
/**
|
|
1856
1914
|
* Optional activation key for the application
|
|
1857
1915
|
* @example "AK-123456"
|
|
@@ -1860,7 +1918,7 @@ export interface InputW46Ry9Xsi5 {
|
|
|
1860
1918
|
}
|
|
1861
1919
|
|
|
1862
1920
|
/** Schema for course submission item details post request. */
|
|
1863
|
-
export interface
|
|
1921
|
+
export interface Input1Gepy2Er06 {
|
|
1864
1922
|
/**
|
|
1865
1923
|
* The ID of the file being submitted.
|
|
1866
1924
|
* @example "fileID123"
|
|
@@ -1874,7 +1932,7 @@ export interface Input1Q6Ejcokqh {
|
|
|
1874
1932
|
}
|
|
1875
1933
|
|
|
1876
1934
|
/** Schema for the response to course submission item details post request. */
|
|
1877
|
-
export interface
|
|
1935
|
+
export interface Output1Gepy2Er06 {
|
|
1878
1936
|
submissionItems: {
|
|
1879
1937
|
/**
|
|
1880
1938
|
* The ID of the file being submitted.
|
|
@@ -1890,7 +1948,7 @@ export interface Output1Q6Ejcokqh {
|
|
|
1890
1948
|
}
|
|
1891
1949
|
|
|
1892
1950
|
/** Pending approval submission parameters */
|
|
1893
|
-
export interface
|
|
1951
|
+
export interface Input2Ypeat3Q15H {
|
|
1894
1952
|
/**
|
|
1895
1953
|
* Type of pending approval
|
|
1896
1954
|
* @example "certification"
|
|
@@ -1911,7 +1969,7 @@ export interface InputRxp3Oxn5Tn {
|
|
|
1911
1969
|
}[]
|
|
1912
1970
|
}
|
|
1913
1971
|
|
|
1914
|
-
export interface
|
|
1972
|
+
export interface Input250S74Bjft {
|
|
1915
1973
|
/**
|
|
1916
1974
|
* The ID of the course for which the license is being redeemed
|
|
1917
1975
|
* @example "courseID123"
|
|
@@ -1980,7 +2038,7 @@ export interface InputFpmobr2I5K {
|
|
|
1980
2038
|
}
|
|
1981
2039
|
|
|
1982
2040
|
/** Validate certification move response schema */
|
|
1983
|
-
export interface
|
|
2041
|
+
export interface OutputApyuuj0P1 {
|
|
1984
2042
|
courses: {
|
|
1985
2043
|
name: string
|
|
1986
2044
|
status: string
|
|
@@ -1992,7 +2050,7 @@ export interface Output68Gczuab0M {
|
|
|
1992
2050
|
mustCreateCP: boolean
|
|
1993
2051
|
}
|
|
1994
2052
|
|
|
1995
|
-
export interface
|
|
2053
|
+
export interface InputL2Zy7U6Osi {
|
|
1996
2054
|
/**
|
|
1997
2055
|
* Comments regarding the end of the cooldown period
|
|
1998
2056
|
* @example "Cooldown period ended successfully."
|
|
@@ -2000,7 +2058,7 @@ export interface Input1Z2S5Mvjmj {
|
|
|
2000
2058
|
comments: string
|
|
2001
2059
|
}
|
|
2002
2060
|
|
|
2003
|
-
export interface
|
|
2061
|
+
export interface OutputXz9Iif7Elb {
|
|
2004
2062
|
/**
|
|
2005
2063
|
* Signed URL for the course file
|
|
2006
2064
|
* @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"
|
|
@@ -2008,7 +2066,7 @@ export interface OutputLfhw9J38Sf {
|
|
|
2008
2066
|
fileURL: string
|
|
2009
2067
|
}
|
|
2010
2068
|
|
|
2011
|
-
export interface
|
|
2069
|
+
export interface InputHkz0Gc0Zaj {
|
|
2012
2070
|
/** @example true */
|
|
2013
2071
|
agreedWithCertTerms: boolean
|
|
2014
2072
|
/** @example 1717230000000 */
|
|
@@ -2095,7 +2153,7 @@ export interface Sponsor {
|
|
|
2095
2153
|
title?: Title
|
|
2096
2154
|
}
|
|
2097
2155
|
|
|
2098
|
-
export interface
|
|
2156
|
+
export interface Input09Umpjsbpm {
|
|
2099
2157
|
/**
|
|
2100
2158
|
* Comments regarding the course unlock action
|
|
2101
2159
|
* @example "Course unlocked successfully."
|
|
@@ -2103,7 +2161,7 @@ export interface Input7Jrsau5Uep {
|
|
|
2103
2161
|
comments: string
|
|
2104
2162
|
}
|
|
2105
2163
|
|
|
2106
|
-
export interface
|
|
2164
|
+
export interface Input8Inz421X6C {
|
|
2107
2165
|
/**
|
|
2108
2166
|
* ITA number to update for the user
|
|
2109
2167
|
* @example "ITA123456"
|
|
@@ -2111,7 +2169,7 @@ export interface InputSdhhf07Dy2 {
|
|
|
2111
2169
|
itaNumber: string
|
|
2112
2170
|
}
|
|
2113
2171
|
|
|
2114
|
-
export interface
|
|
2172
|
+
export interface Input5Num6Uwu17K {
|
|
2115
2173
|
/** @example true */
|
|
2116
2174
|
agreedWithCertTerms: boolean
|
|
2117
2175
|
/** @example 1717230000000 */
|
|
@@ -2186,7 +2244,7 @@ export interface InputMgiii85Qor {
|
|
|
2186
2244
|
sponsor?: Sponsor
|
|
2187
2245
|
}
|
|
2188
2246
|
|
|
2189
|
-
export interface
|
|
2247
|
+
export interface InputV0Qo4M776D {
|
|
2190
2248
|
/**
|
|
2191
2249
|
* The grade to override the course result with
|
|
2192
2250
|
* @example "A"
|
|
@@ -2195,7 +2253,7 @@ export interface Input17Tw549Oah {
|
|
|
2195
2253
|
}
|
|
2196
2254
|
|
|
2197
2255
|
/** Pending approval review parameters */
|
|
2198
|
-
export interface
|
|
2256
|
+
export interface InputGzpcnkmsxo {
|
|
2199
2257
|
/**
|
|
2200
2258
|
* Notes provided by the reviewer for the pending approval
|
|
2201
2259
|
* @example "Please review the submitted documents."
|
|
@@ -2216,7 +2274,7 @@ export interface InputRxs18Ly1Jmf {
|
|
|
2216
2274
|
}
|
|
2217
2275
|
|
|
2218
2276
|
/** Schema for overriding course result dates. */
|
|
2219
|
-
export interface
|
|
2277
|
+
export interface InputC1Toblrnow {
|
|
2220
2278
|
/**
|
|
2221
2279
|
* The date when the course result expires, in milliseconds since epoch.
|
|
2222
2280
|
* @example 1735689600000
|
|
@@ -2232,7 +2290,103 @@ export interface InputFgo7Tyrxudl {
|
|
|
2232
2290
|
/** Reset sponsorship request takes no body */
|
|
2233
2291
|
export type ResetSponsorshipBody = object
|
|
2234
2292
|
|
|
2235
|
-
|
|
2293
|
+
/** List of work hours records for a user */
|
|
2294
|
+
export type WorkHoursListResponse = WorkHoursResponseEntity[]
|
|
2295
|
+
|
|
2296
|
+
/** Single work hours object */
|
|
2297
|
+
export interface WorkHoursResponseEntity {
|
|
2298
|
+
/** User who created the record */
|
|
2299
|
+
createdBy?: CreatedBy
|
|
2300
|
+
/** Timestamp when the record was created */
|
|
2301
|
+
createdOn?: CreatedOn
|
|
2302
|
+
/** User who last updated the record */
|
|
2303
|
+
updatedBy?: UpdatedBy
|
|
2304
|
+
/** Timestamp of last update */
|
|
2305
|
+
updatedOn?: UpdatedOn
|
|
2306
|
+
/** Entity identifier for work hours */
|
|
2307
|
+
dbEntity?: DbEntity
|
|
2308
|
+
/** Unique identifier of the work hours record */
|
|
2309
|
+
id: Id
|
|
2310
|
+
/** Tenant ID associated with the work hours record */
|
|
2311
|
+
tenantID: TenantID
|
|
2312
|
+
/** User ID related with this work hours record */
|
|
2313
|
+
userID: UserID
|
|
2314
|
+
/** Number of hours entered for a specific period */
|
|
2315
|
+
hours?: Hours
|
|
2316
|
+
/** Initial date of the work period (timestamp) */
|
|
2317
|
+
initDate: InitDate
|
|
2318
|
+
/** End date of the work period (timestamp) */
|
|
2319
|
+
endDate?: EndDate
|
|
2320
|
+
/** Concrete pump categories the user selected to enter hours */
|
|
2321
|
+
categories?: Categories
|
|
2322
|
+
/** Array of documents that prove the hours worked */
|
|
2323
|
+
attachments?: Attachments
|
|
2324
|
+
}
|
|
2325
|
+
|
|
2326
|
+
/** Number of hours entered for a specific period */
|
|
2327
|
+
export type Hours = number
|
|
2328
|
+
|
|
2329
|
+
/** Initial date of the work period (timestamp) */
|
|
2330
|
+
export type InitDate = number
|
|
2331
|
+
|
|
2332
|
+
/** End date of the work period (timestamp) */
|
|
2333
|
+
export type EndDate = number
|
|
2334
|
+
|
|
2335
|
+
/** Concrete pump categories the user selected to enter hours */
|
|
2336
|
+
export type Categories = string[]
|
|
2337
|
+
|
|
2338
|
+
/** Array of documents that prove the hours worked */
|
|
2339
|
+
export type Attachments = {
|
|
2340
|
+
/** Identifier of the attachment file */
|
|
2341
|
+
fileID: string
|
|
2342
|
+
/** Name of the attachment file */
|
|
2343
|
+
fileName: string
|
|
2344
|
+
}[]
|
|
2345
|
+
|
|
2346
|
+
/** Payload to create or update a work hours record */
|
|
2347
|
+
export interface WorkHoursWrite {
|
|
2348
|
+
/** @example 40 */
|
|
2349
|
+
hours?: number
|
|
2350
|
+
/** @example 1717230000000 */
|
|
2351
|
+
initDate: number
|
|
2352
|
+
/** @example 1717830000000 */
|
|
2353
|
+
endDate?: number
|
|
2354
|
+
/** @example ["boom","line"] */
|
|
2355
|
+
categories?: string[]
|
|
2356
|
+
/** @example [{"fileID":"fileID","fileName":"proof.pdf"}] */
|
|
2357
|
+
attachments?: {
|
|
2358
|
+
/**
|
|
2359
|
+
* @minLength 1
|
|
2360
|
+
* @example "fileID"
|
|
2361
|
+
*/
|
|
2362
|
+
fileID: string
|
|
2363
|
+
/**
|
|
2364
|
+
* @minLength 1
|
|
2365
|
+
* @example "proof.pdf"
|
|
2366
|
+
*/
|
|
2367
|
+
fileName: string
|
|
2368
|
+
}[]
|
|
2369
|
+
}
|
|
2370
|
+
|
|
2371
|
+
/** Work hours file response */
|
|
2372
|
+
export interface OutputEhwsfr213Q {
|
|
2373
|
+
/**
|
|
2374
|
+
* Signed URL for the work hours file
|
|
2375
|
+
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
|
|
2376
|
+
*/
|
|
2377
|
+
fileURL: string
|
|
2378
|
+
}
|
|
2379
|
+
|
|
2380
|
+
/** Work hours file response */
|
|
2381
|
+
export interface OutputK0Lpmp4384 {
|
|
2382
|
+
/**
|
|
2383
|
+
* Signed URL for the work hours file
|
|
2384
|
+
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
|
|
2385
|
+
*/
|
|
2386
|
+
fileURL: string
|
|
2387
|
+
}
|
|
2388
|
+
|
|
2389
|
+
export interface Input3T6Epmw0B5 {
|
|
2236
2390
|
filter: {
|
|
2237
2391
|
from?: number
|
|
2238
2392
|
sortOrder?: string
|
|
@@ -2240,7 +2394,7 @@ export interface InputKtez8C9Ig9F {
|
|
|
2240
2394
|
}
|
|
2241
2395
|
}
|
|
2242
2396
|
|
|
2243
|
-
export interface
|
|
2397
|
+
export interface Output3T6Epmw0B5 {
|
|
2244
2398
|
users: {
|
|
2245
2399
|
firstName: string
|
|
2246
2400
|
lastName: string
|
|
@@ -2266,7 +2420,7 @@ export enum ReportXlsxSchemaContentTypeEnum {
|
|
|
2266
2420
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
2267
2421
|
* @example "CHECKED"
|
|
2268
2422
|
*/
|
|
2269
|
-
export enum
|
|
2423
|
+
export enum Input9S37F7GzueValueEnum {
|
|
2270
2424
|
CHECKED = 'CHECKED',
|
|
2271
2425
|
UNCHECKED = 'UNCHECKED',
|
|
2272
2426
|
NOVALUE = 'NOVALUE',
|
|
@@ -2310,6 +2464,10 @@ export type GetEventsData = any
|
|
|
2310
2464
|
|
|
2311
2465
|
export type GetEventsError = ErrorResponse
|
|
2312
2466
|
|
|
2467
|
+
export type UpdateApproveData = any
|
|
2468
|
+
|
|
2469
|
+
export type UpdateApproveError = ErrorResponse
|
|
2470
|
+
|
|
2313
2471
|
export type DeleteOrgData = any
|
|
2314
2472
|
|
|
2315
2473
|
export type DeleteOrgError = ErrorResponse
|
|
@@ -2424,7 +2582,7 @@ export type CreateReportUsersSimpleData = any
|
|
|
2424
2582
|
|
|
2425
2583
|
export type CreateReportUsersSimpleError = ErrorResponse
|
|
2426
2584
|
|
|
2427
|
-
export type CreateSearchUsersCountData =
|
|
2585
|
+
export type CreateSearchUsersCountData = Output8Atvagu67T
|
|
2428
2586
|
|
|
2429
2587
|
export type CreateSearchUsersCountError = ErrorResponse
|
|
2430
2588
|
|
|
@@ -2472,7 +2630,7 @@ export type DeleteCertificationCourseFileSignData = any
|
|
|
2472
2630
|
|
|
2473
2631
|
export type DeleteCertificationCourseFileSignError = ErrorResponse
|
|
2474
2632
|
|
|
2475
|
-
export type GetCertificationCourseFileSignData =
|
|
2633
|
+
export type GetCertificationCourseFileSignData = OutputWxu6Mostsg
|
|
2476
2634
|
|
|
2477
2635
|
export type GetCertificationCourseFileSignError = ErrorResponse
|
|
2478
2636
|
|
|
@@ -2489,7 +2647,7 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2489
2647
|
fileId: string
|
|
2490
2648
|
}
|
|
2491
2649
|
|
|
2492
|
-
export type CreateCertificationCourseFileSignData =
|
|
2650
|
+
export type CreateCertificationCourseFileSignData = OutputXz9Iif7Elb
|
|
2493
2651
|
|
|
2494
2652
|
export type CreateCertificationCourseFileSignError = ErrorResponse
|
|
2495
2653
|
|
|
@@ -2497,7 +2655,7 @@ export type DeleteCertificationCourseDocumentData = any
|
|
|
2497
2655
|
|
|
2498
2656
|
export type DeleteCertificationCourseDocumentError = ErrorResponse
|
|
2499
2657
|
|
|
2500
|
-
export type CreateCertificationCourseDocumentData =
|
|
2658
|
+
export type CreateCertificationCourseDocumentData = Output1Gepy2Er06
|
|
2501
2659
|
|
|
2502
2660
|
export type CreateCertificationCourseDocumentError = ErrorResponse
|
|
2503
2661
|
|
|
@@ -2529,7 +2687,7 @@ export type DeleteCertificationCourseData = any
|
|
|
2529
2687
|
|
|
2530
2688
|
export type DeleteCertificationCourseError = ErrorResponse
|
|
2531
2689
|
|
|
2532
|
-
export type GetCertificationApplicationItemFileData =
|
|
2690
|
+
export type GetCertificationApplicationItemFileData = OutputYasax7Adi6
|
|
2533
2691
|
|
|
2534
2692
|
export type GetCertificationApplicationItemFileError = ErrorResponse
|
|
2535
2693
|
|
|
@@ -2546,11 +2704,11 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2546
2704
|
fileVersion: string
|
|
2547
2705
|
}
|
|
2548
2706
|
|
|
2549
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2707
|
+
export type CreateCertificationApplicationItemFileData = OutputDvz4Kpu7Qqf
|
|
2550
2708
|
|
|
2551
2709
|
export type CreateCertificationApplicationItemFileError = ErrorResponse
|
|
2552
2710
|
|
|
2553
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2711
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputEro394Udh7
|
|
2554
2712
|
|
|
2555
2713
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse
|
|
2556
2714
|
|
|
@@ -2566,7 +2724,7 @@ export type GetCertificationsExpandedData = UserExpandedCPResponseSchema
|
|
|
2566
2724
|
|
|
2567
2725
|
export type GetCertificationsExpandedError = ErrorResponse
|
|
2568
2726
|
|
|
2569
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2727
|
+
export type GetCertificationApplicationForeignFillData = OutputG6Fp4O6Jqs
|
|
2570
2728
|
|
|
2571
2729
|
export type GetCertificationApplicationForeignFillError = ErrorResponse
|
|
2572
2730
|
|
|
@@ -2634,7 +2792,7 @@ export type CreateCertificationWaiveData = any
|
|
|
2634
2792
|
|
|
2635
2793
|
export type CreateCertificationWaiveError = ErrorResponse
|
|
2636
2794
|
|
|
2637
|
-
export type CreateCertificationMoveData =
|
|
2795
|
+
export type CreateCertificationMoveData = OutputRt315Aaaee
|
|
2638
2796
|
|
|
2639
2797
|
export type CreateCertificationMoveError = ErrorResponse
|
|
2640
2798
|
|
|
@@ -2698,7 +2856,7 @@ export type CreateCertificationCourseRedeemData = any
|
|
|
2698
2856
|
|
|
2699
2857
|
export type CreateCertificationCourseRedeemError = ErrorResponse
|
|
2700
2858
|
|
|
2701
|
-
export type CreateCertificationMoveValidateData =
|
|
2859
|
+
export type CreateCertificationMoveValidateData = OutputApyuuj0P1
|
|
2702
2860
|
|
|
2703
2861
|
export type CreateCertificationMoveValidateError = ErrorResponse
|
|
2704
2862
|
|
|
@@ -2734,7 +2892,50 @@ export type CreateSponsorshipResetData = any
|
|
|
2734
2892
|
|
|
2735
2893
|
export type CreateSponsorshipResetError = ErrorResponse
|
|
2736
2894
|
|
|
2737
|
-
export type
|
|
2895
|
+
export type GetWorkHoursData = WorkHoursListResponse
|
|
2896
|
+
|
|
2897
|
+
export type GetWorkHoursError = ErrorResponse
|
|
2898
|
+
|
|
2899
|
+
export type GetWorkHours2Data = WorkHoursResponseEntity
|
|
2900
|
+
|
|
2901
|
+
export type GetWorkHours2Error = ErrorResponse
|
|
2902
|
+
|
|
2903
|
+
export type ListWorkHoursData = WorkHoursResponseEntity
|
|
2904
|
+
|
|
2905
|
+
export type ListWorkHoursError = ErrorResponse
|
|
2906
|
+
|
|
2907
|
+
export type UpdateWorkHoursData = WorkHoursResponseEntity
|
|
2908
|
+
|
|
2909
|
+
export type UpdateWorkHoursError = ErrorResponse
|
|
2910
|
+
|
|
2911
|
+
export type DeleteWorkHoursData = any
|
|
2912
|
+
|
|
2913
|
+
export type DeleteWorkHoursError = ErrorResponse
|
|
2914
|
+
|
|
2915
|
+
export interface CreateWorkHoursFileSignParams {
|
|
2916
|
+
/** @example "pdf" */
|
|
2917
|
+
fileType: string
|
|
2918
|
+
/** @example "userID" */
|
|
2919
|
+
userId: string
|
|
2920
|
+
/** @example "workHoursID" */
|
|
2921
|
+
workHoursId: string
|
|
2922
|
+
/** @example "fileID" */
|
|
2923
|
+
fileId: string
|
|
2924
|
+
}
|
|
2925
|
+
|
|
2926
|
+
export type CreateWorkHoursFileSignData = OutputEhwsfr213Q
|
|
2927
|
+
|
|
2928
|
+
export type CreateWorkHoursFileSignError = ErrorResponse
|
|
2929
|
+
|
|
2930
|
+
export type DeleteWorkHoursFileSignData = any
|
|
2931
|
+
|
|
2932
|
+
export type DeleteWorkHoursFileSignError = ErrorResponse
|
|
2933
|
+
|
|
2934
|
+
export type GetWorkHoursFileSignData = OutputK0Lpmp4384
|
|
2935
|
+
|
|
2936
|
+
export type GetWorkHoursFileSignError = ErrorResponse
|
|
2937
|
+
|
|
2938
|
+
export type CreateCertificationResult = Output3T6Epmw0B5
|
|
2738
2939
|
|
|
2739
2940
|
export type CreateCertificationFail = ErrorResponse
|
|
2740
2941
|
|
|
@@ -2880,7 +3081,7 @@ export class HttpClient<SecurityDataType = unknown> {
|
|
|
2880
3081
|
|
|
2881
3082
|
/**
|
|
2882
3083
|
* @title BCCSA Program API
|
|
2883
|
-
* @version 3.0.
|
|
3084
|
+
* @version 3.0.40
|
|
2884
3085
|
* @baseUrl http://localhost:8080
|
|
2885
3086
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2886
3087
|
*/
|
|
@@ -2895,7 +3096,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
2895
3096
|
* @request POST:/contactUs
|
|
2896
3097
|
* @secure
|
|
2897
3098
|
*/
|
|
2898
|
-
listContactUs: (data:
|
|
3099
|
+
listContactUs: (data: InputPayanh5Rg7, params: RequestParams = {}) =>
|
|
2899
3100
|
this.request<ListContactUsData, ListContactUsError>({
|
|
2900
3101
|
path: `/contactUs`,
|
|
2901
3102
|
method: 'POST',
|
|
@@ -2960,6 +3161,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
2960
3161
|
...params,
|
|
2961
3162
|
}),
|
|
2962
3163
|
}
|
|
3164
|
+
sponsorship = {
|
|
3165
|
+
/**
|
|
3166
|
+
* @description Public endpoint that approves a pending sponsorship (attestation) request. The employer-provided details are recorded as approval notes, the request is marked approved by the system, and the student is notified by email.
|
|
3167
|
+
*
|
|
3168
|
+
* @tags Sponsorship
|
|
3169
|
+
* @name UpdateApprove
|
|
3170
|
+
* @summary Approve Sponsorship Request
|
|
3171
|
+
* @request PUT:/sponsorship/approve/{paID}
|
|
3172
|
+
* @secure
|
|
3173
|
+
*/
|
|
3174
|
+
updateApprove: (paId: string, data: InputLuf22Qfjwd, params: RequestParams = {}) =>
|
|
3175
|
+
this.request<UpdateApproveData, UpdateApproveError>({
|
|
3176
|
+
path: `/sponsorship/approve/${paId}`,
|
|
3177
|
+
method: 'PUT',
|
|
3178
|
+
body: data,
|
|
3179
|
+
secure: true,
|
|
3180
|
+
type: ContentType.Json,
|
|
3181
|
+
...params,
|
|
3182
|
+
}),
|
|
3183
|
+
}
|
|
2963
3184
|
tenant = {
|
|
2964
3185
|
/**
|
|
2965
3186
|
* @description Delete bridge
|
|
@@ -3076,7 +3297,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3076
3297
|
* @request POST:/tenant/report/applicationExport
|
|
3077
3298
|
* @secure
|
|
3078
3299
|
*/
|
|
3079
|
-
createReportApplicationExport: (data:
|
|
3300
|
+
createReportApplicationExport: (data: Input7Vmuwipays, params: RequestParams = {}) =>
|
|
3080
3301
|
this.request<CreateReportApplicationExportData, CreateReportApplicationExportError>({
|
|
3081
3302
|
path: `/tenant/report/applicationExport`,
|
|
3082
3303
|
method: 'POST',
|
|
@@ -3095,7 +3316,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3095
3316
|
* @request POST:/tenant/report/applicationStatus
|
|
3096
3317
|
* @secure
|
|
3097
3318
|
*/
|
|
3098
|
-
listReportApplicationStatus: (data:
|
|
3319
|
+
listReportApplicationStatus: (data: Input2Aq4Pyagkd, params: RequestParams = {}) =>
|
|
3099
3320
|
this.request<ListReportApplicationStatusData, ListReportApplicationStatusError>({
|
|
3100
3321
|
path: `/tenant/report/applicationStatus`,
|
|
3101
3322
|
method: 'POST',
|
|
@@ -3114,7 +3335,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3114
3335
|
* @request POST:/tenant/report/applicationsReport
|
|
3115
3336
|
* @secure
|
|
3116
3337
|
*/
|
|
3117
|
-
createReportApplicationsReport: (data:
|
|
3338
|
+
createReportApplicationsReport: (data: Input8Klnphf8Bc, params: RequestParams = {}) =>
|
|
3118
3339
|
this.request<CreateReportApplicationsReportData, CreateReportApplicationsReportError>({
|
|
3119
3340
|
path: `/tenant/report/applicationsReport`,
|
|
3120
3341
|
method: 'POST',
|
|
@@ -3133,7 +3354,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3133
3354
|
* @request POST:/tenant/certificates/email
|
|
3134
3355
|
* @secure
|
|
3135
3356
|
*/
|
|
3136
|
-
createCertificatesEmail: (data:
|
|
3357
|
+
createCertificatesEmail: (data: Input3Nox52Otw6, params: RequestParams = {}) =>
|
|
3137
3358
|
this.request<CreateCertificatesEmailData, CreateCertificatesEmailError>({
|
|
3138
3359
|
path: `/tenant/certificates/email`,
|
|
3139
3360
|
method: 'POST',
|
|
@@ -3191,7 +3412,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3191
3412
|
* @request POST:/tenant/license/redeem/{userID}
|
|
3192
3413
|
* @secure
|
|
3193
3414
|
*/
|
|
3194
|
-
createLicenseRedeem: (userId: string, data:
|
|
3415
|
+
createLicenseRedeem: (userId: string, data: Input6Hyaakdeqh, params: RequestParams = {}) =>
|
|
3195
3416
|
this.request<CreateLicenseRedeemData, CreateLicenseRedeemError>({
|
|
3196
3417
|
path: `/tenant/license/redeem/${userId}`,
|
|
3197
3418
|
method: 'POST',
|
|
@@ -3210,7 +3431,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3210
3431
|
* @request POST:/tenant/report/orglicenses/
|
|
3211
3432
|
* @secure
|
|
3212
3433
|
*/
|
|
3213
|
-
listReportOrglicenses: (data:
|
|
3434
|
+
listReportOrglicenses: (data: Input97Kt0K1U4M, params: RequestParams = {}) =>
|
|
3214
3435
|
this.request<ListReportOrglicensesData, ListReportOrglicensesError>({
|
|
3215
3436
|
path: `/tenant/report/orglicenses/`,
|
|
3216
3437
|
method: 'POST',
|
|
@@ -3229,7 +3450,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3229
3450
|
* @request POST:/tenant/report/orglicenses/preview
|
|
3230
3451
|
* @secure
|
|
3231
3452
|
*/
|
|
3232
|
-
createReportOrglicensesPreview: (data:
|
|
3453
|
+
createReportOrglicensesPreview: (data: Input0Spjg5T0Z6L, params: RequestParams = {}) =>
|
|
3233
3454
|
this.request<CreateReportOrglicensesPreviewData, CreateReportOrglicensesPreviewError>({
|
|
3234
3455
|
path: `/tenant/report/orglicenses/preview`,
|
|
3235
3456
|
method: 'POST',
|
|
@@ -3308,7 +3529,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3308
3529
|
* @request POST:/tenant/report/users/advanced
|
|
3309
3530
|
* @secure
|
|
3310
3531
|
*/
|
|
3311
|
-
createReportUsersAdvanced: (data:
|
|
3532
|
+
createReportUsersAdvanced: (data: InputP41Mwrllc3J, params: RequestParams = {}) =>
|
|
3312
3533
|
this.request<CreateReportUsersAdvancedData, CreateReportUsersAdvancedError>({
|
|
3313
3534
|
path: `/tenant/report/users/advanced`,
|
|
3314
3535
|
method: 'POST',
|
|
@@ -3327,7 +3548,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3327
3548
|
* @request POST:/tenant/search/users/ids
|
|
3328
3549
|
* @secure
|
|
3329
3550
|
*/
|
|
3330
|
-
listSearchUsersIds: (data:
|
|
3551
|
+
listSearchUsersIds: (data: InputXoh70L5Ehi, params: RequestParams = {}) =>
|
|
3331
3552
|
this.request<ListSearchUsersIdsData, ListSearchUsersIdsError>({
|
|
3332
3553
|
path: `/tenant/search/users/ids`,
|
|
3333
3554
|
method: 'POST',
|
|
@@ -3346,7 +3567,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3346
3567
|
* @request POST:/tenant/search/users/term
|
|
3347
3568
|
* @secure
|
|
3348
3569
|
*/
|
|
3349
|
-
createSearchUsersTerm: (data:
|
|
3570
|
+
createSearchUsersTerm: (data: Input0Vk0Eax6Wa, params: RequestParams = {}) =>
|
|
3350
3571
|
this.request<CreateSearchUsersTermData, CreateSearchUsersTermError>({
|
|
3351
3572
|
path: `/tenant/search/users/term`,
|
|
3352
3573
|
method: 'POST',
|
|
@@ -3365,7 +3586,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3365
3586
|
* @request POST:/tenant/report/users/simple
|
|
3366
3587
|
* @secure
|
|
3367
3588
|
*/
|
|
3368
|
-
createReportUsersSimple: (data:
|
|
3589
|
+
createReportUsersSimple: (data: InputC8Zwd7Q8U9, params: RequestParams = {}) =>
|
|
3369
3590
|
this.request<CreateReportUsersSimpleData, CreateReportUsersSimpleError>({
|
|
3370
3591
|
path: `/tenant/report/users/simple`,
|
|
3371
3592
|
method: 'POST',
|
|
@@ -3453,7 +3674,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3453
3674
|
certProcId: string,
|
|
3454
3675
|
applicationType: string,
|
|
3455
3676
|
sourceId: string,
|
|
3456
|
-
data:
|
|
3677
|
+
data: Input6Xov0Uhvug,
|
|
3457
3678
|
params: RequestParams = {}
|
|
3458
3679
|
) =>
|
|
3459
3680
|
this.request<CreateCertificationApplicationItemData, CreateCertificationApplicationItemError>({
|
|
@@ -3713,7 +3934,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3713
3934
|
certProcId: string,
|
|
3714
3935
|
courseId: string,
|
|
3715
3936
|
fileId: string,
|
|
3716
|
-
data:
|
|
3937
|
+
data: Input1Gepy2Er06,
|
|
3717
3938
|
params: RequestParams = {}
|
|
3718
3939
|
) =>
|
|
3719
3940
|
this.request<CreateCertificationCourseDocumentData, CreateCertificationCourseDocumentError>({
|
|
@@ -3812,7 +4033,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3812
4033
|
* @request POST:/user/{userID}
|
|
3813
4034
|
* @secure
|
|
3814
4035
|
*/
|
|
3815
|
-
createUser: (userId: string, data:
|
|
4036
|
+
createUser: (userId: string, data: InputHkz0Gc0Zaj, params: RequestParams = {}) =>
|
|
3816
4037
|
this.request<CreateUserData, CreateUserError>({
|
|
3817
4038
|
path: `/user/${userId}`,
|
|
3818
4039
|
method: 'POST',
|
|
@@ -3831,7 +4052,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
3831
4052
|
* @request PUT:/user/{userID}
|
|
3832
4053
|
* @secure
|
|
3833
4054
|
*/
|
|
3834
|
-
updateUser: (userId: string, data:
|
|
4055
|
+
updateUser: (userId: string, data: Input5Num6Uwu17K, params: RequestParams = {}) =>
|
|
3835
4056
|
this.request<UpdateUserData, UpdateUserError>({
|
|
3836
4057
|
path: `/user/${userId}`,
|
|
3837
4058
|
method: 'PUT',
|
|
@@ -4109,7 +4330,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4109
4330
|
userId: string,
|
|
4110
4331
|
certProcId: string,
|
|
4111
4332
|
applicationType: string,
|
|
4112
|
-
data:
|
|
4333
|
+
data: InputS2I3Ncfw06I,
|
|
4113
4334
|
params: RequestParams = {}
|
|
4114
4335
|
) =>
|
|
4115
4336
|
this.request<CreateCertificationApplicationLockData, CreateCertificationApplicationLockError>({
|
|
@@ -4173,7 +4394,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4173
4394
|
userId: string,
|
|
4174
4395
|
certProcId: string,
|
|
4175
4396
|
applicationType: string,
|
|
4176
|
-
data:
|
|
4397
|
+
data: InputAkthwncsqzg,
|
|
4177
4398
|
params: RequestParams = {}
|
|
4178
4399
|
) =>
|
|
4179
4400
|
this.request<CreateCertificationApplicationReviewData, CreateCertificationApplicationReviewError>({
|
|
@@ -4198,7 +4419,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4198
4419
|
userId: string,
|
|
4199
4420
|
certProcId: string,
|
|
4200
4421
|
applicationType: string,
|
|
4201
|
-
data:
|
|
4422
|
+
data: InputYuieq8467B,
|
|
4202
4423
|
params: RequestParams = {}
|
|
4203
4424
|
) =>
|
|
4204
4425
|
this.request<
|
|
@@ -4222,7 +4443,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4222
4443
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
4223
4444
|
* @secure
|
|
4224
4445
|
*/
|
|
4225
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
4446
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: Input5Sm698V54Kl, params: RequestParams = {}) =>
|
|
4226
4447
|
this.request<CreateCertificationCourseBatchRedeemData, CreateCertificationCourseBatchRedeemError>({
|
|
4227
4448
|
path: `/user/certification/${certSpecId}/course/batchRedeem`,
|
|
4228
4449
|
method: 'POST',
|
|
@@ -4241,7 +4462,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4241
4462
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
4242
4463
|
* @secure
|
|
4243
4464
|
*/
|
|
4244
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
4465
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: Input00Cup216Sw, params: RequestParams = {}) =>
|
|
4245
4466
|
this.request<CreateCertificationCourseBatchInviteData, CreateCertificationCourseBatchInviteError>({
|
|
4246
4467
|
path: `/user/certification/${certSpecId}/course/batchInvite`,
|
|
4247
4468
|
method: 'POST',
|
|
@@ -4317,7 +4538,12 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4317
4538
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
4318
4539
|
* @secure
|
|
4319
4540
|
*/
|
|
4320
|
-
createCertificationWaive: (
|
|
4541
|
+
createCertificationWaive: (
|
|
4542
|
+
userId: string,
|
|
4543
|
+
certProcId: string,
|
|
4544
|
+
data: InputRiihigs1Zdi,
|
|
4545
|
+
params: RequestParams = {}
|
|
4546
|
+
) =>
|
|
4321
4547
|
this.request<CreateCertificationWaiveData, CreateCertificationWaiveError>({
|
|
4322
4548
|
path: `/user/${userId}/certification/${certProcId}/waive`,
|
|
4323
4549
|
method: 'POST',
|
|
@@ -4422,7 +4648,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4422
4648
|
createCertificationTriggerSet: (
|
|
4423
4649
|
userId: string,
|
|
4424
4650
|
certProcId: string,
|
|
4425
|
-
data:
|
|
4651
|
+
data: Input9S37F7Gzue,
|
|
4426
4652
|
params: RequestParams = {}
|
|
4427
4653
|
) =>
|
|
4428
4654
|
this.request<CreateCertificationTriggerSetData, CreateCertificationTriggerSetError>({
|
|
@@ -4549,7 +4775,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4549
4775
|
certProcId: string,
|
|
4550
4776
|
sourceId: string,
|
|
4551
4777
|
itemVersion: string,
|
|
4552
|
-
data:
|
|
4778
|
+
data: InputCc03755Grj,
|
|
4553
4779
|
params: RequestParams = {}
|
|
4554
4780
|
) =>
|
|
4555
4781
|
this.request<CreateCertificationApplicationItemReviewData, CreateCertificationApplicationItemReviewError>({
|
|
@@ -4594,7 +4820,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4594
4820
|
userId: string,
|
|
4595
4821
|
certProcId: string,
|
|
4596
4822
|
applicationType: string,
|
|
4597
|
-
data:
|
|
4823
|
+
data: InputQr67F4X9Qz,
|
|
4598
4824
|
params: RequestParams = {}
|
|
4599
4825
|
) =>
|
|
4600
4826
|
this.request<CreateCertificationApplicationSubmitData, CreateCertificationApplicationSubmitError>({
|
|
@@ -4620,7 +4846,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4620
4846
|
certProcId: string,
|
|
4621
4847
|
courseId: string,
|
|
4622
4848
|
paId: string,
|
|
4623
|
-
data:
|
|
4849
|
+
data: Input2Ypeat3Q15H,
|
|
4624
4850
|
params: RequestParams = {}
|
|
4625
4851
|
) =>
|
|
4626
4852
|
this.request<CreateCertificationCoursePendingApprovalData, CreateCertificationCoursePendingApprovalError>({
|
|
@@ -4646,7 +4872,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4646
4872
|
certProcId: string,
|
|
4647
4873
|
courseId: string,
|
|
4648
4874
|
paId: string,
|
|
4649
|
-
data:
|
|
4875
|
+
data: InputGzpcnkmsxo,
|
|
4650
4876
|
params: RequestParams = {}
|
|
4651
4877
|
) =>
|
|
4652
4878
|
this.request<UpdateCertificationCoursePendingApprovalData, UpdateCertificationCoursePendingApprovalError>({
|
|
@@ -4670,7 +4896,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4670
4896
|
createCertificationCourseRedeem: (
|
|
4671
4897
|
userId: string,
|
|
4672
4898
|
certProcId: string,
|
|
4673
|
-
data:
|
|
4899
|
+
data: Input250S74Bjft,
|
|
4674
4900
|
params: RequestParams = {}
|
|
4675
4901
|
) =>
|
|
4676
4902
|
this.request<CreateCertificationCourseRedeemData, CreateCertificationCourseRedeemError>({
|
|
@@ -4718,7 +4944,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4718
4944
|
userId: string,
|
|
4719
4945
|
certProcId: string,
|
|
4720
4946
|
courseId: string,
|
|
4721
|
-
data:
|
|
4947
|
+
data: InputL2Zy7U6Osi,
|
|
4722
4948
|
params: RequestParams = {}
|
|
4723
4949
|
) =>
|
|
4724
4950
|
this.request<CreateCertificationCourseEndCooldownData, CreateCertificationCourseEndCooldownError>({
|
|
@@ -4743,7 +4969,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4743
4969
|
userId: string,
|
|
4744
4970
|
certProcId: string,
|
|
4745
4971
|
courseId: string,
|
|
4746
|
-
data:
|
|
4972
|
+
data: Input09Umpjsbpm,
|
|
4747
4973
|
params: RequestParams = {}
|
|
4748
4974
|
) =>
|
|
4749
4975
|
this.request<CreateCertificationCourseUnlockCourseData, CreateCertificationCourseUnlockCourseError>({
|
|
@@ -4764,7 +4990,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4764
4990
|
* @request POST:/user/{userID}/updateITA
|
|
4765
4991
|
* @secure
|
|
4766
4992
|
*/
|
|
4767
|
-
createUpdateIta: (userId: string, data:
|
|
4993
|
+
createUpdateIta: (userId: string, data: Input8Inz421X6C, params: RequestParams = {}) =>
|
|
4768
4994
|
this.request<CreateUpdateItaData, CreateUpdateItaError>({
|
|
4769
4995
|
path: `/user/${userId}/updateITA`,
|
|
4770
4996
|
method: 'POST',
|
|
@@ -4787,7 +5013,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4787
5013
|
userId: string,
|
|
4788
5014
|
certProcId: string,
|
|
4789
5015
|
courseId: string,
|
|
4790
|
-
data:
|
|
5016
|
+
data: InputV0Qo4M776D,
|
|
4791
5017
|
params: RequestParams = {}
|
|
4792
5018
|
) =>
|
|
4793
5019
|
this.request<UpdateCertificationCourseOverrideResultData, UpdateCertificationCourseOverrideResultError>({
|
|
@@ -4811,7 +5037,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4811
5037
|
updateCertificationSetDates: (
|
|
4812
5038
|
userId: string,
|
|
4813
5039
|
certProcId: string,
|
|
4814
|
-
data:
|
|
5040
|
+
data: InputC1Toblrnow,
|
|
4815
5041
|
params: RequestParams = {}
|
|
4816
5042
|
) =>
|
|
4817
5043
|
this.request<UpdateCertificationSetDatesData, UpdateCertificationSetDatesError>({
|
|
@@ -4880,6 +5106,158 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4880
5106
|
type: ContentType.Json,
|
|
4881
5107
|
...params,
|
|
4882
5108
|
}),
|
|
5109
|
+
|
|
5110
|
+
/**
|
|
5111
|
+
* @description Retrieve all work hours records (proof of experience) for a user.
|
|
5112
|
+
*
|
|
5113
|
+
* @tags WorkHours
|
|
5114
|
+
* @name GetWorkHours
|
|
5115
|
+
* @summary List User Work Hours
|
|
5116
|
+
* @request GET:/user/{userID}/workHours
|
|
5117
|
+
* @secure
|
|
5118
|
+
*/
|
|
5119
|
+
getWorkHours: (userId: string, params: RequestParams = {}) =>
|
|
5120
|
+
this.request<GetWorkHoursData, GetWorkHoursError>({
|
|
5121
|
+
path: `/user/${userId}/workHours`,
|
|
5122
|
+
method: 'GET',
|
|
5123
|
+
secure: true,
|
|
5124
|
+
format: 'json',
|
|
5125
|
+
...params,
|
|
5126
|
+
}),
|
|
5127
|
+
|
|
5128
|
+
/**
|
|
5129
|
+
* @description Retrieve a single work hours record (proof of experience) for a user by its ID.
|
|
5130
|
+
*
|
|
5131
|
+
* @tags WorkHours
|
|
5132
|
+
* @name GetWorkHours2
|
|
5133
|
+
* @summary Get User Work Hours
|
|
5134
|
+
* @request GET:/user/{userID}/workHours/{workHoursID}
|
|
5135
|
+
* @originalName getWorkHours
|
|
5136
|
+
* @duplicate
|
|
5137
|
+
* @secure
|
|
5138
|
+
*/
|
|
5139
|
+
getWorkHours2: (userId: string, workHoursId: string, params: RequestParams = {}) =>
|
|
5140
|
+
this.request<GetWorkHours2Data, GetWorkHours2Error>({
|
|
5141
|
+
path: `/user/${userId}/workHours/${workHoursId}`,
|
|
5142
|
+
method: 'GET',
|
|
5143
|
+
secure: true,
|
|
5144
|
+
format: 'json',
|
|
5145
|
+
...params,
|
|
5146
|
+
}),
|
|
5147
|
+
|
|
5148
|
+
/**
|
|
5149
|
+
* @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.
|
|
5150
|
+
*
|
|
5151
|
+
* @tags WorkHours
|
|
5152
|
+
* @name ListWorkHours
|
|
5153
|
+
* @summary Create User Work Hours
|
|
5154
|
+
* @request POST:/user/{userID}/workHours/{workHoursID}
|
|
5155
|
+
* @secure
|
|
5156
|
+
*/
|
|
5157
|
+
listWorkHours: (userId: string, workHoursId: string, data: WorkHoursWrite, params: RequestParams = {}) =>
|
|
5158
|
+
this.request<ListWorkHoursData, ListWorkHoursError>({
|
|
5159
|
+
path: `/user/${userId}/workHours/${workHoursId}`,
|
|
5160
|
+
method: 'POST',
|
|
5161
|
+
body: data,
|
|
5162
|
+
secure: true,
|
|
5163
|
+
type: ContentType.Json,
|
|
5164
|
+
format: 'json',
|
|
5165
|
+
...params,
|
|
5166
|
+
}),
|
|
5167
|
+
|
|
5168
|
+
/**
|
|
5169
|
+
* @description Update an existing work hours record (proof of experience) for a user.
|
|
5170
|
+
*
|
|
5171
|
+
* @tags WorkHours
|
|
5172
|
+
* @name UpdateWorkHours
|
|
5173
|
+
* @summary Update User Work Hours
|
|
5174
|
+
* @request PUT:/user/{userID}/workHours/{workHoursID}
|
|
5175
|
+
* @secure
|
|
5176
|
+
*/
|
|
5177
|
+
updateWorkHours: (userId: string, workHoursId: string, data: WorkHoursWrite, params: RequestParams = {}) =>
|
|
5178
|
+
this.request<UpdateWorkHoursData, UpdateWorkHoursError>({
|
|
5179
|
+
path: `/user/${userId}/workHours/${workHoursId}`,
|
|
5180
|
+
method: 'PUT',
|
|
5181
|
+
body: data,
|
|
5182
|
+
secure: true,
|
|
5183
|
+
type: ContentType.Json,
|
|
5184
|
+
format: 'json',
|
|
5185
|
+
...params,
|
|
5186
|
+
}),
|
|
5187
|
+
|
|
5188
|
+
/**
|
|
5189
|
+
* @description Delete a work hours record (proof of experience) for a user by its ID.
|
|
5190
|
+
*
|
|
5191
|
+
* @tags WorkHours
|
|
5192
|
+
* @name DeleteWorkHours
|
|
5193
|
+
* @summary Delete User Work Hours
|
|
5194
|
+
* @request DELETE:/user/{userID}/workHours/{workHoursID}
|
|
5195
|
+
* @secure
|
|
5196
|
+
*/
|
|
5197
|
+
deleteWorkHours: (userId: string, workHoursId: string, params: RequestParams = {}) =>
|
|
5198
|
+
this.request<DeleteWorkHoursData, DeleteWorkHoursError>({
|
|
5199
|
+
path: `/user/${userId}/workHours/${workHoursId}`,
|
|
5200
|
+
method: 'DELETE',
|
|
5201
|
+
secure: true,
|
|
5202
|
+
...params,
|
|
5203
|
+
}),
|
|
5204
|
+
|
|
5205
|
+
/**
|
|
5206
|
+
* @description This route allows you to create a signed URL to upload a work hours file for a user.
|
|
5207
|
+
*
|
|
5208
|
+
* @tags WorkHours
|
|
5209
|
+
* @name CreateWorkHoursFileSign
|
|
5210
|
+
* @summary Work hours file
|
|
5211
|
+
* @request POST:/user/{userID}/workHours/{workHoursID}/fileSign/{fileID}
|
|
5212
|
+
* @secure
|
|
5213
|
+
*/
|
|
5214
|
+
createWorkHoursFileSign: (
|
|
5215
|
+
{ userId, workHoursId, fileId, ...query }: CreateWorkHoursFileSignParams,
|
|
5216
|
+
params: RequestParams = {}
|
|
5217
|
+
) =>
|
|
5218
|
+
this.request<CreateWorkHoursFileSignData, CreateWorkHoursFileSignError>({
|
|
5219
|
+
path: `/user/${userId}/workHours/${workHoursId}/fileSign/${fileId}`,
|
|
5220
|
+
method: 'POST',
|
|
5221
|
+
query: query,
|
|
5222
|
+
secure: true,
|
|
5223
|
+
format: 'json',
|
|
5224
|
+
...params,
|
|
5225
|
+
}),
|
|
5226
|
+
|
|
5227
|
+
/**
|
|
5228
|
+
* @description Delete a work hours file for a user.
|
|
5229
|
+
*
|
|
5230
|
+
* @tags WorkHours
|
|
5231
|
+
* @name DeleteWorkHoursFileSign
|
|
5232
|
+
* @summary Delete Work Hours File
|
|
5233
|
+
* @request DELETE:/user/{userID}/workHours/{workHoursID}/fileSign/{fileID}
|
|
5234
|
+
* @secure
|
|
5235
|
+
*/
|
|
5236
|
+
deleteWorkHoursFileSign: (userId: string, workHoursId: string, fileId: string, params: RequestParams = {}) =>
|
|
5237
|
+
this.request<DeleteWorkHoursFileSignData, DeleteWorkHoursFileSignError>({
|
|
5238
|
+
path: `/user/${userId}/workHours/${workHoursId}/fileSign/${fileId}`,
|
|
5239
|
+
method: 'DELETE',
|
|
5240
|
+
secure: true,
|
|
5241
|
+
...params,
|
|
5242
|
+
}),
|
|
5243
|
+
|
|
5244
|
+
/**
|
|
5245
|
+
* @description Retrieve a signed URL to download a work hours file for a user.
|
|
5246
|
+
*
|
|
5247
|
+
* @tags WorkHours
|
|
5248
|
+
* @name GetWorkHoursFileSign
|
|
5249
|
+
* @summary Get Work Hours File
|
|
5250
|
+
* @request GET:/user/{userID}/workHours/{workHoursID}/fileSign/{fileID}
|
|
5251
|
+
* @secure
|
|
5252
|
+
*/
|
|
5253
|
+
getWorkHoursFileSign: (userId: string, workHoursId: string, fileId: string, params: RequestParams = {}) =>
|
|
5254
|
+
this.request<GetWorkHoursFileSignData, GetWorkHoursFileSignError>({
|
|
5255
|
+
path: `/user/${userId}/workHours/${workHoursId}/fileSign/${fileId}`,
|
|
5256
|
+
method: 'GET',
|
|
5257
|
+
secure: true,
|
|
5258
|
+
format: 'json',
|
|
5259
|
+
...params,
|
|
5260
|
+
}),
|
|
4883
5261
|
}
|
|
4884
5262
|
users = {
|
|
4885
5263
|
/**
|
|
@@ -4891,7 +5269,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
4891
5269
|
* @request POST:/users/certification/{certSpecID}
|
|
4892
5270
|
* @secure
|
|
4893
5271
|
*/
|
|
4894
|
-
createCertification: (certSpecId: string, data:
|
|
5272
|
+
createCertification: (certSpecId: string, data: Input3T6Epmw0B5, params: RequestParams = {}) =>
|
|
4895
5273
|
this.request<CreateCertificationResult, CreateCertificationFail>({
|
|
4896
5274
|
path: `/users/certification/${certSpecId}`,
|
|
4897
5275
|
method: 'POST',
|