@ikonintegration/bccsa-program-api 3.0.13 → 3.0.14
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 +140 -93
- package/dist/Api.d.ts +126 -102
- package/dist/Api.js +34 -8
- package/dist/Api.js.map +1 -1
- package/package.json +2 -2
package/dist/Api.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ export interface ErrorResponse {
|
|
|
5
5
|
/** Error code */
|
|
6
6
|
errCode: string;
|
|
7
7
|
}
|
|
8
|
-
export interface
|
|
8
|
+
export interface Input77Ng49K6Ka {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -449,7 +449,7 @@ export interface PendingApprovalResponseSchema {
|
|
|
449
449
|
}[];
|
|
450
450
|
}[] | null;
|
|
451
451
|
}
|
|
452
|
-
export interface
|
|
452
|
+
export interface InputC66Qlphg8W {
|
|
453
453
|
/**
|
|
454
454
|
* ID of the certification to filter applications by
|
|
455
455
|
* @example "certification123"
|
|
@@ -506,7 +506,7 @@ export interface Input61H4Jikn4Qh {
|
|
|
506
506
|
*/
|
|
507
507
|
ignoreCompletedCertifications?: boolean | null;
|
|
508
508
|
}
|
|
509
|
-
export interface
|
|
509
|
+
export interface InputLtawqytdn2K {
|
|
510
510
|
/**
|
|
511
511
|
* ID of the certification to filter applications by
|
|
512
512
|
* @example "certification123"
|
|
@@ -563,7 +563,7 @@ export interface InputP4Xd9Qgbmg {
|
|
|
563
563
|
*/
|
|
564
564
|
ignoreCompletedCertifications?: boolean | null;
|
|
565
565
|
}
|
|
566
|
-
export interface
|
|
566
|
+
export interface InputEzw3I74O88 {
|
|
567
567
|
/**
|
|
568
568
|
* ID of the certification to filter applications by
|
|
569
569
|
* @example "certification123"
|
|
@@ -620,7 +620,7 @@ export interface InputK95Bmesr8Ok {
|
|
|
620
620
|
*/
|
|
621
621
|
ignoreCompletedCertifications?: boolean | null;
|
|
622
622
|
}
|
|
623
|
-
export interface
|
|
623
|
+
export interface InputReechizngg {
|
|
624
624
|
/**
|
|
625
625
|
* The ID of the certificate specifications to be used for the email
|
|
626
626
|
* @example "certSpecsID123"
|
|
@@ -661,7 +661,7 @@ export interface Input5Teaovaiwik {
|
|
|
661
661
|
emailAddress: string;
|
|
662
662
|
}[];
|
|
663
663
|
}
|
|
664
|
-
export interface
|
|
664
|
+
export interface InputXvb1Cckkphj {
|
|
665
665
|
/**
|
|
666
666
|
* The ID of the product for which the license is being redeemed
|
|
667
667
|
* @example "productID123"
|
|
@@ -673,7 +673,7 @@ export interface InputLf289G8Ine {
|
|
|
673
673
|
*/
|
|
674
674
|
sessionID?: string;
|
|
675
675
|
}
|
|
676
|
-
export interface
|
|
676
|
+
export interface Input9Zuhh59Om6 {
|
|
677
677
|
/**
|
|
678
678
|
* Search term to filter licenses
|
|
679
679
|
* @example "active"
|
|
@@ -690,7 +690,7 @@ export interface InputSiact6Jcsb {
|
|
|
690
690
|
*/
|
|
691
691
|
sortField?: any;
|
|
692
692
|
}
|
|
693
|
-
export interface
|
|
693
|
+
export interface InputXwxwjgny2W {
|
|
694
694
|
/**
|
|
695
695
|
* Search term to filter licenses
|
|
696
696
|
* @example "active"
|
|
@@ -745,7 +745,7 @@ export interface ReportXLSXSchema {
|
|
|
745
745
|
xlsxStream: any;
|
|
746
746
|
contentType: ReportXlsxSchemaContentTypeEnum;
|
|
747
747
|
}
|
|
748
|
-
export interface
|
|
748
|
+
export interface InputRme2Lfmssbf {
|
|
749
749
|
/**
|
|
750
750
|
* Start date for the report
|
|
751
751
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -767,11 +767,11 @@ export interface InputVimqusv4Na {
|
|
|
767
767
|
*/
|
|
768
768
|
dateType?: string;
|
|
769
769
|
}
|
|
770
|
-
export interface
|
|
770
|
+
export interface InputAd7Y2Tok8P {
|
|
771
771
|
/** List of user IDs to search for in the tenant. */
|
|
772
772
|
IDs: (string | null)[];
|
|
773
773
|
}
|
|
774
|
-
export interface
|
|
774
|
+
export interface Input3Cb5S44063 {
|
|
775
775
|
/** The term to search for in the user profiles. */
|
|
776
776
|
searchTerm?: string | null;
|
|
777
777
|
/** Filter criteria for the user search. */
|
|
@@ -811,7 +811,7 @@ export interface InputHoja5Qik5V {
|
|
|
811
811
|
};
|
|
812
812
|
};
|
|
813
813
|
}
|
|
814
|
-
export interface
|
|
814
|
+
export interface InputPo9H04Ocjy {
|
|
815
815
|
/** The term to search for in the user profiles. */
|
|
816
816
|
searchTerm?: string | null;
|
|
817
817
|
/** Filter criteria for the user search. */
|
|
@@ -853,19 +853,19 @@ export interface InputLtsisurick {
|
|
|
853
853
|
}
|
|
854
854
|
/** External system ID 2 */
|
|
855
855
|
export type ExternalID2 = number;
|
|
856
|
-
export interface
|
|
856
|
+
export interface OutputDydlownlhy {
|
|
857
857
|
/** External system ID 2 */
|
|
858
858
|
userCount: ExternalID2;
|
|
859
859
|
transactionID?: string | null;
|
|
860
860
|
}
|
|
861
|
-
export interface
|
|
861
|
+
export interface Output1Gr1600Fma {
|
|
862
862
|
/**
|
|
863
863
|
* Signed URL for the course file
|
|
864
864
|
* @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"
|
|
865
865
|
*/
|
|
866
866
|
fileURL: string;
|
|
867
867
|
}
|
|
868
|
-
export interface
|
|
868
|
+
export interface OutputB7Xwh5L8Rcj {
|
|
869
869
|
/**
|
|
870
870
|
* Amount to be refunded for the cancellation
|
|
871
871
|
* @example 0
|
|
@@ -1156,7 +1156,7 @@ export interface CourseResponseEntity {
|
|
|
1156
1156
|
/** Justifications for overridden course restrictions */
|
|
1157
1157
|
overwrittenJustification?: OverwrittenJustification;
|
|
1158
1158
|
}
|
|
1159
|
-
export interface
|
|
1159
|
+
export interface OutputHn6Wkdevdg {
|
|
1160
1160
|
/**
|
|
1161
1161
|
* Signed URL for the course file
|
|
1162
1162
|
* @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"
|
|
@@ -1174,7 +1174,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1174
1174
|
transactionID?: string | null;
|
|
1175
1175
|
}
|
|
1176
1176
|
/** Application Foreign Fill response type */
|
|
1177
|
-
export interface
|
|
1177
|
+
export interface OutputNmhg7Wzfgw {
|
|
1178
1178
|
items: {
|
|
1179
1179
|
userID: string;
|
|
1180
1180
|
createdOn?: number;
|
|
@@ -1397,7 +1397,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1397
1397
|
applicationItems?: Record<string, any>[];
|
|
1398
1398
|
transactionID?: string | null;
|
|
1399
1399
|
}
|
|
1400
|
-
export interface
|
|
1400
|
+
export interface InputG8Kndhfwiy {
|
|
1401
1401
|
issuedOn?: number;
|
|
1402
1402
|
expiresOn?: number;
|
|
1403
1403
|
fileItems?: {
|
|
@@ -1406,21 +1406,21 @@ export interface InputVyxsjnkmgj {
|
|
|
1406
1406
|
}[];
|
|
1407
1407
|
additionalNotes?: string | null;
|
|
1408
1408
|
}
|
|
1409
|
-
export interface
|
|
1409
|
+
export interface InputCmyyy21Un9F {
|
|
1410
1410
|
/**
|
|
1411
1411
|
* Indicates whether the application is locked
|
|
1412
1412
|
* @example true
|
|
1413
1413
|
*/
|
|
1414
1414
|
isApplicationLocked: boolean;
|
|
1415
1415
|
}
|
|
1416
|
-
export interface
|
|
1416
|
+
export interface OutputZp9Wch1Ta {
|
|
1417
1417
|
/**
|
|
1418
1418
|
* Signed URL for the course file
|
|
1419
1419
|
* @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"
|
|
1420
1420
|
*/
|
|
1421
1421
|
fileURL: string;
|
|
1422
1422
|
}
|
|
1423
|
-
export interface
|
|
1423
|
+
export interface InputIh5Tnf0P5L {
|
|
1424
1424
|
/**
|
|
1425
1425
|
* Indicates whether the waiver is approved
|
|
1426
1426
|
* @example true
|
|
@@ -1432,14 +1432,14 @@ export interface InputEh7Bmvu2Aff {
|
|
|
1432
1432
|
*/
|
|
1433
1433
|
additionalNotes?: string | null;
|
|
1434
1434
|
}
|
|
1435
|
-
export interface
|
|
1435
|
+
export interface InputH9H5U07K33 {
|
|
1436
1436
|
/**
|
|
1437
1437
|
* Optional notes regarding the waiver
|
|
1438
1438
|
* @example "Waiver granted due to special circumstances."
|
|
1439
1439
|
*/
|
|
1440
1440
|
additionalNotes?: string | null;
|
|
1441
1441
|
}
|
|
1442
|
-
export interface
|
|
1442
|
+
export interface Input70Owq1Kboh {
|
|
1443
1443
|
students: {
|
|
1444
1444
|
/**
|
|
1445
1445
|
* User ID of the student to redeem the course for
|
|
@@ -1473,7 +1473,7 @@ export interface InputR140Va3Upl {
|
|
|
1473
1473
|
*/
|
|
1474
1474
|
autoEnrolSessionID?: string;
|
|
1475
1475
|
}
|
|
1476
|
-
export interface
|
|
1476
|
+
export interface InputTh8Wdj68Dji {
|
|
1477
1477
|
invites: {
|
|
1478
1478
|
/**
|
|
1479
1479
|
* Email address of the user to invite
|
|
@@ -1502,7 +1502,7 @@ export interface Input89Ze8Yed00J {
|
|
|
1502
1502
|
*/
|
|
1503
1503
|
isReservedSeat: boolean;
|
|
1504
1504
|
}
|
|
1505
|
-
export interface
|
|
1505
|
+
export interface InputBgtk2Vwgatg {
|
|
1506
1506
|
/**
|
|
1507
1507
|
* Indicates whether to waive the certification process
|
|
1508
1508
|
* @example true
|
|
@@ -1515,7 +1515,7 @@ export interface InputZ3Efzrr30A {
|
|
|
1515
1515
|
comments?: string | null;
|
|
1516
1516
|
}
|
|
1517
1517
|
/** Certification move response schema */
|
|
1518
|
-
export interface
|
|
1518
|
+
export interface OutputV8Ym6Dzytn {
|
|
1519
1519
|
errors?: {
|
|
1520
1520
|
status: string;
|
|
1521
1521
|
object?: Record<string, any>;
|
|
@@ -1523,19 +1523,19 @@ export interface OutputRgieoo39G3 {
|
|
|
1523
1523
|
}[];
|
|
1524
1524
|
}
|
|
1525
1525
|
/** Schema for writing a certification trigger check. */
|
|
1526
|
-
export interface
|
|
1526
|
+
export interface Input8Bfow5Z9Srl {
|
|
1527
1527
|
/**
|
|
1528
1528
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1529
1529
|
* @example "CHECKED"
|
|
1530
1530
|
*/
|
|
1531
|
-
value:
|
|
1531
|
+
value: Input8Bfow5Z9SrlValueEnum;
|
|
1532
1532
|
/**
|
|
1533
1533
|
* List of course IDs that are blocked by this trigger check.
|
|
1534
1534
|
* @example ["course1","course2"]
|
|
1535
1535
|
*/
|
|
1536
1536
|
blockedCourses?: string[];
|
|
1537
1537
|
}
|
|
1538
|
-
export interface
|
|
1538
|
+
export interface Input2Mhqs0Fnt2 {
|
|
1539
1539
|
/**
|
|
1540
1540
|
* Indicates whether the application item is approved
|
|
1541
1541
|
* @example true
|
|
@@ -1561,7 +1561,7 @@ export interface Input1Epjkc08Nx {
|
|
|
1561
1561
|
export interface StudentHistoryRequestSchema {
|
|
1562
1562
|
requirements: string[];
|
|
1563
1563
|
}
|
|
1564
|
-
export interface
|
|
1564
|
+
export interface InputWwtwfps7Vg {
|
|
1565
1565
|
/**
|
|
1566
1566
|
* Optional activation key for the application
|
|
1567
1567
|
* @example "AK-123456"
|
|
@@ -1569,7 +1569,7 @@ export interface InputLswc5Uc0S3L {
|
|
|
1569
1569
|
activationKey?: string;
|
|
1570
1570
|
}
|
|
1571
1571
|
/** Schema for course submission item details post request. */
|
|
1572
|
-
export interface
|
|
1572
|
+
export interface Input63Gpw9Ssci {
|
|
1573
1573
|
/**
|
|
1574
1574
|
* The ID of the file being submitted.
|
|
1575
1575
|
* @example "fileID123"
|
|
@@ -1582,7 +1582,7 @@ export interface InputWuv6N9Jkd4 {
|
|
|
1582
1582
|
fileName: string;
|
|
1583
1583
|
}
|
|
1584
1584
|
/** Schema for the response to course submission item details post request. */
|
|
1585
|
-
export interface
|
|
1585
|
+
export interface Output63Gpw9Ssci {
|
|
1586
1586
|
submissionItems: {
|
|
1587
1587
|
/**
|
|
1588
1588
|
* The ID of the file being submitted.
|
|
@@ -1597,7 +1597,7 @@ export interface OutputWuv6N9Jkd4 {
|
|
|
1597
1597
|
}[];
|
|
1598
1598
|
}
|
|
1599
1599
|
/** Pending approval submission parameters */
|
|
1600
|
-
export interface
|
|
1600
|
+
export interface InputJ8Vv2F6Cn5 {
|
|
1601
1601
|
/**
|
|
1602
1602
|
* Type of pending approval
|
|
1603
1603
|
* @example "certification"
|
|
@@ -1617,7 +1617,7 @@ export interface InputW1S9Mtsl0T {
|
|
|
1617
1617
|
fileName: string;
|
|
1618
1618
|
}[];
|
|
1619
1619
|
}
|
|
1620
|
-
export interface
|
|
1620
|
+
export interface InputFj18Imcto0K {
|
|
1621
1621
|
/**
|
|
1622
1622
|
* The ID of the course for which the license is being redeemed
|
|
1623
1623
|
* @example "courseID123"
|
|
@@ -1685,7 +1685,7 @@ export interface InputRaqngevrd4F {
|
|
|
1685
1685
|
acknowledgement?: string | null;
|
|
1686
1686
|
}
|
|
1687
1687
|
/** Validate certification move response schema */
|
|
1688
|
-
export interface
|
|
1688
|
+
export interface OutputHo5V7Vdsab {
|
|
1689
1689
|
courses: {
|
|
1690
1690
|
name: string;
|
|
1691
1691
|
status: string;
|
|
@@ -1696,21 +1696,21 @@ export interface OutputBjb3Rbdqmzh {
|
|
|
1696
1696
|
validated: boolean;
|
|
1697
1697
|
mustCreateCP: boolean;
|
|
1698
1698
|
}
|
|
1699
|
-
export interface
|
|
1699
|
+
export interface InputS9Jvk0Pxf {
|
|
1700
1700
|
/**
|
|
1701
1701
|
* Comments regarding the end of the cooldown period
|
|
1702
1702
|
* @example "Cooldown period ended successfully."
|
|
1703
1703
|
*/
|
|
1704
1704
|
comments: string;
|
|
1705
1705
|
}
|
|
1706
|
-
export interface
|
|
1706
|
+
export interface OutputRob70W4Zozf {
|
|
1707
1707
|
/**
|
|
1708
1708
|
* Signed URL for the course file
|
|
1709
1709
|
* @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"
|
|
1710
1710
|
*/
|
|
1711
1711
|
fileURL: string;
|
|
1712
1712
|
}
|
|
1713
|
-
export interface
|
|
1713
|
+
export interface InputQu8Lbgia45L {
|
|
1714
1714
|
/** @example true */
|
|
1715
1715
|
agreedWithCertTerms: boolean;
|
|
1716
1716
|
/** @example 1717230000000 */
|
|
@@ -1782,21 +1782,21 @@ export interface Input1Rcojrefvx {
|
|
|
1782
1782
|
/** @example "EXT#999" */
|
|
1783
1783
|
externalID2?: string | null;
|
|
1784
1784
|
}
|
|
1785
|
-
export interface
|
|
1785
|
+
export interface InputZ8Jg5Tk9Lb {
|
|
1786
1786
|
/**
|
|
1787
1787
|
* Comments regarding the course unlock action
|
|
1788
1788
|
* @example "Course unlocked successfully."
|
|
1789
1789
|
*/
|
|
1790
1790
|
comments: string;
|
|
1791
1791
|
}
|
|
1792
|
-
export interface
|
|
1792
|
+
export interface InputNhq272A9E1 {
|
|
1793
1793
|
/**
|
|
1794
1794
|
* ITA number to update for the user
|
|
1795
1795
|
* @example "ITA123456"
|
|
1796
1796
|
*/
|
|
1797
1797
|
itaNumber: string;
|
|
1798
1798
|
}
|
|
1799
|
-
export interface
|
|
1799
|
+
export interface InputWi1Nu2Pkap {
|
|
1800
1800
|
/** @example true */
|
|
1801
1801
|
agreedWithCertTerms: boolean;
|
|
1802
1802
|
/** @example 1717230000000 */
|
|
@@ -1868,7 +1868,7 @@ export interface InputHpo5Uu5Gds {
|
|
|
1868
1868
|
/** @example "EXT#999" */
|
|
1869
1869
|
externalID2?: string | null;
|
|
1870
1870
|
}
|
|
1871
|
-
export interface
|
|
1871
|
+
export interface Input92Pwkq6Eon {
|
|
1872
1872
|
/**
|
|
1873
1873
|
* The grade to override the course result with
|
|
1874
1874
|
* @example "A"
|
|
@@ -1876,7 +1876,7 @@ export interface InputMo0Xp1Mtxh {
|
|
|
1876
1876
|
resultGrade: string;
|
|
1877
1877
|
}
|
|
1878
1878
|
/** Pending approval review parameters */
|
|
1879
|
-
export interface
|
|
1879
|
+
export interface InputJ90M1Fgki9L {
|
|
1880
1880
|
/**
|
|
1881
1881
|
* Notes provided by the reviewer for the pending approval
|
|
1882
1882
|
* @example "Please review the submitted documents."
|
|
@@ -1889,7 +1889,7 @@ export interface InputNpmeuseinl {
|
|
|
1889
1889
|
approved: boolean;
|
|
1890
1890
|
}
|
|
1891
1891
|
/** Schema for overriding course result dates. */
|
|
1892
|
-
export interface
|
|
1892
|
+
export interface Input2Thiin78V5 {
|
|
1893
1893
|
/**
|
|
1894
1894
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1895
1895
|
* @example 1735689600000
|
|
@@ -1901,14 +1901,14 @@ export interface Input507U28Mp4Uf {
|
|
|
1901
1901
|
*/
|
|
1902
1902
|
completionDate?: number;
|
|
1903
1903
|
}
|
|
1904
|
-
export interface
|
|
1904
|
+
export interface InputI6G8Xigbgn {
|
|
1905
1905
|
filter: {
|
|
1906
1906
|
from?: number;
|
|
1907
1907
|
sortOrder?: string;
|
|
1908
1908
|
sortField?: string;
|
|
1909
1909
|
};
|
|
1910
1910
|
}
|
|
1911
|
-
export interface
|
|
1911
|
+
export interface OutputI6G8Xigbgn {
|
|
1912
1912
|
users: {
|
|
1913
1913
|
firstName: string;
|
|
1914
1914
|
lastName: string;
|
|
@@ -1928,7 +1928,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
1928
1928
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1929
1929
|
* @example "CHECKED"
|
|
1930
1930
|
*/
|
|
1931
|
-
export declare enum
|
|
1931
|
+
export declare enum Input8Bfow5Z9SrlValueEnum {
|
|
1932
1932
|
CHECKED = "CHECKED",
|
|
1933
1933
|
UNCHECKED = "UNCHECKED",
|
|
1934
1934
|
NOVALUE = "NOVALUE"
|
|
@@ -2021,7 +2021,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2021
2021
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2022
2022
|
export type CreateReportUsersSimpleData = any;
|
|
2023
2023
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2024
|
-
export type CreateSearchUsersCountData =
|
|
2024
|
+
export type CreateSearchUsersCountData = OutputDydlownlhy;
|
|
2025
2025
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2026
2026
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2027
2027
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2039,7 +2039,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2039
2039
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2040
2040
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2041
2041
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2042
|
-
export type GetCertificationCourseFileSignData =
|
|
2042
|
+
export type GetCertificationCourseFileSignData = OutputHn6Wkdevdg;
|
|
2043
2043
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2044
2044
|
export interface CreateCertificationCourseFileSignParams {
|
|
2045
2045
|
/** @example "pdf" */
|
|
@@ -2053,11 +2053,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2053
2053
|
/** @example "fileID" */
|
|
2054
2054
|
fileId: string;
|
|
2055
2055
|
}
|
|
2056
|
-
export type CreateCertificationCourseFileSignData =
|
|
2056
|
+
export type CreateCertificationCourseFileSignData = OutputRob70W4Zozf;
|
|
2057
2057
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2058
2058
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2059
2059
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2060
|
-
export type CreateCertificationCourseDocumentData =
|
|
2060
|
+
export type CreateCertificationCourseDocumentData = Output63Gpw9Ssci;
|
|
2061
2061
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2062
2062
|
export type DeleteUserData = any;
|
|
2063
2063
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2069,7 +2069,7 @@ export type UpdateUserData = any;
|
|
|
2069
2069
|
export type UpdateUserError = ErrorResponse;
|
|
2070
2070
|
export type DeleteCertificationCourseData = any;
|
|
2071
2071
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2072
|
-
export type GetCertificationApplicationItemFileData =
|
|
2072
|
+
export type GetCertificationApplicationItemFileData = Output1Gr1600Fma;
|
|
2073
2073
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2074
2074
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2075
2075
|
/** @example "pdf" */
|
|
@@ -2083,9 +2083,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2083
2083
|
/** @example "fileVersion" */
|
|
2084
2084
|
fileVersion: string;
|
|
2085
2085
|
}
|
|
2086
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2086
|
+
export type CreateCertificationApplicationItemFileData = OutputZp9Wch1Ta;
|
|
2087
2087
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2088
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2088
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputB7Xwh5L8Rcj;
|
|
2089
2089
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2090
2090
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2091
2091
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2093,7 +2093,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2093
2093
|
export type GetCourseError = ErrorResponse;
|
|
2094
2094
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2095
2095
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2096
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2096
|
+
export type GetCertificationApplicationForeignFillData = OutputNmhg7Wzfgw;
|
|
2097
2097
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2098
2098
|
export type GetCertificationPrintData = any;
|
|
2099
2099
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2129,7 +2129,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2129
2129
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2130
2130
|
export type CreateCertificationWaiveData = any;
|
|
2131
2131
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2132
|
-
export type CreateCertificationMoveData =
|
|
2132
|
+
export type CreateCertificationMoveData = OutputV8Ym6Dzytn;
|
|
2133
2133
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2134
2134
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2135
2135
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2157,7 +2157,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2157
2157
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2158
2158
|
export type CreateCertificationCourseRedeemData = any;
|
|
2159
2159
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2160
|
-
export type CreateCertificationMoveValidateData =
|
|
2160
|
+
export type CreateCertificationMoveValidateData = OutputHo5V7Vdsab;
|
|
2161
2161
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2162
2162
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2163
2163
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2169,8 +2169,12 @@ export type UpdateCertificationCourseOverrideResultData = any;
|
|
|
2169
2169
|
export type UpdateCertificationCourseOverrideResultError = ErrorResponse;
|
|
2170
2170
|
export type UpdateCertificationSetDatesData = any;
|
|
2171
2171
|
export type UpdateCertificationSetDatesError = ErrorResponse;
|
|
2172
|
-
export type
|
|
2172
|
+
export type CreateCertificationPublishInfoData = any;
|
|
2173
|
+
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2174
|
+
export type CreateCertificationResult = OutputI6G8Xigbgn;
|
|
2173
2175
|
export type CreateCertificationFail = ErrorResponse;
|
|
2176
|
+
export type CreateCertificationPublishInfoResult = any;
|
|
2177
|
+
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
2174
2178
|
import type { AxiosInstance, AxiosRequestConfig, ResponseType } from 'axios';
|
|
2175
2179
|
export type QueryParamsType = Record<string | number, any>;
|
|
2176
2180
|
export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
|
|
@@ -2214,7 +2218,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2214
2218
|
}
|
|
2215
2219
|
/**
|
|
2216
2220
|
* @title BCCSA Program API
|
|
2217
|
-
* @version 3.0.
|
|
2221
|
+
* @version 3.0.14
|
|
2218
2222
|
* @baseUrl http://localhost:8080
|
|
2219
2223
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2220
2224
|
*/
|
|
@@ -2229,7 +2233,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2229
2233
|
* @request POST:/contactUs
|
|
2230
2234
|
* @secure
|
|
2231
2235
|
*/
|
|
2232
|
-
listContactUs: (data:
|
|
2236
|
+
listContactUs: (data: Input77Ng49K6Ka, params?: RequestParams) => Promise<any>;
|
|
2233
2237
|
};
|
|
2234
2238
|
customer: {
|
|
2235
2239
|
/**
|
|
@@ -2333,7 +2337,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2333
2337
|
* @request POST:/tenant/report/applicationExport
|
|
2334
2338
|
* @secure
|
|
2335
2339
|
*/
|
|
2336
|
-
createReportApplicationExport: (data:
|
|
2340
|
+
createReportApplicationExport: (data: InputC66Qlphg8W, params?: RequestParams) => Promise<any>;
|
|
2337
2341
|
/**
|
|
2338
2342
|
* @description Export a report of applications based on the provided filters.
|
|
2339
2343
|
*
|
|
@@ -2343,7 +2347,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2343
2347
|
* @request POST:/tenant/report/applicationStatus
|
|
2344
2348
|
* @secure
|
|
2345
2349
|
*/
|
|
2346
|
-
listReportApplicationStatus: (data:
|
|
2350
|
+
listReportApplicationStatus: (data: InputLtawqytdn2K, params?: RequestParams) => Promise<any>;
|
|
2347
2351
|
/**
|
|
2348
2352
|
* @description Export a report of applications based on the provided filters.
|
|
2349
2353
|
*
|
|
@@ -2353,7 +2357,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2353
2357
|
* @request POST:/tenant/report/applicationsReport
|
|
2354
2358
|
* @secure
|
|
2355
2359
|
*/
|
|
2356
|
-
createReportApplicationsReport: (data:
|
|
2360
|
+
createReportApplicationsReport: (data: InputEzw3I74O88, params?: RequestParams) => Promise<any>;
|
|
2357
2361
|
/**
|
|
2358
2362
|
* @description This route allows you to post certificates email for the tenant.
|
|
2359
2363
|
*
|
|
@@ -2363,7 +2367,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2363
2367
|
* @request POST:/tenant/certificates/email
|
|
2364
2368
|
* @secure
|
|
2365
2369
|
*/
|
|
2366
|
-
createCertificatesEmail: (data:
|
|
2370
|
+
createCertificatesEmail: (data: InputReechizngg, params?: RequestParams) => Promise<any>;
|
|
2367
2371
|
/**
|
|
2368
2372
|
* @description Generate a preview of the completed certifications report.
|
|
2369
2373
|
*
|
|
@@ -2393,7 +2397,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2393
2397
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2394
2398
|
* @secure
|
|
2395
2399
|
*/
|
|
2396
|
-
createLicenseRedeem: (userId: string, data:
|
|
2400
|
+
createLicenseRedeem: (userId: string, data: InputXvb1Cckkphj, params?: RequestParams) => Promise<any>;
|
|
2397
2401
|
/**
|
|
2398
2402
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2399
2403
|
*
|
|
@@ -2403,7 +2407,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2403
2407
|
* @request POST:/tenant/report/orglicenses/
|
|
2404
2408
|
* @secure
|
|
2405
2409
|
*/
|
|
2406
|
-
listReportOrglicenses: (data:
|
|
2410
|
+
listReportOrglicenses: (data: Input9Zuhh59Om6, params?: RequestParams) => Promise<any>;
|
|
2407
2411
|
/**
|
|
2408
2412
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2409
2413
|
*
|
|
@@ -2413,7 +2417,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2413
2417
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2414
2418
|
* @secure
|
|
2415
2419
|
*/
|
|
2416
|
-
createReportOrglicensesPreview: (data:
|
|
2420
|
+
createReportOrglicensesPreview: (data: InputXwxwjgny2W, params?: RequestParams) => Promise<any>;
|
|
2417
2421
|
/**
|
|
2418
2422
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2419
2423
|
*
|
|
@@ -2443,7 +2447,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2443
2447
|
* @request POST:/tenant/report/users/advanced
|
|
2444
2448
|
* @secure
|
|
2445
2449
|
*/
|
|
2446
|
-
createReportUsersAdvanced: (data:
|
|
2450
|
+
createReportUsersAdvanced: (data: InputRme2Lfmssbf, params?: RequestParams) => Promise<any>;
|
|
2447
2451
|
/**
|
|
2448
2452
|
* @description Searches for users in the tenant by their IDs.
|
|
2449
2453
|
*
|
|
@@ -2453,7 +2457,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2453
2457
|
* @request POST:/tenant/search/users/ids
|
|
2454
2458
|
* @secure
|
|
2455
2459
|
*/
|
|
2456
|
-
listSearchUsersIds: (data:
|
|
2460
|
+
listSearchUsersIds: (data: InputAd7Y2Tok8P, params?: RequestParams) => Promise<any>;
|
|
2457
2461
|
/**
|
|
2458
2462
|
* @description Searches for users in the tenant by term and filters.
|
|
2459
2463
|
*
|
|
@@ -2463,7 +2467,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2463
2467
|
* @request POST:/tenant/search/users/term
|
|
2464
2468
|
* @secure
|
|
2465
2469
|
*/
|
|
2466
|
-
createSearchUsersTerm: (data:
|
|
2470
|
+
createSearchUsersTerm: (data: Input3Cb5S44063, params?: RequestParams) => Promise<any>;
|
|
2467
2471
|
/**
|
|
2468
2472
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2469
2473
|
*
|
|
@@ -2473,7 +2477,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2473
2477
|
* @request POST:/tenant/report/users/simple
|
|
2474
2478
|
* @secure
|
|
2475
2479
|
*/
|
|
2476
|
-
createReportUsersSimple: (data:
|
|
2480
|
+
createReportUsersSimple: (data: InputPo9H04Ocjy, params?: RequestParams) => Promise<any>;
|
|
2477
2481
|
/**
|
|
2478
2482
|
* @description Retrieve user by ID.
|
|
2479
2483
|
*
|
|
@@ -2483,7 +2487,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2483
2487
|
* @request POST:/tenant/search/users/count
|
|
2484
2488
|
* @secure
|
|
2485
2489
|
*/
|
|
2486
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2490
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputDydlownlhy>;
|
|
2487
2491
|
};
|
|
2488
2492
|
user: {
|
|
2489
2493
|
/**
|
|
@@ -2515,7 +2519,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2515
2519
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2516
2520
|
* @secure
|
|
2517
2521
|
*/
|
|
2518
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2522
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: InputG8Kndhfwiy, params?: RequestParams) => Promise<any>;
|
|
2519
2523
|
/**
|
|
2520
2524
|
* @description Delete a certification process application by type.
|
|
2521
2525
|
*
|
|
@@ -2575,7 +2579,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2575
2579
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2576
2580
|
* @secure
|
|
2577
2581
|
*/
|
|
2578
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2582
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputHn6Wkdevdg>;
|
|
2579
2583
|
/**
|
|
2580
2584
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2581
2585
|
*
|
|
@@ -2585,7 +2589,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2585
2589
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2586
2590
|
* @secure
|
|
2587
2591
|
*/
|
|
2588
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2592
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputRob70W4Zozf>;
|
|
2589
2593
|
/**
|
|
2590
2594
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2591
2595
|
*
|
|
@@ -2605,7 +2609,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2605
2609
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2606
2610
|
* @secure
|
|
2607
2611
|
*/
|
|
2608
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2612
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: Input63Gpw9Ssci, params?: RequestParams) => Promise<Output63Gpw9Ssci>;
|
|
2609
2613
|
/**
|
|
2610
2614
|
* @description Delete user by ID.
|
|
2611
2615
|
*
|
|
@@ -2635,7 +2639,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2635
2639
|
* @request POST:/user/{userID}
|
|
2636
2640
|
* @secure
|
|
2637
2641
|
*/
|
|
2638
|
-
createUser: (userId: string, data:
|
|
2642
|
+
createUser: (userId: string, data: InputQu8Lbgia45L, params?: RequestParams) => Promise<any>;
|
|
2639
2643
|
/**
|
|
2640
2644
|
* @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.
|
|
2641
2645
|
*
|
|
@@ -2645,7 +2649,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2645
2649
|
* @request PUT:/user/{userID}
|
|
2646
2650
|
* @secure
|
|
2647
2651
|
*/
|
|
2648
|
-
updateUser: (userId: string, data:
|
|
2652
|
+
updateUser: (userId: string, data: InputWi1Nu2Pkap, params?: RequestParams) => Promise<any>;
|
|
2649
2653
|
/**
|
|
2650
2654
|
* @description Delete course from user
|
|
2651
2655
|
*
|
|
@@ -2665,7 +2669,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2665
2669
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2666
2670
|
* @secure
|
|
2667
2671
|
*/
|
|
2668
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2672
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<Output1Gr1600Fma>;
|
|
2669
2673
|
/**
|
|
2670
2674
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2671
2675
|
*
|
|
@@ -2675,7 +2679,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2675
2679
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2676
2680
|
* @secure
|
|
2677
2681
|
*/
|
|
2678
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2682
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputZp9Wch1Ta>;
|
|
2679
2683
|
/**
|
|
2680
2684
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2681
2685
|
*
|
|
@@ -2685,7 +2689,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2685
2689
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2686
2690
|
* @secure
|
|
2687
2691
|
*/
|
|
2688
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2692
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputB7Xwh5L8Rcj>;
|
|
2689
2693
|
/**
|
|
2690
2694
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2691
2695
|
*
|
|
@@ -2725,7 +2729,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2725
2729
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2726
2730
|
* @secure
|
|
2727
2731
|
*/
|
|
2728
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2732
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputNmhg7Wzfgw>;
|
|
2729
2733
|
/**
|
|
2730
2734
|
* @description This endpoint will print certificate
|
|
2731
2735
|
*
|
|
@@ -2795,7 +2799,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2795
2799
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2796
2800
|
* @secure
|
|
2797
2801
|
*/
|
|
2798
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2802
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputCmyyy21Un9F, params?: RequestParams) => Promise<any>;
|
|
2799
2803
|
/**
|
|
2800
2804
|
* @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.
|
|
2801
2805
|
*
|
|
@@ -2825,7 +2829,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2825
2829
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2826
2830
|
* @secure
|
|
2827
2831
|
*/
|
|
2828
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2832
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputIh5Tnf0P5L, params?: RequestParams) => Promise<any>;
|
|
2829
2833
|
/**
|
|
2830
2834
|
* @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.
|
|
2831
2835
|
*
|
|
@@ -2835,7 +2839,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2835
2839
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2836
2840
|
* @secure
|
|
2837
2841
|
*/
|
|
2838
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2842
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputH9H5U07K33, params?: RequestParams) => Promise<any>;
|
|
2839
2843
|
/**
|
|
2840
2844
|
* @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.
|
|
2841
2845
|
*
|
|
@@ -2845,7 +2849,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2845
2849
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2846
2850
|
* @secure
|
|
2847
2851
|
*/
|
|
2848
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2852
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: Input70Owq1Kboh, params?: RequestParams) => Promise<any>;
|
|
2849
2853
|
/**
|
|
2850
2854
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2851
2855
|
*
|
|
@@ -2855,7 +2859,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2855
2859
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2856
2860
|
* @secure
|
|
2857
2861
|
*/
|
|
2858
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2862
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputTh8Wdj68Dji, params?: RequestParams) => Promise<any>;
|
|
2859
2863
|
/**
|
|
2860
2864
|
* @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.
|
|
2861
2865
|
*
|
|
@@ -2895,7 +2899,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2895
2899
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2896
2900
|
* @secure
|
|
2897
2901
|
*/
|
|
2898
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2902
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputBgtk2Vwgatg, params?: RequestParams) => Promise<any>;
|
|
2899
2903
|
/**
|
|
2900
2904
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
2901
2905
|
*
|
|
@@ -2905,7 +2909,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2905
2909
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2906
2910
|
* @secure
|
|
2907
2911
|
*/
|
|
2908
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2912
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputV8Ym6Dzytn>;
|
|
2909
2913
|
/**
|
|
2910
2914
|
* @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.
|
|
2911
2915
|
*
|
|
@@ -2935,7 +2939,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2935
2939
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2936
2940
|
* @secure
|
|
2937
2941
|
*/
|
|
2938
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
2942
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: Input8Bfow5Z9Srl, params?: RequestParams) => Promise<any>;
|
|
2939
2943
|
/**
|
|
2940
2944
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
2941
2945
|
*
|
|
@@ -2985,7 +2989,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2985
2989
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
2986
2990
|
* @secure
|
|
2987
2991
|
*/
|
|
2988
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
2992
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: Input2Mhqs0Fnt2, params?: RequestParams) => Promise<any>;
|
|
2989
2993
|
/**
|
|
2990
2994
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
2991
2995
|
*
|
|
@@ -3005,7 +3009,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3005
3009
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3006
3010
|
* @secure
|
|
3007
3011
|
*/
|
|
3008
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3012
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputWwtwfps7Vg, params?: RequestParams) => Promise<any>;
|
|
3009
3013
|
/**
|
|
3010
3014
|
* @description This route allows you to submit a pending approval.
|
|
3011
3015
|
*
|
|
@@ -3015,7 +3019,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3015
3019
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3016
3020
|
* @secure
|
|
3017
3021
|
*/
|
|
3018
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3022
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputJ8Vv2F6Cn5, params?: RequestParams) => Promise<any>;
|
|
3019
3023
|
/**
|
|
3020
3024
|
* @description This route allows you to review a pending approval.
|
|
3021
3025
|
*
|
|
@@ -3025,7 +3029,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3025
3029
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3026
3030
|
* @secure
|
|
3027
3031
|
*/
|
|
3028
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3032
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputJ90M1Fgki9L, params?: RequestParams) => Promise<any>;
|
|
3029
3033
|
/**
|
|
3030
3034
|
* @description Redeems a license for a user by product ID.
|
|
3031
3035
|
*
|
|
@@ -3035,7 +3039,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3035
3039
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3036
3040
|
* @secure
|
|
3037
3041
|
*/
|
|
3038
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3042
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputFj18Imcto0K, params?: RequestParams) => Promise<any>;
|
|
3039
3043
|
/**
|
|
3040
3044
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3041
3045
|
*
|
|
@@ -3045,7 +3049,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3045
3049
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3046
3050
|
* @secure
|
|
3047
3051
|
*/
|
|
3048
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3052
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputHo5V7Vdsab>;
|
|
3049
3053
|
/**
|
|
3050
3054
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3051
3055
|
*
|
|
@@ -3055,7 +3059,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3055
3059
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3056
3060
|
* @secure
|
|
3057
3061
|
*/
|
|
3058
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3062
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputS9Jvk0Pxf, params?: RequestParams) => Promise<any>;
|
|
3059
3063
|
/**
|
|
3060
3064
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3061
3065
|
*
|
|
@@ -3065,7 +3069,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3065
3069
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3066
3070
|
* @secure
|
|
3067
3071
|
*/
|
|
3068
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3072
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputZ8Jg5Tk9Lb, params?: RequestParams) => Promise<any>;
|
|
3069
3073
|
/**
|
|
3070
3074
|
* @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.
|
|
3071
3075
|
*
|
|
@@ -3075,7 +3079,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3075
3079
|
* @request POST:/user/{userID}/updateITA
|
|
3076
3080
|
* @secure
|
|
3077
3081
|
*/
|
|
3078
|
-
createUpdateIta: (userId: string, data:
|
|
3082
|
+
createUpdateIta: (userId: string, data: InputNhq272A9E1, params?: RequestParams) => Promise<any>;
|
|
3079
3083
|
/**
|
|
3080
3084
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3081
3085
|
*
|
|
@@ -3085,7 +3089,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3085
3089
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3086
3090
|
* @secure
|
|
3087
3091
|
*/
|
|
3088
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3092
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: Input92Pwkq6Eon, params?: RequestParams) => Promise<any>;
|
|
3089
3093
|
/**
|
|
3090
3094
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3091
3095
|
*
|
|
@@ -3095,7 +3099,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3095
3099
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3096
3100
|
* @secure
|
|
3097
3101
|
*/
|
|
3098
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3102
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: Input2Thiin78V5, params?: RequestParams) => Promise<any>;
|
|
3103
|
+
/**
|
|
3104
|
+
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3105
|
+
*
|
|
3106
|
+
* @tags Certification
|
|
3107
|
+
* @name CreateCertificationPublishInfo
|
|
3108
|
+
* @summary Publish certification information to LMS event bus
|
|
3109
|
+
* @request POST:/user/{userID}/certification/{certProcID}/publishInfo
|
|
3110
|
+
* @secure
|
|
3111
|
+
*/
|
|
3112
|
+
createCertificationPublishInfo: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
|
|
3099
3113
|
};
|
|
3100
3114
|
users: {
|
|
3101
3115
|
/**
|
|
@@ -3107,6 +3121,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3107
3121
|
* @request POST:/users/certification/{certSpecID}
|
|
3108
3122
|
* @secure
|
|
3109
3123
|
*/
|
|
3110
|
-
createCertification: (certSpecId: string, data:
|
|
3124
|
+
createCertification: (certSpecId: string, data: InputI6G8Xigbgn, params?: RequestParams) => Promise<OutputI6G8Xigbgn>;
|
|
3125
|
+
/**
|
|
3126
|
+
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3127
|
+
*
|
|
3128
|
+
* @tags Users
|
|
3129
|
+
* @name CreateCertificationPublishInfo
|
|
3130
|
+
* @summary Publish Certification Information
|
|
3131
|
+
* @request POST:/users/certification/{certSpecID}/publishInfo
|
|
3132
|
+
* @secure
|
|
3133
|
+
*/
|
|
3134
|
+
createCertificationPublishInfo: (certSpecId: string, params?: RequestParams) => Promise<any>;
|
|
3111
3135
|
};
|
|
3112
3136
|
}
|