@ikonintegration/bccsa-program-api 3.0.37 → 3.0.38
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 +158 -98
- package/dist/Api.d.ts +156 -102
- package/dist/Api.js +24 -8
- package/dist/Api.js.map +1 -1
- package/package.json +1 -1
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 InputY9452P6Ju5 {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -486,7 +486,7 @@ export type SponsorshipRemindersStudent = string[];
|
|
|
486
486
|
export type SponsorshipRemindersSponsor = string[];
|
|
487
487
|
/** Timestamp when the current sponsorship reminder schedule started (set on create and on reset). Reminder dueness is measured from it; when absent, from createdOn. */
|
|
488
488
|
export type RemindersStartedOn = number;
|
|
489
|
-
export interface
|
|
489
|
+
export interface InputI92Gs480Wi {
|
|
490
490
|
/**
|
|
491
491
|
* ID of the certification to filter applications by
|
|
492
492
|
* @example "certification123"
|
|
@@ -543,7 +543,7 @@ export interface InputN2Pbfp1G69 {
|
|
|
543
543
|
*/
|
|
544
544
|
ignoreCompletedCertifications?: boolean | null;
|
|
545
545
|
}
|
|
546
|
-
export interface
|
|
546
|
+
export interface InputRhw4W336M4 {
|
|
547
547
|
/**
|
|
548
548
|
* ID of the certification to filter applications by
|
|
549
549
|
* @example "certification123"
|
|
@@ -600,7 +600,7 @@ export interface InputJ598Pbmrge {
|
|
|
600
600
|
*/
|
|
601
601
|
ignoreCompletedCertifications?: boolean | null;
|
|
602
602
|
}
|
|
603
|
-
export interface
|
|
603
|
+
export interface InputDwl6Jshl2T {
|
|
604
604
|
/**
|
|
605
605
|
* ID of the certification to filter applications by
|
|
606
606
|
* @example "certification123"
|
|
@@ -657,7 +657,7 @@ export interface InputZpvr6A88Xc {
|
|
|
657
657
|
*/
|
|
658
658
|
ignoreCompletedCertifications?: boolean | null;
|
|
659
659
|
}
|
|
660
|
-
export interface
|
|
660
|
+
export interface InputAadskx0R66 {
|
|
661
661
|
/**
|
|
662
662
|
* The ID of the certificate specifications to be used for the email
|
|
663
663
|
* @example "certSpecsID123"
|
|
@@ -698,7 +698,7 @@ export interface InputC1Ye5Hwls5J {
|
|
|
698
698
|
emailAddress: string;
|
|
699
699
|
}[];
|
|
700
700
|
}
|
|
701
|
-
export interface
|
|
701
|
+
export interface InputFzsxnr61Gz {
|
|
702
702
|
/**
|
|
703
703
|
* The ID of the product for which the license is being redeemed
|
|
704
704
|
* @example "productID123"
|
|
@@ -710,7 +710,7 @@ export interface InputSaxqz8G15X {
|
|
|
710
710
|
*/
|
|
711
711
|
sessionID?: string;
|
|
712
712
|
}
|
|
713
|
-
export interface
|
|
713
|
+
export interface InputWb2Lmb2Fy7 {
|
|
714
714
|
/**
|
|
715
715
|
* Search term to filter licenses
|
|
716
716
|
* @example "active"
|
|
@@ -727,7 +727,7 @@ export interface InputQdeponwb9F {
|
|
|
727
727
|
*/
|
|
728
728
|
sortField?: any;
|
|
729
729
|
}
|
|
730
|
-
export interface
|
|
730
|
+
export interface Input8Sx76Qyyss {
|
|
731
731
|
/**
|
|
732
732
|
* Search term to filter licenses
|
|
733
733
|
* @example "active"
|
|
@@ -860,7 +860,7 @@ export interface SearchPendingApprovalsResponseSchema {
|
|
|
860
860
|
remindersStartedOn?: RemindersStartedOn;
|
|
861
861
|
}[];
|
|
862
862
|
}
|
|
863
|
-
export interface
|
|
863
|
+
export interface Input1Ohda2Wgsh {
|
|
864
864
|
/**
|
|
865
865
|
* Start date for the report
|
|
866
866
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -882,11 +882,11 @@ export interface InputJh6321Ew32 {
|
|
|
882
882
|
*/
|
|
883
883
|
dateType?: string;
|
|
884
884
|
}
|
|
885
|
-
export interface
|
|
885
|
+
export interface InputO1Eswyvj0E {
|
|
886
886
|
/** List of user IDs to search for in the tenant. */
|
|
887
887
|
IDs: (string | null)[];
|
|
888
888
|
}
|
|
889
|
-
export interface
|
|
889
|
+
export interface InputRalyzixy0A {
|
|
890
890
|
/** The term to search for in the user profiles. */
|
|
891
891
|
searchTerm?: string | null;
|
|
892
892
|
/** Filter criteria for the user search. */
|
|
@@ -926,7 +926,7 @@ export interface InputCfab2Oqckr {
|
|
|
926
926
|
};
|
|
927
927
|
};
|
|
928
928
|
}
|
|
929
|
-
export interface
|
|
929
|
+
export interface InputVll5Y8N7Fs {
|
|
930
930
|
/** The term to search for in the user profiles. */
|
|
931
931
|
searchTerm?: string | null;
|
|
932
932
|
/** Filter criteria for the user search. */
|
|
@@ -966,7 +966,7 @@ export interface InputFyv0Tovwba {
|
|
|
966
966
|
};
|
|
967
967
|
};
|
|
968
968
|
}
|
|
969
|
-
export interface
|
|
969
|
+
export interface Output4Qe1Gsbbif {
|
|
970
970
|
/** External system ID 2 */
|
|
971
971
|
userCount: ExternalID2;
|
|
972
972
|
transactionID?: string | null;
|
|
@@ -975,14 +975,14 @@ export interface OutputYz6Rjygfu2 {
|
|
|
975
975
|
export type ExternalID2 = number;
|
|
976
976
|
/** This endpoint accepts no request body */
|
|
977
977
|
export type DeletePendingApprovalBody = object;
|
|
978
|
-
export interface
|
|
978
|
+
export interface OutputXmylm4Chhv {
|
|
979
979
|
/**
|
|
980
980
|
* Signed URL for the course file
|
|
981
981
|
* @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"
|
|
982
982
|
*/
|
|
983
983
|
fileURL: string;
|
|
984
984
|
}
|
|
985
|
-
export interface
|
|
985
|
+
export interface Output82Pb5Pn75B {
|
|
986
986
|
/**
|
|
987
987
|
* Amount to be refunded for the cancellation
|
|
988
988
|
* @example 0
|
|
@@ -1282,7 +1282,7 @@ export interface CourseResponseEntity {
|
|
|
1282
1282
|
}
|
|
1283
1283
|
/** Label of the course enrolled (course version) */
|
|
1284
1284
|
export type OnlineCourseLabel = string;
|
|
1285
|
-
export interface
|
|
1285
|
+
export interface OutputGvsap98Xwd {
|
|
1286
1286
|
/**
|
|
1287
1287
|
* Signed URL for the course file
|
|
1288
1288
|
* @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"
|
|
@@ -1300,7 +1300,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1300
1300
|
transactionID?: string | null;
|
|
1301
1301
|
}
|
|
1302
1302
|
/** Application Foreign Fill response type */
|
|
1303
|
-
export interface
|
|
1303
|
+
export interface Output6Pgrlpk9Uci {
|
|
1304
1304
|
items: {
|
|
1305
1305
|
userID: string;
|
|
1306
1306
|
createdOn?: number;
|
|
@@ -1379,6 +1379,41 @@ export type SourceType = string;
|
|
|
1379
1379
|
export type ExpiresOn = number;
|
|
1380
1380
|
/** Date when the result was achieved (e.g., passed) */
|
|
1381
1381
|
export type ResultDate = number;
|
|
1382
|
+
/** The retrieved sponsorship pending-approval record */
|
|
1383
|
+
export interface GetPendingApprovalResponse {
|
|
1384
|
+
/** @example "PA-abc123" */
|
|
1385
|
+
id: string;
|
|
1386
|
+
/** @example "SPONSOR_ATTESTATION" */
|
|
1387
|
+
type: string;
|
|
1388
|
+
/** @example "userID" */
|
|
1389
|
+
userID: string;
|
|
1390
|
+
/** @example "SRBC-01" */
|
|
1391
|
+
tenantID: string;
|
|
1392
|
+
certProcID?: string;
|
|
1393
|
+
courseID?: string;
|
|
1394
|
+
/** @example "PENDING" */
|
|
1395
|
+
approvalState?: string;
|
|
1396
|
+
approvalNotes?: string;
|
|
1397
|
+
reviewedBy?: string;
|
|
1398
|
+
reviewedOn?: number;
|
|
1399
|
+
createdBy?: string;
|
|
1400
|
+
createdOn?: number;
|
|
1401
|
+
updatedBy?: string;
|
|
1402
|
+
updatedOn?: number;
|
|
1403
|
+
sponsor?: {
|
|
1404
|
+
name?: string;
|
|
1405
|
+
phone?: string;
|
|
1406
|
+
email?: string;
|
|
1407
|
+
title?: string;
|
|
1408
|
+
};
|
|
1409
|
+
user?: {
|
|
1410
|
+
id?: string;
|
|
1411
|
+
name?: string;
|
|
1412
|
+
email?: string;
|
|
1413
|
+
};
|
|
1414
|
+
remindersStartedOn?: number;
|
|
1415
|
+
[key: string]: any;
|
|
1416
|
+
}
|
|
1382
1417
|
/** Response with list of user certification processes and it's upcoming courses and sessions */
|
|
1383
1418
|
export interface UserUpcomingCoursesResponseSchema {
|
|
1384
1419
|
procs?: {
|
|
@@ -1488,7 +1523,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1488
1523
|
applicationItems?: Record<string, any>[];
|
|
1489
1524
|
transactionID?: string | null;
|
|
1490
1525
|
}
|
|
1491
|
-
export interface
|
|
1526
|
+
export interface InputZnx3Yaudw0L {
|
|
1492
1527
|
issuedOn?: number;
|
|
1493
1528
|
expiresOn?: number;
|
|
1494
1529
|
fileItems?: {
|
|
@@ -1497,21 +1532,21 @@ export interface InputLok8Yjdg8Lf {
|
|
|
1497
1532
|
}[];
|
|
1498
1533
|
additionalNotes?: string | null;
|
|
1499
1534
|
}
|
|
1500
|
-
export interface
|
|
1535
|
+
export interface InputE24P17Anqn {
|
|
1501
1536
|
/**
|
|
1502
1537
|
* Indicates whether the application is locked
|
|
1503
1538
|
* @example true
|
|
1504
1539
|
*/
|
|
1505
1540
|
isApplicationLocked: boolean;
|
|
1506
1541
|
}
|
|
1507
|
-
export interface
|
|
1542
|
+
export interface Output42Odz333Xq {
|
|
1508
1543
|
/**
|
|
1509
1544
|
* Signed URL for the course file
|
|
1510
1545
|
* @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"
|
|
1511
1546
|
*/
|
|
1512
1547
|
fileURL: string;
|
|
1513
1548
|
}
|
|
1514
|
-
export interface
|
|
1549
|
+
export interface InputOke7Fx73Wa {
|
|
1515
1550
|
/**
|
|
1516
1551
|
* Indicates whether the waiver is approved
|
|
1517
1552
|
* @example true
|
|
@@ -1523,14 +1558,14 @@ export interface InputV9Pu8Hsooe {
|
|
|
1523
1558
|
*/
|
|
1524
1559
|
additionalNotes?: string | null;
|
|
1525
1560
|
}
|
|
1526
|
-
export interface
|
|
1561
|
+
export interface InputMyxld51Ils {
|
|
1527
1562
|
/**
|
|
1528
1563
|
* Optional notes regarding the waiver
|
|
1529
1564
|
* @example "Waiver granted due to special circumstances."
|
|
1530
1565
|
*/
|
|
1531
1566
|
additionalNotes?: string | null;
|
|
1532
1567
|
}
|
|
1533
|
-
export interface
|
|
1568
|
+
export interface Input78Oq3Ogocp {
|
|
1534
1569
|
students: {
|
|
1535
1570
|
/**
|
|
1536
1571
|
* User ID of the student to redeem the course for
|
|
@@ -1564,7 +1599,7 @@ export interface InputZv1Ikpfitw {
|
|
|
1564
1599
|
*/
|
|
1565
1600
|
autoEnrolSessionID?: string;
|
|
1566
1601
|
}
|
|
1567
|
-
export interface
|
|
1602
|
+
export interface InputI19Hnqwxd9 {
|
|
1568
1603
|
invites: {
|
|
1569
1604
|
/**
|
|
1570
1605
|
* Email address of the user to invite
|
|
@@ -1593,7 +1628,7 @@ export interface InputNf5K52Xa14 {
|
|
|
1593
1628
|
*/
|
|
1594
1629
|
isReservedSeat: boolean;
|
|
1595
1630
|
}
|
|
1596
|
-
export interface
|
|
1631
|
+
export interface Input0Rf8Rir2Wi {
|
|
1597
1632
|
/**
|
|
1598
1633
|
* Indicates whether to waive the certification process
|
|
1599
1634
|
* @example true
|
|
@@ -1606,7 +1641,7 @@ export interface Input1B88Huavnlf {
|
|
|
1606
1641
|
comments?: string | null;
|
|
1607
1642
|
}
|
|
1608
1643
|
/** Certification move response schema */
|
|
1609
|
-
export interface
|
|
1644
|
+
export interface OutputCunolmrmg2 {
|
|
1610
1645
|
errors?: {
|
|
1611
1646
|
status: string;
|
|
1612
1647
|
object?: Record<string, any>;
|
|
@@ -1614,19 +1649,19 @@ export interface OutputK40A9P4Wntj {
|
|
|
1614
1649
|
}[];
|
|
1615
1650
|
}
|
|
1616
1651
|
/** Schema for writing a certification trigger check. */
|
|
1617
|
-
export interface
|
|
1652
|
+
export interface InputFsr7Mbfjl2 {
|
|
1618
1653
|
/**
|
|
1619
1654
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1620
1655
|
* @example "CHECKED"
|
|
1621
1656
|
*/
|
|
1622
|
-
value:
|
|
1657
|
+
value: InputFsr7Mbfjl2ValueEnum;
|
|
1623
1658
|
/**
|
|
1624
1659
|
* List of course IDs that are blocked by this trigger check.
|
|
1625
1660
|
* @example ["course1","course2"]
|
|
1626
1661
|
*/
|
|
1627
1662
|
blockedCourses?: string[];
|
|
1628
1663
|
}
|
|
1629
|
-
export interface
|
|
1664
|
+
export interface InputNsoff4Aqr6 {
|
|
1630
1665
|
/**
|
|
1631
1666
|
* Indicates whether the application item is approved
|
|
1632
1667
|
* @example true
|
|
@@ -1652,7 +1687,7 @@ export interface InputTyyk1Gva3F {
|
|
|
1652
1687
|
export interface StudentHistoryRequestSchema {
|
|
1653
1688
|
requirements: string[];
|
|
1654
1689
|
}
|
|
1655
|
-
export interface
|
|
1690
|
+
export interface InputW46Ry9Xsi5 {
|
|
1656
1691
|
/**
|
|
1657
1692
|
* Optional activation key for the application
|
|
1658
1693
|
* @example "AK-123456"
|
|
@@ -1660,7 +1695,7 @@ export interface Input1Ud4Zfxio7 {
|
|
|
1660
1695
|
activationKey?: string;
|
|
1661
1696
|
}
|
|
1662
1697
|
/** Schema for course submission item details post request. */
|
|
1663
|
-
export interface
|
|
1698
|
+
export interface Input1Q6Ejcokqh {
|
|
1664
1699
|
/**
|
|
1665
1700
|
* The ID of the file being submitted.
|
|
1666
1701
|
* @example "fileID123"
|
|
@@ -1673,7 +1708,7 @@ export interface Input9Ar42O9Flp {
|
|
|
1673
1708
|
fileName: string;
|
|
1674
1709
|
}
|
|
1675
1710
|
/** Schema for the response to course submission item details post request. */
|
|
1676
|
-
export interface
|
|
1711
|
+
export interface Output1Q6Ejcokqh {
|
|
1677
1712
|
submissionItems: {
|
|
1678
1713
|
/**
|
|
1679
1714
|
* The ID of the file being submitted.
|
|
@@ -1688,7 +1723,7 @@ export interface Output9Ar42O9Flp {
|
|
|
1688
1723
|
}[];
|
|
1689
1724
|
}
|
|
1690
1725
|
/** Pending approval submission parameters */
|
|
1691
|
-
export interface
|
|
1726
|
+
export interface InputRxp3Oxn5Tn {
|
|
1692
1727
|
/**
|
|
1693
1728
|
* Type of pending approval
|
|
1694
1729
|
* @example "certification"
|
|
@@ -1708,7 +1743,7 @@ export interface Input83Eunpl3Y9 {
|
|
|
1708
1743
|
fileName: string;
|
|
1709
1744
|
}[];
|
|
1710
1745
|
}
|
|
1711
|
-
export interface
|
|
1746
|
+
export interface InputFpmobr2I5K {
|
|
1712
1747
|
/**
|
|
1713
1748
|
* The ID of the course for which the license is being redeemed
|
|
1714
1749
|
* @example "courseID123"
|
|
@@ -1776,7 +1811,7 @@ export interface InputBvmzq8Voop {
|
|
|
1776
1811
|
acknowledgement?: string | null;
|
|
1777
1812
|
}
|
|
1778
1813
|
/** Validate certification move response schema */
|
|
1779
|
-
export interface
|
|
1814
|
+
export interface Output68Gczuab0M {
|
|
1780
1815
|
courses: {
|
|
1781
1816
|
name: string;
|
|
1782
1817
|
status: string;
|
|
@@ -1787,21 +1822,21 @@ export interface OutputGbnglvar32H {
|
|
|
1787
1822
|
validated: boolean;
|
|
1788
1823
|
mustCreateCP: boolean;
|
|
1789
1824
|
}
|
|
1790
|
-
export interface
|
|
1825
|
+
export interface Input1Z2S5Mvjmj {
|
|
1791
1826
|
/**
|
|
1792
1827
|
* Comments regarding the end of the cooldown period
|
|
1793
1828
|
* @example "Cooldown period ended successfully."
|
|
1794
1829
|
*/
|
|
1795
1830
|
comments: string;
|
|
1796
1831
|
}
|
|
1797
|
-
export interface
|
|
1832
|
+
export interface OutputLfhw9J38Sf {
|
|
1798
1833
|
/**
|
|
1799
1834
|
* Signed URL for the course file
|
|
1800
1835
|
* @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"
|
|
1801
1836
|
*/
|
|
1802
1837
|
fileURL: string;
|
|
1803
1838
|
}
|
|
1804
|
-
export interface
|
|
1839
|
+
export interface InputKz3Sd08My4 {
|
|
1805
1840
|
/** @example true */
|
|
1806
1841
|
agreedWithCertTerms: boolean;
|
|
1807
1842
|
/** @example 1717230000000 */
|
|
@@ -1886,21 +1921,21 @@ export interface Sponsor {
|
|
|
1886
1921
|
/** Title of the sponsor of the student in the tenant */
|
|
1887
1922
|
title?: Title;
|
|
1888
1923
|
}
|
|
1889
|
-
export interface
|
|
1924
|
+
export interface Input7Jrsau5Uep {
|
|
1890
1925
|
/**
|
|
1891
1926
|
* Comments regarding the course unlock action
|
|
1892
1927
|
* @example "Course unlocked successfully."
|
|
1893
1928
|
*/
|
|
1894
1929
|
comments: string;
|
|
1895
1930
|
}
|
|
1896
|
-
export interface
|
|
1931
|
+
export interface InputSdhhf07Dy2 {
|
|
1897
1932
|
/**
|
|
1898
1933
|
* ITA number to update for the user
|
|
1899
1934
|
* @example "ITA123456"
|
|
1900
1935
|
*/
|
|
1901
1936
|
itaNumber: string;
|
|
1902
1937
|
}
|
|
1903
|
-
export interface
|
|
1938
|
+
export interface InputMgiii85Qor {
|
|
1904
1939
|
/** @example true */
|
|
1905
1940
|
agreedWithCertTerms: boolean;
|
|
1906
1941
|
/** @example 1717230000000 */
|
|
@@ -1974,7 +2009,7 @@ export interface InputXumdodu3Vg {
|
|
|
1974
2009
|
/** Sponsor information for a student in the tenant */
|
|
1975
2010
|
sponsor?: Sponsor;
|
|
1976
2011
|
}
|
|
1977
|
-
export interface
|
|
2012
|
+
export interface Input17Tw549Oah {
|
|
1978
2013
|
/**
|
|
1979
2014
|
* The grade to override the course result with
|
|
1980
2015
|
* @example "A"
|
|
@@ -1982,7 +2017,7 @@ export interface InputPpbi3Eojs7 {
|
|
|
1982
2017
|
resultGrade: string;
|
|
1983
2018
|
}
|
|
1984
2019
|
/** Pending approval review parameters */
|
|
1985
|
-
export interface
|
|
2020
|
+
export interface InputRxs18Ly1Jmf {
|
|
1986
2021
|
/**
|
|
1987
2022
|
* Notes provided by the reviewer for the pending approval
|
|
1988
2023
|
* @example "Please review the submitted documents."
|
|
@@ -1993,9 +2028,16 @@ export interface Input9Vbbkncaff {
|
|
|
1993
2028
|
* @example true
|
|
1994
2029
|
*/
|
|
1995
2030
|
approved: boolean;
|
|
2031
|
+
/**
|
|
2032
|
+
* Timestamp (epoch milliseconds) of when the review was performed. Defaults to now when omitted.
|
|
2033
|
+
* @min 0
|
|
2034
|
+
* @exclusiveMin true
|
|
2035
|
+
* @example 1700000000000
|
|
2036
|
+
*/
|
|
2037
|
+
reviewedOn?: number;
|
|
1996
2038
|
}
|
|
1997
2039
|
/** Schema for overriding course result dates. */
|
|
1998
|
-
export interface
|
|
2040
|
+
export interface InputFgo7Tyrxudl {
|
|
1999
2041
|
/**
|
|
2000
2042
|
* The date when the course result expires, in milliseconds since epoch.
|
|
2001
2043
|
* @example 1735689600000
|
|
@@ -2009,14 +2051,14 @@ export interface Input1Gg425Q9K7 {
|
|
|
2009
2051
|
}
|
|
2010
2052
|
/** Reset sponsorship request takes no body */
|
|
2011
2053
|
export type ResetSponsorshipBody = object;
|
|
2012
|
-
export interface
|
|
2054
|
+
export interface InputKtez8C9Ig9F {
|
|
2013
2055
|
filter: {
|
|
2014
2056
|
from?: number;
|
|
2015
2057
|
sortOrder?: string;
|
|
2016
2058
|
sortField?: string;
|
|
2017
2059
|
};
|
|
2018
2060
|
}
|
|
2019
|
-
export interface
|
|
2061
|
+
export interface OutputKtez8C9Ig9F {
|
|
2020
2062
|
users: {
|
|
2021
2063
|
firstName: string;
|
|
2022
2064
|
lastName: string;
|
|
@@ -2040,7 +2082,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
2040
2082
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
2041
2083
|
* @example "CHECKED"
|
|
2042
2084
|
*/
|
|
2043
|
-
export declare enum
|
|
2085
|
+
export declare enum InputFsr7Mbfjl2ValueEnum {
|
|
2044
2086
|
CHECKED = "CHECKED",
|
|
2045
2087
|
UNCHECKED = "UNCHECKED",
|
|
2046
2088
|
NOVALUE = "NOVALUE"
|
|
@@ -2139,7 +2181,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2139
2181
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2140
2182
|
export type CreateReportUsersSimpleData = any;
|
|
2141
2183
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2142
|
-
export type CreateSearchUsersCountData =
|
|
2184
|
+
export type CreateSearchUsersCountData = Output4Qe1Gsbbif;
|
|
2143
2185
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2144
2186
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2145
2187
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2163,7 +2205,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2163
2205
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2164
2206
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2165
2207
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2166
|
-
export type GetCertificationCourseFileSignData =
|
|
2208
|
+
export type GetCertificationCourseFileSignData = OutputGvsap98Xwd;
|
|
2167
2209
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2168
2210
|
export interface CreateCertificationCourseFileSignParams {
|
|
2169
2211
|
/** @example "pdf" */
|
|
@@ -2177,14 +2219,16 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2177
2219
|
/** @example "fileID" */
|
|
2178
2220
|
fileId: string;
|
|
2179
2221
|
}
|
|
2180
|
-
export type CreateCertificationCourseFileSignData =
|
|
2222
|
+
export type CreateCertificationCourseFileSignData = OutputLfhw9J38Sf;
|
|
2181
2223
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2182
2224
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2183
2225
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2184
|
-
export type CreateCertificationCourseDocumentData =
|
|
2226
|
+
export type CreateCertificationCourseDocumentData = Output1Q6Ejcokqh;
|
|
2185
2227
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2186
2228
|
export type DeleteSponsorshipPendingApprovalData = any;
|
|
2187
2229
|
export type DeleteSponsorshipPendingApprovalError = ErrorResponse;
|
|
2230
|
+
export type GetSponsorshipPendingApprovalData = GetPendingApprovalResponse;
|
|
2231
|
+
export type GetSponsorshipPendingApprovalError = ErrorResponse;
|
|
2188
2232
|
export type DeleteUserData = any;
|
|
2189
2233
|
export type DeleteUserError = ErrorResponse;
|
|
2190
2234
|
export type GetUserResult = UserResponseEntity;
|
|
@@ -2195,7 +2239,7 @@ export type UpdateUserData = any;
|
|
|
2195
2239
|
export type UpdateUserError = ErrorResponse;
|
|
2196
2240
|
export type DeleteCertificationCourseData = any;
|
|
2197
2241
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2198
|
-
export type GetCertificationApplicationItemFileData =
|
|
2242
|
+
export type GetCertificationApplicationItemFileData = OutputXmylm4Chhv;
|
|
2199
2243
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2200
2244
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2201
2245
|
/** @example "pdf" */
|
|
@@ -2209,9 +2253,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2209
2253
|
/** @example "fileVersion" */
|
|
2210
2254
|
fileVersion: string;
|
|
2211
2255
|
}
|
|
2212
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2256
|
+
export type CreateCertificationApplicationItemFileData = Output42Odz333Xq;
|
|
2213
2257
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2214
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2258
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = Output82Pb5Pn75B;
|
|
2215
2259
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2216
2260
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2217
2261
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2219,7 +2263,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2219
2263
|
export type GetCourseError = ErrorResponse;
|
|
2220
2264
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2221
2265
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2222
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2266
|
+
export type GetCertificationApplicationForeignFillData = Output6Pgrlpk9Uci;
|
|
2223
2267
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2224
2268
|
export type GetCertificationPrintData = any;
|
|
2225
2269
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2253,7 +2297,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2253
2297
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2254
2298
|
export type CreateCertificationWaiveData = any;
|
|
2255
2299
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2256
|
-
export type CreateCertificationMoveData =
|
|
2300
|
+
export type CreateCertificationMoveData = OutputCunolmrmg2;
|
|
2257
2301
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2258
2302
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2259
2303
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2285,7 +2329,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2285
2329
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2286
2330
|
export type CreateCertificationCourseRedeemData = any;
|
|
2287
2331
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2288
|
-
export type CreateCertificationMoveValidateData =
|
|
2332
|
+
export type CreateCertificationMoveValidateData = Output68Gczuab0M;
|
|
2289
2333
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2290
2334
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2291
2335
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2303,7 +2347,7 @@ export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
|
2303
2347
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2304
2348
|
export type CreateSponsorshipResetData = any;
|
|
2305
2349
|
export type CreateSponsorshipResetError = ErrorResponse;
|
|
2306
|
-
export type CreateCertificationResult =
|
|
2350
|
+
export type CreateCertificationResult = OutputKtez8C9Ig9F;
|
|
2307
2351
|
export type CreateCertificationFail = ErrorResponse;
|
|
2308
2352
|
export type CreateCertificationPublishInfoResult = any;
|
|
2309
2353
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2350,7 +2394,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2350
2394
|
}
|
|
2351
2395
|
/**
|
|
2352
2396
|
* @title BCCSA Program API
|
|
2353
|
-
* @version 3.0.
|
|
2397
|
+
* @version 3.0.38
|
|
2354
2398
|
* @baseUrl http://localhost:8080
|
|
2355
2399
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2356
2400
|
*/
|
|
@@ -2365,7 +2409,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2365
2409
|
* @request POST:/contactUs
|
|
2366
2410
|
* @secure
|
|
2367
2411
|
*/
|
|
2368
|
-
listContactUs: (data:
|
|
2412
|
+
listContactUs: (data: InputY9452P6Ju5, params?: RequestParams) => Promise<any>;
|
|
2369
2413
|
};
|
|
2370
2414
|
customer: {
|
|
2371
2415
|
/**
|
|
@@ -2469,7 +2513,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2469
2513
|
* @request POST:/tenant/report/applicationExport
|
|
2470
2514
|
* @secure
|
|
2471
2515
|
*/
|
|
2472
|
-
createReportApplicationExport: (data:
|
|
2516
|
+
createReportApplicationExport: (data: InputI92Gs480Wi, params?: RequestParams) => Promise<any>;
|
|
2473
2517
|
/**
|
|
2474
2518
|
* @description Export a report of applications based on the provided filters.
|
|
2475
2519
|
*
|
|
@@ -2479,7 +2523,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2479
2523
|
* @request POST:/tenant/report/applicationStatus
|
|
2480
2524
|
* @secure
|
|
2481
2525
|
*/
|
|
2482
|
-
listReportApplicationStatus: (data:
|
|
2526
|
+
listReportApplicationStatus: (data: InputRhw4W336M4, params?: RequestParams) => Promise<any>;
|
|
2483
2527
|
/**
|
|
2484
2528
|
* @description Export a report of applications based on the provided filters.
|
|
2485
2529
|
*
|
|
@@ -2489,7 +2533,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2489
2533
|
* @request POST:/tenant/report/applicationsReport
|
|
2490
2534
|
* @secure
|
|
2491
2535
|
*/
|
|
2492
|
-
createReportApplicationsReport: (data:
|
|
2536
|
+
createReportApplicationsReport: (data: InputDwl6Jshl2T, params?: RequestParams) => Promise<any>;
|
|
2493
2537
|
/**
|
|
2494
2538
|
* @description This route allows you to post certificates email for the tenant.
|
|
2495
2539
|
*
|
|
@@ -2499,7 +2543,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2499
2543
|
* @request POST:/tenant/certificates/email
|
|
2500
2544
|
* @secure
|
|
2501
2545
|
*/
|
|
2502
|
-
createCertificatesEmail: (data:
|
|
2546
|
+
createCertificatesEmail: (data: InputAadskx0R66, params?: RequestParams) => Promise<any>;
|
|
2503
2547
|
/**
|
|
2504
2548
|
* @description Generate a preview of the completed certifications report.
|
|
2505
2549
|
*
|
|
@@ -2529,7 +2573,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2529
2573
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2530
2574
|
* @secure
|
|
2531
2575
|
*/
|
|
2532
|
-
createLicenseRedeem: (userId: string, data:
|
|
2576
|
+
createLicenseRedeem: (userId: string, data: InputFzsxnr61Gz, params?: RequestParams) => Promise<any>;
|
|
2533
2577
|
/**
|
|
2534
2578
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2535
2579
|
*
|
|
@@ -2539,7 +2583,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2539
2583
|
* @request POST:/tenant/report/orglicenses/
|
|
2540
2584
|
* @secure
|
|
2541
2585
|
*/
|
|
2542
|
-
listReportOrglicenses: (data:
|
|
2586
|
+
listReportOrglicenses: (data: InputWb2Lmb2Fy7, params?: RequestParams) => Promise<any>;
|
|
2543
2587
|
/**
|
|
2544
2588
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2545
2589
|
*
|
|
@@ -2549,7 +2593,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2549
2593
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2550
2594
|
* @secure
|
|
2551
2595
|
*/
|
|
2552
|
-
createReportOrglicensesPreview: (data:
|
|
2596
|
+
createReportOrglicensesPreview: (data: Input8Sx76Qyyss, params?: RequestParams) => Promise<any>;
|
|
2553
2597
|
/**
|
|
2554
2598
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2555
2599
|
*
|
|
@@ -2589,7 +2633,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2589
2633
|
* @request POST:/tenant/report/users/advanced
|
|
2590
2634
|
* @secure
|
|
2591
2635
|
*/
|
|
2592
|
-
createReportUsersAdvanced: (data:
|
|
2636
|
+
createReportUsersAdvanced: (data: Input1Ohda2Wgsh, params?: RequestParams) => Promise<any>;
|
|
2593
2637
|
/**
|
|
2594
2638
|
* @description Searches for users in the tenant by their IDs.
|
|
2595
2639
|
*
|
|
@@ -2599,7 +2643,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2599
2643
|
* @request POST:/tenant/search/users/ids
|
|
2600
2644
|
* @secure
|
|
2601
2645
|
*/
|
|
2602
|
-
listSearchUsersIds: (data:
|
|
2646
|
+
listSearchUsersIds: (data: InputO1Eswyvj0E, params?: RequestParams) => Promise<any>;
|
|
2603
2647
|
/**
|
|
2604
2648
|
* @description Searches for users in the tenant by term and filters.
|
|
2605
2649
|
*
|
|
@@ -2609,7 +2653,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2609
2653
|
* @request POST:/tenant/search/users/term
|
|
2610
2654
|
* @secure
|
|
2611
2655
|
*/
|
|
2612
|
-
createSearchUsersTerm: (data:
|
|
2656
|
+
createSearchUsersTerm: (data: InputRalyzixy0A, params?: RequestParams) => Promise<any>;
|
|
2613
2657
|
/**
|
|
2614
2658
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2615
2659
|
*
|
|
@@ -2619,7 +2663,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2619
2663
|
* @request POST:/tenant/report/users/simple
|
|
2620
2664
|
* @secure
|
|
2621
2665
|
*/
|
|
2622
|
-
createReportUsersSimple: (data:
|
|
2666
|
+
createReportUsersSimple: (data: InputVll5Y8N7Fs, params?: RequestParams) => Promise<any>;
|
|
2623
2667
|
/**
|
|
2624
2668
|
* @description Retrieve user by ID.
|
|
2625
2669
|
*
|
|
@@ -2629,7 +2673,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2629
2673
|
* @request POST:/tenant/search/users/count
|
|
2630
2674
|
* @secure
|
|
2631
2675
|
*/
|
|
2632
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2676
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<Output4Qe1Gsbbif>;
|
|
2633
2677
|
};
|
|
2634
2678
|
user: {
|
|
2635
2679
|
/**
|
|
@@ -2661,7 +2705,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2661
2705
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2662
2706
|
* @secure
|
|
2663
2707
|
*/
|
|
2664
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2708
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: InputZnx3Yaudw0L, params?: RequestParams) => Promise<any>;
|
|
2665
2709
|
/**
|
|
2666
2710
|
* @description Delete a certification process application by type.
|
|
2667
2711
|
*
|
|
@@ -2751,7 +2795,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2751
2795
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2752
2796
|
* @secure
|
|
2753
2797
|
*/
|
|
2754
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2798
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputGvsap98Xwd>;
|
|
2755
2799
|
/**
|
|
2756
2800
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2757
2801
|
*
|
|
@@ -2761,7 +2805,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2761
2805
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2762
2806
|
* @secure
|
|
2763
2807
|
*/
|
|
2764
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2808
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputLfhw9J38Sf>;
|
|
2765
2809
|
/**
|
|
2766
2810
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2767
2811
|
*
|
|
@@ -2781,7 +2825,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2781
2825
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2782
2826
|
* @secure
|
|
2783
2827
|
*/
|
|
2784
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2828
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: Input1Q6Ejcokqh, params?: RequestParams) => Promise<Output1Q6Ejcokqh>;
|
|
2785
2829
|
/**
|
|
2786
2830
|
* @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.
|
|
2787
2831
|
*
|
|
@@ -2792,6 +2836,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2792
2836
|
* @secure
|
|
2793
2837
|
*/
|
|
2794
2838
|
deleteSponsorshipPendingApproval: (userId: string, paId: string, data: DeletePendingApprovalBody, params?: RequestParams) => Promise<any>;
|
|
2839
|
+
/**
|
|
2840
|
+
* @description Retrieves a sponsorship/attestation pending-approval record by its id for the given user. Admin only.
|
|
2841
|
+
*
|
|
2842
|
+
* @tags Sponsorship
|
|
2843
|
+
* @name GetSponsorshipPendingApproval
|
|
2844
|
+
* @summary Get a pending sponsorship request
|
|
2845
|
+
* @request GET:/user/{userID}/sponsorship/pendingApproval/{paID}
|
|
2846
|
+
* @secure
|
|
2847
|
+
*/
|
|
2848
|
+
getSponsorshipPendingApproval: (userId: string, paId: string, params?: RequestParams) => Promise<GetPendingApprovalResponse>;
|
|
2795
2849
|
/**
|
|
2796
2850
|
* @description Delete user by ID.
|
|
2797
2851
|
*
|
|
@@ -2821,7 +2875,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2821
2875
|
* @request POST:/user/{userID}
|
|
2822
2876
|
* @secure
|
|
2823
2877
|
*/
|
|
2824
|
-
createUser: (userId: string, data:
|
|
2878
|
+
createUser: (userId: string, data: InputKz3Sd08My4, params?: RequestParams) => Promise<any>;
|
|
2825
2879
|
/**
|
|
2826
2880
|
* @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.
|
|
2827
2881
|
*
|
|
@@ -2831,7 +2885,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2831
2885
|
* @request PUT:/user/{userID}
|
|
2832
2886
|
* @secure
|
|
2833
2887
|
*/
|
|
2834
|
-
updateUser: (userId: string, data:
|
|
2888
|
+
updateUser: (userId: string, data: InputMgiii85Qor, params?: RequestParams) => Promise<any>;
|
|
2835
2889
|
/**
|
|
2836
2890
|
* @description Delete course from user
|
|
2837
2891
|
*
|
|
@@ -2851,7 +2905,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2851
2905
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2852
2906
|
* @secure
|
|
2853
2907
|
*/
|
|
2854
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2908
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputXmylm4Chhv>;
|
|
2855
2909
|
/**
|
|
2856
2910
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2857
2911
|
*
|
|
@@ -2861,7 +2915,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2861
2915
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2862
2916
|
* @secure
|
|
2863
2917
|
*/
|
|
2864
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2918
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<Output42Odz333Xq>;
|
|
2865
2919
|
/**
|
|
2866
2920
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2867
2921
|
*
|
|
@@ -2871,7 +2925,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2871
2925
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2872
2926
|
* @secure
|
|
2873
2927
|
*/
|
|
2874
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2928
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<Output82Pb5Pn75B>;
|
|
2875
2929
|
/**
|
|
2876
2930
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2877
2931
|
*
|
|
@@ -2911,7 +2965,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2911
2965
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2912
2966
|
* @secure
|
|
2913
2967
|
*/
|
|
2914
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2968
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<Output6Pgrlpk9Uci>;
|
|
2915
2969
|
/**
|
|
2916
2970
|
* @description This endpoint will print certificate
|
|
2917
2971
|
*
|
|
@@ -2971,7 +3025,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2971
3025
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2972
3026
|
* @secure
|
|
2973
3027
|
*/
|
|
2974
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
3028
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputE24P17Anqn, params?: RequestParams) => Promise<any>;
|
|
2975
3029
|
/**
|
|
2976
3030
|
* @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.
|
|
2977
3031
|
*
|
|
@@ -3001,7 +3055,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3001
3055
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
3002
3056
|
* @secure
|
|
3003
3057
|
*/
|
|
3004
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3058
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputOke7Fx73Wa, params?: RequestParams) => Promise<any>;
|
|
3005
3059
|
/**
|
|
3006
3060
|
* @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.
|
|
3007
3061
|
*
|
|
@@ -3011,7 +3065,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3011
3065
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
3012
3066
|
* @secure
|
|
3013
3067
|
*/
|
|
3014
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3068
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputMyxld51Ils, params?: RequestParams) => Promise<any>;
|
|
3015
3069
|
/**
|
|
3016
3070
|
* @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.
|
|
3017
3071
|
*
|
|
@@ -3021,7 +3075,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3021
3075
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
3022
3076
|
* @secure
|
|
3023
3077
|
*/
|
|
3024
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
3078
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: Input78Oq3Ogocp, params?: RequestParams) => Promise<any>;
|
|
3025
3079
|
/**
|
|
3026
3080
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
3027
3081
|
*
|
|
@@ -3031,7 +3085,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3031
3085
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
3032
3086
|
* @secure
|
|
3033
3087
|
*/
|
|
3034
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
3088
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputI19Hnqwxd9, params?: RequestParams) => Promise<any>;
|
|
3035
3089
|
/**
|
|
3036
3090
|
* @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.
|
|
3037
3091
|
*
|
|
@@ -3071,7 +3125,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3071
3125
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
3072
3126
|
* @secure
|
|
3073
3127
|
*/
|
|
3074
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
3128
|
+
createCertificationWaive: (userId: string, certProcId: string, data: Input0Rf8Rir2Wi, params?: RequestParams) => Promise<any>;
|
|
3075
3129
|
/**
|
|
3076
3130
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
3077
3131
|
*
|
|
@@ -3081,7 +3135,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3081
3135
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
3082
3136
|
* @secure
|
|
3083
3137
|
*/
|
|
3084
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3138
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputCunolmrmg2>;
|
|
3085
3139
|
/**
|
|
3086
3140
|
* @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.
|
|
3087
3141
|
*
|
|
@@ -3121,7 +3175,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3121
3175
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
3122
3176
|
* @secure
|
|
3123
3177
|
*/
|
|
3124
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
3178
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputFsr7Mbfjl2, params?: RequestParams) => Promise<any>;
|
|
3125
3179
|
/**
|
|
3126
3180
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
3127
3181
|
*
|
|
@@ -3181,7 +3235,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3181
3235
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3182
3236
|
* @secure
|
|
3183
3237
|
*/
|
|
3184
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
3238
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: InputNsoff4Aqr6, params?: RequestParams) => Promise<any>;
|
|
3185
3239
|
/**
|
|
3186
3240
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3187
3241
|
*
|
|
@@ -3201,7 +3255,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3201
3255
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3202
3256
|
* @secure
|
|
3203
3257
|
*/
|
|
3204
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3258
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputW46Ry9Xsi5, params?: RequestParams) => Promise<any>;
|
|
3205
3259
|
/**
|
|
3206
3260
|
* @description This route allows you to submit a pending approval.
|
|
3207
3261
|
*
|
|
@@ -3211,7 +3265,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3211
3265
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3212
3266
|
* @secure
|
|
3213
3267
|
*/
|
|
3214
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3268
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputRxp3Oxn5Tn, params?: RequestParams) => Promise<any>;
|
|
3215
3269
|
/**
|
|
3216
3270
|
* @description This route allows you to review a pending approval.
|
|
3217
3271
|
*
|
|
@@ -3221,7 +3275,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3221
3275
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3222
3276
|
* @secure
|
|
3223
3277
|
*/
|
|
3224
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3278
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputRxs18Ly1Jmf, params?: RequestParams) => Promise<any>;
|
|
3225
3279
|
/**
|
|
3226
3280
|
* @description Redeems a license for a user by product ID.
|
|
3227
3281
|
*
|
|
@@ -3231,7 +3285,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3231
3285
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3232
3286
|
* @secure
|
|
3233
3287
|
*/
|
|
3234
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3288
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputFpmobr2I5K, params?: RequestParams) => Promise<any>;
|
|
3235
3289
|
/**
|
|
3236
3290
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3237
3291
|
*
|
|
@@ -3241,7 +3295,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3241
3295
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3242
3296
|
* @secure
|
|
3243
3297
|
*/
|
|
3244
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3298
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<Output68Gczuab0M>;
|
|
3245
3299
|
/**
|
|
3246
3300
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3247
3301
|
*
|
|
@@ -3251,7 +3305,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3251
3305
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3252
3306
|
* @secure
|
|
3253
3307
|
*/
|
|
3254
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3308
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: Input1Z2S5Mvjmj, params?: RequestParams) => Promise<any>;
|
|
3255
3309
|
/**
|
|
3256
3310
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3257
3311
|
*
|
|
@@ -3261,7 +3315,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3261
3315
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3262
3316
|
* @secure
|
|
3263
3317
|
*/
|
|
3264
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3318
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input7Jrsau5Uep, params?: RequestParams) => Promise<any>;
|
|
3265
3319
|
/**
|
|
3266
3320
|
* @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.
|
|
3267
3321
|
*
|
|
@@ -3271,7 +3325,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3271
3325
|
* @request POST:/user/{userID}/updateITA
|
|
3272
3326
|
* @secure
|
|
3273
3327
|
*/
|
|
3274
|
-
createUpdateIta: (userId: string, data:
|
|
3328
|
+
createUpdateIta: (userId: string, data: InputSdhhf07Dy2, params?: RequestParams) => Promise<any>;
|
|
3275
3329
|
/**
|
|
3276
3330
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3277
3331
|
*
|
|
@@ -3281,7 +3335,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3281
3335
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3282
3336
|
* @secure
|
|
3283
3337
|
*/
|
|
3284
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3338
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: Input17Tw549Oah, params?: RequestParams) => Promise<any>;
|
|
3285
3339
|
/**
|
|
3286
3340
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3287
3341
|
*
|
|
@@ -3291,7 +3345,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3291
3345
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3292
3346
|
* @secure
|
|
3293
3347
|
*/
|
|
3294
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3348
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputFgo7Tyrxudl, params?: RequestParams) => Promise<any>;
|
|
3295
3349
|
/**
|
|
3296
3350
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3297
3351
|
*
|
|
@@ -3333,7 +3387,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3333
3387
|
* @request POST:/users/certification/{certSpecID}
|
|
3334
3388
|
* @secure
|
|
3335
3389
|
*/
|
|
3336
|
-
createCertification: (certSpecId: string, data:
|
|
3390
|
+
createCertification: (certSpecId: string, data: InputKtez8C9Ig9F, params?: RequestParams) => Promise<OutputKtez8C9Ig9F>;
|
|
3337
3391
|
/**
|
|
3338
3392
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3339
3393
|
*
|