@ikonintegration/bccsa-program-api 3.0.12 → 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 +145 -93
- package/dist/Api.d.ts +130 -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 InputTl5Xrjjwwg {
|
|
|
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 Input7Wkfcnrebb {
|
|
|
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 InputTyiwrdmgw6 {
|
|
|
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 InputG65298619Kg {
|
|
|
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 Input2E7Irudg4C {
|
|
|
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 InputRek8Ekfq6G {
|
|
|
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 InputOix1Fbwy5J {
|
|
|
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 InputTtclghucpzg {
|
|
|
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 InputSozb4Fr6Pwk {
|
|
|
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
|
|
@@ -907,6 +907,8 @@ export interface OutputBmpg97Oc6O {
|
|
|
907
907
|
*/
|
|
908
908
|
transactionID: string;
|
|
909
909
|
}
|
|
910
|
+
/** Timestamp when the application will be auto-unlocked */
|
|
911
|
+
export type AutoUnlockOn = number;
|
|
910
912
|
/** Certification number issued to the user */
|
|
911
913
|
export type CertNumber = string;
|
|
912
914
|
/** Original date of completion */
|
|
@@ -962,6 +964,8 @@ export interface CertificationProcessResponseSchema {
|
|
|
962
964
|
updatedBy?: UpdatedBy;
|
|
963
965
|
/** Internal database entity identifier */
|
|
964
966
|
dbEntity?: DbEntity;
|
|
967
|
+
/** Timestamp when the application will be auto-unlocked */
|
|
968
|
+
autoUnlockOn?: AutoUnlockOn;
|
|
965
969
|
/** Certification number issued to the user */
|
|
966
970
|
certNumber?: CertNumber;
|
|
967
971
|
/** Date of certification completion */
|
|
@@ -1152,7 +1156,7 @@ export interface CourseResponseEntity {
|
|
|
1152
1156
|
/** Justifications for overridden course restrictions */
|
|
1153
1157
|
overwrittenJustification?: OverwrittenJustification;
|
|
1154
1158
|
}
|
|
1155
|
-
export interface
|
|
1159
|
+
export interface OutputHn6Wkdevdg {
|
|
1156
1160
|
/**
|
|
1157
1161
|
* Signed URL for the course file
|
|
1158
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"
|
|
@@ -1170,7 +1174,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1170
1174
|
transactionID?: string | null;
|
|
1171
1175
|
}
|
|
1172
1176
|
/** Application Foreign Fill response type */
|
|
1173
|
-
export interface
|
|
1177
|
+
export interface OutputNmhg7Wzfgw {
|
|
1174
1178
|
items: {
|
|
1175
1179
|
userID: string;
|
|
1176
1180
|
createdOn?: number;
|
|
@@ -1393,7 +1397,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1393
1397
|
applicationItems?: Record<string, any>[];
|
|
1394
1398
|
transactionID?: string | null;
|
|
1395
1399
|
}
|
|
1396
|
-
export interface
|
|
1400
|
+
export interface InputG8Kndhfwiy {
|
|
1397
1401
|
issuedOn?: number;
|
|
1398
1402
|
expiresOn?: number;
|
|
1399
1403
|
fileItems?: {
|
|
@@ -1402,21 +1406,21 @@ export interface InputBejlnd4Qri {
|
|
|
1402
1406
|
}[];
|
|
1403
1407
|
additionalNotes?: string | null;
|
|
1404
1408
|
}
|
|
1405
|
-
export interface
|
|
1409
|
+
export interface InputCmyyy21Un9F {
|
|
1406
1410
|
/**
|
|
1407
1411
|
* Indicates whether the application is locked
|
|
1408
1412
|
* @example true
|
|
1409
1413
|
*/
|
|
1410
1414
|
isApplicationLocked: boolean;
|
|
1411
1415
|
}
|
|
1412
|
-
export interface
|
|
1416
|
+
export interface OutputZp9Wch1Ta {
|
|
1413
1417
|
/**
|
|
1414
1418
|
* Signed URL for the course file
|
|
1415
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"
|
|
1416
1420
|
*/
|
|
1417
1421
|
fileURL: string;
|
|
1418
1422
|
}
|
|
1419
|
-
export interface
|
|
1423
|
+
export interface InputIh5Tnf0P5L {
|
|
1420
1424
|
/**
|
|
1421
1425
|
* Indicates whether the waiver is approved
|
|
1422
1426
|
* @example true
|
|
@@ -1428,14 +1432,14 @@ export interface InputOrjwer2Lg8 {
|
|
|
1428
1432
|
*/
|
|
1429
1433
|
additionalNotes?: string | null;
|
|
1430
1434
|
}
|
|
1431
|
-
export interface
|
|
1435
|
+
export interface InputH9H5U07K33 {
|
|
1432
1436
|
/**
|
|
1433
1437
|
* Optional notes regarding the waiver
|
|
1434
1438
|
* @example "Waiver granted due to special circumstances."
|
|
1435
1439
|
*/
|
|
1436
1440
|
additionalNotes?: string | null;
|
|
1437
1441
|
}
|
|
1438
|
-
export interface
|
|
1442
|
+
export interface Input70Owq1Kboh {
|
|
1439
1443
|
students: {
|
|
1440
1444
|
/**
|
|
1441
1445
|
* User ID of the student to redeem the course for
|
|
@@ -1469,7 +1473,7 @@ export interface Input5Btgd4Ab7W {
|
|
|
1469
1473
|
*/
|
|
1470
1474
|
autoEnrolSessionID?: string;
|
|
1471
1475
|
}
|
|
1472
|
-
export interface
|
|
1476
|
+
export interface InputTh8Wdj68Dji {
|
|
1473
1477
|
invites: {
|
|
1474
1478
|
/**
|
|
1475
1479
|
* Email address of the user to invite
|
|
@@ -1498,7 +1502,7 @@ export interface InputLpq2890S17K {
|
|
|
1498
1502
|
*/
|
|
1499
1503
|
isReservedSeat: boolean;
|
|
1500
1504
|
}
|
|
1501
|
-
export interface
|
|
1505
|
+
export interface InputBgtk2Vwgatg {
|
|
1502
1506
|
/**
|
|
1503
1507
|
* Indicates whether to waive the certification process
|
|
1504
1508
|
* @example true
|
|
@@ -1511,7 +1515,7 @@ export interface InputJ9Dcdc6Jvp {
|
|
|
1511
1515
|
comments?: string | null;
|
|
1512
1516
|
}
|
|
1513
1517
|
/** Certification move response schema */
|
|
1514
|
-
export interface
|
|
1518
|
+
export interface OutputV8Ym6Dzytn {
|
|
1515
1519
|
errors?: {
|
|
1516
1520
|
status: string;
|
|
1517
1521
|
object?: Record<string, any>;
|
|
@@ -1519,19 +1523,19 @@ export interface OutputNxirkiytfi {
|
|
|
1519
1523
|
}[];
|
|
1520
1524
|
}
|
|
1521
1525
|
/** Schema for writing a certification trigger check. */
|
|
1522
|
-
export interface
|
|
1526
|
+
export interface Input8Bfow5Z9Srl {
|
|
1523
1527
|
/**
|
|
1524
1528
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1525
1529
|
* @example "CHECKED"
|
|
1526
1530
|
*/
|
|
1527
|
-
value:
|
|
1531
|
+
value: Input8Bfow5Z9SrlValueEnum;
|
|
1528
1532
|
/**
|
|
1529
1533
|
* List of course IDs that are blocked by this trigger check.
|
|
1530
1534
|
* @example ["course1","course2"]
|
|
1531
1535
|
*/
|
|
1532
1536
|
blockedCourses?: string[];
|
|
1533
1537
|
}
|
|
1534
|
-
export interface
|
|
1538
|
+
export interface Input2Mhqs0Fnt2 {
|
|
1535
1539
|
/**
|
|
1536
1540
|
* Indicates whether the application item is approved
|
|
1537
1541
|
* @example true
|
|
@@ -1557,7 +1561,7 @@ export interface InputZ1Lsr49K6C {
|
|
|
1557
1561
|
export interface StudentHistoryRequestSchema {
|
|
1558
1562
|
requirements: string[];
|
|
1559
1563
|
}
|
|
1560
|
-
export interface
|
|
1564
|
+
export interface InputWwtwfps7Vg {
|
|
1561
1565
|
/**
|
|
1562
1566
|
* Optional activation key for the application
|
|
1563
1567
|
* @example "AK-123456"
|
|
@@ -1565,7 +1569,7 @@ export interface InputUate2Qkkga {
|
|
|
1565
1569
|
activationKey?: string;
|
|
1566
1570
|
}
|
|
1567
1571
|
/** Schema for course submission item details post request. */
|
|
1568
|
-
export interface
|
|
1572
|
+
export interface Input63Gpw9Ssci {
|
|
1569
1573
|
/**
|
|
1570
1574
|
* The ID of the file being submitted.
|
|
1571
1575
|
* @example "fileID123"
|
|
@@ -1578,7 +1582,7 @@ export interface InputMypoea77Dig {
|
|
|
1578
1582
|
fileName: string;
|
|
1579
1583
|
}
|
|
1580
1584
|
/** Schema for the response to course submission item details post request. */
|
|
1581
|
-
export interface
|
|
1585
|
+
export interface Output63Gpw9Ssci {
|
|
1582
1586
|
submissionItems: {
|
|
1583
1587
|
/**
|
|
1584
1588
|
* The ID of the file being submitted.
|
|
@@ -1593,7 +1597,7 @@ export interface OutputMypoea77Dig {
|
|
|
1593
1597
|
}[];
|
|
1594
1598
|
}
|
|
1595
1599
|
/** Pending approval submission parameters */
|
|
1596
|
-
export interface
|
|
1600
|
+
export interface InputJ8Vv2F6Cn5 {
|
|
1597
1601
|
/**
|
|
1598
1602
|
* Type of pending approval
|
|
1599
1603
|
* @example "certification"
|
|
@@ -1613,7 +1617,7 @@ export interface InputN6Mrda0K2I {
|
|
|
1613
1617
|
fileName: string;
|
|
1614
1618
|
}[];
|
|
1615
1619
|
}
|
|
1616
|
-
export interface
|
|
1620
|
+
export interface InputFj18Imcto0K {
|
|
1617
1621
|
/**
|
|
1618
1622
|
* The ID of the course for which the license is being redeemed
|
|
1619
1623
|
* @example "courseID123"
|
|
@@ -1681,7 +1685,7 @@ export interface InputOpeoejj9Rp {
|
|
|
1681
1685
|
acknowledgement?: string | null;
|
|
1682
1686
|
}
|
|
1683
1687
|
/** Validate certification move response schema */
|
|
1684
|
-
export interface
|
|
1688
|
+
export interface OutputHo5V7Vdsab {
|
|
1685
1689
|
courses: {
|
|
1686
1690
|
name: string;
|
|
1687
1691
|
status: string;
|
|
@@ -1692,21 +1696,21 @@ export interface OutputU7D0Strhe {
|
|
|
1692
1696
|
validated: boolean;
|
|
1693
1697
|
mustCreateCP: boolean;
|
|
1694
1698
|
}
|
|
1695
|
-
export interface
|
|
1699
|
+
export interface InputS9Jvk0Pxf {
|
|
1696
1700
|
/**
|
|
1697
1701
|
* Comments regarding the end of the cooldown period
|
|
1698
1702
|
* @example "Cooldown period ended successfully."
|
|
1699
1703
|
*/
|
|
1700
1704
|
comments: string;
|
|
1701
1705
|
}
|
|
1702
|
-
export interface
|
|
1706
|
+
export interface OutputRob70W4Zozf {
|
|
1703
1707
|
/**
|
|
1704
1708
|
* Signed URL for the course file
|
|
1705
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"
|
|
1706
1710
|
*/
|
|
1707
1711
|
fileURL: string;
|
|
1708
1712
|
}
|
|
1709
|
-
export interface
|
|
1713
|
+
export interface InputQu8Lbgia45L {
|
|
1710
1714
|
/** @example true */
|
|
1711
1715
|
agreedWithCertTerms: boolean;
|
|
1712
1716
|
/** @example 1717230000000 */
|
|
@@ -1778,21 +1782,21 @@ export interface Input1Anuav4Wq {
|
|
|
1778
1782
|
/** @example "EXT#999" */
|
|
1779
1783
|
externalID2?: string | null;
|
|
1780
1784
|
}
|
|
1781
|
-
export interface
|
|
1785
|
+
export interface InputZ8Jg5Tk9Lb {
|
|
1782
1786
|
/**
|
|
1783
1787
|
* Comments regarding the course unlock action
|
|
1784
1788
|
* @example "Course unlocked successfully."
|
|
1785
1789
|
*/
|
|
1786
1790
|
comments: string;
|
|
1787
1791
|
}
|
|
1788
|
-
export interface
|
|
1792
|
+
export interface InputNhq272A9E1 {
|
|
1789
1793
|
/**
|
|
1790
1794
|
* ITA number to update for the user
|
|
1791
1795
|
* @example "ITA123456"
|
|
1792
1796
|
*/
|
|
1793
1797
|
itaNumber: string;
|
|
1794
1798
|
}
|
|
1795
|
-
export interface
|
|
1799
|
+
export interface InputWi1Nu2Pkap {
|
|
1796
1800
|
/** @example true */
|
|
1797
1801
|
agreedWithCertTerms: boolean;
|
|
1798
1802
|
/** @example 1717230000000 */
|
|
@@ -1864,7 +1868,7 @@ export interface InputBmj0Xzqnsb {
|
|
|
1864
1868
|
/** @example "EXT#999" */
|
|
1865
1869
|
externalID2?: string | null;
|
|
1866
1870
|
}
|
|
1867
|
-
export interface
|
|
1871
|
+
export interface Input92Pwkq6Eon {
|
|
1868
1872
|
/**
|
|
1869
1873
|
* The grade to override the course result with
|
|
1870
1874
|
* @example "A"
|
|
@@ -1872,7 +1876,7 @@ export interface InputZ1Izmy5Hlbg {
|
|
|
1872
1876
|
resultGrade: string;
|
|
1873
1877
|
}
|
|
1874
1878
|
/** Pending approval review parameters */
|
|
1875
|
-
export interface
|
|
1879
|
+
export interface InputJ90M1Fgki9L {
|
|
1876
1880
|
/**
|
|
1877
1881
|
* Notes provided by the reviewer for the pending approval
|
|
1878
1882
|
* @example "Please review the submitted documents."
|
|
@@ -1885,7 +1889,7 @@ export interface InputL3M904Duc3 {
|
|
|
1885
1889
|
approved: boolean;
|
|
1886
1890
|
}
|
|
1887
1891
|
/** Schema for overriding course result dates. */
|
|
1888
|
-
export interface
|
|
1892
|
+
export interface Input2Thiin78V5 {
|
|
1889
1893
|
/**
|
|
1890
1894
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1891
1895
|
* @example 1735689600000
|
|
@@ -1897,14 +1901,14 @@ export interface Input2Yxx0Kgi6F {
|
|
|
1897
1901
|
*/
|
|
1898
1902
|
completionDate?: number;
|
|
1899
1903
|
}
|
|
1900
|
-
export interface
|
|
1904
|
+
export interface InputI6G8Xigbgn {
|
|
1901
1905
|
filter: {
|
|
1902
1906
|
from?: number;
|
|
1903
1907
|
sortOrder?: string;
|
|
1904
1908
|
sortField?: string;
|
|
1905
1909
|
};
|
|
1906
1910
|
}
|
|
1907
|
-
export interface
|
|
1911
|
+
export interface OutputI6G8Xigbgn {
|
|
1908
1912
|
users: {
|
|
1909
1913
|
firstName: string;
|
|
1910
1914
|
lastName: string;
|
|
@@ -1924,7 +1928,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
1924
1928
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1925
1929
|
* @example "CHECKED"
|
|
1926
1930
|
*/
|
|
1927
|
-
export declare enum
|
|
1931
|
+
export declare enum Input8Bfow5Z9SrlValueEnum {
|
|
1928
1932
|
CHECKED = "CHECKED",
|
|
1929
1933
|
UNCHECKED = "UNCHECKED",
|
|
1930
1934
|
NOVALUE = "NOVALUE"
|
|
@@ -2017,7 +2021,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2017
2021
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2018
2022
|
export type CreateReportUsersSimpleData = any;
|
|
2019
2023
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2020
|
-
export type CreateSearchUsersCountData =
|
|
2024
|
+
export type CreateSearchUsersCountData = OutputDydlownlhy;
|
|
2021
2025
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2022
2026
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2023
2027
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2035,7 +2039,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2035
2039
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2036
2040
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2037
2041
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2038
|
-
export type GetCertificationCourseFileSignData =
|
|
2042
|
+
export type GetCertificationCourseFileSignData = OutputHn6Wkdevdg;
|
|
2039
2043
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2040
2044
|
export interface CreateCertificationCourseFileSignParams {
|
|
2041
2045
|
/** @example "pdf" */
|
|
@@ -2049,11 +2053,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2049
2053
|
/** @example "fileID" */
|
|
2050
2054
|
fileId: string;
|
|
2051
2055
|
}
|
|
2052
|
-
export type CreateCertificationCourseFileSignData =
|
|
2056
|
+
export type CreateCertificationCourseFileSignData = OutputRob70W4Zozf;
|
|
2053
2057
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2054
2058
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2055
2059
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2056
|
-
export type CreateCertificationCourseDocumentData =
|
|
2060
|
+
export type CreateCertificationCourseDocumentData = Output63Gpw9Ssci;
|
|
2057
2061
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2058
2062
|
export type DeleteUserData = any;
|
|
2059
2063
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2065,7 +2069,7 @@ export type UpdateUserData = any;
|
|
|
2065
2069
|
export type UpdateUserError = ErrorResponse;
|
|
2066
2070
|
export type DeleteCertificationCourseData = any;
|
|
2067
2071
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2068
|
-
export type GetCertificationApplicationItemFileData =
|
|
2072
|
+
export type GetCertificationApplicationItemFileData = Output1Gr1600Fma;
|
|
2069
2073
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2070
2074
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2071
2075
|
/** @example "pdf" */
|
|
@@ -2079,9 +2083,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2079
2083
|
/** @example "fileVersion" */
|
|
2080
2084
|
fileVersion: string;
|
|
2081
2085
|
}
|
|
2082
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2086
|
+
export type CreateCertificationApplicationItemFileData = OutputZp9Wch1Ta;
|
|
2083
2087
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2084
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2088
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputB7Xwh5L8Rcj;
|
|
2085
2089
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2086
2090
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2087
2091
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2089,7 +2093,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2089
2093
|
export type GetCourseError = ErrorResponse;
|
|
2090
2094
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2091
2095
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2092
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2096
|
+
export type GetCertificationApplicationForeignFillData = OutputNmhg7Wzfgw;
|
|
2093
2097
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2094
2098
|
export type GetCertificationPrintData = any;
|
|
2095
2099
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2125,7 +2129,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2125
2129
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2126
2130
|
export type CreateCertificationWaiveData = any;
|
|
2127
2131
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2128
|
-
export type CreateCertificationMoveData =
|
|
2132
|
+
export type CreateCertificationMoveData = OutputV8Ym6Dzytn;
|
|
2129
2133
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2130
2134
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2131
2135
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2153,7 +2157,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2153
2157
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2154
2158
|
export type CreateCertificationCourseRedeemData = any;
|
|
2155
2159
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2156
|
-
export type CreateCertificationMoveValidateData =
|
|
2160
|
+
export type CreateCertificationMoveValidateData = OutputHo5V7Vdsab;
|
|
2157
2161
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2158
2162
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2159
2163
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2165,8 +2169,12 @@ export type UpdateCertificationCourseOverrideResultData = any;
|
|
|
2165
2169
|
export type UpdateCertificationCourseOverrideResultError = ErrorResponse;
|
|
2166
2170
|
export type UpdateCertificationSetDatesData = any;
|
|
2167
2171
|
export type UpdateCertificationSetDatesError = ErrorResponse;
|
|
2168
|
-
export type
|
|
2172
|
+
export type CreateCertificationPublishInfoData = any;
|
|
2173
|
+
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2174
|
+
export type CreateCertificationResult = OutputI6G8Xigbgn;
|
|
2169
2175
|
export type CreateCertificationFail = ErrorResponse;
|
|
2176
|
+
export type CreateCertificationPublishInfoResult = any;
|
|
2177
|
+
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
2170
2178
|
import type { AxiosInstance, AxiosRequestConfig, ResponseType } from 'axios';
|
|
2171
2179
|
export type QueryParamsType = Record<string | number, any>;
|
|
2172
2180
|
export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
|
|
@@ -2210,7 +2218,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2210
2218
|
}
|
|
2211
2219
|
/**
|
|
2212
2220
|
* @title BCCSA Program API
|
|
2213
|
-
* @version 3.0.
|
|
2221
|
+
* @version 3.0.14
|
|
2214
2222
|
* @baseUrl http://localhost:8080
|
|
2215
2223
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2216
2224
|
*/
|
|
@@ -2225,7 +2233,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2225
2233
|
* @request POST:/contactUs
|
|
2226
2234
|
* @secure
|
|
2227
2235
|
*/
|
|
2228
|
-
listContactUs: (data:
|
|
2236
|
+
listContactUs: (data: Input77Ng49K6Ka, params?: RequestParams) => Promise<any>;
|
|
2229
2237
|
};
|
|
2230
2238
|
customer: {
|
|
2231
2239
|
/**
|
|
@@ -2329,7 +2337,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2329
2337
|
* @request POST:/tenant/report/applicationExport
|
|
2330
2338
|
* @secure
|
|
2331
2339
|
*/
|
|
2332
|
-
createReportApplicationExport: (data:
|
|
2340
|
+
createReportApplicationExport: (data: InputC66Qlphg8W, params?: RequestParams) => Promise<any>;
|
|
2333
2341
|
/**
|
|
2334
2342
|
* @description Export a report of applications based on the provided filters.
|
|
2335
2343
|
*
|
|
@@ -2339,7 +2347,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2339
2347
|
* @request POST:/tenant/report/applicationStatus
|
|
2340
2348
|
* @secure
|
|
2341
2349
|
*/
|
|
2342
|
-
listReportApplicationStatus: (data:
|
|
2350
|
+
listReportApplicationStatus: (data: InputLtawqytdn2K, params?: RequestParams) => Promise<any>;
|
|
2343
2351
|
/**
|
|
2344
2352
|
* @description Export a report of applications based on the provided filters.
|
|
2345
2353
|
*
|
|
@@ -2349,7 +2357,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2349
2357
|
* @request POST:/tenant/report/applicationsReport
|
|
2350
2358
|
* @secure
|
|
2351
2359
|
*/
|
|
2352
|
-
createReportApplicationsReport: (data:
|
|
2360
|
+
createReportApplicationsReport: (data: InputEzw3I74O88, params?: RequestParams) => Promise<any>;
|
|
2353
2361
|
/**
|
|
2354
2362
|
* @description This route allows you to post certificates email for the tenant.
|
|
2355
2363
|
*
|
|
@@ -2359,7 +2367,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2359
2367
|
* @request POST:/tenant/certificates/email
|
|
2360
2368
|
* @secure
|
|
2361
2369
|
*/
|
|
2362
|
-
createCertificatesEmail: (data:
|
|
2370
|
+
createCertificatesEmail: (data: InputReechizngg, params?: RequestParams) => Promise<any>;
|
|
2363
2371
|
/**
|
|
2364
2372
|
* @description Generate a preview of the completed certifications report.
|
|
2365
2373
|
*
|
|
@@ -2389,7 +2397,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2389
2397
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2390
2398
|
* @secure
|
|
2391
2399
|
*/
|
|
2392
|
-
createLicenseRedeem: (userId: string, data:
|
|
2400
|
+
createLicenseRedeem: (userId: string, data: InputXvb1Cckkphj, params?: RequestParams) => Promise<any>;
|
|
2393
2401
|
/**
|
|
2394
2402
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2395
2403
|
*
|
|
@@ -2399,7 +2407,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2399
2407
|
* @request POST:/tenant/report/orglicenses/
|
|
2400
2408
|
* @secure
|
|
2401
2409
|
*/
|
|
2402
|
-
listReportOrglicenses: (data:
|
|
2410
|
+
listReportOrglicenses: (data: Input9Zuhh59Om6, params?: RequestParams) => Promise<any>;
|
|
2403
2411
|
/**
|
|
2404
2412
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2405
2413
|
*
|
|
@@ -2409,7 +2417,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2409
2417
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2410
2418
|
* @secure
|
|
2411
2419
|
*/
|
|
2412
|
-
createReportOrglicensesPreview: (data:
|
|
2420
|
+
createReportOrglicensesPreview: (data: InputXwxwjgny2W, params?: RequestParams) => Promise<any>;
|
|
2413
2421
|
/**
|
|
2414
2422
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2415
2423
|
*
|
|
@@ -2439,7 +2447,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2439
2447
|
* @request POST:/tenant/report/users/advanced
|
|
2440
2448
|
* @secure
|
|
2441
2449
|
*/
|
|
2442
|
-
createReportUsersAdvanced: (data:
|
|
2450
|
+
createReportUsersAdvanced: (data: InputRme2Lfmssbf, params?: RequestParams) => Promise<any>;
|
|
2443
2451
|
/**
|
|
2444
2452
|
* @description Searches for users in the tenant by their IDs.
|
|
2445
2453
|
*
|
|
@@ -2449,7 +2457,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2449
2457
|
* @request POST:/tenant/search/users/ids
|
|
2450
2458
|
* @secure
|
|
2451
2459
|
*/
|
|
2452
|
-
listSearchUsersIds: (data:
|
|
2460
|
+
listSearchUsersIds: (data: InputAd7Y2Tok8P, params?: RequestParams) => Promise<any>;
|
|
2453
2461
|
/**
|
|
2454
2462
|
* @description Searches for users in the tenant by term and filters.
|
|
2455
2463
|
*
|
|
@@ -2459,7 +2467,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2459
2467
|
* @request POST:/tenant/search/users/term
|
|
2460
2468
|
* @secure
|
|
2461
2469
|
*/
|
|
2462
|
-
createSearchUsersTerm: (data:
|
|
2470
|
+
createSearchUsersTerm: (data: Input3Cb5S44063, params?: RequestParams) => Promise<any>;
|
|
2463
2471
|
/**
|
|
2464
2472
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2465
2473
|
*
|
|
@@ -2469,7 +2477,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2469
2477
|
* @request POST:/tenant/report/users/simple
|
|
2470
2478
|
* @secure
|
|
2471
2479
|
*/
|
|
2472
|
-
createReportUsersSimple: (data:
|
|
2480
|
+
createReportUsersSimple: (data: InputPo9H04Ocjy, params?: RequestParams) => Promise<any>;
|
|
2473
2481
|
/**
|
|
2474
2482
|
* @description Retrieve user by ID.
|
|
2475
2483
|
*
|
|
@@ -2479,7 +2487,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2479
2487
|
* @request POST:/tenant/search/users/count
|
|
2480
2488
|
* @secure
|
|
2481
2489
|
*/
|
|
2482
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2490
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputDydlownlhy>;
|
|
2483
2491
|
};
|
|
2484
2492
|
user: {
|
|
2485
2493
|
/**
|
|
@@ -2511,7 +2519,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2511
2519
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2512
2520
|
* @secure
|
|
2513
2521
|
*/
|
|
2514
|
-
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>;
|
|
2515
2523
|
/**
|
|
2516
2524
|
* @description Delete a certification process application by type.
|
|
2517
2525
|
*
|
|
@@ -2571,7 +2579,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2571
2579
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2572
2580
|
* @secure
|
|
2573
2581
|
*/
|
|
2574
|
-
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>;
|
|
2575
2583
|
/**
|
|
2576
2584
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2577
2585
|
*
|
|
@@ -2581,7 +2589,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2581
2589
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2582
2590
|
* @secure
|
|
2583
2591
|
*/
|
|
2584
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2592
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputRob70W4Zozf>;
|
|
2585
2593
|
/**
|
|
2586
2594
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2587
2595
|
*
|
|
@@ -2601,7 +2609,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2601
2609
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2602
2610
|
* @secure
|
|
2603
2611
|
*/
|
|
2604
|
-
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>;
|
|
2605
2613
|
/**
|
|
2606
2614
|
* @description Delete user by ID.
|
|
2607
2615
|
*
|
|
@@ -2631,7 +2639,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2631
2639
|
* @request POST:/user/{userID}
|
|
2632
2640
|
* @secure
|
|
2633
2641
|
*/
|
|
2634
|
-
createUser: (userId: string, data:
|
|
2642
|
+
createUser: (userId: string, data: InputQu8Lbgia45L, params?: RequestParams) => Promise<any>;
|
|
2635
2643
|
/**
|
|
2636
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.
|
|
2637
2645
|
*
|
|
@@ -2641,7 +2649,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2641
2649
|
* @request PUT:/user/{userID}
|
|
2642
2650
|
* @secure
|
|
2643
2651
|
*/
|
|
2644
|
-
updateUser: (userId: string, data:
|
|
2652
|
+
updateUser: (userId: string, data: InputWi1Nu2Pkap, params?: RequestParams) => Promise<any>;
|
|
2645
2653
|
/**
|
|
2646
2654
|
* @description Delete course from user
|
|
2647
2655
|
*
|
|
@@ -2661,7 +2669,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2661
2669
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2662
2670
|
* @secure
|
|
2663
2671
|
*/
|
|
2664
|
-
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>;
|
|
2665
2673
|
/**
|
|
2666
2674
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2667
2675
|
*
|
|
@@ -2671,7 +2679,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2671
2679
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2672
2680
|
* @secure
|
|
2673
2681
|
*/
|
|
2674
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2682
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputZp9Wch1Ta>;
|
|
2675
2683
|
/**
|
|
2676
2684
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2677
2685
|
*
|
|
@@ -2681,7 +2689,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2681
2689
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2682
2690
|
* @secure
|
|
2683
2691
|
*/
|
|
2684
|
-
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>;
|
|
2685
2693
|
/**
|
|
2686
2694
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2687
2695
|
*
|
|
@@ -2721,7 +2729,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2721
2729
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2722
2730
|
* @secure
|
|
2723
2731
|
*/
|
|
2724
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2732
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputNmhg7Wzfgw>;
|
|
2725
2733
|
/**
|
|
2726
2734
|
* @description This endpoint will print certificate
|
|
2727
2735
|
*
|
|
@@ -2791,7 +2799,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2791
2799
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2792
2800
|
* @secure
|
|
2793
2801
|
*/
|
|
2794
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2802
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputCmyyy21Un9F, params?: RequestParams) => Promise<any>;
|
|
2795
2803
|
/**
|
|
2796
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.
|
|
2797
2805
|
*
|
|
@@ -2821,7 +2829,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2821
2829
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2822
2830
|
* @secure
|
|
2823
2831
|
*/
|
|
2824
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2832
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputIh5Tnf0P5L, params?: RequestParams) => Promise<any>;
|
|
2825
2833
|
/**
|
|
2826
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.
|
|
2827
2835
|
*
|
|
@@ -2831,7 +2839,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2831
2839
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2832
2840
|
* @secure
|
|
2833
2841
|
*/
|
|
2834
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2842
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputH9H5U07K33, params?: RequestParams) => Promise<any>;
|
|
2835
2843
|
/**
|
|
2836
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.
|
|
2837
2845
|
*
|
|
@@ -2841,7 +2849,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2841
2849
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2842
2850
|
* @secure
|
|
2843
2851
|
*/
|
|
2844
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2852
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: Input70Owq1Kboh, params?: RequestParams) => Promise<any>;
|
|
2845
2853
|
/**
|
|
2846
2854
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2847
2855
|
*
|
|
@@ -2851,7 +2859,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2851
2859
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2852
2860
|
* @secure
|
|
2853
2861
|
*/
|
|
2854
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2862
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputTh8Wdj68Dji, params?: RequestParams) => Promise<any>;
|
|
2855
2863
|
/**
|
|
2856
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.
|
|
2857
2865
|
*
|
|
@@ -2891,7 +2899,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2891
2899
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2892
2900
|
* @secure
|
|
2893
2901
|
*/
|
|
2894
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2902
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputBgtk2Vwgatg, params?: RequestParams) => Promise<any>;
|
|
2895
2903
|
/**
|
|
2896
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.
|
|
2897
2905
|
*
|
|
@@ -2901,7 +2909,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2901
2909
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2902
2910
|
* @secure
|
|
2903
2911
|
*/
|
|
2904
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2912
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputV8Ym6Dzytn>;
|
|
2905
2913
|
/**
|
|
2906
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.
|
|
2907
2915
|
*
|
|
@@ -2931,7 +2939,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2931
2939
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2932
2940
|
* @secure
|
|
2933
2941
|
*/
|
|
2934
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
2942
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: Input8Bfow5Z9Srl, params?: RequestParams) => Promise<any>;
|
|
2935
2943
|
/**
|
|
2936
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.
|
|
2937
2945
|
*
|
|
@@ -2981,7 +2989,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2981
2989
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
2982
2990
|
* @secure
|
|
2983
2991
|
*/
|
|
2984
|
-
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>;
|
|
2985
2993
|
/**
|
|
2986
2994
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
2987
2995
|
*
|
|
@@ -3001,7 +3009,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3001
3009
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3002
3010
|
* @secure
|
|
3003
3011
|
*/
|
|
3004
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3012
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputWwtwfps7Vg, params?: RequestParams) => Promise<any>;
|
|
3005
3013
|
/**
|
|
3006
3014
|
* @description This route allows you to submit a pending approval.
|
|
3007
3015
|
*
|
|
@@ -3011,7 +3019,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3011
3019
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3012
3020
|
* @secure
|
|
3013
3021
|
*/
|
|
3014
|
-
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>;
|
|
3015
3023
|
/**
|
|
3016
3024
|
* @description This route allows you to review a pending approval.
|
|
3017
3025
|
*
|
|
@@ -3021,7 +3029,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3021
3029
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3022
3030
|
* @secure
|
|
3023
3031
|
*/
|
|
3024
|
-
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>;
|
|
3025
3033
|
/**
|
|
3026
3034
|
* @description Redeems a license for a user by product ID.
|
|
3027
3035
|
*
|
|
@@ -3031,7 +3039,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3031
3039
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3032
3040
|
* @secure
|
|
3033
3041
|
*/
|
|
3034
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3042
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputFj18Imcto0K, params?: RequestParams) => Promise<any>;
|
|
3035
3043
|
/**
|
|
3036
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.
|
|
3037
3045
|
*
|
|
@@ -3041,7 +3049,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3041
3049
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3042
3050
|
* @secure
|
|
3043
3051
|
*/
|
|
3044
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3052
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputHo5V7Vdsab>;
|
|
3045
3053
|
/**
|
|
3046
3054
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3047
3055
|
*
|
|
@@ -3051,7 +3059,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3051
3059
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3052
3060
|
* @secure
|
|
3053
3061
|
*/
|
|
3054
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3062
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputS9Jvk0Pxf, params?: RequestParams) => Promise<any>;
|
|
3055
3063
|
/**
|
|
3056
3064
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3057
3065
|
*
|
|
@@ -3061,7 +3069,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3061
3069
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3062
3070
|
* @secure
|
|
3063
3071
|
*/
|
|
3064
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3072
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputZ8Jg5Tk9Lb, params?: RequestParams) => Promise<any>;
|
|
3065
3073
|
/**
|
|
3066
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.
|
|
3067
3075
|
*
|
|
@@ -3071,7 +3079,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3071
3079
|
* @request POST:/user/{userID}/updateITA
|
|
3072
3080
|
* @secure
|
|
3073
3081
|
*/
|
|
3074
|
-
createUpdateIta: (userId: string, data:
|
|
3082
|
+
createUpdateIta: (userId: string, data: InputNhq272A9E1, params?: RequestParams) => Promise<any>;
|
|
3075
3083
|
/**
|
|
3076
3084
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3077
3085
|
*
|
|
@@ -3081,7 +3089,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3081
3089
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3082
3090
|
* @secure
|
|
3083
3091
|
*/
|
|
3084
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3092
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: Input92Pwkq6Eon, params?: RequestParams) => Promise<any>;
|
|
3085
3093
|
/**
|
|
3086
3094
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3087
3095
|
*
|
|
@@ -3091,7 +3099,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3091
3099
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3092
3100
|
* @secure
|
|
3093
3101
|
*/
|
|
3094
|
-
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>;
|
|
3095
3113
|
};
|
|
3096
3114
|
users: {
|
|
3097
3115
|
/**
|
|
@@ -3103,6 +3121,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3103
3121
|
* @request POST:/users/certification/{certSpecID}
|
|
3104
3122
|
* @secure
|
|
3105
3123
|
*/
|
|
3106
|
-
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>;
|
|
3107
3135
|
};
|
|
3108
3136
|
}
|