@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/dist/Api.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ export interface ErrorResponse {
|
|
|
5
5
|
/** Error code */
|
|
6
6
|
errCode: string;
|
|
7
7
|
}
|
|
8
|
-
export interface
|
|
8
|
+
export interface InputIpmc99Otqdg {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -329,7 +329,7 @@ export type RevokedByID = string;
|
|
|
329
329
|
/** Display name of the user who revoked the course */
|
|
330
330
|
export type RevokedByName = string;
|
|
331
331
|
/** Sponsorship approval parameters */
|
|
332
|
-
export interface
|
|
332
|
+
export interface InputNdozkicip3 {
|
|
333
333
|
/**
|
|
334
334
|
* Employer first name
|
|
335
335
|
* @maxLength 255
|
|
@@ -543,7 +543,7 @@ export type SponsorshipRemindersStudent = string[];
|
|
|
543
543
|
export type SponsorshipRemindersSponsor = string[];
|
|
544
544
|
/** Timestamp when the current sponsorship reminder schedule started (set on create and on reset). Reminder dueness is measured from it; when absent, from createdOn. */
|
|
545
545
|
export type RemindersStartedOn = number;
|
|
546
|
-
export interface
|
|
546
|
+
export interface InputD4Rprncvca {
|
|
547
547
|
/**
|
|
548
548
|
* ID of the certification to filter applications by
|
|
549
549
|
* @example "certification123"
|
|
@@ -600,7 +600,7 @@ export interface InputAo0Hmwpt3Z {
|
|
|
600
600
|
*/
|
|
601
601
|
ignoreCompletedCertifications?: boolean | null;
|
|
602
602
|
}
|
|
603
|
-
export interface
|
|
603
|
+
export interface InputOdq90W7Fvd {
|
|
604
604
|
/**
|
|
605
605
|
* ID of the certification to filter applications by
|
|
606
606
|
* @example "certification123"
|
|
@@ -657,7 +657,7 @@ export interface InputSf456Uwm0Y {
|
|
|
657
657
|
*/
|
|
658
658
|
ignoreCompletedCertifications?: boolean | null;
|
|
659
659
|
}
|
|
660
|
-
export interface
|
|
660
|
+
export interface InputKhw29Smbei {
|
|
661
661
|
/**
|
|
662
662
|
* ID of the certification to filter applications by
|
|
663
663
|
* @example "certification123"
|
|
@@ -714,7 +714,7 @@ export interface InputGk0V7Sd10D {
|
|
|
714
714
|
*/
|
|
715
715
|
ignoreCompletedCertifications?: boolean | null;
|
|
716
716
|
}
|
|
717
|
-
export interface
|
|
717
|
+
export interface InputE4Gqi912J9 {
|
|
718
718
|
/**
|
|
719
719
|
* The ID of the certificate specifications to be used for the email
|
|
720
720
|
* @example "certSpecsID123"
|
|
@@ -755,7 +755,7 @@ export interface InputRw5C352Zh1 {
|
|
|
755
755
|
emailAddress: string;
|
|
756
756
|
}[];
|
|
757
757
|
}
|
|
758
|
-
export interface
|
|
758
|
+
export interface InputQihsbffnta {
|
|
759
759
|
/**
|
|
760
760
|
* The ID of the product for which the license is being redeemed
|
|
761
761
|
* @example "productID123"
|
|
@@ -767,7 +767,7 @@ export interface InputWq7Kc998Gu {
|
|
|
767
767
|
*/
|
|
768
768
|
sessionID?: string;
|
|
769
769
|
}
|
|
770
|
-
export interface
|
|
770
|
+
export interface Input0Cdbeyihx9 {
|
|
771
771
|
/**
|
|
772
772
|
* Search term to filter licenses
|
|
773
773
|
* @example "active"
|
|
@@ -784,7 +784,7 @@ export interface InputAohpyyjnf {
|
|
|
784
784
|
*/
|
|
785
785
|
sortField?: any;
|
|
786
786
|
}
|
|
787
|
-
export interface
|
|
787
|
+
export interface Input03993Y2Hmhg {
|
|
788
788
|
/**
|
|
789
789
|
* Search term to filter licenses
|
|
790
790
|
* @example "active"
|
|
@@ -917,7 +917,7 @@ export interface SearchPendingApprovalsResponseSchema {
|
|
|
917
917
|
remindersStartedOn?: RemindersStartedOn;
|
|
918
918
|
}[];
|
|
919
919
|
}
|
|
920
|
-
export interface
|
|
920
|
+
export interface InputX6Br1Bzszd {
|
|
921
921
|
/**
|
|
922
922
|
* Start date for the report
|
|
923
923
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -939,11 +939,11 @@ export interface Input7U9Wc63O0Z {
|
|
|
939
939
|
*/
|
|
940
940
|
dateType?: string;
|
|
941
941
|
}
|
|
942
|
-
export interface
|
|
942
|
+
export interface InputAcb6Cb0Wc {
|
|
943
943
|
/** List of user IDs to search for in the tenant. */
|
|
944
944
|
IDs: (string | null)[];
|
|
945
945
|
}
|
|
946
|
-
export interface
|
|
946
|
+
export interface InputSnyycdllar {
|
|
947
947
|
/** The term to search for in the user profiles. */
|
|
948
948
|
searchTerm?: string | null;
|
|
949
949
|
/** Filter criteria for the user search. */
|
|
@@ -983,7 +983,7 @@ export interface InputRx2Of25Z1S {
|
|
|
983
983
|
};
|
|
984
984
|
};
|
|
985
985
|
}
|
|
986
|
-
export interface
|
|
986
|
+
export interface InputV6Bi78Xqc6 {
|
|
987
987
|
/** The term to search for in the user profiles. */
|
|
988
988
|
searchTerm?: string | null;
|
|
989
989
|
/** Filter criteria for the user search. */
|
|
@@ -1023,23 +1023,49 @@ export interface InputBwf6Vwqau4H {
|
|
|
1023
1023
|
};
|
|
1024
1024
|
};
|
|
1025
1025
|
}
|
|
1026
|
-
export interface
|
|
1026
|
+
export interface OutputSa87Chshb2 {
|
|
1027
1027
|
/** External system ID 2 */
|
|
1028
1028
|
userCount: ExternalID2;
|
|
1029
1029
|
transactionID?: string | null;
|
|
1030
1030
|
}
|
|
1031
1031
|
/** External system ID 2 */
|
|
1032
1032
|
export type ExternalID2 = number;
|
|
1033
|
+
export interface InputXc4U9K5Ew {
|
|
1034
|
+
/** Report filter */
|
|
1035
|
+
filter: {
|
|
1036
|
+
/**
|
|
1037
|
+
* Course specification IDs to include (1 to 100 entries, required)
|
|
1038
|
+
* @maxItems 100
|
|
1039
|
+
* @minItems 1
|
|
1040
|
+
* @example ["course123"]
|
|
1041
|
+
*/
|
|
1042
|
+
courseID: string[];
|
|
1043
|
+
/**
|
|
1044
|
+
* Inclusive lower bound of the enrolment date (epoch milliseconds). Requires "to".
|
|
1045
|
+
* @min 0
|
|
1046
|
+
* @max 4102444800000
|
|
1047
|
+
* @example 1672531200000
|
|
1048
|
+
*/
|
|
1049
|
+
from?: number;
|
|
1050
|
+
/**
|
|
1051
|
+
* Inclusive upper bound of the enrolment date (epoch milliseconds). Requires "from".
|
|
1052
|
+
* @min 0
|
|
1053
|
+
* @max 4102444800000
|
|
1054
|
+
* @example 1672617600000
|
|
1055
|
+
*/
|
|
1056
|
+
to?: number;
|
|
1057
|
+
};
|
|
1058
|
+
}
|
|
1033
1059
|
/** This endpoint accepts no request body */
|
|
1034
1060
|
export type DeletePendingApprovalBody = object;
|
|
1035
|
-
export interface
|
|
1061
|
+
export interface Output5Wy4Ij5R2L {
|
|
1036
1062
|
/**
|
|
1037
1063
|
* Signed URL for the course file
|
|
1038
1064
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
1039
1065
|
*/
|
|
1040
1066
|
fileURL: string;
|
|
1041
1067
|
}
|
|
1042
|
-
export interface
|
|
1068
|
+
export interface Output93Vvrem4Cnj {
|
|
1043
1069
|
/**
|
|
1044
1070
|
* Amount to be refunded for the cancellation
|
|
1045
1071
|
* @example 0
|
|
@@ -1339,7 +1365,7 @@ export interface CourseResponseEntity {
|
|
|
1339
1365
|
}
|
|
1340
1366
|
/** Label of the course enrolled (course version) */
|
|
1341
1367
|
export type OnlineCourseLabel = string;
|
|
1342
|
-
export interface
|
|
1368
|
+
export interface OutputMzn398Miqag {
|
|
1343
1369
|
/**
|
|
1344
1370
|
* Signed URL for the course file
|
|
1345
1371
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
@@ -1357,7 +1383,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1357
1383
|
transactionID?: string | null;
|
|
1358
1384
|
}
|
|
1359
1385
|
/** Application Foreign Fill response type */
|
|
1360
|
-
export interface
|
|
1386
|
+
export interface Output4R7Cihk7Va {
|
|
1361
1387
|
items: {
|
|
1362
1388
|
userID: string;
|
|
1363
1389
|
createdOn?: number;
|
|
@@ -1580,7 +1606,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1580
1606
|
applicationItems?: Record<string, any>[];
|
|
1581
1607
|
transactionID?: string | null;
|
|
1582
1608
|
}
|
|
1583
|
-
export interface
|
|
1609
|
+
export interface InputDo34Iz9Dvd {
|
|
1584
1610
|
issuedOn?: number;
|
|
1585
1611
|
expiresOn?: number;
|
|
1586
1612
|
fileItems?: {
|
|
@@ -1589,21 +1615,21 @@ export interface InputO6S14Hm8Ny {
|
|
|
1589
1615
|
}[];
|
|
1590
1616
|
additionalNotes?: string | null;
|
|
1591
1617
|
}
|
|
1592
|
-
export interface
|
|
1618
|
+
export interface InputX6Wo72Dybzj {
|
|
1593
1619
|
/**
|
|
1594
1620
|
* Indicates whether the application is locked
|
|
1595
1621
|
* @example true
|
|
1596
1622
|
*/
|
|
1597
1623
|
isApplicationLocked: boolean;
|
|
1598
1624
|
}
|
|
1599
|
-
export interface
|
|
1625
|
+
export interface OutputO44Lmw18Hm {
|
|
1600
1626
|
/**
|
|
1601
1627
|
* Signed URL for the course file
|
|
1602
1628
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
1603
1629
|
*/
|
|
1604
1630
|
fileURL: string;
|
|
1605
1631
|
}
|
|
1606
|
-
export interface
|
|
1632
|
+
export interface InputFvtyzhspxlk {
|
|
1607
1633
|
/**
|
|
1608
1634
|
* Indicates whether the waiver is approved
|
|
1609
1635
|
* @example true
|
|
@@ -1615,14 +1641,14 @@ export interface InputHttuep0Xaa {
|
|
|
1615
1641
|
*/
|
|
1616
1642
|
additionalNotes?: string | null;
|
|
1617
1643
|
}
|
|
1618
|
-
export interface
|
|
1644
|
+
export interface Input5R9Ud8Ixob {
|
|
1619
1645
|
/**
|
|
1620
1646
|
* Optional notes regarding the waiver
|
|
1621
1647
|
* @example "Waiver granted due to special circumstances."
|
|
1622
1648
|
*/
|
|
1623
1649
|
additionalNotes?: string | null;
|
|
1624
1650
|
}
|
|
1625
|
-
export interface
|
|
1651
|
+
export interface InputSwpu5Vwre6 {
|
|
1626
1652
|
students: {
|
|
1627
1653
|
/**
|
|
1628
1654
|
* User ID of the student to redeem the course for
|
|
@@ -1656,7 +1682,7 @@ export interface InputS523Pjmwoa {
|
|
|
1656
1682
|
*/
|
|
1657
1683
|
autoEnrolSessionID?: string;
|
|
1658
1684
|
}
|
|
1659
|
-
export interface
|
|
1685
|
+
export interface InputM3Vuv0N0Ko {
|
|
1660
1686
|
invites: {
|
|
1661
1687
|
/**
|
|
1662
1688
|
* Email address of the user to invite
|
|
@@ -1685,7 +1711,7 @@ export interface Input7Pkse4K1Q5 {
|
|
|
1685
1711
|
*/
|
|
1686
1712
|
isReservedSeat: boolean;
|
|
1687
1713
|
}
|
|
1688
|
-
export interface
|
|
1714
|
+
export interface Input67Joiiq2Mlf {
|
|
1689
1715
|
/**
|
|
1690
1716
|
* Indicates whether to waive the certification process
|
|
1691
1717
|
* @example true
|
|
@@ -1698,7 +1724,7 @@ export interface Input3Dqkxxnovwg {
|
|
|
1698
1724
|
comments?: string | null;
|
|
1699
1725
|
}
|
|
1700
1726
|
/** Certification move response schema */
|
|
1701
|
-
export interface
|
|
1727
|
+
export interface OutputC6Swugv92O {
|
|
1702
1728
|
errors?: {
|
|
1703
1729
|
status: string;
|
|
1704
1730
|
object?: Record<string, any>;
|
|
@@ -1706,19 +1732,19 @@ export interface OutputLakap8U75H {
|
|
|
1706
1732
|
}[];
|
|
1707
1733
|
}
|
|
1708
1734
|
/** Schema for writing a certification trigger check. */
|
|
1709
|
-
export interface
|
|
1735
|
+
export interface Input8F9Tnd70S1 {
|
|
1710
1736
|
/**
|
|
1711
1737
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1712
1738
|
* @example "CHECKED"
|
|
1713
1739
|
*/
|
|
1714
|
-
value:
|
|
1740
|
+
value: Input8F9Tnd70S1ValueEnum;
|
|
1715
1741
|
/**
|
|
1716
1742
|
* List of course IDs that are blocked by this trigger check.
|
|
1717
1743
|
* @example ["course1","course2"]
|
|
1718
1744
|
*/
|
|
1719
1745
|
blockedCourses?: string[];
|
|
1720
1746
|
}
|
|
1721
|
-
export interface
|
|
1747
|
+
export interface InputDvl5Dcmb96 {
|
|
1722
1748
|
/**
|
|
1723
1749
|
* Indicates whether the application item is approved
|
|
1724
1750
|
* @example true
|
|
@@ -1744,7 +1770,7 @@ export interface InputQ6D0Sejtsf {
|
|
|
1744
1770
|
export interface StudentHistoryRequestSchema {
|
|
1745
1771
|
requirements: string[];
|
|
1746
1772
|
}
|
|
1747
|
-
export interface
|
|
1773
|
+
export interface InputXgiq6Ooomw {
|
|
1748
1774
|
/**
|
|
1749
1775
|
* Optional activation key for the application
|
|
1750
1776
|
* @example "AK-123456"
|
|
@@ -1752,7 +1778,7 @@ export interface InputMzh8Dry519 {
|
|
|
1752
1778
|
activationKey?: string;
|
|
1753
1779
|
}
|
|
1754
1780
|
/** Schema for course submission item details post request. */
|
|
1755
|
-
export interface
|
|
1781
|
+
export interface InputSj177Dwq6Q {
|
|
1756
1782
|
/**
|
|
1757
1783
|
* The ID of the file being submitted.
|
|
1758
1784
|
* @example "fileID123"
|
|
@@ -1765,7 +1791,7 @@ export interface Input907Bqms0Gd {
|
|
|
1765
1791
|
fileName: string;
|
|
1766
1792
|
}
|
|
1767
1793
|
/** Schema for the response to course submission item details post request. */
|
|
1768
|
-
export interface
|
|
1794
|
+
export interface OutputSj177Dwq6Q {
|
|
1769
1795
|
submissionItems: {
|
|
1770
1796
|
/**
|
|
1771
1797
|
* The ID of the file being submitted.
|
|
@@ -1780,7 +1806,7 @@ export interface Output907Bqms0Gd {
|
|
|
1780
1806
|
}[];
|
|
1781
1807
|
}
|
|
1782
1808
|
/** Pending approval submission parameters */
|
|
1783
|
-
export interface
|
|
1809
|
+
export interface InputOexr2Qxfau {
|
|
1784
1810
|
/**
|
|
1785
1811
|
* Type of pending approval
|
|
1786
1812
|
* @example "certification"
|
|
@@ -1800,7 +1826,7 @@ export interface InputIw7Hk3Mq5M {
|
|
|
1800
1826
|
fileName: string;
|
|
1801
1827
|
}[];
|
|
1802
1828
|
}
|
|
1803
|
-
export interface
|
|
1829
|
+
export interface InputMsk4L6Y8T6 {
|
|
1804
1830
|
/**
|
|
1805
1831
|
* The ID of the course for which the license is being redeemed
|
|
1806
1832
|
* @example "courseID123"
|
|
@@ -1868,7 +1894,7 @@ export interface InputLh0T8171Wqg {
|
|
|
1868
1894
|
acknowledgement?: string | null;
|
|
1869
1895
|
}
|
|
1870
1896
|
/** Validate certification move response schema */
|
|
1871
|
-
export interface
|
|
1897
|
+
export interface OutputK50Eo4Le8G {
|
|
1872
1898
|
courses: {
|
|
1873
1899
|
name: string;
|
|
1874
1900
|
status: string;
|
|
@@ -1879,21 +1905,21 @@ export interface OutputHmffu9Hc2H {
|
|
|
1879
1905
|
validated: boolean;
|
|
1880
1906
|
mustCreateCP: boolean;
|
|
1881
1907
|
}
|
|
1882
|
-
export interface
|
|
1908
|
+
export interface InputNbfoc0D7Fok {
|
|
1883
1909
|
/**
|
|
1884
1910
|
* Comments regarding the end of the cooldown period
|
|
1885
1911
|
* @example "Cooldown period ended successfully."
|
|
1886
1912
|
*/
|
|
1887
1913
|
comments: string;
|
|
1888
1914
|
}
|
|
1889
|
-
export interface
|
|
1915
|
+
export interface OutputO7Izub8Bxe {
|
|
1890
1916
|
/**
|
|
1891
1917
|
* Signed URL for the course file
|
|
1892
1918
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
1893
1919
|
*/
|
|
1894
1920
|
fileURL: string;
|
|
1895
1921
|
}
|
|
1896
|
-
export interface
|
|
1922
|
+
export interface InputGud41Drhmr {
|
|
1897
1923
|
/** @example true */
|
|
1898
1924
|
agreedWithCertTerms: boolean;
|
|
1899
1925
|
/** @example 1717230000000 */
|
|
@@ -1978,21 +2004,21 @@ export interface Sponsor {
|
|
|
1978
2004
|
/** Title of the sponsor of the student in the tenant */
|
|
1979
2005
|
title?: Title;
|
|
1980
2006
|
}
|
|
1981
|
-
export interface
|
|
2007
|
+
export interface InputH27O516961 {
|
|
1982
2008
|
/**
|
|
1983
2009
|
* Comments regarding the course unlock action
|
|
1984
2010
|
* @example "Course unlocked successfully."
|
|
1985
2011
|
*/
|
|
1986
2012
|
comments: string;
|
|
1987
2013
|
}
|
|
1988
|
-
export interface
|
|
2014
|
+
export interface Input1Slvu9Z87P {
|
|
1989
2015
|
/**
|
|
1990
2016
|
* ITA number to update for the user
|
|
1991
2017
|
* @example "ITA123456"
|
|
1992
2018
|
*/
|
|
1993
2019
|
itaNumber: string;
|
|
1994
2020
|
}
|
|
1995
|
-
export interface
|
|
2021
|
+
export interface InputBknn2Isn2Ll {
|
|
1996
2022
|
/** @example true */
|
|
1997
2023
|
agreedWithCertTerms: boolean;
|
|
1998
2024
|
/** @example 1717230000000 */
|
|
@@ -2066,7 +2092,7 @@ export interface InputVynk4V82Hlf {
|
|
|
2066
2092
|
/** Sponsor information for a student in the tenant */
|
|
2067
2093
|
sponsor?: Sponsor;
|
|
2068
2094
|
}
|
|
2069
|
-
export interface
|
|
2095
|
+
export interface Input2V0Cmpfq55G {
|
|
2070
2096
|
/**
|
|
2071
2097
|
* The grade to override the course result with
|
|
2072
2098
|
* @example "A"
|
|
@@ -2074,7 +2100,7 @@ export interface InputSzdt1Ehw1F {
|
|
|
2074
2100
|
resultGrade: string;
|
|
2075
2101
|
}
|
|
2076
2102
|
/** Pending approval review parameters */
|
|
2077
|
-
export interface
|
|
2103
|
+
export interface InputZauj6Kl3W2 {
|
|
2078
2104
|
/**
|
|
2079
2105
|
* Notes provided by the reviewer for the pending approval
|
|
2080
2106
|
* @example "Please review the submitted documents."
|
|
@@ -2094,7 +2120,7 @@ export interface InputRaggvf9Tdaf {
|
|
|
2094
2120
|
reviewedOn?: number;
|
|
2095
2121
|
}
|
|
2096
2122
|
/** Schema for overriding course result dates. */
|
|
2097
|
-
export interface
|
|
2123
|
+
export interface InputL7Diqqlzdq {
|
|
2098
2124
|
/**
|
|
2099
2125
|
* The date when the course result expires, in milliseconds since epoch.
|
|
2100
2126
|
* @example 1735689600000
|
|
@@ -2108,14 +2134,100 @@ export interface Input504Pqmq2W3 {
|
|
|
2108
2134
|
}
|
|
2109
2135
|
/** Reset sponsorship request takes no body */
|
|
2110
2136
|
export type ResetSponsorshipBody = object;
|
|
2111
|
-
|
|
2137
|
+
/** List of work hours records for a user */
|
|
2138
|
+
export type WorkHoursListResponse = WorkHoursResponseEntity[];
|
|
2139
|
+
/** Single work hours object */
|
|
2140
|
+
export interface WorkHoursResponseEntity {
|
|
2141
|
+
/** User who created the record */
|
|
2142
|
+
createdBy?: CreatedBy;
|
|
2143
|
+
/** Timestamp when the record was created */
|
|
2144
|
+
createdOn?: CreatedOn;
|
|
2145
|
+
/** User who last updated the record */
|
|
2146
|
+
updatedBy?: UpdatedBy;
|
|
2147
|
+
/** Timestamp of last update */
|
|
2148
|
+
updatedOn?: UpdatedOn;
|
|
2149
|
+
/** Entity identifier for work hours */
|
|
2150
|
+
dbEntity?: DbEntity;
|
|
2151
|
+
/** Unique identifier of the work hours record */
|
|
2152
|
+
id: Id;
|
|
2153
|
+
/** Tenant ID associated with the work hours record */
|
|
2154
|
+
tenantID: TenantID;
|
|
2155
|
+
/** User ID related with this work hours record */
|
|
2156
|
+
userID: UserID;
|
|
2157
|
+
/** Number of hours entered for a specific period */
|
|
2158
|
+
hours?: Hours;
|
|
2159
|
+
/** Initial date of the work period (timestamp) */
|
|
2160
|
+
initDate: InitDate;
|
|
2161
|
+
/** End date of the work period (timestamp) */
|
|
2162
|
+
endDate?: EndDate;
|
|
2163
|
+
/** Concrete pump categories the user selected to enter hours */
|
|
2164
|
+
categories?: Categories;
|
|
2165
|
+
/** Array of documents that prove the hours worked */
|
|
2166
|
+
attachments?: Attachments;
|
|
2167
|
+
}
|
|
2168
|
+
/** Number of hours entered for a specific period */
|
|
2169
|
+
export type Hours = number;
|
|
2170
|
+
/** Initial date of the work period (timestamp) */
|
|
2171
|
+
export type InitDate = number;
|
|
2172
|
+
/** End date of the work period (timestamp) */
|
|
2173
|
+
export type EndDate = number;
|
|
2174
|
+
/** Concrete pump categories the user selected to enter hours */
|
|
2175
|
+
export type Categories = string[];
|
|
2176
|
+
/** Array of documents that prove the hours worked */
|
|
2177
|
+
export type Attachments = {
|
|
2178
|
+
/** Identifier of the attachment file */
|
|
2179
|
+
fileID: string;
|
|
2180
|
+
/** Name of the attachment file */
|
|
2181
|
+
fileName: string;
|
|
2182
|
+
}[];
|
|
2183
|
+
/** Payload to create or update a work hours record */
|
|
2184
|
+
export interface WorkHoursWrite {
|
|
2185
|
+
/** @example 40 */
|
|
2186
|
+
hours?: number;
|
|
2187
|
+
/** @example 1717230000000 */
|
|
2188
|
+
initDate: number;
|
|
2189
|
+
/** @example 1717830000000 */
|
|
2190
|
+
endDate?: number;
|
|
2191
|
+
/** @example ["boom","line"] */
|
|
2192
|
+
categories?: string[];
|
|
2193
|
+
/** @example [{"fileID":"fileID","fileName":"proof.pdf"}] */
|
|
2194
|
+
attachments?: {
|
|
2195
|
+
/**
|
|
2196
|
+
* @minLength 1
|
|
2197
|
+
* @example "fileID"
|
|
2198
|
+
*/
|
|
2199
|
+
fileID: string;
|
|
2200
|
+
/**
|
|
2201
|
+
* @minLength 1
|
|
2202
|
+
* @example "proof.pdf"
|
|
2203
|
+
*/
|
|
2204
|
+
fileName: string;
|
|
2205
|
+
}[];
|
|
2206
|
+
}
|
|
2207
|
+
/** Work hours file response */
|
|
2208
|
+
export interface OutputDfi7Lgx5Y2 {
|
|
2209
|
+
/**
|
|
2210
|
+
* Signed URL for the work hours file
|
|
2211
|
+
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
|
|
2212
|
+
*/
|
|
2213
|
+
fileURL: string;
|
|
2214
|
+
}
|
|
2215
|
+
/** Work hours file response */
|
|
2216
|
+
export interface OutputG0Ygvys9Tfl {
|
|
2217
|
+
/**
|
|
2218
|
+
* Signed URL for the work hours file
|
|
2219
|
+
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
|
|
2220
|
+
*/
|
|
2221
|
+
fileURL: string;
|
|
2222
|
+
}
|
|
2223
|
+
export interface InputVn7Imocp5P {
|
|
2112
2224
|
filter: {
|
|
2113
2225
|
from?: number;
|
|
2114
2226
|
sortOrder?: string;
|
|
2115
2227
|
sortField?: string;
|
|
2116
2228
|
};
|
|
2117
2229
|
}
|
|
2118
|
-
export interface
|
|
2230
|
+
export interface OutputVn7Imocp5P {
|
|
2119
2231
|
users: {
|
|
2120
2232
|
firstName: string;
|
|
2121
2233
|
lastName: string;
|
|
@@ -2139,7 +2251,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
2139
2251
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
2140
2252
|
* @example "CHECKED"
|
|
2141
2253
|
*/
|
|
2142
|
-
export declare enum
|
|
2254
|
+
export declare enum Input8F9Tnd70S1ValueEnum {
|
|
2143
2255
|
CHECKED = "CHECKED",
|
|
2144
2256
|
UNCHECKED = "UNCHECKED",
|
|
2145
2257
|
NOVALUE = "NOVALUE"
|
|
@@ -2240,8 +2352,10 @@ export type CreateSearchUsersTermData = any;
|
|
|
2240
2352
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2241
2353
|
export type CreateReportUsersSimpleData = any;
|
|
2242
2354
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2243
|
-
export type CreateSearchUsersCountData =
|
|
2355
|
+
export type CreateSearchUsersCountData = OutputSa87Chshb2;
|
|
2244
2356
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2357
|
+
export type CreateReportStudentsPaidIncompleteCourseData = any;
|
|
2358
|
+
export type CreateReportStudentsPaidIncompleteCourseError = ErrorResponse;
|
|
2245
2359
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2246
2360
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
2247
2361
|
export type DeleteCertificationApplicationItemData = any;
|
|
@@ -2264,7 +2378,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2264
2378
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2265
2379
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2266
2380
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2267
|
-
export type GetCertificationCourseFileSignData =
|
|
2381
|
+
export type GetCertificationCourseFileSignData = OutputMzn398Miqag;
|
|
2268
2382
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2269
2383
|
export interface CreateCertificationCourseFileSignParams {
|
|
2270
2384
|
/** @example "pdf" */
|
|
@@ -2278,11 +2392,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2278
2392
|
/** @example "fileID" */
|
|
2279
2393
|
fileId: string;
|
|
2280
2394
|
}
|
|
2281
|
-
export type CreateCertificationCourseFileSignData =
|
|
2395
|
+
export type CreateCertificationCourseFileSignData = OutputO7Izub8Bxe;
|
|
2282
2396
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2283
2397
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2284
2398
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2285
|
-
export type CreateCertificationCourseDocumentData =
|
|
2399
|
+
export type CreateCertificationCourseDocumentData = OutputSj177Dwq6Q;
|
|
2286
2400
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2287
2401
|
export type DeleteSponsorshipPendingApprovalData = any;
|
|
2288
2402
|
export type DeleteSponsorshipPendingApprovalError = ErrorResponse;
|
|
@@ -2298,7 +2412,7 @@ export type UpdateUserData = any;
|
|
|
2298
2412
|
export type UpdateUserError = ErrorResponse;
|
|
2299
2413
|
export type DeleteCertificationCourseData = any;
|
|
2300
2414
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2301
|
-
export type GetCertificationApplicationItemFileData =
|
|
2415
|
+
export type GetCertificationApplicationItemFileData = Output5Wy4Ij5R2L;
|
|
2302
2416
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2303
2417
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2304
2418
|
/** @example "pdf" */
|
|
@@ -2312,9 +2426,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2312
2426
|
/** @example "fileVersion" */
|
|
2313
2427
|
fileVersion: string;
|
|
2314
2428
|
}
|
|
2315
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2429
|
+
export type CreateCertificationApplicationItemFileData = OutputO44Lmw18Hm;
|
|
2316
2430
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2317
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2431
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = Output93Vvrem4Cnj;
|
|
2318
2432
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2319
2433
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2320
2434
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2322,7 +2436,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2322
2436
|
export type GetCourseError = ErrorResponse;
|
|
2323
2437
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2324
2438
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2325
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2439
|
+
export type GetCertificationApplicationForeignFillData = Output4R7Cihk7Va;
|
|
2326
2440
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2327
2441
|
export type GetCertificationPrintData = any;
|
|
2328
2442
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2356,7 +2470,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2356
2470
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2357
2471
|
export type CreateCertificationWaiveData = any;
|
|
2358
2472
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2359
|
-
export type CreateCertificationMoveData =
|
|
2473
|
+
export type CreateCertificationMoveData = OutputC6Swugv92O;
|
|
2360
2474
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2361
2475
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2362
2476
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2388,7 +2502,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2388
2502
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2389
2503
|
export type CreateCertificationCourseRedeemData = any;
|
|
2390
2504
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2391
|
-
export type CreateCertificationMoveValidateData =
|
|
2505
|
+
export type CreateCertificationMoveValidateData = OutputK50Eo4Le8G;
|
|
2392
2506
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2393
2507
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2394
2508
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2406,7 +2520,33 @@ export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
|
2406
2520
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2407
2521
|
export type CreateSponsorshipResetData = any;
|
|
2408
2522
|
export type CreateSponsorshipResetError = ErrorResponse;
|
|
2409
|
-
export type
|
|
2523
|
+
export type GetWorkHoursData = WorkHoursListResponse;
|
|
2524
|
+
export type GetWorkHoursError = ErrorResponse;
|
|
2525
|
+
export type GetWorkHours2Data = WorkHoursResponseEntity;
|
|
2526
|
+
export type GetWorkHours2Error = ErrorResponse;
|
|
2527
|
+
export type ListWorkHoursData = WorkHoursResponseEntity;
|
|
2528
|
+
export type ListWorkHoursError = ErrorResponse;
|
|
2529
|
+
export type UpdateWorkHoursData = WorkHoursResponseEntity;
|
|
2530
|
+
export type UpdateWorkHoursError = ErrorResponse;
|
|
2531
|
+
export type DeleteWorkHoursData = any;
|
|
2532
|
+
export type DeleteWorkHoursError = ErrorResponse;
|
|
2533
|
+
export interface CreateWorkHoursFileSignParams {
|
|
2534
|
+
/** @example "pdf" */
|
|
2535
|
+
fileType: string;
|
|
2536
|
+
/** @example "userID" */
|
|
2537
|
+
userId: string;
|
|
2538
|
+
/** @example "workHoursID" */
|
|
2539
|
+
workHoursId: string;
|
|
2540
|
+
/** @example "fileID" */
|
|
2541
|
+
fileId: string;
|
|
2542
|
+
}
|
|
2543
|
+
export type CreateWorkHoursFileSignData = OutputDfi7Lgx5Y2;
|
|
2544
|
+
export type CreateWorkHoursFileSignError = ErrorResponse;
|
|
2545
|
+
export type DeleteWorkHoursFileSignData = any;
|
|
2546
|
+
export type DeleteWorkHoursFileSignError = ErrorResponse;
|
|
2547
|
+
export type GetWorkHoursFileSignData = OutputG0Ygvys9Tfl;
|
|
2548
|
+
export type GetWorkHoursFileSignError = ErrorResponse;
|
|
2549
|
+
export type CreateCertificationResult = OutputVn7Imocp5P;
|
|
2410
2550
|
export type CreateCertificationFail = ErrorResponse;
|
|
2411
2551
|
export type CreateCertificationPublishInfoResult = any;
|
|
2412
2552
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2453,7 +2593,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2453
2593
|
}
|
|
2454
2594
|
/**
|
|
2455
2595
|
* @title BCCSA Program API
|
|
2456
|
-
* @version 3.0.
|
|
2596
|
+
* @version 3.0.41
|
|
2457
2597
|
* @baseUrl http://localhost:8080
|
|
2458
2598
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2459
2599
|
*/
|
|
@@ -2468,7 +2608,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2468
2608
|
* @request POST:/contactUs
|
|
2469
2609
|
* @secure
|
|
2470
2610
|
*/
|
|
2471
|
-
listContactUs: (data:
|
|
2611
|
+
listContactUs: (data: InputIpmc99Otqdg, params?: RequestParams) => Promise<any>;
|
|
2472
2612
|
};
|
|
2473
2613
|
customer: {
|
|
2474
2614
|
/**
|
|
@@ -2512,7 +2652,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2512
2652
|
* @request PUT:/sponsorship/approve/{paID}
|
|
2513
2653
|
* @secure
|
|
2514
2654
|
*/
|
|
2515
|
-
updateApprove: (paId: string, data:
|
|
2655
|
+
updateApprove: (paId: string, data: InputNdozkicip3, params?: RequestParams) => Promise<any>;
|
|
2516
2656
|
};
|
|
2517
2657
|
tenant: {
|
|
2518
2658
|
/**
|
|
@@ -2584,7 +2724,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2584
2724
|
* @request POST:/tenant/report/applicationExport
|
|
2585
2725
|
* @secure
|
|
2586
2726
|
*/
|
|
2587
|
-
createReportApplicationExport: (data:
|
|
2727
|
+
createReportApplicationExport: (data: InputD4Rprncvca, params?: RequestParams) => Promise<any>;
|
|
2588
2728
|
/**
|
|
2589
2729
|
* @description Export a report of applications based on the provided filters.
|
|
2590
2730
|
*
|
|
@@ -2594,7 +2734,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2594
2734
|
* @request POST:/tenant/report/applicationStatus
|
|
2595
2735
|
* @secure
|
|
2596
2736
|
*/
|
|
2597
|
-
listReportApplicationStatus: (data:
|
|
2737
|
+
listReportApplicationStatus: (data: InputOdq90W7Fvd, params?: RequestParams) => Promise<any>;
|
|
2598
2738
|
/**
|
|
2599
2739
|
* @description Export a report of applications based on the provided filters.
|
|
2600
2740
|
*
|
|
@@ -2604,7 +2744,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2604
2744
|
* @request POST:/tenant/report/applicationsReport
|
|
2605
2745
|
* @secure
|
|
2606
2746
|
*/
|
|
2607
|
-
createReportApplicationsReport: (data:
|
|
2747
|
+
createReportApplicationsReport: (data: InputKhw29Smbei, params?: RequestParams) => Promise<any>;
|
|
2608
2748
|
/**
|
|
2609
2749
|
* @description This route allows you to post certificates email for the tenant.
|
|
2610
2750
|
*
|
|
@@ -2614,7 +2754,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2614
2754
|
* @request POST:/tenant/certificates/email
|
|
2615
2755
|
* @secure
|
|
2616
2756
|
*/
|
|
2617
|
-
createCertificatesEmail: (data:
|
|
2757
|
+
createCertificatesEmail: (data: InputE4Gqi912J9, params?: RequestParams) => Promise<any>;
|
|
2618
2758
|
/**
|
|
2619
2759
|
* @description Generate a preview of the completed certifications report.
|
|
2620
2760
|
*
|
|
@@ -2644,7 +2784,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2644
2784
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2645
2785
|
* @secure
|
|
2646
2786
|
*/
|
|
2647
|
-
createLicenseRedeem: (userId: string, data:
|
|
2787
|
+
createLicenseRedeem: (userId: string, data: InputQihsbffnta, params?: RequestParams) => Promise<any>;
|
|
2648
2788
|
/**
|
|
2649
2789
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2650
2790
|
*
|
|
@@ -2654,7 +2794,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2654
2794
|
* @request POST:/tenant/report/orglicenses/
|
|
2655
2795
|
* @secure
|
|
2656
2796
|
*/
|
|
2657
|
-
listReportOrglicenses: (data:
|
|
2797
|
+
listReportOrglicenses: (data: Input0Cdbeyihx9, params?: RequestParams) => Promise<any>;
|
|
2658
2798
|
/**
|
|
2659
2799
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2660
2800
|
*
|
|
@@ -2664,7 +2804,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2664
2804
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2665
2805
|
* @secure
|
|
2666
2806
|
*/
|
|
2667
|
-
createReportOrglicensesPreview: (data:
|
|
2807
|
+
createReportOrglicensesPreview: (data: Input03993Y2Hmhg, params?: RequestParams) => Promise<any>;
|
|
2668
2808
|
/**
|
|
2669
2809
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2670
2810
|
*
|
|
@@ -2704,7 +2844,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2704
2844
|
* @request POST:/tenant/report/users/advanced
|
|
2705
2845
|
* @secure
|
|
2706
2846
|
*/
|
|
2707
|
-
createReportUsersAdvanced: (data:
|
|
2847
|
+
createReportUsersAdvanced: (data: InputX6Br1Bzszd, params?: RequestParams) => Promise<any>;
|
|
2708
2848
|
/**
|
|
2709
2849
|
* @description Searches for users in the tenant by their IDs.
|
|
2710
2850
|
*
|
|
@@ -2714,7 +2854,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2714
2854
|
* @request POST:/tenant/search/users/ids
|
|
2715
2855
|
* @secure
|
|
2716
2856
|
*/
|
|
2717
|
-
listSearchUsersIds: (data:
|
|
2857
|
+
listSearchUsersIds: (data: InputAcb6Cb0Wc, params?: RequestParams) => Promise<any>;
|
|
2718
2858
|
/**
|
|
2719
2859
|
* @description Searches for users in the tenant by term and filters.
|
|
2720
2860
|
*
|
|
@@ -2724,7 +2864,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2724
2864
|
* @request POST:/tenant/search/users/term
|
|
2725
2865
|
* @secure
|
|
2726
2866
|
*/
|
|
2727
|
-
createSearchUsersTerm: (data:
|
|
2867
|
+
createSearchUsersTerm: (data: InputSnyycdllar, params?: RequestParams) => Promise<any>;
|
|
2728
2868
|
/**
|
|
2729
2869
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2730
2870
|
*
|
|
@@ -2734,7 +2874,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2734
2874
|
* @request POST:/tenant/report/users/simple
|
|
2735
2875
|
* @secure
|
|
2736
2876
|
*/
|
|
2737
|
-
createReportUsersSimple: (data:
|
|
2877
|
+
createReportUsersSimple: (data: InputV6Bi78Xqc6, params?: RequestParams) => Promise<any>;
|
|
2738
2878
|
/**
|
|
2739
2879
|
* @description Retrieve user by ID.
|
|
2740
2880
|
*
|
|
@@ -2744,7 +2884,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2744
2884
|
* @request POST:/tenant/search/users/count
|
|
2745
2885
|
* @secure
|
|
2746
2886
|
*/
|
|
2747
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2887
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputSa87Chshb2>;
|
|
2888
|
+
/**
|
|
2889
|
+
* @description Returns the students of the current tenant with a PENDING enrolment in any of the given courses, optionally restricted to an enrolment date range.
|
|
2890
|
+
*
|
|
2891
|
+
* @tags Reports
|
|
2892
|
+
* @name CreateReportStudentsPaidIncompleteCourse
|
|
2893
|
+
* @summary Students who paid for a course but have not completed it
|
|
2894
|
+
* @request POST:/tenant/report/studentsPaidIncompleteCourse
|
|
2895
|
+
* @secure
|
|
2896
|
+
*/
|
|
2897
|
+
createReportStudentsPaidIncompleteCourse: (data: InputXc4U9K5Ew, params?: RequestParams) => Promise<any>;
|
|
2748
2898
|
};
|
|
2749
2899
|
user: {
|
|
2750
2900
|
/**
|
|
@@ -2776,7 +2926,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2776
2926
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2777
2927
|
* @secure
|
|
2778
2928
|
*/
|
|
2779
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2929
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: InputDo34Iz9Dvd, params?: RequestParams) => Promise<any>;
|
|
2780
2930
|
/**
|
|
2781
2931
|
* @description Delete a certification process application by type.
|
|
2782
2932
|
*
|
|
@@ -2866,7 +3016,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2866
3016
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2867
3017
|
* @secure
|
|
2868
3018
|
*/
|
|
2869
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
3019
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputMzn398Miqag>;
|
|
2870
3020
|
/**
|
|
2871
3021
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2872
3022
|
*
|
|
@@ -2876,7 +3026,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2876
3026
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2877
3027
|
* @secure
|
|
2878
3028
|
*/
|
|
2879
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
3029
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputO7Izub8Bxe>;
|
|
2880
3030
|
/**
|
|
2881
3031
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2882
3032
|
*
|
|
@@ -2896,7 +3046,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2896
3046
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2897
3047
|
* @secure
|
|
2898
3048
|
*/
|
|
2899
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
3049
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputSj177Dwq6Q, params?: RequestParams) => Promise<OutputSj177Dwq6Q>;
|
|
2900
3050
|
/**
|
|
2901
3051
|
* @description Deletes (cancels) a PENDING sponsorship/attestation pending-approval request for the given user. Admin only. Completed (approved/rejected) requests cannot be deleted. No notification is sent.
|
|
2902
3052
|
*
|
|
@@ -2946,7 +3096,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2946
3096
|
* @request POST:/user/{userID}
|
|
2947
3097
|
* @secure
|
|
2948
3098
|
*/
|
|
2949
|
-
createUser: (userId: string, data:
|
|
3099
|
+
createUser: (userId: string, data: InputGud41Drhmr, params?: RequestParams) => Promise<any>;
|
|
2950
3100
|
/**
|
|
2951
3101
|
* @description Update user in the system. This endpoint allows you to update a user with the provided details. The user will be updated to the database and an email notification will be sent to the user. When provided, the sponsor is saved on the user only; this does not update the pending sponsorship request or email the sponsor. Use POST /user/{userID}/sponsorship/reset to refresh the pending request from the stored sponsor and re-send the request.
|
|
2952
3102
|
*
|
|
@@ -2956,7 +3106,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2956
3106
|
* @request PUT:/user/{userID}
|
|
2957
3107
|
* @secure
|
|
2958
3108
|
*/
|
|
2959
|
-
updateUser: (userId: string, data:
|
|
3109
|
+
updateUser: (userId: string, data: InputBknn2Isn2Ll, params?: RequestParams) => Promise<any>;
|
|
2960
3110
|
/**
|
|
2961
3111
|
* @description Delete course from user
|
|
2962
3112
|
*
|
|
@@ -2976,7 +3126,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2976
3126
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2977
3127
|
* @secure
|
|
2978
3128
|
*/
|
|
2979
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
3129
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<Output5Wy4Ij5R2L>;
|
|
2980
3130
|
/**
|
|
2981
3131
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2982
3132
|
*
|
|
@@ -2986,7 +3136,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2986
3136
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2987
3137
|
* @secure
|
|
2988
3138
|
*/
|
|
2989
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
3139
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputO44Lmw18Hm>;
|
|
2990
3140
|
/**
|
|
2991
3141
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2992
3142
|
*
|
|
@@ -2996,7 +3146,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2996
3146
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2997
3147
|
* @secure
|
|
2998
3148
|
*/
|
|
2999
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
3149
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<Output93Vvrem4Cnj>;
|
|
3000
3150
|
/**
|
|
3001
3151
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
3002
3152
|
*
|
|
@@ -3036,7 +3186,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3036
3186
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
3037
3187
|
* @secure
|
|
3038
3188
|
*/
|
|
3039
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
3189
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<Output4R7Cihk7Va>;
|
|
3040
3190
|
/**
|
|
3041
3191
|
* @description This endpoint will print certificate
|
|
3042
3192
|
*
|
|
@@ -3096,7 +3246,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3096
3246
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
3097
3247
|
* @secure
|
|
3098
3248
|
*/
|
|
3099
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
3249
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputX6Wo72Dybzj, params?: RequestParams) => Promise<any>;
|
|
3100
3250
|
/**
|
|
3101
3251
|
* @description This endpoint allows you to add a user to a session in a certification process. It requires the user ID, certification process ID, secondary user ID, course ID, and session ID as path parameters.
|
|
3102
3252
|
*
|
|
@@ -3126,7 +3276,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3126
3276
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
3127
3277
|
* @secure
|
|
3128
3278
|
*/
|
|
3129
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3279
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputFvtyzhspxlk, params?: RequestParams) => Promise<any>;
|
|
3130
3280
|
/**
|
|
3131
3281
|
* @description This route allows you to pre approval review a certification application for a user. This is used to review applications before they are submitted for final approval.
|
|
3132
3282
|
*
|
|
@@ -3136,7 +3286,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3136
3286
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
3137
3287
|
* @secure
|
|
3138
3288
|
*/
|
|
3139
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3289
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: Input5R9Ud8Ixob, params?: RequestParams) => Promise<any>;
|
|
3140
3290
|
/**
|
|
3141
3291
|
* @description This endpoint allows the redemption of a batch course for a user in a certification process. It requires the user ID and certification process ID as path parameters, and the course redemption details in the request body.
|
|
3142
3292
|
*
|
|
@@ -3146,7 +3296,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3146
3296
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
3147
3297
|
* @secure
|
|
3148
3298
|
*/
|
|
3149
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
3299
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputSwpu5Vwre6, params?: RequestParams) => Promise<any>;
|
|
3150
3300
|
/**
|
|
3151
3301
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
3152
3302
|
*
|
|
@@ -3156,7 +3306,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3156
3306
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
3157
3307
|
* @secure
|
|
3158
3308
|
*/
|
|
3159
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
3309
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputM3Vuv0N0Ko, params?: RequestParams) => Promise<any>;
|
|
3160
3310
|
/**
|
|
3161
3311
|
* @description This endpoint allows you to cancel a certification enrolment for a user in a specific course session. It requires the user ID, certification process ID, course ID, and session ID as path parameters.
|
|
3162
3312
|
*
|
|
@@ -3196,7 +3346,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3196
3346
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
3197
3347
|
* @secure
|
|
3198
3348
|
*/
|
|
3199
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
3349
|
+
createCertificationWaive: (userId: string, certProcId: string, data: Input67Joiiq2Mlf, params?: RequestParams) => Promise<any>;
|
|
3200
3350
|
/**
|
|
3201
3351
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
3202
3352
|
*
|
|
@@ -3206,7 +3356,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3206
3356
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
3207
3357
|
* @secure
|
|
3208
3358
|
*/
|
|
3209
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3359
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputC6Swugv92O>;
|
|
3210
3360
|
/**
|
|
3211
3361
|
* @description This endpoint allows you to replace a certification enrolment for a user in a specific course session. It requires the user ID, certification process ID, secondary user ID, course ID, and session ID as path parameters.
|
|
3212
3362
|
*
|
|
@@ -3246,7 +3396,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3246
3396
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
3247
3397
|
* @secure
|
|
3248
3398
|
*/
|
|
3249
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
3399
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: Input8F9Tnd70S1, params?: RequestParams) => Promise<any>;
|
|
3250
3400
|
/**
|
|
3251
3401
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
3252
3402
|
*
|
|
@@ -3306,7 +3456,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3306
3456
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3307
3457
|
* @secure
|
|
3308
3458
|
*/
|
|
3309
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
3459
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: InputDvl5Dcmb96, params?: RequestParams) => Promise<any>;
|
|
3310
3460
|
/**
|
|
3311
3461
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3312
3462
|
*
|
|
@@ -3326,7 +3476,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3326
3476
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3327
3477
|
* @secure
|
|
3328
3478
|
*/
|
|
3329
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3479
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputXgiq6Ooomw, params?: RequestParams) => Promise<any>;
|
|
3330
3480
|
/**
|
|
3331
3481
|
* @description This route allows you to submit a pending approval.
|
|
3332
3482
|
*
|
|
@@ -3336,7 +3486,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3336
3486
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3337
3487
|
* @secure
|
|
3338
3488
|
*/
|
|
3339
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3489
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputOexr2Qxfau, params?: RequestParams) => Promise<any>;
|
|
3340
3490
|
/**
|
|
3341
3491
|
* @description This route allows you to review a pending approval.
|
|
3342
3492
|
*
|
|
@@ -3346,7 +3496,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3346
3496
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3347
3497
|
* @secure
|
|
3348
3498
|
*/
|
|
3349
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3499
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputZauj6Kl3W2, params?: RequestParams) => Promise<any>;
|
|
3350
3500
|
/**
|
|
3351
3501
|
* @description Redeems a license for a user by product ID.
|
|
3352
3502
|
*
|
|
@@ -3356,7 +3506,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3356
3506
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3357
3507
|
* @secure
|
|
3358
3508
|
*/
|
|
3359
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3509
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputMsk4L6Y8T6, params?: RequestParams) => Promise<any>;
|
|
3360
3510
|
/**
|
|
3361
3511
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3362
3512
|
*
|
|
@@ -3366,7 +3516,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3366
3516
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3367
3517
|
* @secure
|
|
3368
3518
|
*/
|
|
3369
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3519
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputK50Eo4Le8G>;
|
|
3370
3520
|
/**
|
|
3371
3521
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3372
3522
|
*
|
|
@@ -3376,7 +3526,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3376
3526
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3377
3527
|
* @secure
|
|
3378
3528
|
*/
|
|
3379
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3529
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputNbfoc0D7Fok, params?: RequestParams) => Promise<any>;
|
|
3380
3530
|
/**
|
|
3381
3531
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3382
3532
|
*
|
|
@@ -3386,7 +3536,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3386
3536
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3387
3537
|
* @secure
|
|
3388
3538
|
*/
|
|
3389
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3539
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputH27O516961, params?: RequestParams) => Promise<any>;
|
|
3390
3540
|
/**
|
|
3391
3541
|
* @description This endpoint allows updating the ITA number for a user. It requires the user ID as a path parameter and the new ITA number in the request body.
|
|
3392
3542
|
*
|
|
@@ -3396,7 +3546,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3396
3546
|
* @request POST:/user/{userID}/updateITA
|
|
3397
3547
|
* @secure
|
|
3398
3548
|
*/
|
|
3399
|
-
createUpdateIta: (userId: string, data:
|
|
3549
|
+
createUpdateIta: (userId: string, data: Input1Slvu9Z87P, params?: RequestParams) => Promise<any>;
|
|
3400
3550
|
/**
|
|
3401
3551
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3402
3552
|
*
|
|
@@ -3406,7 +3556,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3406
3556
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3407
3557
|
* @secure
|
|
3408
3558
|
*/
|
|
3409
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3559
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: Input2V0Cmpfq55G, params?: RequestParams) => Promise<any>;
|
|
3410
3560
|
/**
|
|
3411
3561
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3412
3562
|
*
|
|
@@ -3416,7 +3566,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3416
3566
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3417
3567
|
* @secure
|
|
3418
3568
|
*/
|
|
3419
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3569
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputL7Diqqlzdq, params?: RequestParams) => Promise<any>;
|
|
3420
3570
|
/**
|
|
3421
3571
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3422
3572
|
*
|
|
@@ -3447,6 +3597,88 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3447
3597
|
* @secure
|
|
3448
3598
|
*/
|
|
3449
3599
|
createSponsorshipReset: (userId: string, data: ResetSponsorshipBody, params?: RequestParams) => Promise<any>;
|
|
3600
|
+
/**
|
|
3601
|
+
* @description Retrieve all work hours records (proof of experience) for a user.
|
|
3602
|
+
*
|
|
3603
|
+
* @tags WorkHours
|
|
3604
|
+
* @name GetWorkHours
|
|
3605
|
+
* @summary List User Work Hours
|
|
3606
|
+
* @request GET:/user/{userID}/workHours
|
|
3607
|
+
* @secure
|
|
3608
|
+
*/
|
|
3609
|
+
getWorkHours: (userId: string, params?: RequestParams) => Promise<WorkHoursListResponse>;
|
|
3610
|
+
/**
|
|
3611
|
+
* @description Retrieve a single work hours record (proof of experience) for a user by its ID.
|
|
3612
|
+
*
|
|
3613
|
+
* @tags WorkHours
|
|
3614
|
+
* @name GetWorkHours2
|
|
3615
|
+
* @summary Get User Work Hours
|
|
3616
|
+
* @request GET:/user/{userID}/workHours/{workHoursID}
|
|
3617
|
+
* @originalName getWorkHours
|
|
3618
|
+
* @duplicate
|
|
3619
|
+
* @secure
|
|
3620
|
+
*/
|
|
3621
|
+
getWorkHours2: (userId: string, workHoursId: string, params?: RequestParams) => Promise<WorkHoursResponseEntity>;
|
|
3622
|
+
/**
|
|
3623
|
+
* @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.
|
|
3624
|
+
*
|
|
3625
|
+
* @tags WorkHours
|
|
3626
|
+
* @name ListWorkHours
|
|
3627
|
+
* @summary Create User Work Hours
|
|
3628
|
+
* @request POST:/user/{userID}/workHours/{workHoursID}
|
|
3629
|
+
* @secure
|
|
3630
|
+
*/
|
|
3631
|
+
listWorkHours: (userId: string, workHoursId: string, data: WorkHoursWrite, params?: RequestParams) => Promise<WorkHoursResponseEntity>;
|
|
3632
|
+
/**
|
|
3633
|
+
* @description Update an existing work hours record (proof of experience) for a user.
|
|
3634
|
+
*
|
|
3635
|
+
* @tags WorkHours
|
|
3636
|
+
* @name UpdateWorkHours
|
|
3637
|
+
* @summary Update User Work Hours
|
|
3638
|
+
* @request PUT:/user/{userID}/workHours/{workHoursID}
|
|
3639
|
+
* @secure
|
|
3640
|
+
*/
|
|
3641
|
+
updateWorkHours: (userId: string, workHoursId: string, data: WorkHoursWrite, params?: RequestParams) => Promise<WorkHoursResponseEntity>;
|
|
3642
|
+
/**
|
|
3643
|
+
* @description Delete a work hours record (proof of experience) for a user by its ID.
|
|
3644
|
+
*
|
|
3645
|
+
* @tags WorkHours
|
|
3646
|
+
* @name DeleteWorkHours
|
|
3647
|
+
* @summary Delete User Work Hours
|
|
3648
|
+
* @request DELETE:/user/{userID}/workHours/{workHoursID}
|
|
3649
|
+
* @secure
|
|
3650
|
+
*/
|
|
3651
|
+
deleteWorkHours: (userId: string, workHoursId: string, params?: RequestParams) => Promise<any>;
|
|
3652
|
+
/**
|
|
3653
|
+
* @description This route allows you to create a signed URL to upload a work hours file for a user.
|
|
3654
|
+
*
|
|
3655
|
+
* @tags WorkHours
|
|
3656
|
+
* @name CreateWorkHoursFileSign
|
|
3657
|
+
* @summary Work hours file
|
|
3658
|
+
* @request POST:/user/{userID}/workHours/{workHoursID}/fileSign/{fileID}
|
|
3659
|
+
* @secure
|
|
3660
|
+
*/
|
|
3661
|
+
createWorkHoursFileSign: ({ userId, workHoursId, fileId, ...query }: CreateWorkHoursFileSignParams, params?: RequestParams) => Promise<OutputDfi7Lgx5Y2>;
|
|
3662
|
+
/**
|
|
3663
|
+
* @description Delete a work hours file for a user.
|
|
3664
|
+
*
|
|
3665
|
+
* @tags WorkHours
|
|
3666
|
+
* @name DeleteWorkHoursFileSign
|
|
3667
|
+
* @summary Delete Work Hours File
|
|
3668
|
+
* @request DELETE:/user/{userID}/workHours/{workHoursID}/fileSign/{fileID}
|
|
3669
|
+
* @secure
|
|
3670
|
+
*/
|
|
3671
|
+
deleteWorkHoursFileSign: (userId: string, workHoursId: string, fileId: string, params?: RequestParams) => Promise<any>;
|
|
3672
|
+
/**
|
|
3673
|
+
* @description Retrieve a signed URL to download a work hours file for a user.
|
|
3674
|
+
*
|
|
3675
|
+
* @tags WorkHours
|
|
3676
|
+
* @name GetWorkHoursFileSign
|
|
3677
|
+
* @summary Get Work Hours File
|
|
3678
|
+
* @request GET:/user/{userID}/workHours/{workHoursID}/fileSign/{fileID}
|
|
3679
|
+
* @secure
|
|
3680
|
+
*/
|
|
3681
|
+
getWorkHoursFileSign: (userId: string, workHoursId: string, fileId: string, params?: RequestParams) => Promise<OutputG0Ygvys9Tfl>;
|
|
3450
3682
|
};
|
|
3451
3683
|
users: {
|
|
3452
3684
|
/**
|
|
@@ -3458,7 +3690,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3458
3690
|
* @request POST:/users/certification/{certSpecID}
|
|
3459
3691
|
* @secure
|
|
3460
3692
|
*/
|
|
3461
|
-
createCertification: (certSpecId: string, data:
|
|
3693
|
+
createCertification: (certSpecId: string, data: InputVn7Imocp5P, params?: RequestParams) => Promise<OutputVn7Imocp5P>;
|
|
3462
3694
|
/**
|
|
3463
3695
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3464
3696
|
*
|