@ikonintegration/bccsa-program-api 3.0.35 → 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 +124 -93
- package/dist/Api.d.ts +116 -102
- package/dist/Api.js +25 -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 InputZkkizspn1Ug {
|
|
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 InputN2Pbfp1G69 {
|
|
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 InputJ598Pbmrge {
|
|
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 InputZpvr6A88Xc {
|
|
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 InputC1Ye5Hwls5J {
|
|
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 InputSaxqz8G15X {
|
|
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 InputQdeponwb9F {
|
|
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 InputC0Apqdl809I {
|
|
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 InputJh6321Ew32 {
|
|
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 InputIi4P7M7Hs9 {
|
|
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 InputCfab2Oqckr {
|
|
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 InputFyv0Tovwba {
|
|
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 OutputYz6Rjygfu2 {
|
|
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 OutputB9Rbrha4Sb {
|
|
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 OutputZ0668Cjphf {
|
|
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 OutputJ1Oqgachio {
|
|
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 OutputXtyq604Vdy {
|
|
1302
1304
|
items: {
|
|
1303
1305
|
userID: string;
|
|
1304
1306
|
createdOn?: number;
|
|
@@ -1486,7 +1488,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1486
1488
|
applicationItems?: Record<string, any>[];
|
|
1487
1489
|
transactionID?: string | null;
|
|
1488
1490
|
}
|
|
1489
|
-
export interface
|
|
1491
|
+
export interface InputLok8Yjdg8Lf {
|
|
1490
1492
|
issuedOn?: number;
|
|
1491
1493
|
expiresOn?: number;
|
|
1492
1494
|
fileItems?: {
|
|
@@ -1495,21 +1497,21 @@ export interface InputUdco8Yiz4U {
|
|
|
1495
1497
|
}[];
|
|
1496
1498
|
additionalNotes?: string | null;
|
|
1497
1499
|
}
|
|
1498
|
-
export interface
|
|
1500
|
+
export interface Input8Jtmo5Z719K {
|
|
1499
1501
|
/**
|
|
1500
1502
|
* Indicates whether the application is locked
|
|
1501
1503
|
* @example true
|
|
1502
1504
|
*/
|
|
1503
1505
|
isApplicationLocked: boolean;
|
|
1504
1506
|
}
|
|
1505
|
-
export interface
|
|
1507
|
+
export interface OutputEu94Ew8Yhf {
|
|
1506
1508
|
/**
|
|
1507
1509
|
* Signed URL for the course file
|
|
1508
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"
|
|
1509
1511
|
*/
|
|
1510
1512
|
fileURL: string;
|
|
1511
1513
|
}
|
|
1512
|
-
export interface
|
|
1514
|
+
export interface InputV9Pu8Hsooe {
|
|
1513
1515
|
/**
|
|
1514
1516
|
* Indicates whether the waiver is approved
|
|
1515
1517
|
* @example true
|
|
@@ -1521,14 +1523,14 @@ export interface InputKa30H4Ner6 {
|
|
|
1521
1523
|
*/
|
|
1522
1524
|
additionalNotes?: string | null;
|
|
1523
1525
|
}
|
|
1524
|
-
export interface
|
|
1526
|
+
export interface Input8P34Cst6Sz {
|
|
1525
1527
|
/**
|
|
1526
1528
|
* Optional notes regarding the waiver
|
|
1527
1529
|
* @example "Waiver granted due to special circumstances."
|
|
1528
1530
|
*/
|
|
1529
1531
|
additionalNotes?: string | null;
|
|
1530
1532
|
}
|
|
1531
|
-
export interface
|
|
1533
|
+
export interface InputZv1Ikpfitw {
|
|
1532
1534
|
students: {
|
|
1533
1535
|
/**
|
|
1534
1536
|
* User ID of the student to redeem the course for
|
|
@@ -1562,7 +1564,7 @@ export interface InputY2D9S4Qy4S {
|
|
|
1562
1564
|
*/
|
|
1563
1565
|
autoEnrolSessionID?: string;
|
|
1564
1566
|
}
|
|
1565
|
-
export interface
|
|
1567
|
+
export interface InputNf5K52Xa14 {
|
|
1566
1568
|
invites: {
|
|
1567
1569
|
/**
|
|
1568
1570
|
* Email address of the user to invite
|
|
@@ -1591,7 +1593,7 @@ export interface Input62Nyiggonmh {
|
|
|
1591
1593
|
*/
|
|
1592
1594
|
isReservedSeat: boolean;
|
|
1593
1595
|
}
|
|
1594
|
-
export interface
|
|
1596
|
+
export interface Input1B88Huavnlf {
|
|
1595
1597
|
/**
|
|
1596
1598
|
* Indicates whether to waive the certification process
|
|
1597
1599
|
* @example true
|
|
@@ -1604,7 +1606,7 @@ export interface InputXqdgr5Oa5Vh {
|
|
|
1604
1606
|
comments?: string | null;
|
|
1605
1607
|
}
|
|
1606
1608
|
/** Certification move response schema */
|
|
1607
|
-
export interface
|
|
1609
|
+
export interface OutputK40A9P4Wntj {
|
|
1608
1610
|
errors?: {
|
|
1609
1611
|
status: string;
|
|
1610
1612
|
object?: Record<string, any>;
|
|
@@ -1612,19 +1614,19 @@ export interface Output6D4Ct52Qpe {
|
|
|
1612
1614
|
}[];
|
|
1613
1615
|
}
|
|
1614
1616
|
/** Schema for writing a certification trigger check. */
|
|
1615
|
-
export interface
|
|
1617
|
+
export interface Input72Yx0Bqloy {
|
|
1616
1618
|
/**
|
|
1617
1619
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1618
1620
|
* @example "CHECKED"
|
|
1619
1621
|
*/
|
|
1620
|
-
value:
|
|
1622
|
+
value: Input72Yx0BqloyValueEnum;
|
|
1621
1623
|
/**
|
|
1622
1624
|
* List of course IDs that are blocked by this trigger check.
|
|
1623
1625
|
* @example ["course1","course2"]
|
|
1624
1626
|
*/
|
|
1625
1627
|
blockedCourses?: string[];
|
|
1626
1628
|
}
|
|
1627
|
-
export interface
|
|
1629
|
+
export interface InputTyyk1Gva3F {
|
|
1628
1630
|
/**
|
|
1629
1631
|
* Indicates whether the application item is approved
|
|
1630
1632
|
* @example true
|
|
@@ -1650,7 +1652,7 @@ export interface Input1Lghooas4I {
|
|
|
1650
1652
|
export interface StudentHistoryRequestSchema {
|
|
1651
1653
|
requirements: string[];
|
|
1652
1654
|
}
|
|
1653
|
-
export interface
|
|
1655
|
+
export interface Input1Ud4Zfxio7 {
|
|
1654
1656
|
/**
|
|
1655
1657
|
* Optional activation key for the application
|
|
1656
1658
|
* @example "AK-123456"
|
|
@@ -1658,7 +1660,7 @@ export interface InputCgletgibfvi {
|
|
|
1658
1660
|
activationKey?: string;
|
|
1659
1661
|
}
|
|
1660
1662
|
/** Schema for course submission item details post request. */
|
|
1661
|
-
export interface
|
|
1663
|
+
export interface Input9Ar42O9Flp {
|
|
1662
1664
|
/**
|
|
1663
1665
|
* The ID of the file being submitted.
|
|
1664
1666
|
* @example "fileID123"
|
|
@@ -1671,7 +1673,7 @@ export interface InputOszbc2Lfht {
|
|
|
1671
1673
|
fileName: string;
|
|
1672
1674
|
}
|
|
1673
1675
|
/** Schema for the response to course submission item details post request. */
|
|
1674
|
-
export interface
|
|
1676
|
+
export interface Output9Ar42O9Flp {
|
|
1675
1677
|
submissionItems: {
|
|
1676
1678
|
/**
|
|
1677
1679
|
* The ID of the file being submitted.
|
|
@@ -1686,7 +1688,7 @@ export interface OutputOszbc2Lfht {
|
|
|
1686
1688
|
}[];
|
|
1687
1689
|
}
|
|
1688
1690
|
/** Pending approval submission parameters */
|
|
1689
|
-
export interface
|
|
1691
|
+
export interface Input83Eunpl3Y9 {
|
|
1690
1692
|
/**
|
|
1691
1693
|
* Type of pending approval
|
|
1692
1694
|
* @example "certification"
|
|
@@ -1706,7 +1708,7 @@ export interface InputDv9Ni3Aar5 {
|
|
|
1706
1708
|
fileName: string;
|
|
1707
1709
|
}[];
|
|
1708
1710
|
}
|
|
1709
|
-
export interface
|
|
1711
|
+
export interface InputBvmzq8Voop {
|
|
1710
1712
|
/**
|
|
1711
1713
|
* The ID of the course for which the license is being redeemed
|
|
1712
1714
|
* @example "courseID123"
|
|
@@ -1774,7 +1776,7 @@ export interface InputGhxoi4I6V8 {
|
|
|
1774
1776
|
acknowledgement?: string | null;
|
|
1775
1777
|
}
|
|
1776
1778
|
/** Validate certification move response schema */
|
|
1777
|
-
export interface
|
|
1779
|
+
export interface OutputGbnglvar32H {
|
|
1778
1780
|
courses: {
|
|
1779
1781
|
name: string;
|
|
1780
1782
|
status: string;
|
|
@@ -1785,21 +1787,21 @@ export interface OutputMlk3Y0Sufr {
|
|
|
1785
1787
|
validated: boolean;
|
|
1786
1788
|
mustCreateCP: boolean;
|
|
1787
1789
|
}
|
|
1788
|
-
export interface
|
|
1790
|
+
export interface InputMjpfe7392W {
|
|
1789
1791
|
/**
|
|
1790
1792
|
* Comments regarding the end of the cooldown period
|
|
1791
1793
|
* @example "Cooldown period ended successfully."
|
|
1792
1794
|
*/
|
|
1793
1795
|
comments: string;
|
|
1794
1796
|
}
|
|
1795
|
-
export interface
|
|
1797
|
+
export interface Output4Bdvouau4O {
|
|
1796
1798
|
/**
|
|
1797
1799
|
* Signed URL for the course file
|
|
1798
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"
|
|
1799
1801
|
*/
|
|
1800
1802
|
fileURL: string;
|
|
1801
1803
|
}
|
|
1802
|
-
export interface
|
|
1804
|
+
export interface InputV5Njfikakn {
|
|
1803
1805
|
/** @example true */
|
|
1804
1806
|
agreedWithCertTerms: boolean;
|
|
1805
1807
|
/** @example 1717230000000 */
|
|
@@ -1884,21 +1886,21 @@ export interface Sponsor {
|
|
|
1884
1886
|
/** Title of the sponsor of the student in the tenant */
|
|
1885
1887
|
title?: Title;
|
|
1886
1888
|
}
|
|
1887
|
-
export interface
|
|
1889
|
+
export interface InputZ0H2Pu9Q1B {
|
|
1888
1890
|
/**
|
|
1889
1891
|
* Comments regarding the course unlock action
|
|
1890
1892
|
* @example "Course unlocked successfully."
|
|
1891
1893
|
*/
|
|
1892
1894
|
comments: string;
|
|
1893
1895
|
}
|
|
1894
|
-
export interface
|
|
1896
|
+
export interface InputVv8Lphiol4 {
|
|
1895
1897
|
/**
|
|
1896
1898
|
* ITA number to update for the user
|
|
1897
1899
|
* @example "ITA123456"
|
|
1898
1900
|
*/
|
|
1899
1901
|
itaNumber: string;
|
|
1900
1902
|
}
|
|
1901
|
-
export interface
|
|
1903
|
+
export interface InputXumdodu3Vg {
|
|
1902
1904
|
/** @example true */
|
|
1903
1905
|
agreedWithCertTerms: boolean;
|
|
1904
1906
|
/** @example 1717230000000 */
|
|
@@ -1972,7 +1974,7 @@ export interface Input3Q79Al8T06 {
|
|
|
1972
1974
|
/** Sponsor information for a student in the tenant */
|
|
1973
1975
|
sponsor?: Sponsor;
|
|
1974
1976
|
}
|
|
1975
|
-
export interface
|
|
1977
|
+
export interface InputPpbi3Eojs7 {
|
|
1976
1978
|
/**
|
|
1977
1979
|
* The grade to override the course result with
|
|
1978
1980
|
* @example "A"
|
|
@@ -1980,7 +1982,7 @@ export interface InputW1Qz7Aegx2 {
|
|
|
1980
1982
|
resultGrade: string;
|
|
1981
1983
|
}
|
|
1982
1984
|
/** Pending approval review parameters */
|
|
1983
|
-
export interface
|
|
1985
|
+
export interface Input9Vbbkncaff {
|
|
1984
1986
|
/**
|
|
1985
1987
|
* Notes provided by the reviewer for the pending approval
|
|
1986
1988
|
* @example "Please review the submitted documents."
|
|
@@ -1993,7 +1995,7 @@ export interface InputAihldyxydl {
|
|
|
1993
1995
|
approved: boolean;
|
|
1994
1996
|
}
|
|
1995
1997
|
/** Schema for overriding course result dates. */
|
|
1996
|
-
export interface
|
|
1998
|
+
export interface Input1Gg425Q9K7 {
|
|
1997
1999
|
/**
|
|
1998
2000
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1999
2001
|
* @example 1735689600000
|
|
@@ -2007,14 +2009,14 @@ export interface InputL5Uvh80Jwdh {
|
|
|
2007
2009
|
}
|
|
2008
2010
|
/** Reset sponsorship request takes no body */
|
|
2009
2011
|
export type ResetSponsorshipBody = object;
|
|
2010
|
-
export interface
|
|
2012
|
+
export interface Input18207Fqjkf {
|
|
2011
2013
|
filter: {
|
|
2012
2014
|
from?: number;
|
|
2013
2015
|
sortOrder?: string;
|
|
2014
2016
|
sortField?: string;
|
|
2015
2017
|
};
|
|
2016
2018
|
}
|
|
2017
|
-
export interface
|
|
2019
|
+
export interface Output18207Fqjkf {
|
|
2018
2020
|
users: {
|
|
2019
2021
|
firstName: string;
|
|
2020
2022
|
lastName: string;
|
|
@@ -2038,7 +2040,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
2038
2040
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
2039
2041
|
* @example "CHECKED"
|
|
2040
2042
|
*/
|
|
2041
|
-
export declare enum
|
|
2043
|
+
export declare enum Input72Yx0BqloyValueEnum {
|
|
2042
2044
|
CHECKED = "CHECKED",
|
|
2043
2045
|
UNCHECKED = "UNCHECKED",
|
|
2044
2046
|
NOVALUE = "NOVALUE"
|
|
@@ -2137,7 +2139,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2137
2139
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2138
2140
|
export type CreateReportUsersSimpleData = any;
|
|
2139
2141
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2140
|
-
export type CreateSearchUsersCountData =
|
|
2142
|
+
export type CreateSearchUsersCountData = OutputYz6Rjygfu2;
|
|
2141
2143
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2142
2144
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2143
2145
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2161,7 +2163,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2161
2163
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2162
2164
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2163
2165
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2164
|
-
export type GetCertificationCourseFileSignData =
|
|
2166
|
+
export type GetCertificationCourseFileSignData = OutputJ1Oqgachio;
|
|
2165
2167
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2166
2168
|
export interface CreateCertificationCourseFileSignParams {
|
|
2167
2169
|
/** @example "pdf" */
|
|
@@ -2175,12 +2177,14 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2175
2177
|
/** @example "fileID" */
|
|
2176
2178
|
fileId: string;
|
|
2177
2179
|
}
|
|
2178
|
-
export type CreateCertificationCourseFileSignData =
|
|
2180
|
+
export type CreateCertificationCourseFileSignData = Output4Bdvouau4O;
|
|
2179
2181
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2180
2182
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2181
2183
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2182
|
-
export type CreateCertificationCourseDocumentData =
|
|
2184
|
+
export type CreateCertificationCourseDocumentData = Output9Ar42O9Flp;
|
|
2183
2185
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2186
|
+
export type DeleteSponsorshipPendingApprovalData = any;
|
|
2187
|
+
export type DeleteSponsorshipPendingApprovalError = ErrorResponse;
|
|
2184
2188
|
export type DeleteUserData = any;
|
|
2185
2189
|
export type DeleteUserError = ErrorResponse;
|
|
2186
2190
|
export type GetUserResult = UserResponseEntity;
|
|
@@ -2191,7 +2195,7 @@ export type UpdateUserData = any;
|
|
|
2191
2195
|
export type UpdateUserError = ErrorResponse;
|
|
2192
2196
|
export type DeleteCertificationCourseData = any;
|
|
2193
2197
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2194
|
-
export type GetCertificationApplicationItemFileData =
|
|
2198
|
+
export type GetCertificationApplicationItemFileData = OutputB9Rbrha4Sb;
|
|
2195
2199
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2196
2200
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2197
2201
|
/** @example "pdf" */
|
|
@@ -2205,9 +2209,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2205
2209
|
/** @example "fileVersion" */
|
|
2206
2210
|
fileVersion: string;
|
|
2207
2211
|
}
|
|
2208
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2212
|
+
export type CreateCertificationApplicationItemFileData = OutputEu94Ew8Yhf;
|
|
2209
2213
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2210
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2214
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputZ0668Cjphf;
|
|
2211
2215
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2212
2216
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2213
2217
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2215,7 +2219,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2215
2219
|
export type GetCourseError = ErrorResponse;
|
|
2216
2220
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2217
2221
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2218
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2222
|
+
export type GetCertificationApplicationForeignFillData = OutputXtyq604Vdy;
|
|
2219
2223
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2220
2224
|
export type GetCertificationPrintData = any;
|
|
2221
2225
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2249,7 +2253,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2249
2253
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2250
2254
|
export type CreateCertificationWaiveData = any;
|
|
2251
2255
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2252
|
-
export type CreateCertificationMoveData =
|
|
2256
|
+
export type CreateCertificationMoveData = OutputK40A9P4Wntj;
|
|
2253
2257
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2254
2258
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2255
2259
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2281,7 +2285,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2281
2285
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2282
2286
|
export type CreateCertificationCourseRedeemData = any;
|
|
2283
2287
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2284
|
-
export type CreateCertificationMoveValidateData =
|
|
2288
|
+
export type CreateCertificationMoveValidateData = OutputGbnglvar32H;
|
|
2285
2289
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2286
2290
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2287
2291
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2299,7 +2303,7 @@ export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
|
2299
2303
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2300
2304
|
export type CreateSponsorshipResetData = any;
|
|
2301
2305
|
export type CreateSponsorshipResetError = ErrorResponse;
|
|
2302
|
-
export type CreateCertificationResult =
|
|
2306
|
+
export type CreateCertificationResult = Output18207Fqjkf;
|
|
2303
2307
|
export type CreateCertificationFail = ErrorResponse;
|
|
2304
2308
|
export type CreateCertificationPublishInfoResult = any;
|
|
2305
2309
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2346,7 +2350,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2346
2350
|
}
|
|
2347
2351
|
/**
|
|
2348
2352
|
* @title BCCSA Program API
|
|
2349
|
-
* @version 3.0.
|
|
2353
|
+
* @version 3.0.37
|
|
2350
2354
|
* @baseUrl http://localhost:8080
|
|
2351
2355
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2352
2356
|
*/
|
|
@@ -2361,7 +2365,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2361
2365
|
* @request POST:/contactUs
|
|
2362
2366
|
* @secure
|
|
2363
2367
|
*/
|
|
2364
|
-
listContactUs: (data:
|
|
2368
|
+
listContactUs: (data: InputZkkizspn1Ug, params?: RequestParams) => Promise<any>;
|
|
2365
2369
|
};
|
|
2366
2370
|
customer: {
|
|
2367
2371
|
/**
|
|
@@ -2465,7 +2469,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2465
2469
|
* @request POST:/tenant/report/applicationExport
|
|
2466
2470
|
* @secure
|
|
2467
2471
|
*/
|
|
2468
|
-
createReportApplicationExport: (data:
|
|
2472
|
+
createReportApplicationExport: (data: InputN2Pbfp1G69, params?: RequestParams) => Promise<any>;
|
|
2469
2473
|
/**
|
|
2470
2474
|
* @description Export a report of applications based on the provided filters.
|
|
2471
2475
|
*
|
|
@@ -2475,7 +2479,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2475
2479
|
* @request POST:/tenant/report/applicationStatus
|
|
2476
2480
|
* @secure
|
|
2477
2481
|
*/
|
|
2478
|
-
listReportApplicationStatus: (data:
|
|
2482
|
+
listReportApplicationStatus: (data: InputJ598Pbmrge, params?: RequestParams) => Promise<any>;
|
|
2479
2483
|
/**
|
|
2480
2484
|
* @description Export a report of applications based on the provided filters.
|
|
2481
2485
|
*
|
|
@@ -2485,7 +2489,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2485
2489
|
* @request POST:/tenant/report/applicationsReport
|
|
2486
2490
|
* @secure
|
|
2487
2491
|
*/
|
|
2488
|
-
createReportApplicationsReport: (data:
|
|
2492
|
+
createReportApplicationsReport: (data: InputZpvr6A88Xc, params?: RequestParams) => Promise<any>;
|
|
2489
2493
|
/**
|
|
2490
2494
|
* @description This route allows you to post certificates email for the tenant.
|
|
2491
2495
|
*
|
|
@@ -2495,7 +2499,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2495
2499
|
* @request POST:/tenant/certificates/email
|
|
2496
2500
|
* @secure
|
|
2497
2501
|
*/
|
|
2498
|
-
createCertificatesEmail: (data:
|
|
2502
|
+
createCertificatesEmail: (data: InputC1Ye5Hwls5J, params?: RequestParams) => Promise<any>;
|
|
2499
2503
|
/**
|
|
2500
2504
|
* @description Generate a preview of the completed certifications report.
|
|
2501
2505
|
*
|
|
@@ -2525,7 +2529,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2525
2529
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2526
2530
|
* @secure
|
|
2527
2531
|
*/
|
|
2528
|
-
createLicenseRedeem: (userId: string, data:
|
|
2532
|
+
createLicenseRedeem: (userId: string, data: InputSaxqz8G15X, params?: RequestParams) => Promise<any>;
|
|
2529
2533
|
/**
|
|
2530
2534
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2531
2535
|
*
|
|
@@ -2535,7 +2539,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2535
2539
|
* @request POST:/tenant/report/orglicenses/
|
|
2536
2540
|
* @secure
|
|
2537
2541
|
*/
|
|
2538
|
-
listReportOrglicenses: (data:
|
|
2542
|
+
listReportOrglicenses: (data: InputQdeponwb9F, params?: RequestParams) => Promise<any>;
|
|
2539
2543
|
/**
|
|
2540
2544
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2541
2545
|
*
|
|
@@ -2545,7 +2549,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2545
2549
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2546
2550
|
* @secure
|
|
2547
2551
|
*/
|
|
2548
|
-
createReportOrglicensesPreview: (data:
|
|
2552
|
+
createReportOrglicensesPreview: (data: InputC0Apqdl809I, params?: RequestParams) => Promise<any>;
|
|
2549
2553
|
/**
|
|
2550
2554
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2551
2555
|
*
|
|
@@ -2585,7 +2589,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2585
2589
|
* @request POST:/tenant/report/users/advanced
|
|
2586
2590
|
* @secure
|
|
2587
2591
|
*/
|
|
2588
|
-
createReportUsersAdvanced: (data:
|
|
2592
|
+
createReportUsersAdvanced: (data: InputJh6321Ew32, params?: RequestParams) => Promise<any>;
|
|
2589
2593
|
/**
|
|
2590
2594
|
* @description Searches for users in the tenant by their IDs.
|
|
2591
2595
|
*
|
|
@@ -2595,7 +2599,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2595
2599
|
* @request POST:/tenant/search/users/ids
|
|
2596
2600
|
* @secure
|
|
2597
2601
|
*/
|
|
2598
|
-
listSearchUsersIds: (data:
|
|
2602
|
+
listSearchUsersIds: (data: InputIi4P7M7Hs9, params?: RequestParams) => Promise<any>;
|
|
2599
2603
|
/**
|
|
2600
2604
|
* @description Searches for users in the tenant by term and filters.
|
|
2601
2605
|
*
|
|
@@ -2605,7 +2609,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2605
2609
|
* @request POST:/tenant/search/users/term
|
|
2606
2610
|
* @secure
|
|
2607
2611
|
*/
|
|
2608
|
-
createSearchUsersTerm: (data:
|
|
2612
|
+
createSearchUsersTerm: (data: InputCfab2Oqckr, params?: RequestParams) => Promise<any>;
|
|
2609
2613
|
/**
|
|
2610
2614
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2611
2615
|
*
|
|
@@ -2615,7 +2619,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2615
2619
|
* @request POST:/tenant/report/users/simple
|
|
2616
2620
|
* @secure
|
|
2617
2621
|
*/
|
|
2618
|
-
createReportUsersSimple: (data:
|
|
2622
|
+
createReportUsersSimple: (data: InputFyv0Tovwba, params?: RequestParams) => Promise<any>;
|
|
2619
2623
|
/**
|
|
2620
2624
|
* @description Retrieve user by ID.
|
|
2621
2625
|
*
|
|
@@ -2625,7 +2629,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2625
2629
|
* @request POST:/tenant/search/users/count
|
|
2626
2630
|
* @secure
|
|
2627
2631
|
*/
|
|
2628
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2632
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputYz6Rjygfu2>;
|
|
2629
2633
|
};
|
|
2630
2634
|
user: {
|
|
2631
2635
|
/**
|
|
@@ -2657,7 +2661,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2657
2661
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2658
2662
|
* @secure
|
|
2659
2663
|
*/
|
|
2660
|
-
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>;
|
|
2661
2665
|
/**
|
|
2662
2666
|
* @description Delete a certification process application by type.
|
|
2663
2667
|
*
|
|
@@ -2747,7 +2751,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2747
2751
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2748
2752
|
* @secure
|
|
2749
2753
|
*/
|
|
2750
|
-
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>;
|
|
2751
2755
|
/**
|
|
2752
2756
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2753
2757
|
*
|
|
@@ -2757,7 +2761,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2757
2761
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2758
2762
|
* @secure
|
|
2759
2763
|
*/
|
|
2760
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2764
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<Output4Bdvouau4O>;
|
|
2761
2765
|
/**
|
|
2762
2766
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2763
2767
|
*
|
|
@@ -2777,7 +2781,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2777
2781
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2778
2782
|
* @secure
|
|
2779
2783
|
*/
|
|
2780
|
-
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>;
|
|
2781
2795
|
/**
|
|
2782
2796
|
* @description Delete user by ID.
|
|
2783
2797
|
*
|
|
@@ -2807,7 +2821,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2807
2821
|
* @request POST:/user/{userID}
|
|
2808
2822
|
* @secure
|
|
2809
2823
|
*/
|
|
2810
|
-
createUser: (userId: string, data:
|
|
2824
|
+
createUser: (userId: string, data: InputV5Njfikakn, params?: RequestParams) => Promise<any>;
|
|
2811
2825
|
/**
|
|
2812
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.
|
|
2813
2827
|
*
|
|
@@ -2817,7 +2831,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2817
2831
|
* @request PUT:/user/{userID}
|
|
2818
2832
|
* @secure
|
|
2819
2833
|
*/
|
|
2820
|
-
updateUser: (userId: string, data:
|
|
2834
|
+
updateUser: (userId: string, data: InputXumdodu3Vg, params?: RequestParams) => Promise<any>;
|
|
2821
2835
|
/**
|
|
2822
2836
|
* @description Delete course from user
|
|
2823
2837
|
*
|
|
@@ -2837,7 +2851,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2837
2851
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2838
2852
|
* @secure
|
|
2839
2853
|
*/
|
|
2840
|
-
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>;
|
|
2841
2855
|
/**
|
|
2842
2856
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2843
2857
|
*
|
|
@@ -2847,7 +2861,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2847
2861
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2848
2862
|
* @secure
|
|
2849
2863
|
*/
|
|
2850
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2864
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputEu94Ew8Yhf>;
|
|
2851
2865
|
/**
|
|
2852
2866
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2853
2867
|
*
|
|
@@ -2857,7 +2871,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2857
2871
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2858
2872
|
* @secure
|
|
2859
2873
|
*/
|
|
2860
|
-
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>;
|
|
2861
2875
|
/**
|
|
2862
2876
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2863
2877
|
*
|
|
@@ -2897,7 +2911,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2897
2911
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2898
2912
|
* @secure
|
|
2899
2913
|
*/
|
|
2900
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2914
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputXtyq604Vdy>;
|
|
2901
2915
|
/**
|
|
2902
2916
|
* @description This endpoint will print certificate
|
|
2903
2917
|
*
|
|
@@ -2957,7 +2971,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2957
2971
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2958
2972
|
* @secure
|
|
2959
2973
|
*/
|
|
2960
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2974
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: Input8Jtmo5Z719K, params?: RequestParams) => Promise<any>;
|
|
2961
2975
|
/**
|
|
2962
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.
|
|
2963
2977
|
*
|
|
@@ -2987,7 +3001,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2987
3001
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2988
3002
|
* @secure
|
|
2989
3003
|
*/
|
|
2990
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3004
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputV9Pu8Hsooe, params?: RequestParams) => Promise<any>;
|
|
2991
3005
|
/**
|
|
2992
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.
|
|
2993
3007
|
*
|
|
@@ -2997,7 +3011,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2997
3011
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2998
3012
|
* @secure
|
|
2999
3013
|
*/
|
|
3000
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3014
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: Input8P34Cst6Sz, params?: RequestParams) => Promise<any>;
|
|
3001
3015
|
/**
|
|
3002
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.
|
|
3003
3017
|
*
|
|
@@ -3007,7 +3021,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3007
3021
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
3008
3022
|
* @secure
|
|
3009
3023
|
*/
|
|
3010
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
3024
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputZv1Ikpfitw, params?: RequestParams) => Promise<any>;
|
|
3011
3025
|
/**
|
|
3012
3026
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
3013
3027
|
*
|
|
@@ -3017,7 +3031,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3017
3031
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
3018
3032
|
* @secure
|
|
3019
3033
|
*/
|
|
3020
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
3034
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputNf5K52Xa14, params?: RequestParams) => Promise<any>;
|
|
3021
3035
|
/**
|
|
3022
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.
|
|
3023
3037
|
*
|
|
@@ -3057,7 +3071,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3057
3071
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
3058
3072
|
* @secure
|
|
3059
3073
|
*/
|
|
3060
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
3074
|
+
createCertificationWaive: (userId: string, certProcId: string, data: Input1B88Huavnlf, params?: RequestParams) => Promise<any>;
|
|
3061
3075
|
/**
|
|
3062
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.
|
|
3063
3077
|
*
|
|
@@ -3067,7 +3081,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3067
3081
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
3068
3082
|
* @secure
|
|
3069
3083
|
*/
|
|
3070
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3084
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputK40A9P4Wntj>;
|
|
3071
3085
|
/**
|
|
3072
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.
|
|
3073
3087
|
*
|
|
@@ -3107,7 +3121,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3107
3121
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
3108
3122
|
* @secure
|
|
3109
3123
|
*/
|
|
3110
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
3124
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: Input72Yx0Bqloy, params?: RequestParams) => Promise<any>;
|
|
3111
3125
|
/**
|
|
3112
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.
|
|
3113
3127
|
*
|
|
@@ -3167,7 +3181,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3167
3181
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3168
3182
|
* @secure
|
|
3169
3183
|
*/
|
|
3170
|
-
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>;
|
|
3171
3185
|
/**
|
|
3172
3186
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3173
3187
|
*
|
|
@@ -3187,7 +3201,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3187
3201
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3188
3202
|
* @secure
|
|
3189
3203
|
*/
|
|
3190
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3204
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: Input1Ud4Zfxio7, params?: RequestParams) => Promise<any>;
|
|
3191
3205
|
/**
|
|
3192
3206
|
* @description This route allows you to submit a pending approval.
|
|
3193
3207
|
*
|
|
@@ -3197,7 +3211,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3197
3211
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3198
3212
|
* @secure
|
|
3199
3213
|
*/
|
|
3200
|
-
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>;
|
|
3201
3215
|
/**
|
|
3202
3216
|
* @description This route allows you to review a pending approval.
|
|
3203
3217
|
*
|
|
@@ -3207,7 +3221,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3207
3221
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3208
3222
|
* @secure
|
|
3209
3223
|
*/
|
|
3210
|
-
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>;
|
|
3211
3225
|
/**
|
|
3212
3226
|
* @description Redeems a license for a user by product ID.
|
|
3213
3227
|
*
|
|
@@ -3217,7 +3231,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3217
3231
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3218
3232
|
* @secure
|
|
3219
3233
|
*/
|
|
3220
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3234
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputBvmzq8Voop, params?: RequestParams) => Promise<any>;
|
|
3221
3235
|
/**
|
|
3222
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.
|
|
3223
3237
|
*
|
|
@@ -3227,7 +3241,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3227
3241
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3228
3242
|
* @secure
|
|
3229
3243
|
*/
|
|
3230
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3244
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputGbnglvar32H>;
|
|
3231
3245
|
/**
|
|
3232
3246
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3233
3247
|
*
|
|
@@ -3237,7 +3251,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3237
3251
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3238
3252
|
* @secure
|
|
3239
3253
|
*/
|
|
3240
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3254
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputMjpfe7392W, params?: RequestParams) => Promise<any>;
|
|
3241
3255
|
/**
|
|
3242
3256
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3243
3257
|
*
|
|
@@ -3247,7 +3261,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3247
3261
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3248
3262
|
* @secure
|
|
3249
3263
|
*/
|
|
3250
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3264
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputZ0H2Pu9Q1B, params?: RequestParams) => Promise<any>;
|
|
3251
3265
|
/**
|
|
3252
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.
|
|
3253
3267
|
*
|
|
@@ -3257,7 +3271,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3257
3271
|
* @request POST:/user/{userID}/updateITA
|
|
3258
3272
|
* @secure
|
|
3259
3273
|
*/
|
|
3260
|
-
createUpdateIta: (userId: string, data:
|
|
3274
|
+
createUpdateIta: (userId: string, data: InputVv8Lphiol4, params?: RequestParams) => Promise<any>;
|
|
3261
3275
|
/**
|
|
3262
3276
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3263
3277
|
*
|
|
@@ -3267,7 +3281,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3267
3281
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3268
3282
|
* @secure
|
|
3269
3283
|
*/
|
|
3270
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3284
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputPpbi3Eojs7, params?: RequestParams) => Promise<any>;
|
|
3271
3285
|
/**
|
|
3272
3286
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3273
3287
|
*
|
|
@@ -3277,7 +3291,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3277
3291
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3278
3292
|
* @secure
|
|
3279
3293
|
*/
|
|
3280
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3294
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: Input1Gg425Q9K7, params?: RequestParams) => Promise<any>;
|
|
3281
3295
|
/**
|
|
3282
3296
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3283
3297
|
*
|
|
@@ -3319,7 +3333,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3319
3333
|
* @request POST:/users/certification/{certSpecID}
|
|
3320
3334
|
* @secure
|
|
3321
3335
|
*/
|
|
3322
|
-
createCertification: (certSpecId: string, data:
|
|
3336
|
+
createCertification: (certSpecId: string, data: Input18207Fqjkf, params?: RequestParams) => Promise<Output18207Fqjkf>;
|
|
3323
3337
|
/**
|
|
3324
3338
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3325
3339
|
*
|