@ikonintegration/bccsa-program-api 3.0.40 → 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 +149 -99
- package/dist/Api.d.ts +148 -110
- package/dist/Api.js +25 -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 Input7Vmuwipays {
|
|
|
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 Input2Aq4Pyagkd {
|
|
|
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 Input8Klnphf8Bc {
|
|
|
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 Input3Nox52Otw6 {
|
|
|
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 Input6Hyaakdeqh {
|
|
|
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 Input97Kt0K1U4M {
|
|
|
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 InputP41Mwrllc3J {
|
|
|
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 Input0Vk0Eax6Wa {
|
|
|
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 InputC8Zwd7Q8U9 {
|
|
|
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 Input6Xov0Uhvug {
|
|
|
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 InputAkthwncsqzg {
|
|
|
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 Input5Sm698V54Kl {
|
|
|
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 Input00Cup216Sw {
|
|
|
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 InputRiihigs1Zdi {
|
|
|
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 OutputRt315Aaaee {
|
|
|
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 InputCc03755Grj {
|
|
|
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 InputQr67F4X9Qz {
|
|
|
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 Input1Gepy2Er06 {
|
|
|
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 Output1Gepy2Er06 {
|
|
|
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 Input2Ypeat3Q15H {
|
|
|
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 Input250S74Bjft {
|
|
|
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 OutputApyuuj0P1 {
|
|
|
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 Input5Num6Uwu17K {
|
|
|
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 InputV0Qo4M776D {
|
|
|
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 InputGzpcnkmsxo {
|
|
|
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
|
|
@@ -2179,7 +2205,7 @@ export interface WorkHoursWrite {
|
|
|
2179
2205
|
}[];
|
|
2180
2206
|
}
|
|
2181
2207
|
/** Work hours file response */
|
|
2182
|
-
export interface
|
|
2208
|
+
export interface OutputDfi7Lgx5Y2 {
|
|
2183
2209
|
/**
|
|
2184
2210
|
* Signed URL for the work hours file
|
|
2185
2211
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
|
|
@@ -2187,21 +2213,21 @@ export interface OutputEhwsfr213Q {
|
|
|
2187
2213
|
fileURL: string;
|
|
2188
2214
|
}
|
|
2189
2215
|
/** Work hours file response */
|
|
2190
|
-
export interface
|
|
2216
|
+
export interface OutputG0Ygvys9Tfl {
|
|
2191
2217
|
/**
|
|
2192
2218
|
* Signed URL for the work hours file
|
|
2193
2219
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
|
|
2194
2220
|
*/
|
|
2195
2221
|
fileURL: string;
|
|
2196
2222
|
}
|
|
2197
|
-
export interface
|
|
2223
|
+
export interface InputVn7Imocp5P {
|
|
2198
2224
|
filter: {
|
|
2199
2225
|
from?: number;
|
|
2200
2226
|
sortOrder?: string;
|
|
2201
2227
|
sortField?: string;
|
|
2202
2228
|
};
|
|
2203
2229
|
}
|
|
2204
|
-
export interface
|
|
2230
|
+
export interface OutputVn7Imocp5P {
|
|
2205
2231
|
users: {
|
|
2206
2232
|
firstName: string;
|
|
2207
2233
|
lastName: string;
|
|
@@ -2225,7 +2251,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
2225
2251
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
2226
2252
|
* @example "CHECKED"
|
|
2227
2253
|
*/
|
|
2228
|
-
export declare enum
|
|
2254
|
+
export declare enum Input8F9Tnd70S1ValueEnum {
|
|
2229
2255
|
CHECKED = "CHECKED",
|
|
2230
2256
|
UNCHECKED = "UNCHECKED",
|
|
2231
2257
|
NOVALUE = "NOVALUE"
|
|
@@ -2326,8 +2352,10 @@ export type CreateSearchUsersTermData = any;
|
|
|
2326
2352
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2327
2353
|
export type CreateReportUsersSimpleData = any;
|
|
2328
2354
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2329
|
-
export type CreateSearchUsersCountData =
|
|
2355
|
+
export type CreateSearchUsersCountData = OutputSa87Chshb2;
|
|
2330
2356
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2357
|
+
export type CreateReportStudentsPaidIncompleteCourseData = any;
|
|
2358
|
+
export type CreateReportStudentsPaidIncompleteCourseError = ErrorResponse;
|
|
2331
2359
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2332
2360
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
2333
2361
|
export type DeleteCertificationApplicationItemData = any;
|
|
@@ -2350,7 +2378,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2350
2378
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2351
2379
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2352
2380
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2353
|
-
export type GetCertificationCourseFileSignData =
|
|
2381
|
+
export type GetCertificationCourseFileSignData = OutputMzn398Miqag;
|
|
2354
2382
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2355
2383
|
export interface CreateCertificationCourseFileSignParams {
|
|
2356
2384
|
/** @example "pdf" */
|
|
@@ -2364,11 +2392,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2364
2392
|
/** @example "fileID" */
|
|
2365
2393
|
fileId: string;
|
|
2366
2394
|
}
|
|
2367
|
-
export type CreateCertificationCourseFileSignData =
|
|
2395
|
+
export type CreateCertificationCourseFileSignData = OutputO7Izub8Bxe;
|
|
2368
2396
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2369
2397
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2370
2398
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2371
|
-
export type CreateCertificationCourseDocumentData =
|
|
2399
|
+
export type CreateCertificationCourseDocumentData = OutputSj177Dwq6Q;
|
|
2372
2400
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2373
2401
|
export type DeleteSponsorshipPendingApprovalData = any;
|
|
2374
2402
|
export type DeleteSponsorshipPendingApprovalError = ErrorResponse;
|
|
@@ -2384,7 +2412,7 @@ export type UpdateUserData = any;
|
|
|
2384
2412
|
export type UpdateUserError = ErrorResponse;
|
|
2385
2413
|
export type DeleteCertificationCourseData = any;
|
|
2386
2414
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2387
|
-
export type GetCertificationApplicationItemFileData =
|
|
2415
|
+
export type GetCertificationApplicationItemFileData = Output5Wy4Ij5R2L;
|
|
2388
2416
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2389
2417
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2390
2418
|
/** @example "pdf" */
|
|
@@ -2398,9 +2426,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2398
2426
|
/** @example "fileVersion" */
|
|
2399
2427
|
fileVersion: string;
|
|
2400
2428
|
}
|
|
2401
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2429
|
+
export type CreateCertificationApplicationItemFileData = OutputO44Lmw18Hm;
|
|
2402
2430
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2403
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2431
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = Output93Vvrem4Cnj;
|
|
2404
2432
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2405
2433
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2406
2434
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2408,7 +2436,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2408
2436
|
export type GetCourseError = ErrorResponse;
|
|
2409
2437
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2410
2438
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2411
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2439
|
+
export type GetCertificationApplicationForeignFillData = Output4R7Cihk7Va;
|
|
2412
2440
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2413
2441
|
export type GetCertificationPrintData = any;
|
|
2414
2442
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2442,7 +2470,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2442
2470
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2443
2471
|
export type CreateCertificationWaiveData = any;
|
|
2444
2472
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2445
|
-
export type CreateCertificationMoveData =
|
|
2473
|
+
export type CreateCertificationMoveData = OutputC6Swugv92O;
|
|
2446
2474
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2447
2475
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2448
2476
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2474,7 +2502,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2474
2502
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2475
2503
|
export type CreateCertificationCourseRedeemData = any;
|
|
2476
2504
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2477
|
-
export type CreateCertificationMoveValidateData =
|
|
2505
|
+
export type CreateCertificationMoveValidateData = OutputK50Eo4Le8G;
|
|
2478
2506
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2479
2507
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2480
2508
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2512,13 +2540,13 @@ export interface CreateWorkHoursFileSignParams {
|
|
|
2512
2540
|
/** @example "fileID" */
|
|
2513
2541
|
fileId: string;
|
|
2514
2542
|
}
|
|
2515
|
-
export type CreateWorkHoursFileSignData =
|
|
2543
|
+
export type CreateWorkHoursFileSignData = OutputDfi7Lgx5Y2;
|
|
2516
2544
|
export type CreateWorkHoursFileSignError = ErrorResponse;
|
|
2517
2545
|
export type DeleteWorkHoursFileSignData = any;
|
|
2518
2546
|
export type DeleteWorkHoursFileSignError = ErrorResponse;
|
|
2519
|
-
export type GetWorkHoursFileSignData =
|
|
2547
|
+
export type GetWorkHoursFileSignData = OutputG0Ygvys9Tfl;
|
|
2520
2548
|
export type GetWorkHoursFileSignError = ErrorResponse;
|
|
2521
|
-
export type CreateCertificationResult =
|
|
2549
|
+
export type CreateCertificationResult = OutputVn7Imocp5P;
|
|
2522
2550
|
export type CreateCertificationFail = ErrorResponse;
|
|
2523
2551
|
export type CreateCertificationPublishInfoResult = any;
|
|
2524
2552
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2565,7 +2593,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2565
2593
|
}
|
|
2566
2594
|
/**
|
|
2567
2595
|
* @title BCCSA Program API
|
|
2568
|
-
* @version 3.0.
|
|
2596
|
+
* @version 3.0.41
|
|
2569
2597
|
* @baseUrl http://localhost:8080
|
|
2570
2598
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2571
2599
|
*/
|
|
@@ -2580,7 +2608,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2580
2608
|
* @request POST:/contactUs
|
|
2581
2609
|
* @secure
|
|
2582
2610
|
*/
|
|
2583
|
-
listContactUs: (data:
|
|
2611
|
+
listContactUs: (data: InputIpmc99Otqdg, params?: RequestParams) => Promise<any>;
|
|
2584
2612
|
};
|
|
2585
2613
|
customer: {
|
|
2586
2614
|
/**
|
|
@@ -2624,7 +2652,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2624
2652
|
* @request PUT:/sponsorship/approve/{paID}
|
|
2625
2653
|
* @secure
|
|
2626
2654
|
*/
|
|
2627
|
-
updateApprove: (paId: string, data:
|
|
2655
|
+
updateApprove: (paId: string, data: InputNdozkicip3, params?: RequestParams) => Promise<any>;
|
|
2628
2656
|
};
|
|
2629
2657
|
tenant: {
|
|
2630
2658
|
/**
|
|
@@ -2696,7 +2724,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2696
2724
|
* @request POST:/tenant/report/applicationExport
|
|
2697
2725
|
* @secure
|
|
2698
2726
|
*/
|
|
2699
|
-
createReportApplicationExport: (data:
|
|
2727
|
+
createReportApplicationExport: (data: InputD4Rprncvca, params?: RequestParams) => Promise<any>;
|
|
2700
2728
|
/**
|
|
2701
2729
|
* @description Export a report of applications based on the provided filters.
|
|
2702
2730
|
*
|
|
@@ -2706,7 +2734,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2706
2734
|
* @request POST:/tenant/report/applicationStatus
|
|
2707
2735
|
* @secure
|
|
2708
2736
|
*/
|
|
2709
|
-
listReportApplicationStatus: (data:
|
|
2737
|
+
listReportApplicationStatus: (data: InputOdq90W7Fvd, params?: RequestParams) => Promise<any>;
|
|
2710
2738
|
/**
|
|
2711
2739
|
* @description Export a report of applications based on the provided filters.
|
|
2712
2740
|
*
|
|
@@ -2716,7 +2744,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2716
2744
|
* @request POST:/tenant/report/applicationsReport
|
|
2717
2745
|
* @secure
|
|
2718
2746
|
*/
|
|
2719
|
-
createReportApplicationsReport: (data:
|
|
2747
|
+
createReportApplicationsReport: (data: InputKhw29Smbei, params?: RequestParams) => Promise<any>;
|
|
2720
2748
|
/**
|
|
2721
2749
|
* @description This route allows you to post certificates email for the tenant.
|
|
2722
2750
|
*
|
|
@@ -2726,7 +2754,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2726
2754
|
* @request POST:/tenant/certificates/email
|
|
2727
2755
|
* @secure
|
|
2728
2756
|
*/
|
|
2729
|
-
createCertificatesEmail: (data:
|
|
2757
|
+
createCertificatesEmail: (data: InputE4Gqi912J9, params?: RequestParams) => Promise<any>;
|
|
2730
2758
|
/**
|
|
2731
2759
|
* @description Generate a preview of the completed certifications report.
|
|
2732
2760
|
*
|
|
@@ -2756,7 +2784,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2756
2784
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2757
2785
|
* @secure
|
|
2758
2786
|
*/
|
|
2759
|
-
createLicenseRedeem: (userId: string, data:
|
|
2787
|
+
createLicenseRedeem: (userId: string, data: InputQihsbffnta, params?: RequestParams) => Promise<any>;
|
|
2760
2788
|
/**
|
|
2761
2789
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2762
2790
|
*
|
|
@@ -2766,7 +2794,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2766
2794
|
* @request POST:/tenant/report/orglicenses/
|
|
2767
2795
|
* @secure
|
|
2768
2796
|
*/
|
|
2769
|
-
listReportOrglicenses: (data:
|
|
2797
|
+
listReportOrglicenses: (data: Input0Cdbeyihx9, params?: RequestParams) => Promise<any>;
|
|
2770
2798
|
/**
|
|
2771
2799
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2772
2800
|
*
|
|
@@ -2776,7 +2804,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2776
2804
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2777
2805
|
* @secure
|
|
2778
2806
|
*/
|
|
2779
|
-
createReportOrglicensesPreview: (data:
|
|
2807
|
+
createReportOrglicensesPreview: (data: Input03993Y2Hmhg, params?: RequestParams) => Promise<any>;
|
|
2780
2808
|
/**
|
|
2781
2809
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2782
2810
|
*
|
|
@@ -2816,7 +2844,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2816
2844
|
* @request POST:/tenant/report/users/advanced
|
|
2817
2845
|
* @secure
|
|
2818
2846
|
*/
|
|
2819
|
-
createReportUsersAdvanced: (data:
|
|
2847
|
+
createReportUsersAdvanced: (data: InputX6Br1Bzszd, params?: RequestParams) => Promise<any>;
|
|
2820
2848
|
/**
|
|
2821
2849
|
* @description Searches for users in the tenant by their IDs.
|
|
2822
2850
|
*
|
|
@@ -2826,7 +2854,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2826
2854
|
* @request POST:/tenant/search/users/ids
|
|
2827
2855
|
* @secure
|
|
2828
2856
|
*/
|
|
2829
|
-
listSearchUsersIds: (data:
|
|
2857
|
+
listSearchUsersIds: (data: InputAcb6Cb0Wc, params?: RequestParams) => Promise<any>;
|
|
2830
2858
|
/**
|
|
2831
2859
|
* @description Searches for users in the tenant by term and filters.
|
|
2832
2860
|
*
|
|
@@ -2836,7 +2864,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2836
2864
|
* @request POST:/tenant/search/users/term
|
|
2837
2865
|
* @secure
|
|
2838
2866
|
*/
|
|
2839
|
-
createSearchUsersTerm: (data:
|
|
2867
|
+
createSearchUsersTerm: (data: InputSnyycdllar, params?: RequestParams) => Promise<any>;
|
|
2840
2868
|
/**
|
|
2841
2869
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2842
2870
|
*
|
|
@@ -2846,7 +2874,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2846
2874
|
* @request POST:/tenant/report/users/simple
|
|
2847
2875
|
* @secure
|
|
2848
2876
|
*/
|
|
2849
|
-
createReportUsersSimple: (data:
|
|
2877
|
+
createReportUsersSimple: (data: InputV6Bi78Xqc6, params?: RequestParams) => Promise<any>;
|
|
2850
2878
|
/**
|
|
2851
2879
|
* @description Retrieve user by ID.
|
|
2852
2880
|
*
|
|
@@ -2856,7 +2884,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2856
2884
|
* @request POST:/tenant/search/users/count
|
|
2857
2885
|
* @secure
|
|
2858
2886
|
*/
|
|
2859
|
-
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>;
|
|
2860
2898
|
};
|
|
2861
2899
|
user: {
|
|
2862
2900
|
/**
|
|
@@ -2888,7 +2926,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2888
2926
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2889
2927
|
* @secure
|
|
2890
2928
|
*/
|
|
2891
|
-
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>;
|
|
2892
2930
|
/**
|
|
2893
2931
|
* @description Delete a certification process application by type.
|
|
2894
2932
|
*
|
|
@@ -2978,7 +3016,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2978
3016
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2979
3017
|
* @secure
|
|
2980
3018
|
*/
|
|
2981
|
-
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>;
|
|
2982
3020
|
/**
|
|
2983
3021
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2984
3022
|
*
|
|
@@ -2988,7 +3026,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2988
3026
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2989
3027
|
* @secure
|
|
2990
3028
|
*/
|
|
2991
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
3029
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputO7Izub8Bxe>;
|
|
2992
3030
|
/**
|
|
2993
3031
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2994
3032
|
*
|
|
@@ -3008,7 +3046,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3008
3046
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
3009
3047
|
* @secure
|
|
3010
3048
|
*/
|
|
3011
|
-
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>;
|
|
3012
3050
|
/**
|
|
3013
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.
|
|
3014
3052
|
*
|
|
@@ -3058,7 +3096,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3058
3096
|
* @request POST:/user/{userID}
|
|
3059
3097
|
* @secure
|
|
3060
3098
|
*/
|
|
3061
|
-
createUser: (userId: string, data:
|
|
3099
|
+
createUser: (userId: string, data: InputGud41Drhmr, params?: RequestParams) => Promise<any>;
|
|
3062
3100
|
/**
|
|
3063
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.
|
|
3064
3102
|
*
|
|
@@ -3068,7 +3106,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3068
3106
|
* @request PUT:/user/{userID}
|
|
3069
3107
|
* @secure
|
|
3070
3108
|
*/
|
|
3071
|
-
updateUser: (userId: string, data:
|
|
3109
|
+
updateUser: (userId: string, data: InputBknn2Isn2Ll, params?: RequestParams) => Promise<any>;
|
|
3072
3110
|
/**
|
|
3073
3111
|
* @description Delete course from user
|
|
3074
3112
|
*
|
|
@@ -3088,7 +3126,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3088
3126
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
3089
3127
|
* @secure
|
|
3090
3128
|
*/
|
|
3091
|
-
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>;
|
|
3092
3130
|
/**
|
|
3093
3131
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
3094
3132
|
*
|
|
@@ -3098,7 +3136,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3098
3136
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
3099
3137
|
* @secure
|
|
3100
3138
|
*/
|
|
3101
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
3139
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputO44Lmw18Hm>;
|
|
3102
3140
|
/**
|
|
3103
3141
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
3104
3142
|
*
|
|
@@ -3108,7 +3146,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3108
3146
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
3109
3147
|
* @secure
|
|
3110
3148
|
*/
|
|
3111
|
-
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>;
|
|
3112
3150
|
/**
|
|
3113
3151
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
3114
3152
|
*
|
|
@@ -3148,7 +3186,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3148
3186
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
3149
3187
|
* @secure
|
|
3150
3188
|
*/
|
|
3151
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
3189
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<Output4R7Cihk7Va>;
|
|
3152
3190
|
/**
|
|
3153
3191
|
* @description This endpoint will print certificate
|
|
3154
3192
|
*
|
|
@@ -3208,7 +3246,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3208
3246
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
3209
3247
|
* @secure
|
|
3210
3248
|
*/
|
|
3211
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
3249
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputX6Wo72Dybzj, params?: RequestParams) => Promise<any>;
|
|
3212
3250
|
/**
|
|
3213
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.
|
|
3214
3252
|
*
|
|
@@ -3238,7 +3276,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3238
3276
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
3239
3277
|
* @secure
|
|
3240
3278
|
*/
|
|
3241
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3279
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputFvtyzhspxlk, params?: RequestParams) => Promise<any>;
|
|
3242
3280
|
/**
|
|
3243
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.
|
|
3244
3282
|
*
|
|
@@ -3248,7 +3286,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3248
3286
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
3249
3287
|
* @secure
|
|
3250
3288
|
*/
|
|
3251
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3289
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: Input5R9Ud8Ixob, params?: RequestParams) => Promise<any>;
|
|
3252
3290
|
/**
|
|
3253
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.
|
|
3254
3292
|
*
|
|
@@ -3258,7 +3296,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3258
3296
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
3259
3297
|
* @secure
|
|
3260
3298
|
*/
|
|
3261
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
3299
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputSwpu5Vwre6, params?: RequestParams) => Promise<any>;
|
|
3262
3300
|
/**
|
|
3263
3301
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
3264
3302
|
*
|
|
@@ -3268,7 +3306,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3268
3306
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
3269
3307
|
* @secure
|
|
3270
3308
|
*/
|
|
3271
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
3309
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputM3Vuv0N0Ko, params?: RequestParams) => Promise<any>;
|
|
3272
3310
|
/**
|
|
3273
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.
|
|
3274
3312
|
*
|
|
@@ -3308,7 +3346,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3308
3346
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
3309
3347
|
* @secure
|
|
3310
3348
|
*/
|
|
3311
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
3349
|
+
createCertificationWaive: (userId: string, certProcId: string, data: Input67Joiiq2Mlf, params?: RequestParams) => Promise<any>;
|
|
3312
3350
|
/**
|
|
3313
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.
|
|
3314
3352
|
*
|
|
@@ -3318,7 +3356,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3318
3356
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
3319
3357
|
* @secure
|
|
3320
3358
|
*/
|
|
3321
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3359
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputC6Swugv92O>;
|
|
3322
3360
|
/**
|
|
3323
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.
|
|
3324
3362
|
*
|
|
@@ -3358,7 +3396,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3358
3396
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
3359
3397
|
* @secure
|
|
3360
3398
|
*/
|
|
3361
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
3399
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: Input8F9Tnd70S1, params?: RequestParams) => Promise<any>;
|
|
3362
3400
|
/**
|
|
3363
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.
|
|
3364
3402
|
*
|
|
@@ -3418,7 +3456,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3418
3456
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3419
3457
|
* @secure
|
|
3420
3458
|
*/
|
|
3421
|
-
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>;
|
|
3422
3460
|
/**
|
|
3423
3461
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3424
3462
|
*
|
|
@@ -3438,7 +3476,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3438
3476
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3439
3477
|
* @secure
|
|
3440
3478
|
*/
|
|
3441
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3479
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputXgiq6Ooomw, params?: RequestParams) => Promise<any>;
|
|
3442
3480
|
/**
|
|
3443
3481
|
* @description This route allows you to submit a pending approval.
|
|
3444
3482
|
*
|
|
@@ -3448,7 +3486,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3448
3486
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3449
3487
|
* @secure
|
|
3450
3488
|
*/
|
|
3451
|
-
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>;
|
|
3452
3490
|
/**
|
|
3453
3491
|
* @description This route allows you to review a pending approval.
|
|
3454
3492
|
*
|
|
@@ -3458,7 +3496,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3458
3496
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3459
3497
|
* @secure
|
|
3460
3498
|
*/
|
|
3461
|
-
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>;
|
|
3462
3500
|
/**
|
|
3463
3501
|
* @description Redeems a license for a user by product ID.
|
|
3464
3502
|
*
|
|
@@ -3468,7 +3506,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3468
3506
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3469
3507
|
* @secure
|
|
3470
3508
|
*/
|
|
3471
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3509
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputMsk4L6Y8T6, params?: RequestParams) => Promise<any>;
|
|
3472
3510
|
/**
|
|
3473
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.
|
|
3474
3512
|
*
|
|
@@ -3478,7 +3516,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3478
3516
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3479
3517
|
* @secure
|
|
3480
3518
|
*/
|
|
3481
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3519
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputK50Eo4Le8G>;
|
|
3482
3520
|
/**
|
|
3483
3521
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3484
3522
|
*
|
|
@@ -3488,7 +3526,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3488
3526
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3489
3527
|
* @secure
|
|
3490
3528
|
*/
|
|
3491
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3529
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputNbfoc0D7Fok, params?: RequestParams) => Promise<any>;
|
|
3492
3530
|
/**
|
|
3493
3531
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3494
3532
|
*
|
|
@@ -3498,7 +3536,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3498
3536
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3499
3537
|
* @secure
|
|
3500
3538
|
*/
|
|
3501
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3539
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputH27O516961, params?: RequestParams) => Promise<any>;
|
|
3502
3540
|
/**
|
|
3503
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.
|
|
3504
3542
|
*
|
|
@@ -3508,7 +3546,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3508
3546
|
* @request POST:/user/{userID}/updateITA
|
|
3509
3547
|
* @secure
|
|
3510
3548
|
*/
|
|
3511
|
-
createUpdateIta: (userId: string, data:
|
|
3549
|
+
createUpdateIta: (userId: string, data: Input1Slvu9Z87P, params?: RequestParams) => Promise<any>;
|
|
3512
3550
|
/**
|
|
3513
3551
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3514
3552
|
*
|
|
@@ -3518,7 +3556,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3518
3556
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3519
3557
|
* @secure
|
|
3520
3558
|
*/
|
|
3521
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3559
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: Input2V0Cmpfq55G, params?: RequestParams) => Promise<any>;
|
|
3522
3560
|
/**
|
|
3523
3561
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3524
3562
|
*
|
|
@@ -3528,7 +3566,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3528
3566
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3529
3567
|
* @secure
|
|
3530
3568
|
*/
|
|
3531
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3569
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputL7Diqqlzdq, params?: RequestParams) => Promise<any>;
|
|
3532
3570
|
/**
|
|
3533
3571
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3534
3572
|
*
|
|
@@ -3620,7 +3658,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3620
3658
|
* @request POST:/user/{userID}/workHours/{workHoursID}/fileSign/{fileID}
|
|
3621
3659
|
* @secure
|
|
3622
3660
|
*/
|
|
3623
|
-
createWorkHoursFileSign: ({ userId, workHoursId, fileId, ...query }: CreateWorkHoursFileSignParams, params?: RequestParams) => Promise<
|
|
3661
|
+
createWorkHoursFileSign: ({ userId, workHoursId, fileId, ...query }: CreateWorkHoursFileSignParams, params?: RequestParams) => Promise<OutputDfi7Lgx5Y2>;
|
|
3624
3662
|
/**
|
|
3625
3663
|
* @description Delete a work hours file for a user.
|
|
3626
3664
|
*
|
|
@@ -3640,7 +3678,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3640
3678
|
* @request GET:/user/{userID}/workHours/{workHoursID}/fileSign/{fileID}
|
|
3641
3679
|
* @secure
|
|
3642
3680
|
*/
|
|
3643
|
-
getWorkHoursFileSign: (userId: string, workHoursId: string, fileId: string, params?: RequestParams) => Promise<
|
|
3681
|
+
getWorkHoursFileSign: (userId: string, workHoursId: string, fileId: string, params?: RequestParams) => Promise<OutputG0Ygvys9Tfl>;
|
|
3644
3682
|
};
|
|
3645
3683
|
users: {
|
|
3646
3684
|
/**
|
|
@@ -3652,7 +3690,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3652
3690
|
* @request POST:/users/certification/{certSpecID}
|
|
3653
3691
|
* @secure
|
|
3654
3692
|
*/
|
|
3655
|
-
createCertification: (certSpecId: string, data:
|
|
3693
|
+
createCertification: (certSpecId: string, data: InputVn7Imocp5P, params?: RequestParams) => Promise<OutputVn7Imocp5P>;
|
|
3656
3694
|
/**
|
|
3657
3695
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3658
3696
|
*
|