@ikonintegration/bccsa-program-api 3.0.33 → 3.0.37
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 +163 -94
- package/dist/Api.d.ts +137 -103
- package/dist/Api.js +43 -9
- 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 InputZkkizspn1Ug {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -445,6 +445,8 @@ export interface PendingApprovalResponseSchema {
|
|
|
445
445
|
sponsorshipRemindersStudent?: SponsorshipRemindersStudent;
|
|
446
446
|
/** Pending sponsorship request reminders sent to the sponsor (array with reminder IDs, where reminderID is template-numdays) */
|
|
447
447
|
sponsorshipRemindersSponsor?: SponsorshipRemindersSponsor;
|
|
448
|
+
/** Timestamp when the current sponsorship reminder schedule started (set on create and on reset). Reminder dueness is measured from it; when absent, from createdOn. */
|
|
449
|
+
remindersStartedOn?: RemindersStartedOn;
|
|
448
450
|
}[] | null;
|
|
449
451
|
}
|
|
450
452
|
/** Timestamp when the entry was last updated */
|
|
@@ -482,7 +484,9 @@ export type Title = string;
|
|
|
482
484
|
export type SponsorshipRemindersStudent = string[];
|
|
483
485
|
/** Pending sponsorship request reminders sent to the sponsor (array with reminder IDs, where reminderID is template-numdays) */
|
|
484
486
|
export type SponsorshipRemindersSponsor = string[];
|
|
485
|
-
|
|
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
|
+
export type RemindersStartedOn = number;
|
|
489
|
+
export interface InputN2Pbfp1G69 {
|
|
486
490
|
/**
|
|
487
491
|
* ID of the certification to filter applications by
|
|
488
492
|
* @example "certification123"
|
|
@@ -539,7 +543,7 @@ export interface InputHtrrxf8Yp9K {
|
|
|
539
543
|
*/
|
|
540
544
|
ignoreCompletedCertifications?: boolean | null;
|
|
541
545
|
}
|
|
542
|
-
export interface
|
|
546
|
+
export interface InputJ598Pbmrge {
|
|
543
547
|
/**
|
|
544
548
|
* ID of the certification to filter applications by
|
|
545
549
|
* @example "certification123"
|
|
@@ -596,7 +600,7 @@ export interface InputTq7O0B5F3S {
|
|
|
596
600
|
*/
|
|
597
601
|
ignoreCompletedCertifications?: boolean | null;
|
|
598
602
|
}
|
|
599
|
-
export interface
|
|
603
|
+
export interface InputZpvr6A88Xc {
|
|
600
604
|
/**
|
|
601
605
|
* ID of the certification to filter applications by
|
|
602
606
|
* @example "certification123"
|
|
@@ -653,7 +657,7 @@ export interface InputVeillj4Rt0L {
|
|
|
653
657
|
*/
|
|
654
658
|
ignoreCompletedCertifications?: boolean | null;
|
|
655
659
|
}
|
|
656
|
-
export interface
|
|
660
|
+
export interface InputC1Ye5Hwls5J {
|
|
657
661
|
/**
|
|
658
662
|
* The ID of the certificate specifications to be used for the email
|
|
659
663
|
* @example "certSpecsID123"
|
|
@@ -694,7 +698,7 @@ export interface InputOaldjlebnx {
|
|
|
694
698
|
emailAddress: string;
|
|
695
699
|
}[];
|
|
696
700
|
}
|
|
697
|
-
export interface
|
|
701
|
+
export interface InputSaxqz8G15X {
|
|
698
702
|
/**
|
|
699
703
|
* The ID of the product for which the license is being redeemed
|
|
700
704
|
* @example "productID123"
|
|
@@ -706,7 +710,7 @@ export interface InputKkyamupnlt {
|
|
|
706
710
|
*/
|
|
707
711
|
sessionID?: string;
|
|
708
712
|
}
|
|
709
|
-
export interface
|
|
713
|
+
export interface InputQdeponwb9F {
|
|
710
714
|
/**
|
|
711
715
|
* Search term to filter licenses
|
|
712
716
|
* @example "active"
|
|
@@ -723,7 +727,7 @@ export interface InputUkvmhdqu3Zh {
|
|
|
723
727
|
*/
|
|
724
728
|
sortField?: any;
|
|
725
729
|
}
|
|
726
|
-
export interface
|
|
730
|
+
export interface InputC0Apqdl809I {
|
|
727
731
|
/**
|
|
728
732
|
* Search term to filter licenses
|
|
729
733
|
* @example "active"
|
|
@@ -852,9 +856,11 @@ export interface SearchPendingApprovalsResponseSchema {
|
|
|
852
856
|
sponsorshipRemindersStudent?: SponsorshipRemindersStudent;
|
|
853
857
|
/** Pending sponsorship request reminders sent to the sponsor (array with reminder IDs, where reminderID is template-numdays) */
|
|
854
858
|
sponsorshipRemindersSponsor?: SponsorshipRemindersSponsor;
|
|
859
|
+
/** Timestamp when the current sponsorship reminder schedule started (set on create and on reset). Reminder dueness is measured from it; when absent, from createdOn. */
|
|
860
|
+
remindersStartedOn?: RemindersStartedOn;
|
|
855
861
|
}[];
|
|
856
862
|
}
|
|
857
|
-
export interface
|
|
863
|
+
export interface InputJh6321Ew32 {
|
|
858
864
|
/**
|
|
859
865
|
* Start date for the report
|
|
860
866
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -876,11 +882,11 @@ export interface Input7Il0Lvxsvl {
|
|
|
876
882
|
*/
|
|
877
883
|
dateType?: string;
|
|
878
884
|
}
|
|
879
|
-
export interface
|
|
885
|
+
export interface InputIi4P7M7Hs9 {
|
|
880
886
|
/** List of user IDs to search for in the tenant. */
|
|
881
887
|
IDs: (string | null)[];
|
|
882
888
|
}
|
|
883
|
-
export interface
|
|
889
|
+
export interface InputCfab2Oqckr {
|
|
884
890
|
/** The term to search for in the user profiles. */
|
|
885
891
|
searchTerm?: string | null;
|
|
886
892
|
/** Filter criteria for the user search. */
|
|
@@ -920,7 +926,7 @@ export interface InputVawcwl0959 {
|
|
|
920
926
|
};
|
|
921
927
|
};
|
|
922
928
|
}
|
|
923
|
-
export interface
|
|
929
|
+
export interface InputFyv0Tovwba {
|
|
924
930
|
/** The term to search for in the user profiles. */
|
|
925
931
|
searchTerm?: string | null;
|
|
926
932
|
/** Filter criteria for the user search. */
|
|
@@ -960,21 +966,23 @@ export interface InputHlghz0Fmyni {
|
|
|
960
966
|
};
|
|
961
967
|
};
|
|
962
968
|
}
|
|
963
|
-
export interface
|
|
969
|
+
export interface OutputYz6Rjygfu2 {
|
|
964
970
|
/** External system ID 2 */
|
|
965
971
|
userCount: ExternalID2;
|
|
966
972
|
transactionID?: string | null;
|
|
967
973
|
}
|
|
968
974
|
/** External system ID 2 */
|
|
969
975
|
export type ExternalID2 = number;
|
|
970
|
-
|
|
976
|
+
/** This endpoint accepts no request body */
|
|
977
|
+
export type DeletePendingApprovalBody = object;
|
|
978
|
+
export interface OutputB9Rbrha4Sb {
|
|
971
979
|
/**
|
|
972
980
|
* Signed URL for the course file
|
|
973
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"
|
|
974
982
|
*/
|
|
975
983
|
fileURL: string;
|
|
976
984
|
}
|
|
977
|
-
export interface
|
|
985
|
+
export interface OutputZ0668Cjphf {
|
|
978
986
|
/**
|
|
979
987
|
* Amount to be refunded for the cancellation
|
|
980
988
|
* @example 0
|
|
@@ -1274,7 +1282,7 @@ export interface CourseResponseEntity {
|
|
|
1274
1282
|
}
|
|
1275
1283
|
/** Label of the course enrolled (course version) */
|
|
1276
1284
|
export type OnlineCourseLabel = string;
|
|
1277
|
-
export interface
|
|
1285
|
+
export interface OutputJ1Oqgachio {
|
|
1278
1286
|
/**
|
|
1279
1287
|
* Signed URL for the course file
|
|
1280
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"
|
|
@@ -1292,7 +1300,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1292
1300
|
transactionID?: string | null;
|
|
1293
1301
|
}
|
|
1294
1302
|
/** Application Foreign Fill response type */
|
|
1295
|
-
export interface
|
|
1303
|
+
export interface OutputXtyq604Vdy {
|
|
1296
1304
|
items: {
|
|
1297
1305
|
userID: string;
|
|
1298
1306
|
createdOn?: number;
|
|
@@ -1480,7 +1488,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1480
1488
|
applicationItems?: Record<string, any>[];
|
|
1481
1489
|
transactionID?: string | null;
|
|
1482
1490
|
}
|
|
1483
|
-
export interface
|
|
1491
|
+
export interface InputLok8Yjdg8Lf {
|
|
1484
1492
|
issuedOn?: number;
|
|
1485
1493
|
expiresOn?: number;
|
|
1486
1494
|
fileItems?: {
|
|
@@ -1489,21 +1497,21 @@ export interface InputZe9R08Tm0T {
|
|
|
1489
1497
|
}[];
|
|
1490
1498
|
additionalNotes?: string | null;
|
|
1491
1499
|
}
|
|
1492
|
-
export interface
|
|
1500
|
+
export interface Input8Jtmo5Z719K {
|
|
1493
1501
|
/**
|
|
1494
1502
|
* Indicates whether the application is locked
|
|
1495
1503
|
* @example true
|
|
1496
1504
|
*/
|
|
1497
1505
|
isApplicationLocked: boolean;
|
|
1498
1506
|
}
|
|
1499
|
-
export interface
|
|
1507
|
+
export interface OutputEu94Ew8Yhf {
|
|
1500
1508
|
/**
|
|
1501
1509
|
* Signed URL for the course file
|
|
1502
1510
|
* @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"
|
|
1503
1511
|
*/
|
|
1504
1512
|
fileURL: string;
|
|
1505
1513
|
}
|
|
1506
|
-
export interface
|
|
1514
|
+
export interface InputV9Pu8Hsooe {
|
|
1507
1515
|
/**
|
|
1508
1516
|
* Indicates whether the waiver is approved
|
|
1509
1517
|
* @example true
|
|
@@ -1515,14 +1523,14 @@ export interface InputKc1Ehdb5Ps {
|
|
|
1515
1523
|
*/
|
|
1516
1524
|
additionalNotes?: string | null;
|
|
1517
1525
|
}
|
|
1518
|
-
export interface
|
|
1526
|
+
export interface Input8P34Cst6Sz {
|
|
1519
1527
|
/**
|
|
1520
1528
|
* Optional notes regarding the waiver
|
|
1521
1529
|
* @example "Waiver granted due to special circumstances."
|
|
1522
1530
|
*/
|
|
1523
1531
|
additionalNotes?: string | null;
|
|
1524
1532
|
}
|
|
1525
|
-
export interface
|
|
1533
|
+
export interface InputZv1Ikpfitw {
|
|
1526
1534
|
students: {
|
|
1527
1535
|
/**
|
|
1528
1536
|
* User ID of the student to redeem the course for
|
|
@@ -1556,7 +1564,7 @@ export interface Input5L25G7Qxfo {
|
|
|
1556
1564
|
*/
|
|
1557
1565
|
autoEnrolSessionID?: string;
|
|
1558
1566
|
}
|
|
1559
|
-
export interface
|
|
1567
|
+
export interface InputNf5K52Xa14 {
|
|
1560
1568
|
invites: {
|
|
1561
1569
|
/**
|
|
1562
1570
|
* Email address of the user to invite
|
|
@@ -1585,7 +1593,7 @@ export interface InputLkqgxr42Ux {
|
|
|
1585
1593
|
*/
|
|
1586
1594
|
isReservedSeat: boolean;
|
|
1587
1595
|
}
|
|
1588
|
-
export interface
|
|
1596
|
+
export interface Input1B88Huavnlf {
|
|
1589
1597
|
/**
|
|
1590
1598
|
* Indicates whether to waive the certification process
|
|
1591
1599
|
* @example true
|
|
@@ -1598,7 +1606,7 @@ export interface InputHvql6Tv30P {
|
|
|
1598
1606
|
comments?: string | null;
|
|
1599
1607
|
}
|
|
1600
1608
|
/** Certification move response schema */
|
|
1601
|
-
export interface
|
|
1609
|
+
export interface OutputK40A9P4Wntj {
|
|
1602
1610
|
errors?: {
|
|
1603
1611
|
status: string;
|
|
1604
1612
|
object?: Record<string, any>;
|
|
@@ -1606,19 +1614,19 @@ export interface OutputIpk3Gr4Jn2 {
|
|
|
1606
1614
|
}[];
|
|
1607
1615
|
}
|
|
1608
1616
|
/** Schema for writing a certification trigger check. */
|
|
1609
|
-
export interface
|
|
1617
|
+
export interface Input72Yx0Bqloy {
|
|
1610
1618
|
/**
|
|
1611
1619
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1612
1620
|
* @example "CHECKED"
|
|
1613
1621
|
*/
|
|
1614
|
-
value:
|
|
1622
|
+
value: Input72Yx0BqloyValueEnum;
|
|
1615
1623
|
/**
|
|
1616
1624
|
* List of course IDs that are blocked by this trigger check.
|
|
1617
1625
|
* @example ["course1","course2"]
|
|
1618
1626
|
*/
|
|
1619
1627
|
blockedCourses?: string[];
|
|
1620
1628
|
}
|
|
1621
|
-
export interface
|
|
1629
|
+
export interface InputTyyk1Gva3F {
|
|
1622
1630
|
/**
|
|
1623
1631
|
* Indicates whether the application item is approved
|
|
1624
1632
|
* @example true
|
|
@@ -1644,7 +1652,7 @@ export interface InputWk711Xrjeq {
|
|
|
1644
1652
|
export interface StudentHistoryRequestSchema {
|
|
1645
1653
|
requirements: string[];
|
|
1646
1654
|
}
|
|
1647
|
-
export interface
|
|
1655
|
+
export interface Input1Ud4Zfxio7 {
|
|
1648
1656
|
/**
|
|
1649
1657
|
* Optional activation key for the application
|
|
1650
1658
|
* @example "AK-123456"
|
|
@@ -1652,7 +1660,7 @@ export interface InputTtdoeespbb {
|
|
|
1652
1660
|
activationKey?: string;
|
|
1653
1661
|
}
|
|
1654
1662
|
/** Schema for course submission item details post request. */
|
|
1655
|
-
export interface
|
|
1663
|
+
export interface Input9Ar42O9Flp {
|
|
1656
1664
|
/**
|
|
1657
1665
|
* The ID of the file being submitted.
|
|
1658
1666
|
* @example "fileID123"
|
|
@@ -1665,7 +1673,7 @@ export interface InputCvqczxrsu6 {
|
|
|
1665
1673
|
fileName: string;
|
|
1666
1674
|
}
|
|
1667
1675
|
/** Schema for the response to course submission item details post request. */
|
|
1668
|
-
export interface
|
|
1676
|
+
export interface Output9Ar42O9Flp {
|
|
1669
1677
|
submissionItems: {
|
|
1670
1678
|
/**
|
|
1671
1679
|
* The ID of the file being submitted.
|
|
@@ -1680,7 +1688,7 @@ export interface OutputCvqczxrsu6 {
|
|
|
1680
1688
|
}[];
|
|
1681
1689
|
}
|
|
1682
1690
|
/** Pending approval submission parameters */
|
|
1683
|
-
export interface
|
|
1691
|
+
export interface Input83Eunpl3Y9 {
|
|
1684
1692
|
/**
|
|
1685
1693
|
* Type of pending approval
|
|
1686
1694
|
* @example "certification"
|
|
@@ -1700,7 +1708,7 @@ export interface InputPmeud0A4Jo {
|
|
|
1700
1708
|
fileName: string;
|
|
1701
1709
|
}[];
|
|
1702
1710
|
}
|
|
1703
|
-
export interface
|
|
1711
|
+
export interface InputBvmzq8Voop {
|
|
1704
1712
|
/**
|
|
1705
1713
|
* The ID of the course for which the license is being redeemed
|
|
1706
1714
|
* @example "courseID123"
|
|
@@ -1768,7 +1776,7 @@ export interface Input92Ud3Ap8Ee {
|
|
|
1768
1776
|
acknowledgement?: string | null;
|
|
1769
1777
|
}
|
|
1770
1778
|
/** Validate certification move response schema */
|
|
1771
|
-
export interface
|
|
1779
|
+
export interface OutputGbnglvar32H {
|
|
1772
1780
|
courses: {
|
|
1773
1781
|
name: string;
|
|
1774
1782
|
status: string;
|
|
@@ -1779,21 +1787,21 @@ export interface OutputZ780Quci3Tj {
|
|
|
1779
1787
|
validated: boolean;
|
|
1780
1788
|
mustCreateCP: boolean;
|
|
1781
1789
|
}
|
|
1782
|
-
export interface
|
|
1790
|
+
export interface InputMjpfe7392W {
|
|
1783
1791
|
/**
|
|
1784
1792
|
* Comments regarding the end of the cooldown period
|
|
1785
1793
|
* @example "Cooldown period ended successfully."
|
|
1786
1794
|
*/
|
|
1787
1795
|
comments: string;
|
|
1788
1796
|
}
|
|
1789
|
-
export interface
|
|
1797
|
+
export interface Output4Bdvouau4O {
|
|
1790
1798
|
/**
|
|
1791
1799
|
* Signed URL for the course file
|
|
1792
1800
|
* @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"
|
|
1793
1801
|
*/
|
|
1794
1802
|
fileURL: string;
|
|
1795
1803
|
}
|
|
1796
|
-
export interface
|
|
1804
|
+
export interface InputV5Njfikakn {
|
|
1797
1805
|
/** @example true */
|
|
1798
1806
|
agreedWithCertTerms: boolean;
|
|
1799
1807
|
/** @example 1717230000000 */
|
|
@@ -1878,21 +1886,21 @@ export interface Sponsor {
|
|
|
1878
1886
|
/** Title of the sponsor of the student in the tenant */
|
|
1879
1887
|
title?: Title;
|
|
1880
1888
|
}
|
|
1881
|
-
export interface
|
|
1889
|
+
export interface InputZ0H2Pu9Q1B {
|
|
1882
1890
|
/**
|
|
1883
1891
|
* Comments regarding the course unlock action
|
|
1884
1892
|
* @example "Course unlocked successfully."
|
|
1885
1893
|
*/
|
|
1886
1894
|
comments: string;
|
|
1887
1895
|
}
|
|
1888
|
-
export interface
|
|
1896
|
+
export interface InputVv8Lphiol4 {
|
|
1889
1897
|
/**
|
|
1890
1898
|
* ITA number to update for the user
|
|
1891
1899
|
* @example "ITA123456"
|
|
1892
1900
|
*/
|
|
1893
1901
|
itaNumber: string;
|
|
1894
1902
|
}
|
|
1895
|
-
export interface
|
|
1903
|
+
export interface InputXumdodu3Vg {
|
|
1896
1904
|
/** @example true */
|
|
1897
1905
|
agreedWithCertTerms: boolean;
|
|
1898
1906
|
/** @example 1717230000000 */
|
|
@@ -1966,7 +1974,7 @@ export interface InputCe5785R8Zs {
|
|
|
1966
1974
|
/** Sponsor information for a student in the tenant */
|
|
1967
1975
|
sponsor?: Sponsor;
|
|
1968
1976
|
}
|
|
1969
|
-
export interface
|
|
1977
|
+
export interface InputPpbi3Eojs7 {
|
|
1970
1978
|
/**
|
|
1971
1979
|
* The grade to override the course result with
|
|
1972
1980
|
* @example "A"
|
|
@@ -1974,7 +1982,7 @@ export interface InputFih2S2Mlabl {
|
|
|
1974
1982
|
resultGrade: string;
|
|
1975
1983
|
}
|
|
1976
1984
|
/** Pending approval review parameters */
|
|
1977
|
-
export interface
|
|
1985
|
+
export interface Input9Vbbkncaff {
|
|
1978
1986
|
/**
|
|
1979
1987
|
* Notes provided by the reviewer for the pending approval
|
|
1980
1988
|
* @example "Please review the submitted documents."
|
|
@@ -1987,7 +1995,7 @@ export interface Input711J32K5Lx {
|
|
|
1987
1995
|
approved: boolean;
|
|
1988
1996
|
}
|
|
1989
1997
|
/** Schema for overriding course result dates. */
|
|
1990
|
-
export interface
|
|
1998
|
+
export interface Input1Gg425Q9K7 {
|
|
1991
1999
|
/**
|
|
1992
2000
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1993
2001
|
* @example 1735689600000
|
|
@@ -1999,14 +2007,16 @@ export interface InputLwd5Q9Dzkoi {
|
|
|
1999
2007
|
*/
|
|
2000
2008
|
completionDate?: number;
|
|
2001
2009
|
}
|
|
2002
|
-
|
|
2010
|
+
/** Reset sponsorship request takes no body */
|
|
2011
|
+
export type ResetSponsorshipBody = object;
|
|
2012
|
+
export interface Input18207Fqjkf {
|
|
2003
2013
|
filter: {
|
|
2004
2014
|
from?: number;
|
|
2005
2015
|
sortOrder?: string;
|
|
2006
2016
|
sortField?: string;
|
|
2007
2017
|
};
|
|
2008
2018
|
}
|
|
2009
|
-
export interface
|
|
2019
|
+
export interface Output18207Fqjkf {
|
|
2010
2020
|
users: {
|
|
2011
2021
|
firstName: string;
|
|
2012
2022
|
lastName: string;
|
|
@@ -2030,7 +2040,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
2030
2040
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
2031
2041
|
* @example "CHECKED"
|
|
2032
2042
|
*/
|
|
2033
|
-
export declare enum
|
|
2043
|
+
export declare enum Input72Yx0BqloyValueEnum {
|
|
2034
2044
|
CHECKED = "CHECKED",
|
|
2035
2045
|
UNCHECKED = "UNCHECKED",
|
|
2036
2046
|
NOVALUE = "NOVALUE"
|
|
@@ -2129,7 +2139,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2129
2139
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2130
2140
|
export type CreateReportUsersSimpleData = any;
|
|
2131
2141
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2132
|
-
export type CreateSearchUsersCountData =
|
|
2142
|
+
export type CreateSearchUsersCountData = OutputYz6Rjygfu2;
|
|
2133
2143
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2134
2144
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2135
2145
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2153,7 +2163,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2153
2163
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2154
2164
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2155
2165
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2156
|
-
export type GetCertificationCourseFileSignData =
|
|
2166
|
+
export type GetCertificationCourseFileSignData = OutputJ1Oqgachio;
|
|
2157
2167
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2158
2168
|
export interface CreateCertificationCourseFileSignParams {
|
|
2159
2169
|
/** @example "pdf" */
|
|
@@ -2167,12 +2177,14 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2167
2177
|
/** @example "fileID" */
|
|
2168
2178
|
fileId: string;
|
|
2169
2179
|
}
|
|
2170
|
-
export type CreateCertificationCourseFileSignData =
|
|
2180
|
+
export type CreateCertificationCourseFileSignData = Output4Bdvouau4O;
|
|
2171
2181
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2172
2182
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2173
2183
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2174
|
-
export type CreateCertificationCourseDocumentData =
|
|
2184
|
+
export type CreateCertificationCourseDocumentData = Output9Ar42O9Flp;
|
|
2175
2185
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2186
|
+
export type DeleteSponsorshipPendingApprovalData = any;
|
|
2187
|
+
export type DeleteSponsorshipPendingApprovalError = ErrorResponse;
|
|
2176
2188
|
export type DeleteUserData = any;
|
|
2177
2189
|
export type DeleteUserError = ErrorResponse;
|
|
2178
2190
|
export type GetUserResult = UserResponseEntity;
|
|
@@ -2183,7 +2195,7 @@ export type UpdateUserData = any;
|
|
|
2183
2195
|
export type UpdateUserError = ErrorResponse;
|
|
2184
2196
|
export type DeleteCertificationCourseData = any;
|
|
2185
2197
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2186
|
-
export type GetCertificationApplicationItemFileData =
|
|
2198
|
+
export type GetCertificationApplicationItemFileData = OutputB9Rbrha4Sb;
|
|
2187
2199
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2188
2200
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2189
2201
|
/** @example "pdf" */
|
|
@@ -2197,9 +2209,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2197
2209
|
/** @example "fileVersion" */
|
|
2198
2210
|
fileVersion: string;
|
|
2199
2211
|
}
|
|
2200
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2212
|
+
export type CreateCertificationApplicationItemFileData = OutputEu94Ew8Yhf;
|
|
2201
2213
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2202
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2214
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputZ0668Cjphf;
|
|
2203
2215
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2204
2216
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2205
2217
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2207,7 +2219,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2207
2219
|
export type GetCourseError = ErrorResponse;
|
|
2208
2220
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2209
2221
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2210
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2222
|
+
export type GetCertificationApplicationForeignFillData = OutputXtyq604Vdy;
|
|
2211
2223
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2212
2224
|
export type GetCertificationPrintData = any;
|
|
2213
2225
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2241,7 +2253,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2241
2253
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2242
2254
|
export type CreateCertificationWaiveData = any;
|
|
2243
2255
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2244
|
-
export type CreateCertificationMoveData =
|
|
2256
|
+
export type CreateCertificationMoveData = OutputK40A9P4Wntj;
|
|
2245
2257
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2246
2258
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2247
2259
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2273,7 +2285,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2273
2285
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2274
2286
|
export type CreateCertificationCourseRedeemData = any;
|
|
2275
2287
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2276
|
-
export type CreateCertificationMoveValidateData =
|
|
2288
|
+
export type CreateCertificationMoveValidateData = OutputGbnglvar32H;
|
|
2277
2289
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2278
2290
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2279
2291
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2289,7 +2301,9 @@ export type CreateCertificationPublishInfoData = any;
|
|
|
2289
2301
|
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2290
2302
|
export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
2291
2303
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2292
|
-
export type
|
|
2304
|
+
export type CreateSponsorshipResetData = any;
|
|
2305
|
+
export type CreateSponsorshipResetError = ErrorResponse;
|
|
2306
|
+
export type CreateCertificationResult = Output18207Fqjkf;
|
|
2293
2307
|
export type CreateCertificationFail = ErrorResponse;
|
|
2294
2308
|
export type CreateCertificationPublishInfoResult = any;
|
|
2295
2309
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2336,7 +2350,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2336
2350
|
}
|
|
2337
2351
|
/**
|
|
2338
2352
|
* @title BCCSA Program API
|
|
2339
|
-
* @version 3.0.
|
|
2353
|
+
* @version 3.0.37
|
|
2340
2354
|
* @baseUrl http://localhost:8080
|
|
2341
2355
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2342
2356
|
*/
|
|
@@ -2351,7 +2365,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2351
2365
|
* @request POST:/contactUs
|
|
2352
2366
|
* @secure
|
|
2353
2367
|
*/
|
|
2354
|
-
listContactUs: (data:
|
|
2368
|
+
listContactUs: (data: InputZkkizspn1Ug, params?: RequestParams) => Promise<any>;
|
|
2355
2369
|
};
|
|
2356
2370
|
customer: {
|
|
2357
2371
|
/**
|
|
@@ -2455,7 +2469,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2455
2469
|
* @request POST:/tenant/report/applicationExport
|
|
2456
2470
|
* @secure
|
|
2457
2471
|
*/
|
|
2458
|
-
createReportApplicationExport: (data:
|
|
2472
|
+
createReportApplicationExport: (data: InputN2Pbfp1G69, params?: RequestParams) => Promise<any>;
|
|
2459
2473
|
/**
|
|
2460
2474
|
* @description Export a report of applications based on the provided filters.
|
|
2461
2475
|
*
|
|
@@ -2465,7 +2479,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2465
2479
|
* @request POST:/tenant/report/applicationStatus
|
|
2466
2480
|
* @secure
|
|
2467
2481
|
*/
|
|
2468
|
-
listReportApplicationStatus: (data:
|
|
2482
|
+
listReportApplicationStatus: (data: InputJ598Pbmrge, params?: RequestParams) => Promise<any>;
|
|
2469
2483
|
/**
|
|
2470
2484
|
* @description Export a report of applications based on the provided filters.
|
|
2471
2485
|
*
|
|
@@ -2475,7 +2489,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2475
2489
|
* @request POST:/tenant/report/applicationsReport
|
|
2476
2490
|
* @secure
|
|
2477
2491
|
*/
|
|
2478
|
-
createReportApplicationsReport: (data:
|
|
2492
|
+
createReportApplicationsReport: (data: InputZpvr6A88Xc, params?: RequestParams) => Promise<any>;
|
|
2479
2493
|
/**
|
|
2480
2494
|
* @description This route allows you to post certificates email for the tenant.
|
|
2481
2495
|
*
|
|
@@ -2485,7 +2499,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2485
2499
|
* @request POST:/tenant/certificates/email
|
|
2486
2500
|
* @secure
|
|
2487
2501
|
*/
|
|
2488
|
-
createCertificatesEmail: (data:
|
|
2502
|
+
createCertificatesEmail: (data: InputC1Ye5Hwls5J, params?: RequestParams) => Promise<any>;
|
|
2489
2503
|
/**
|
|
2490
2504
|
* @description Generate a preview of the completed certifications report.
|
|
2491
2505
|
*
|
|
@@ -2515,7 +2529,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2515
2529
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2516
2530
|
* @secure
|
|
2517
2531
|
*/
|
|
2518
|
-
createLicenseRedeem: (userId: string, data:
|
|
2532
|
+
createLicenseRedeem: (userId: string, data: InputSaxqz8G15X, params?: RequestParams) => Promise<any>;
|
|
2519
2533
|
/**
|
|
2520
2534
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2521
2535
|
*
|
|
@@ -2525,7 +2539,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2525
2539
|
* @request POST:/tenant/report/orglicenses/
|
|
2526
2540
|
* @secure
|
|
2527
2541
|
*/
|
|
2528
|
-
listReportOrglicenses: (data:
|
|
2542
|
+
listReportOrglicenses: (data: InputQdeponwb9F, params?: RequestParams) => Promise<any>;
|
|
2529
2543
|
/**
|
|
2530
2544
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2531
2545
|
*
|
|
@@ -2535,7 +2549,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2535
2549
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2536
2550
|
* @secure
|
|
2537
2551
|
*/
|
|
2538
|
-
createReportOrglicensesPreview: (data:
|
|
2552
|
+
createReportOrglicensesPreview: (data: InputC0Apqdl809I, params?: RequestParams) => Promise<any>;
|
|
2539
2553
|
/**
|
|
2540
2554
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2541
2555
|
*
|
|
@@ -2575,7 +2589,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2575
2589
|
* @request POST:/tenant/report/users/advanced
|
|
2576
2590
|
* @secure
|
|
2577
2591
|
*/
|
|
2578
|
-
createReportUsersAdvanced: (data:
|
|
2592
|
+
createReportUsersAdvanced: (data: InputJh6321Ew32, params?: RequestParams) => Promise<any>;
|
|
2579
2593
|
/**
|
|
2580
2594
|
* @description Searches for users in the tenant by their IDs.
|
|
2581
2595
|
*
|
|
@@ -2585,7 +2599,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2585
2599
|
* @request POST:/tenant/search/users/ids
|
|
2586
2600
|
* @secure
|
|
2587
2601
|
*/
|
|
2588
|
-
listSearchUsersIds: (data:
|
|
2602
|
+
listSearchUsersIds: (data: InputIi4P7M7Hs9, params?: RequestParams) => Promise<any>;
|
|
2589
2603
|
/**
|
|
2590
2604
|
* @description Searches for users in the tenant by term and filters.
|
|
2591
2605
|
*
|
|
@@ -2595,7 +2609,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2595
2609
|
* @request POST:/tenant/search/users/term
|
|
2596
2610
|
* @secure
|
|
2597
2611
|
*/
|
|
2598
|
-
createSearchUsersTerm: (data:
|
|
2612
|
+
createSearchUsersTerm: (data: InputCfab2Oqckr, params?: RequestParams) => Promise<any>;
|
|
2599
2613
|
/**
|
|
2600
2614
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2601
2615
|
*
|
|
@@ -2605,7 +2619,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2605
2619
|
* @request POST:/tenant/report/users/simple
|
|
2606
2620
|
* @secure
|
|
2607
2621
|
*/
|
|
2608
|
-
createReportUsersSimple: (data:
|
|
2622
|
+
createReportUsersSimple: (data: InputFyv0Tovwba, params?: RequestParams) => Promise<any>;
|
|
2609
2623
|
/**
|
|
2610
2624
|
* @description Retrieve user by ID.
|
|
2611
2625
|
*
|
|
@@ -2615,7 +2629,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2615
2629
|
* @request POST:/tenant/search/users/count
|
|
2616
2630
|
* @secure
|
|
2617
2631
|
*/
|
|
2618
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2632
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputYz6Rjygfu2>;
|
|
2619
2633
|
};
|
|
2620
2634
|
user: {
|
|
2621
2635
|
/**
|
|
@@ -2647,7 +2661,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2647
2661
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2648
2662
|
* @secure
|
|
2649
2663
|
*/
|
|
2650
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2664
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: InputLok8Yjdg8Lf, params?: RequestParams) => Promise<any>;
|
|
2651
2665
|
/**
|
|
2652
2666
|
* @description Delete a certification process application by type.
|
|
2653
2667
|
*
|
|
@@ -2737,7 +2751,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2737
2751
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2738
2752
|
* @secure
|
|
2739
2753
|
*/
|
|
2740
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2754
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputJ1Oqgachio>;
|
|
2741
2755
|
/**
|
|
2742
2756
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2743
2757
|
*
|
|
@@ -2747,7 +2761,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2747
2761
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2748
2762
|
* @secure
|
|
2749
2763
|
*/
|
|
2750
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2764
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<Output4Bdvouau4O>;
|
|
2751
2765
|
/**
|
|
2752
2766
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2753
2767
|
*
|
|
@@ -2767,7 +2781,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2767
2781
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2768
2782
|
* @secure
|
|
2769
2783
|
*/
|
|
2770
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2784
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: Input9Ar42O9Flp, params?: RequestParams) => Promise<Output9Ar42O9Flp>;
|
|
2785
|
+
/**
|
|
2786
|
+
* @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
|
+
*
|
|
2788
|
+
* @tags Sponsorship
|
|
2789
|
+
* @name DeleteSponsorshipPendingApproval
|
|
2790
|
+
* @summary Delete a pending sponsorship request
|
|
2791
|
+
* @request DELETE:/user/{userID}/sponsorship/pendingApproval/{paID}
|
|
2792
|
+
* @secure
|
|
2793
|
+
*/
|
|
2794
|
+
deleteSponsorshipPendingApproval: (userId: string, paId: string, data: DeletePendingApprovalBody, params?: RequestParams) => Promise<any>;
|
|
2771
2795
|
/**
|
|
2772
2796
|
* @description Delete user by ID.
|
|
2773
2797
|
*
|
|
@@ -2797,9 +2821,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2797
2821
|
* @request POST:/user/{userID}
|
|
2798
2822
|
* @secure
|
|
2799
2823
|
*/
|
|
2800
|
-
createUser: (userId: string, data:
|
|
2824
|
+
createUser: (userId: string, data: InputV5Njfikakn, params?: RequestParams) => Promise<any>;
|
|
2801
2825
|
/**
|
|
2802
|
-
* @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.
|
|
2826
|
+
* @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.
|
|
2803
2827
|
*
|
|
2804
2828
|
* @tags User
|
|
2805
2829
|
* @name UpdateUser
|
|
@@ -2807,7 +2831,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2807
2831
|
* @request PUT:/user/{userID}
|
|
2808
2832
|
* @secure
|
|
2809
2833
|
*/
|
|
2810
|
-
updateUser: (userId: string, data:
|
|
2834
|
+
updateUser: (userId: string, data: InputXumdodu3Vg, params?: RequestParams) => Promise<any>;
|
|
2811
2835
|
/**
|
|
2812
2836
|
* @description Delete course from user
|
|
2813
2837
|
*
|
|
@@ -2827,7 +2851,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2827
2851
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2828
2852
|
* @secure
|
|
2829
2853
|
*/
|
|
2830
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2854
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputB9Rbrha4Sb>;
|
|
2831
2855
|
/**
|
|
2832
2856
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2833
2857
|
*
|
|
@@ -2837,7 +2861,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2837
2861
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2838
2862
|
* @secure
|
|
2839
2863
|
*/
|
|
2840
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2864
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputEu94Ew8Yhf>;
|
|
2841
2865
|
/**
|
|
2842
2866
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2843
2867
|
*
|
|
@@ -2847,7 +2871,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2847
2871
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2848
2872
|
* @secure
|
|
2849
2873
|
*/
|
|
2850
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2874
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputZ0668Cjphf>;
|
|
2851
2875
|
/**
|
|
2852
2876
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2853
2877
|
*
|
|
@@ -2887,7 +2911,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2887
2911
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2888
2912
|
* @secure
|
|
2889
2913
|
*/
|
|
2890
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2914
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputXtyq604Vdy>;
|
|
2891
2915
|
/**
|
|
2892
2916
|
* @description This endpoint will print certificate
|
|
2893
2917
|
*
|
|
@@ -2947,7 +2971,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2947
2971
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2948
2972
|
* @secure
|
|
2949
2973
|
*/
|
|
2950
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2974
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: Input8Jtmo5Z719K, params?: RequestParams) => Promise<any>;
|
|
2951
2975
|
/**
|
|
2952
2976
|
* @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.
|
|
2953
2977
|
*
|
|
@@ -2977,7 +3001,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2977
3001
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2978
3002
|
* @secure
|
|
2979
3003
|
*/
|
|
2980
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3004
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputV9Pu8Hsooe, params?: RequestParams) => Promise<any>;
|
|
2981
3005
|
/**
|
|
2982
3006
|
* @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.
|
|
2983
3007
|
*
|
|
@@ -2987,7 +3011,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2987
3011
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2988
3012
|
* @secure
|
|
2989
3013
|
*/
|
|
2990
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3014
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: Input8P34Cst6Sz, params?: RequestParams) => Promise<any>;
|
|
2991
3015
|
/**
|
|
2992
3016
|
* @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.
|
|
2993
3017
|
*
|
|
@@ -2997,7 +3021,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2997
3021
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2998
3022
|
* @secure
|
|
2999
3023
|
*/
|
|
3000
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
3024
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputZv1Ikpfitw, params?: RequestParams) => Promise<any>;
|
|
3001
3025
|
/**
|
|
3002
3026
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
3003
3027
|
*
|
|
@@ -3007,7 +3031,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3007
3031
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
3008
3032
|
* @secure
|
|
3009
3033
|
*/
|
|
3010
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
3034
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputNf5K52Xa14, params?: RequestParams) => Promise<any>;
|
|
3011
3035
|
/**
|
|
3012
3036
|
* @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.
|
|
3013
3037
|
*
|
|
@@ -3047,7 +3071,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3047
3071
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
3048
3072
|
* @secure
|
|
3049
3073
|
*/
|
|
3050
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
3074
|
+
createCertificationWaive: (userId: string, certProcId: string, data: Input1B88Huavnlf, params?: RequestParams) => Promise<any>;
|
|
3051
3075
|
/**
|
|
3052
3076
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
3053
3077
|
*
|
|
@@ -3057,7 +3081,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3057
3081
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
3058
3082
|
* @secure
|
|
3059
3083
|
*/
|
|
3060
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3084
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputK40A9P4Wntj>;
|
|
3061
3085
|
/**
|
|
3062
3086
|
* @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.
|
|
3063
3087
|
*
|
|
@@ -3097,7 +3121,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3097
3121
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
3098
3122
|
* @secure
|
|
3099
3123
|
*/
|
|
3100
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
3124
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: Input72Yx0Bqloy, params?: RequestParams) => Promise<any>;
|
|
3101
3125
|
/**
|
|
3102
3126
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
3103
3127
|
*
|
|
@@ -3157,7 +3181,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3157
3181
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3158
3182
|
* @secure
|
|
3159
3183
|
*/
|
|
3160
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
3184
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: InputTyyk1Gva3F, params?: RequestParams) => Promise<any>;
|
|
3161
3185
|
/**
|
|
3162
3186
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3163
3187
|
*
|
|
@@ -3177,7 +3201,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3177
3201
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3178
3202
|
* @secure
|
|
3179
3203
|
*/
|
|
3180
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3204
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: Input1Ud4Zfxio7, params?: RequestParams) => Promise<any>;
|
|
3181
3205
|
/**
|
|
3182
3206
|
* @description This route allows you to submit a pending approval.
|
|
3183
3207
|
*
|
|
@@ -3187,7 +3211,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3187
3211
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3188
3212
|
* @secure
|
|
3189
3213
|
*/
|
|
3190
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3214
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: Input83Eunpl3Y9, params?: RequestParams) => Promise<any>;
|
|
3191
3215
|
/**
|
|
3192
3216
|
* @description This route allows you to review a pending approval.
|
|
3193
3217
|
*
|
|
@@ -3197,7 +3221,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3197
3221
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3198
3222
|
* @secure
|
|
3199
3223
|
*/
|
|
3200
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3224
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: Input9Vbbkncaff, params?: RequestParams) => Promise<any>;
|
|
3201
3225
|
/**
|
|
3202
3226
|
* @description Redeems a license for a user by product ID.
|
|
3203
3227
|
*
|
|
@@ -3207,7 +3231,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3207
3231
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3208
3232
|
* @secure
|
|
3209
3233
|
*/
|
|
3210
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3234
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputBvmzq8Voop, params?: RequestParams) => Promise<any>;
|
|
3211
3235
|
/**
|
|
3212
3236
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3213
3237
|
*
|
|
@@ -3217,7 +3241,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3217
3241
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3218
3242
|
* @secure
|
|
3219
3243
|
*/
|
|
3220
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3244
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputGbnglvar32H>;
|
|
3221
3245
|
/**
|
|
3222
3246
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3223
3247
|
*
|
|
@@ -3227,7 +3251,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3227
3251
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3228
3252
|
* @secure
|
|
3229
3253
|
*/
|
|
3230
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3254
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputMjpfe7392W, params?: RequestParams) => Promise<any>;
|
|
3231
3255
|
/**
|
|
3232
3256
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3233
3257
|
*
|
|
@@ -3237,7 +3261,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3237
3261
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3238
3262
|
* @secure
|
|
3239
3263
|
*/
|
|
3240
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3264
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputZ0H2Pu9Q1B, params?: RequestParams) => Promise<any>;
|
|
3241
3265
|
/**
|
|
3242
3266
|
* @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.
|
|
3243
3267
|
*
|
|
@@ -3247,7 +3271,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3247
3271
|
* @request POST:/user/{userID}/updateITA
|
|
3248
3272
|
* @secure
|
|
3249
3273
|
*/
|
|
3250
|
-
createUpdateIta: (userId: string, data:
|
|
3274
|
+
createUpdateIta: (userId: string, data: InputVv8Lphiol4, params?: RequestParams) => Promise<any>;
|
|
3251
3275
|
/**
|
|
3252
3276
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3253
3277
|
*
|
|
@@ -3257,7 +3281,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3257
3281
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3258
3282
|
* @secure
|
|
3259
3283
|
*/
|
|
3260
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3284
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputPpbi3Eojs7, params?: RequestParams) => Promise<any>;
|
|
3261
3285
|
/**
|
|
3262
3286
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3263
3287
|
*
|
|
@@ -3267,7 +3291,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3267
3291
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3268
3292
|
* @secure
|
|
3269
3293
|
*/
|
|
3270
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3294
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: Input1Gg425Q9K7, params?: RequestParams) => Promise<any>;
|
|
3271
3295
|
/**
|
|
3272
3296
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3273
3297
|
*
|
|
@@ -3288,6 +3312,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3288
3312
|
* @secure
|
|
3289
3313
|
*/
|
|
3290
3314
|
createCertificationCourseRequestEnrolment: (userId: string, certProcId: string, courseId: string, params?: RequestParams) => Promise<any>;
|
|
3315
|
+
/**
|
|
3316
|
+
* @description Restart a user sponsorship / attestation request from the user's currently stored sponsor data. Refreshes an existing pending request in place, or creates a new request when the previous one is completed or missing, and re-sends the sponsor request email.
|
|
3317
|
+
*
|
|
3318
|
+
* @tags Sponsorship
|
|
3319
|
+
* @name CreateSponsorshipReset
|
|
3320
|
+
* @summary ResetSponsorshipRequest
|
|
3321
|
+
* @request POST:/user/{userID}/sponsorship/reset
|
|
3322
|
+
* @secure
|
|
3323
|
+
*/
|
|
3324
|
+
createSponsorshipReset: (userId: string, data: ResetSponsorshipBody, params?: RequestParams) => Promise<any>;
|
|
3291
3325
|
};
|
|
3292
3326
|
users: {
|
|
3293
3327
|
/**
|
|
@@ -3299,7 +3333,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3299
3333
|
* @request POST:/users/certification/{certSpecID}
|
|
3300
3334
|
* @secure
|
|
3301
3335
|
*/
|
|
3302
|
-
createCertification: (certSpecId: string, data:
|
|
3336
|
+
createCertification: (certSpecId: string, data: Input18207Fqjkf, params?: RequestParams) => Promise<Output18207Fqjkf>;
|
|
3303
3337
|
/**
|
|
3304
3338
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3305
3339
|
*
|