@ikonintegration/bccsa-program-api 3.0.35 → 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 +189 -98
- package/dist/Api.d.ts +170 -102
- package/dist/Api.js +41 -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 InputHvh2Rhjuk6 {
|
|
|
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 Input5K8X950Ztg {
|
|
|
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 InputV73Gd5K2S3 {
|
|
|
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 InputYuucneuxkg {
|
|
|
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 InputIc5N9Ldrci {
|
|
|
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 InputJu8Q7Jd4Rm {
|
|
|
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 InputF5Jjnrfmt7I {
|
|
|
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 Input4H67Nuuo8P {
|
|
|
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,21 +966,23 @@ export interface Input2Mihdr2Tcif {
|
|
|
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;
|
|
973
973
|
}
|
|
974
974
|
/** External system ID 2 */
|
|
975
975
|
export type ExternalID2 = number;
|
|
976
|
-
|
|
976
|
+
/** This endpoint accepts no request body */
|
|
977
|
+
export type DeletePendingApprovalBody = object;
|
|
978
|
+
export interface OutputXmylm4Chhv {
|
|
977
979
|
/**
|
|
978
980
|
* Signed URL for the course file
|
|
979
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"
|
|
980
982
|
*/
|
|
981
983
|
fileURL: string;
|
|
982
984
|
}
|
|
983
|
-
export interface
|
|
985
|
+
export interface Output82Pb5Pn75B {
|
|
984
986
|
/**
|
|
985
987
|
* Amount to be refunded for the cancellation
|
|
986
988
|
* @example 0
|
|
@@ -1280,7 +1282,7 @@ export interface CourseResponseEntity {
|
|
|
1280
1282
|
}
|
|
1281
1283
|
/** Label of the course enrolled (course version) */
|
|
1282
1284
|
export type OnlineCourseLabel = string;
|
|
1283
|
-
export interface
|
|
1285
|
+
export interface OutputGvsap98Xwd {
|
|
1284
1286
|
/**
|
|
1285
1287
|
* Signed URL for the course file
|
|
1286
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"
|
|
@@ -1298,7 +1300,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1298
1300
|
transactionID?: string | null;
|
|
1299
1301
|
}
|
|
1300
1302
|
/** Application Foreign Fill response type */
|
|
1301
|
-
export interface
|
|
1303
|
+
export interface Output6Pgrlpk9Uci {
|
|
1302
1304
|
items: {
|
|
1303
1305
|
userID: string;
|
|
1304
1306
|
createdOn?: number;
|
|
@@ -1377,6 +1379,41 @@ export type SourceType = string;
|
|
|
1377
1379
|
export type ExpiresOn = number;
|
|
1378
1380
|
/** Date when the result was achieved (e.g., passed) */
|
|
1379
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
|
+
}
|
|
1380
1417
|
/** Response with list of user certification processes and it's upcoming courses and sessions */
|
|
1381
1418
|
export interface UserUpcomingCoursesResponseSchema {
|
|
1382
1419
|
procs?: {
|
|
@@ -1486,7 +1523,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1486
1523
|
applicationItems?: Record<string, any>[];
|
|
1487
1524
|
transactionID?: string | null;
|
|
1488
1525
|
}
|
|
1489
|
-
export interface
|
|
1526
|
+
export interface InputZnx3Yaudw0L {
|
|
1490
1527
|
issuedOn?: number;
|
|
1491
1528
|
expiresOn?: number;
|
|
1492
1529
|
fileItems?: {
|
|
@@ -1495,21 +1532,21 @@ export interface InputUdco8Yiz4U {
|
|
|
1495
1532
|
}[];
|
|
1496
1533
|
additionalNotes?: string | null;
|
|
1497
1534
|
}
|
|
1498
|
-
export interface
|
|
1535
|
+
export interface InputE24P17Anqn {
|
|
1499
1536
|
/**
|
|
1500
1537
|
* Indicates whether the application is locked
|
|
1501
1538
|
* @example true
|
|
1502
1539
|
*/
|
|
1503
1540
|
isApplicationLocked: boolean;
|
|
1504
1541
|
}
|
|
1505
|
-
export interface
|
|
1542
|
+
export interface Output42Odz333Xq {
|
|
1506
1543
|
/**
|
|
1507
1544
|
* Signed URL for the course file
|
|
1508
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"
|
|
1509
1546
|
*/
|
|
1510
1547
|
fileURL: string;
|
|
1511
1548
|
}
|
|
1512
|
-
export interface
|
|
1549
|
+
export interface InputOke7Fx73Wa {
|
|
1513
1550
|
/**
|
|
1514
1551
|
* Indicates whether the waiver is approved
|
|
1515
1552
|
* @example true
|
|
@@ -1521,14 +1558,14 @@ export interface InputKa30H4Ner6 {
|
|
|
1521
1558
|
*/
|
|
1522
1559
|
additionalNotes?: string | null;
|
|
1523
1560
|
}
|
|
1524
|
-
export interface
|
|
1561
|
+
export interface InputMyxld51Ils {
|
|
1525
1562
|
/**
|
|
1526
1563
|
* Optional notes regarding the waiver
|
|
1527
1564
|
* @example "Waiver granted due to special circumstances."
|
|
1528
1565
|
*/
|
|
1529
1566
|
additionalNotes?: string | null;
|
|
1530
1567
|
}
|
|
1531
|
-
export interface
|
|
1568
|
+
export interface Input78Oq3Ogocp {
|
|
1532
1569
|
students: {
|
|
1533
1570
|
/**
|
|
1534
1571
|
* User ID of the student to redeem the course for
|
|
@@ -1562,7 +1599,7 @@ export interface InputY2D9S4Qy4S {
|
|
|
1562
1599
|
*/
|
|
1563
1600
|
autoEnrolSessionID?: string;
|
|
1564
1601
|
}
|
|
1565
|
-
export interface
|
|
1602
|
+
export interface InputI19Hnqwxd9 {
|
|
1566
1603
|
invites: {
|
|
1567
1604
|
/**
|
|
1568
1605
|
* Email address of the user to invite
|
|
@@ -1591,7 +1628,7 @@ export interface Input62Nyiggonmh {
|
|
|
1591
1628
|
*/
|
|
1592
1629
|
isReservedSeat: boolean;
|
|
1593
1630
|
}
|
|
1594
|
-
export interface
|
|
1631
|
+
export interface Input0Rf8Rir2Wi {
|
|
1595
1632
|
/**
|
|
1596
1633
|
* Indicates whether to waive the certification process
|
|
1597
1634
|
* @example true
|
|
@@ -1604,7 +1641,7 @@ export interface InputXqdgr5Oa5Vh {
|
|
|
1604
1641
|
comments?: string | null;
|
|
1605
1642
|
}
|
|
1606
1643
|
/** Certification move response schema */
|
|
1607
|
-
export interface
|
|
1644
|
+
export interface OutputCunolmrmg2 {
|
|
1608
1645
|
errors?: {
|
|
1609
1646
|
status: string;
|
|
1610
1647
|
object?: Record<string, any>;
|
|
@@ -1612,19 +1649,19 @@ export interface Output6D4Ct52Qpe {
|
|
|
1612
1649
|
}[];
|
|
1613
1650
|
}
|
|
1614
1651
|
/** Schema for writing a certification trigger check. */
|
|
1615
|
-
export interface
|
|
1652
|
+
export interface InputFsr7Mbfjl2 {
|
|
1616
1653
|
/**
|
|
1617
1654
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1618
1655
|
* @example "CHECKED"
|
|
1619
1656
|
*/
|
|
1620
|
-
value:
|
|
1657
|
+
value: InputFsr7Mbfjl2ValueEnum;
|
|
1621
1658
|
/**
|
|
1622
1659
|
* List of course IDs that are blocked by this trigger check.
|
|
1623
1660
|
* @example ["course1","course2"]
|
|
1624
1661
|
*/
|
|
1625
1662
|
blockedCourses?: string[];
|
|
1626
1663
|
}
|
|
1627
|
-
export interface
|
|
1664
|
+
export interface InputNsoff4Aqr6 {
|
|
1628
1665
|
/**
|
|
1629
1666
|
* Indicates whether the application item is approved
|
|
1630
1667
|
* @example true
|
|
@@ -1650,7 +1687,7 @@ export interface Input1Lghooas4I {
|
|
|
1650
1687
|
export interface StudentHistoryRequestSchema {
|
|
1651
1688
|
requirements: string[];
|
|
1652
1689
|
}
|
|
1653
|
-
export interface
|
|
1690
|
+
export interface InputW46Ry9Xsi5 {
|
|
1654
1691
|
/**
|
|
1655
1692
|
* Optional activation key for the application
|
|
1656
1693
|
* @example "AK-123456"
|
|
@@ -1658,7 +1695,7 @@ export interface InputCgletgibfvi {
|
|
|
1658
1695
|
activationKey?: string;
|
|
1659
1696
|
}
|
|
1660
1697
|
/** Schema for course submission item details post request. */
|
|
1661
|
-
export interface
|
|
1698
|
+
export interface Input1Q6Ejcokqh {
|
|
1662
1699
|
/**
|
|
1663
1700
|
* The ID of the file being submitted.
|
|
1664
1701
|
* @example "fileID123"
|
|
@@ -1671,7 +1708,7 @@ export interface InputOszbc2Lfht {
|
|
|
1671
1708
|
fileName: string;
|
|
1672
1709
|
}
|
|
1673
1710
|
/** Schema for the response to course submission item details post request. */
|
|
1674
|
-
export interface
|
|
1711
|
+
export interface Output1Q6Ejcokqh {
|
|
1675
1712
|
submissionItems: {
|
|
1676
1713
|
/**
|
|
1677
1714
|
* The ID of the file being submitted.
|
|
@@ -1686,7 +1723,7 @@ export interface OutputOszbc2Lfht {
|
|
|
1686
1723
|
}[];
|
|
1687
1724
|
}
|
|
1688
1725
|
/** Pending approval submission parameters */
|
|
1689
|
-
export interface
|
|
1726
|
+
export interface InputRxp3Oxn5Tn {
|
|
1690
1727
|
/**
|
|
1691
1728
|
* Type of pending approval
|
|
1692
1729
|
* @example "certification"
|
|
@@ -1706,7 +1743,7 @@ export interface InputDv9Ni3Aar5 {
|
|
|
1706
1743
|
fileName: string;
|
|
1707
1744
|
}[];
|
|
1708
1745
|
}
|
|
1709
|
-
export interface
|
|
1746
|
+
export interface InputFpmobr2I5K {
|
|
1710
1747
|
/**
|
|
1711
1748
|
* The ID of the course for which the license is being redeemed
|
|
1712
1749
|
* @example "courseID123"
|
|
@@ -1774,7 +1811,7 @@ export interface InputGhxoi4I6V8 {
|
|
|
1774
1811
|
acknowledgement?: string | null;
|
|
1775
1812
|
}
|
|
1776
1813
|
/** Validate certification move response schema */
|
|
1777
|
-
export interface
|
|
1814
|
+
export interface Output68Gczuab0M {
|
|
1778
1815
|
courses: {
|
|
1779
1816
|
name: string;
|
|
1780
1817
|
status: string;
|
|
@@ -1785,21 +1822,21 @@ export interface OutputMlk3Y0Sufr {
|
|
|
1785
1822
|
validated: boolean;
|
|
1786
1823
|
mustCreateCP: boolean;
|
|
1787
1824
|
}
|
|
1788
|
-
export interface
|
|
1825
|
+
export interface Input1Z2S5Mvjmj {
|
|
1789
1826
|
/**
|
|
1790
1827
|
* Comments regarding the end of the cooldown period
|
|
1791
1828
|
* @example "Cooldown period ended successfully."
|
|
1792
1829
|
*/
|
|
1793
1830
|
comments: string;
|
|
1794
1831
|
}
|
|
1795
|
-
export interface
|
|
1832
|
+
export interface OutputLfhw9J38Sf {
|
|
1796
1833
|
/**
|
|
1797
1834
|
* Signed URL for the course file
|
|
1798
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"
|
|
1799
1836
|
*/
|
|
1800
1837
|
fileURL: string;
|
|
1801
1838
|
}
|
|
1802
|
-
export interface
|
|
1839
|
+
export interface InputKz3Sd08My4 {
|
|
1803
1840
|
/** @example true */
|
|
1804
1841
|
agreedWithCertTerms: boolean;
|
|
1805
1842
|
/** @example 1717230000000 */
|
|
@@ -1884,21 +1921,21 @@ export interface Sponsor {
|
|
|
1884
1921
|
/** Title of the sponsor of the student in the tenant */
|
|
1885
1922
|
title?: Title;
|
|
1886
1923
|
}
|
|
1887
|
-
export interface
|
|
1924
|
+
export interface Input7Jrsau5Uep {
|
|
1888
1925
|
/**
|
|
1889
1926
|
* Comments regarding the course unlock action
|
|
1890
1927
|
* @example "Course unlocked successfully."
|
|
1891
1928
|
*/
|
|
1892
1929
|
comments: string;
|
|
1893
1930
|
}
|
|
1894
|
-
export interface
|
|
1931
|
+
export interface InputSdhhf07Dy2 {
|
|
1895
1932
|
/**
|
|
1896
1933
|
* ITA number to update for the user
|
|
1897
1934
|
* @example "ITA123456"
|
|
1898
1935
|
*/
|
|
1899
1936
|
itaNumber: string;
|
|
1900
1937
|
}
|
|
1901
|
-
export interface
|
|
1938
|
+
export interface InputMgiii85Qor {
|
|
1902
1939
|
/** @example true */
|
|
1903
1940
|
agreedWithCertTerms: boolean;
|
|
1904
1941
|
/** @example 1717230000000 */
|
|
@@ -1972,7 +2009,7 @@ export interface Input3Q79Al8T06 {
|
|
|
1972
2009
|
/** Sponsor information for a student in the tenant */
|
|
1973
2010
|
sponsor?: Sponsor;
|
|
1974
2011
|
}
|
|
1975
|
-
export interface
|
|
2012
|
+
export interface Input17Tw549Oah {
|
|
1976
2013
|
/**
|
|
1977
2014
|
* The grade to override the course result with
|
|
1978
2015
|
* @example "A"
|
|
@@ -1980,7 +2017,7 @@ export interface InputW1Qz7Aegx2 {
|
|
|
1980
2017
|
resultGrade: string;
|
|
1981
2018
|
}
|
|
1982
2019
|
/** Pending approval review parameters */
|
|
1983
|
-
export interface
|
|
2020
|
+
export interface InputRxs18Ly1Jmf {
|
|
1984
2021
|
/**
|
|
1985
2022
|
* Notes provided by the reviewer for the pending approval
|
|
1986
2023
|
* @example "Please review the submitted documents."
|
|
@@ -1991,9 +2028,16 @@ export interface InputAihldyxydl {
|
|
|
1991
2028
|
* @example true
|
|
1992
2029
|
*/
|
|
1993
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;
|
|
1994
2038
|
}
|
|
1995
2039
|
/** Schema for overriding course result dates. */
|
|
1996
|
-
export interface
|
|
2040
|
+
export interface InputFgo7Tyrxudl {
|
|
1997
2041
|
/**
|
|
1998
2042
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1999
2043
|
* @example 1735689600000
|
|
@@ -2007,14 +2051,14 @@ export interface InputL5Uvh80Jwdh {
|
|
|
2007
2051
|
}
|
|
2008
2052
|
/** Reset sponsorship request takes no body */
|
|
2009
2053
|
export type ResetSponsorshipBody = object;
|
|
2010
|
-
export interface
|
|
2054
|
+
export interface InputKtez8C9Ig9F {
|
|
2011
2055
|
filter: {
|
|
2012
2056
|
from?: number;
|
|
2013
2057
|
sortOrder?: string;
|
|
2014
2058
|
sortField?: string;
|
|
2015
2059
|
};
|
|
2016
2060
|
}
|
|
2017
|
-
export interface
|
|
2061
|
+
export interface OutputKtez8C9Ig9F {
|
|
2018
2062
|
users: {
|
|
2019
2063
|
firstName: string;
|
|
2020
2064
|
lastName: string;
|
|
@@ -2038,7 +2082,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
2038
2082
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
2039
2083
|
* @example "CHECKED"
|
|
2040
2084
|
*/
|
|
2041
|
-
export declare enum
|
|
2085
|
+
export declare enum InputFsr7Mbfjl2ValueEnum {
|
|
2042
2086
|
CHECKED = "CHECKED",
|
|
2043
2087
|
UNCHECKED = "UNCHECKED",
|
|
2044
2088
|
NOVALUE = "NOVALUE"
|
|
@@ -2137,7 +2181,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2137
2181
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2138
2182
|
export type CreateReportUsersSimpleData = any;
|
|
2139
2183
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2140
|
-
export type CreateSearchUsersCountData =
|
|
2184
|
+
export type CreateSearchUsersCountData = Output4Qe1Gsbbif;
|
|
2141
2185
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2142
2186
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2143
2187
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2161,7 +2205,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2161
2205
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2162
2206
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2163
2207
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2164
|
-
export type GetCertificationCourseFileSignData =
|
|
2208
|
+
export type GetCertificationCourseFileSignData = OutputGvsap98Xwd;
|
|
2165
2209
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2166
2210
|
export interface CreateCertificationCourseFileSignParams {
|
|
2167
2211
|
/** @example "pdf" */
|
|
@@ -2175,12 +2219,16 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2175
2219
|
/** @example "fileID" */
|
|
2176
2220
|
fileId: string;
|
|
2177
2221
|
}
|
|
2178
|
-
export type CreateCertificationCourseFileSignData =
|
|
2222
|
+
export type CreateCertificationCourseFileSignData = OutputLfhw9J38Sf;
|
|
2179
2223
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2180
2224
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2181
2225
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2182
|
-
export type CreateCertificationCourseDocumentData =
|
|
2226
|
+
export type CreateCertificationCourseDocumentData = Output1Q6Ejcokqh;
|
|
2183
2227
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2228
|
+
export type DeleteSponsorshipPendingApprovalData = any;
|
|
2229
|
+
export type DeleteSponsorshipPendingApprovalError = ErrorResponse;
|
|
2230
|
+
export type GetSponsorshipPendingApprovalData = GetPendingApprovalResponse;
|
|
2231
|
+
export type GetSponsorshipPendingApprovalError = ErrorResponse;
|
|
2184
2232
|
export type DeleteUserData = any;
|
|
2185
2233
|
export type DeleteUserError = ErrorResponse;
|
|
2186
2234
|
export type GetUserResult = UserResponseEntity;
|
|
@@ -2191,7 +2239,7 @@ export type UpdateUserData = any;
|
|
|
2191
2239
|
export type UpdateUserError = ErrorResponse;
|
|
2192
2240
|
export type DeleteCertificationCourseData = any;
|
|
2193
2241
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2194
|
-
export type GetCertificationApplicationItemFileData =
|
|
2242
|
+
export type GetCertificationApplicationItemFileData = OutputXmylm4Chhv;
|
|
2195
2243
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2196
2244
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2197
2245
|
/** @example "pdf" */
|
|
@@ -2205,9 +2253,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2205
2253
|
/** @example "fileVersion" */
|
|
2206
2254
|
fileVersion: string;
|
|
2207
2255
|
}
|
|
2208
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2256
|
+
export type CreateCertificationApplicationItemFileData = Output42Odz333Xq;
|
|
2209
2257
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2210
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2258
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = Output82Pb5Pn75B;
|
|
2211
2259
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2212
2260
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2213
2261
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2215,7 +2263,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2215
2263
|
export type GetCourseError = ErrorResponse;
|
|
2216
2264
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2217
2265
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2218
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2266
|
+
export type GetCertificationApplicationForeignFillData = Output6Pgrlpk9Uci;
|
|
2219
2267
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2220
2268
|
export type GetCertificationPrintData = any;
|
|
2221
2269
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2249,7 +2297,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2249
2297
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2250
2298
|
export type CreateCertificationWaiveData = any;
|
|
2251
2299
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2252
|
-
export type CreateCertificationMoveData =
|
|
2300
|
+
export type CreateCertificationMoveData = OutputCunolmrmg2;
|
|
2253
2301
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2254
2302
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2255
2303
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2281,7 +2329,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2281
2329
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2282
2330
|
export type CreateCertificationCourseRedeemData = any;
|
|
2283
2331
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2284
|
-
export type CreateCertificationMoveValidateData =
|
|
2332
|
+
export type CreateCertificationMoveValidateData = Output68Gczuab0M;
|
|
2285
2333
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2286
2334
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2287
2335
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2299,7 +2347,7 @@ export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
|
2299
2347
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2300
2348
|
export type CreateSponsorshipResetData = any;
|
|
2301
2349
|
export type CreateSponsorshipResetError = ErrorResponse;
|
|
2302
|
-
export type CreateCertificationResult =
|
|
2350
|
+
export type CreateCertificationResult = OutputKtez8C9Ig9F;
|
|
2303
2351
|
export type CreateCertificationFail = ErrorResponse;
|
|
2304
2352
|
export type CreateCertificationPublishInfoResult = any;
|
|
2305
2353
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2346,7 +2394,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2346
2394
|
}
|
|
2347
2395
|
/**
|
|
2348
2396
|
* @title BCCSA Program API
|
|
2349
|
-
* @version 3.0.
|
|
2397
|
+
* @version 3.0.38
|
|
2350
2398
|
* @baseUrl http://localhost:8080
|
|
2351
2399
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2352
2400
|
*/
|
|
@@ -2361,7 +2409,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2361
2409
|
* @request POST:/contactUs
|
|
2362
2410
|
* @secure
|
|
2363
2411
|
*/
|
|
2364
|
-
listContactUs: (data:
|
|
2412
|
+
listContactUs: (data: InputY9452P6Ju5, params?: RequestParams) => Promise<any>;
|
|
2365
2413
|
};
|
|
2366
2414
|
customer: {
|
|
2367
2415
|
/**
|
|
@@ -2465,7 +2513,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2465
2513
|
* @request POST:/tenant/report/applicationExport
|
|
2466
2514
|
* @secure
|
|
2467
2515
|
*/
|
|
2468
|
-
createReportApplicationExport: (data:
|
|
2516
|
+
createReportApplicationExport: (data: InputI92Gs480Wi, params?: RequestParams) => Promise<any>;
|
|
2469
2517
|
/**
|
|
2470
2518
|
* @description Export a report of applications based on the provided filters.
|
|
2471
2519
|
*
|
|
@@ -2475,7 +2523,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2475
2523
|
* @request POST:/tenant/report/applicationStatus
|
|
2476
2524
|
* @secure
|
|
2477
2525
|
*/
|
|
2478
|
-
listReportApplicationStatus: (data:
|
|
2526
|
+
listReportApplicationStatus: (data: InputRhw4W336M4, params?: RequestParams) => Promise<any>;
|
|
2479
2527
|
/**
|
|
2480
2528
|
* @description Export a report of applications based on the provided filters.
|
|
2481
2529
|
*
|
|
@@ -2485,7 +2533,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2485
2533
|
* @request POST:/tenant/report/applicationsReport
|
|
2486
2534
|
* @secure
|
|
2487
2535
|
*/
|
|
2488
|
-
createReportApplicationsReport: (data:
|
|
2536
|
+
createReportApplicationsReport: (data: InputDwl6Jshl2T, params?: RequestParams) => Promise<any>;
|
|
2489
2537
|
/**
|
|
2490
2538
|
* @description This route allows you to post certificates email for the tenant.
|
|
2491
2539
|
*
|
|
@@ -2495,7 +2543,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2495
2543
|
* @request POST:/tenant/certificates/email
|
|
2496
2544
|
* @secure
|
|
2497
2545
|
*/
|
|
2498
|
-
createCertificatesEmail: (data:
|
|
2546
|
+
createCertificatesEmail: (data: InputAadskx0R66, params?: RequestParams) => Promise<any>;
|
|
2499
2547
|
/**
|
|
2500
2548
|
* @description Generate a preview of the completed certifications report.
|
|
2501
2549
|
*
|
|
@@ -2525,7 +2573,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2525
2573
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2526
2574
|
* @secure
|
|
2527
2575
|
*/
|
|
2528
|
-
createLicenseRedeem: (userId: string, data:
|
|
2576
|
+
createLicenseRedeem: (userId: string, data: InputFzsxnr61Gz, params?: RequestParams) => Promise<any>;
|
|
2529
2577
|
/**
|
|
2530
2578
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2531
2579
|
*
|
|
@@ -2535,7 +2583,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2535
2583
|
* @request POST:/tenant/report/orglicenses/
|
|
2536
2584
|
* @secure
|
|
2537
2585
|
*/
|
|
2538
|
-
listReportOrglicenses: (data:
|
|
2586
|
+
listReportOrglicenses: (data: InputWb2Lmb2Fy7, params?: RequestParams) => Promise<any>;
|
|
2539
2587
|
/**
|
|
2540
2588
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2541
2589
|
*
|
|
@@ -2545,7 +2593,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2545
2593
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2546
2594
|
* @secure
|
|
2547
2595
|
*/
|
|
2548
|
-
createReportOrglicensesPreview: (data:
|
|
2596
|
+
createReportOrglicensesPreview: (data: Input8Sx76Qyyss, params?: RequestParams) => Promise<any>;
|
|
2549
2597
|
/**
|
|
2550
2598
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2551
2599
|
*
|
|
@@ -2585,7 +2633,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2585
2633
|
* @request POST:/tenant/report/users/advanced
|
|
2586
2634
|
* @secure
|
|
2587
2635
|
*/
|
|
2588
|
-
createReportUsersAdvanced: (data:
|
|
2636
|
+
createReportUsersAdvanced: (data: Input1Ohda2Wgsh, params?: RequestParams) => Promise<any>;
|
|
2589
2637
|
/**
|
|
2590
2638
|
* @description Searches for users in the tenant by their IDs.
|
|
2591
2639
|
*
|
|
@@ -2595,7 +2643,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2595
2643
|
* @request POST:/tenant/search/users/ids
|
|
2596
2644
|
* @secure
|
|
2597
2645
|
*/
|
|
2598
|
-
listSearchUsersIds: (data:
|
|
2646
|
+
listSearchUsersIds: (data: InputO1Eswyvj0E, params?: RequestParams) => Promise<any>;
|
|
2599
2647
|
/**
|
|
2600
2648
|
* @description Searches for users in the tenant by term and filters.
|
|
2601
2649
|
*
|
|
@@ -2605,7 +2653,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2605
2653
|
* @request POST:/tenant/search/users/term
|
|
2606
2654
|
* @secure
|
|
2607
2655
|
*/
|
|
2608
|
-
createSearchUsersTerm: (data:
|
|
2656
|
+
createSearchUsersTerm: (data: InputRalyzixy0A, params?: RequestParams) => Promise<any>;
|
|
2609
2657
|
/**
|
|
2610
2658
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2611
2659
|
*
|
|
@@ -2615,7 +2663,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2615
2663
|
* @request POST:/tenant/report/users/simple
|
|
2616
2664
|
* @secure
|
|
2617
2665
|
*/
|
|
2618
|
-
createReportUsersSimple: (data:
|
|
2666
|
+
createReportUsersSimple: (data: InputVll5Y8N7Fs, params?: RequestParams) => Promise<any>;
|
|
2619
2667
|
/**
|
|
2620
2668
|
* @description Retrieve user by ID.
|
|
2621
2669
|
*
|
|
@@ -2625,7 +2673,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2625
2673
|
* @request POST:/tenant/search/users/count
|
|
2626
2674
|
* @secure
|
|
2627
2675
|
*/
|
|
2628
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2676
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<Output4Qe1Gsbbif>;
|
|
2629
2677
|
};
|
|
2630
2678
|
user: {
|
|
2631
2679
|
/**
|
|
@@ -2657,7 +2705,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2657
2705
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2658
2706
|
* @secure
|
|
2659
2707
|
*/
|
|
2660
|
-
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>;
|
|
2661
2709
|
/**
|
|
2662
2710
|
* @description Delete a certification process application by type.
|
|
2663
2711
|
*
|
|
@@ -2747,7 +2795,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2747
2795
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2748
2796
|
* @secure
|
|
2749
2797
|
*/
|
|
2750
|
-
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>;
|
|
2751
2799
|
/**
|
|
2752
2800
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2753
2801
|
*
|
|
@@ -2757,7 +2805,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2757
2805
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2758
2806
|
* @secure
|
|
2759
2807
|
*/
|
|
2760
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2808
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputLfhw9J38Sf>;
|
|
2761
2809
|
/**
|
|
2762
2810
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2763
2811
|
*
|
|
@@ -2777,7 +2825,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2777
2825
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2778
2826
|
* @secure
|
|
2779
2827
|
*/
|
|
2780
|
-
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>;
|
|
2829
|
+
/**
|
|
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.
|
|
2831
|
+
*
|
|
2832
|
+
* @tags Sponsorship
|
|
2833
|
+
* @name DeleteSponsorshipPendingApproval
|
|
2834
|
+
* @summary Delete a pending sponsorship request
|
|
2835
|
+
* @request DELETE:/user/{userID}/sponsorship/pendingApproval/{paID}
|
|
2836
|
+
* @secure
|
|
2837
|
+
*/
|
|
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>;
|
|
2781
2849
|
/**
|
|
2782
2850
|
* @description Delete user by ID.
|
|
2783
2851
|
*
|
|
@@ -2807,7 +2875,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2807
2875
|
* @request POST:/user/{userID}
|
|
2808
2876
|
* @secure
|
|
2809
2877
|
*/
|
|
2810
|
-
createUser: (userId: string, data:
|
|
2878
|
+
createUser: (userId: string, data: InputKz3Sd08My4, params?: RequestParams) => Promise<any>;
|
|
2811
2879
|
/**
|
|
2812
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.
|
|
2813
2881
|
*
|
|
@@ -2817,7 +2885,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2817
2885
|
* @request PUT:/user/{userID}
|
|
2818
2886
|
* @secure
|
|
2819
2887
|
*/
|
|
2820
|
-
updateUser: (userId: string, data:
|
|
2888
|
+
updateUser: (userId: string, data: InputMgiii85Qor, params?: RequestParams) => Promise<any>;
|
|
2821
2889
|
/**
|
|
2822
2890
|
* @description Delete course from user
|
|
2823
2891
|
*
|
|
@@ -2837,7 +2905,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2837
2905
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2838
2906
|
* @secure
|
|
2839
2907
|
*/
|
|
2840
|
-
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>;
|
|
2841
2909
|
/**
|
|
2842
2910
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2843
2911
|
*
|
|
@@ -2847,7 +2915,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2847
2915
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2848
2916
|
* @secure
|
|
2849
2917
|
*/
|
|
2850
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2918
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<Output42Odz333Xq>;
|
|
2851
2919
|
/**
|
|
2852
2920
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2853
2921
|
*
|
|
@@ -2857,7 +2925,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2857
2925
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2858
2926
|
* @secure
|
|
2859
2927
|
*/
|
|
2860
|
-
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>;
|
|
2861
2929
|
/**
|
|
2862
2930
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2863
2931
|
*
|
|
@@ -2897,7 +2965,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2897
2965
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2898
2966
|
* @secure
|
|
2899
2967
|
*/
|
|
2900
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2968
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<Output6Pgrlpk9Uci>;
|
|
2901
2969
|
/**
|
|
2902
2970
|
* @description This endpoint will print certificate
|
|
2903
2971
|
*
|
|
@@ -2957,7 +3025,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2957
3025
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2958
3026
|
* @secure
|
|
2959
3027
|
*/
|
|
2960
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
3028
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputE24P17Anqn, params?: RequestParams) => Promise<any>;
|
|
2961
3029
|
/**
|
|
2962
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.
|
|
2963
3031
|
*
|
|
@@ -2987,7 +3055,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2987
3055
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2988
3056
|
* @secure
|
|
2989
3057
|
*/
|
|
2990
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3058
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputOke7Fx73Wa, params?: RequestParams) => Promise<any>;
|
|
2991
3059
|
/**
|
|
2992
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.
|
|
2993
3061
|
*
|
|
@@ -2997,7 +3065,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2997
3065
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2998
3066
|
* @secure
|
|
2999
3067
|
*/
|
|
3000
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3068
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputMyxld51Ils, params?: RequestParams) => Promise<any>;
|
|
3001
3069
|
/**
|
|
3002
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.
|
|
3003
3071
|
*
|
|
@@ -3007,7 +3075,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3007
3075
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
3008
3076
|
* @secure
|
|
3009
3077
|
*/
|
|
3010
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
3078
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: Input78Oq3Ogocp, params?: RequestParams) => Promise<any>;
|
|
3011
3079
|
/**
|
|
3012
3080
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
3013
3081
|
*
|
|
@@ -3017,7 +3085,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3017
3085
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
3018
3086
|
* @secure
|
|
3019
3087
|
*/
|
|
3020
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
3088
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputI19Hnqwxd9, params?: RequestParams) => Promise<any>;
|
|
3021
3089
|
/**
|
|
3022
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.
|
|
3023
3091
|
*
|
|
@@ -3057,7 +3125,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3057
3125
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
3058
3126
|
* @secure
|
|
3059
3127
|
*/
|
|
3060
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
3128
|
+
createCertificationWaive: (userId: string, certProcId: string, data: Input0Rf8Rir2Wi, params?: RequestParams) => Promise<any>;
|
|
3061
3129
|
/**
|
|
3062
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.
|
|
3063
3131
|
*
|
|
@@ -3067,7 +3135,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3067
3135
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
3068
3136
|
* @secure
|
|
3069
3137
|
*/
|
|
3070
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3138
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputCunolmrmg2>;
|
|
3071
3139
|
/**
|
|
3072
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.
|
|
3073
3141
|
*
|
|
@@ -3107,7 +3175,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3107
3175
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
3108
3176
|
* @secure
|
|
3109
3177
|
*/
|
|
3110
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
3178
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputFsr7Mbfjl2, params?: RequestParams) => Promise<any>;
|
|
3111
3179
|
/**
|
|
3112
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.
|
|
3113
3181
|
*
|
|
@@ -3167,7 +3235,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3167
3235
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3168
3236
|
* @secure
|
|
3169
3237
|
*/
|
|
3170
|
-
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>;
|
|
3171
3239
|
/**
|
|
3172
3240
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3173
3241
|
*
|
|
@@ -3187,7 +3255,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3187
3255
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3188
3256
|
* @secure
|
|
3189
3257
|
*/
|
|
3190
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3258
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputW46Ry9Xsi5, params?: RequestParams) => Promise<any>;
|
|
3191
3259
|
/**
|
|
3192
3260
|
* @description This route allows you to submit a pending approval.
|
|
3193
3261
|
*
|
|
@@ -3197,7 +3265,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3197
3265
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3198
3266
|
* @secure
|
|
3199
3267
|
*/
|
|
3200
|
-
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>;
|
|
3201
3269
|
/**
|
|
3202
3270
|
* @description This route allows you to review a pending approval.
|
|
3203
3271
|
*
|
|
@@ -3207,7 +3275,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3207
3275
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3208
3276
|
* @secure
|
|
3209
3277
|
*/
|
|
3210
|
-
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>;
|
|
3211
3279
|
/**
|
|
3212
3280
|
* @description Redeems a license for a user by product ID.
|
|
3213
3281
|
*
|
|
@@ -3217,7 +3285,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3217
3285
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3218
3286
|
* @secure
|
|
3219
3287
|
*/
|
|
3220
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3288
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputFpmobr2I5K, params?: RequestParams) => Promise<any>;
|
|
3221
3289
|
/**
|
|
3222
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.
|
|
3223
3291
|
*
|
|
@@ -3227,7 +3295,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3227
3295
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3228
3296
|
* @secure
|
|
3229
3297
|
*/
|
|
3230
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3298
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<Output68Gczuab0M>;
|
|
3231
3299
|
/**
|
|
3232
3300
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3233
3301
|
*
|
|
@@ -3237,7 +3305,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3237
3305
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3238
3306
|
* @secure
|
|
3239
3307
|
*/
|
|
3240
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3308
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: Input1Z2S5Mvjmj, params?: RequestParams) => Promise<any>;
|
|
3241
3309
|
/**
|
|
3242
3310
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3243
3311
|
*
|
|
@@ -3247,7 +3315,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3247
3315
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3248
3316
|
* @secure
|
|
3249
3317
|
*/
|
|
3250
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3318
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input7Jrsau5Uep, params?: RequestParams) => Promise<any>;
|
|
3251
3319
|
/**
|
|
3252
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.
|
|
3253
3321
|
*
|
|
@@ -3257,7 +3325,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3257
3325
|
* @request POST:/user/{userID}/updateITA
|
|
3258
3326
|
* @secure
|
|
3259
3327
|
*/
|
|
3260
|
-
createUpdateIta: (userId: string, data:
|
|
3328
|
+
createUpdateIta: (userId: string, data: InputSdhhf07Dy2, params?: RequestParams) => Promise<any>;
|
|
3261
3329
|
/**
|
|
3262
3330
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3263
3331
|
*
|
|
@@ -3267,7 +3335,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3267
3335
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3268
3336
|
* @secure
|
|
3269
3337
|
*/
|
|
3270
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3338
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: Input17Tw549Oah, params?: RequestParams) => Promise<any>;
|
|
3271
3339
|
/**
|
|
3272
3340
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3273
3341
|
*
|
|
@@ -3277,7 +3345,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3277
3345
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3278
3346
|
* @secure
|
|
3279
3347
|
*/
|
|
3280
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3348
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputFgo7Tyrxudl, params?: RequestParams) => Promise<any>;
|
|
3281
3349
|
/**
|
|
3282
3350
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3283
3351
|
*
|
|
@@ -3319,7 +3387,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3319
3387
|
* @request POST:/users/certification/{certSpecID}
|
|
3320
3388
|
* @secure
|
|
3321
3389
|
*/
|
|
3322
|
-
createCertification: (certSpecId: string, data:
|
|
3390
|
+
createCertification: (certSpecId: string, data: InputKtez8C9Ig9F, params?: RequestParams) => Promise<OutputKtez8C9Ig9F>;
|
|
3323
3391
|
/**
|
|
3324
3392
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3325
3393
|
*
|