@ikonintegration/bccsa-program-api 3.0.0 → 3.0.3
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 +166 -107
- package/dist/Api.d.ts +144 -110
- package/dist/Api.js +39 -13
- package/dist/Api.js.map +1 -1
- package/package.json +1 -1
package/dist/Api.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ export interface ErrorResponse {
|
|
|
5
5
|
/** Error code */
|
|
6
6
|
errCode: string;
|
|
7
7
|
}
|
|
8
|
-
export interface
|
|
8
|
+
export interface InputTvxwuv0Lzz {
|
|
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 InputZ6Pi8Vxh7M {
|
|
453
453
|
/**
|
|
454
454
|
* ID of the certification to filter applications by
|
|
455
455
|
* @example "certification123"
|
|
@@ -506,14 +506,14 @@ export interface InputN4Ndusy4P2 {
|
|
|
506
506
|
*/
|
|
507
507
|
ignoreCompletedCertifications?: boolean | null;
|
|
508
508
|
}
|
|
509
|
-
export interface
|
|
509
|
+
export interface InputGye2V8Ohmd {
|
|
510
510
|
/**
|
|
511
511
|
* ID of the certification to filter applications by
|
|
512
512
|
* @example "certification123"
|
|
513
513
|
*/
|
|
514
514
|
certificationID: string;
|
|
515
515
|
}
|
|
516
|
-
export interface
|
|
516
|
+
export interface InputOv5Fi8V7Spg {
|
|
517
517
|
/**
|
|
518
518
|
* ID of the certification to filter applications by
|
|
519
519
|
* @example "certification123"
|
|
@@ -570,7 +570,7 @@ export interface Input39Rlhyxzj2 {
|
|
|
570
570
|
*/
|
|
571
571
|
ignoreCompletedCertifications?: boolean | null;
|
|
572
572
|
}
|
|
573
|
-
export interface
|
|
573
|
+
export interface InputBkk90S004W {
|
|
574
574
|
/**
|
|
575
575
|
* The ID of the certificate specifications to be used for the email
|
|
576
576
|
* @example "certSpecsID123"
|
|
@@ -611,7 +611,7 @@ export interface InputLop7Riutcm {
|
|
|
611
611
|
emailAddress: string;
|
|
612
612
|
}[];
|
|
613
613
|
}
|
|
614
|
-
export interface
|
|
614
|
+
export interface InputX2C1K65Gifl {
|
|
615
615
|
/**
|
|
616
616
|
* The ID of the product for which the license is being redeemed
|
|
617
617
|
* @example "productID123"
|
|
@@ -623,7 +623,7 @@ export interface InputGikxez8Kaz {
|
|
|
623
623
|
*/
|
|
624
624
|
sessionID?: string;
|
|
625
625
|
}
|
|
626
|
-
export interface
|
|
626
|
+
export interface Input2Wsk314Pl5 {
|
|
627
627
|
/**
|
|
628
628
|
* Search term to filter licenses
|
|
629
629
|
* @example "active"
|
|
@@ -640,7 +640,7 @@ export interface InputK0Mnve89M3 {
|
|
|
640
640
|
*/
|
|
641
641
|
sortField?: any;
|
|
642
642
|
}
|
|
643
|
-
export interface
|
|
643
|
+
export interface InputTxggs7Woq6 {
|
|
644
644
|
/**
|
|
645
645
|
* Search term to filter licenses
|
|
646
646
|
* @example "active"
|
|
@@ -679,7 +679,7 @@ export interface ReportXLSXSchema {
|
|
|
679
679
|
xlsxStream: any;
|
|
680
680
|
contentType: ReportXlsxSchemaContentTypeEnum;
|
|
681
681
|
}
|
|
682
|
-
export interface
|
|
682
|
+
export interface InputYq50Sx0V4B {
|
|
683
683
|
/**
|
|
684
684
|
* Start date for the report
|
|
685
685
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -701,11 +701,11 @@ export interface InputK49I8Qntjc {
|
|
|
701
701
|
*/
|
|
702
702
|
dateType?: string;
|
|
703
703
|
}
|
|
704
|
-
export interface
|
|
704
|
+
export interface InputTbhih4Yvyml {
|
|
705
705
|
/** List of user IDs to search for in the tenant. */
|
|
706
706
|
IDs: (string | null)[];
|
|
707
707
|
}
|
|
708
|
-
export interface
|
|
708
|
+
export interface InputO4A7I6Erux {
|
|
709
709
|
/** The term to search for in the user profiles. */
|
|
710
710
|
searchTerm?: string | null;
|
|
711
711
|
/** Filter criteria for the user search. */
|
|
@@ -745,7 +745,7 @@ export interface InputG5Bir0Wo4E {
|
|
|
745
745
|
};
|
|
746
746
|
};
|
|
747
747
|
}
|
|
748
|
-
export interface
|
|
748
|
+
export interface InputAvxn578Ayl {
|
|
749
749
|
/** The term to search for in the user profiles. */
|
|
750
750
|
searchTerm?: string | null;
|
|
751
751
|
/** Filter criteria for the user search. */
|
|
@@ -785,14 +785,21 @@ export interface InputNdh9V3T3Og {
|
|
|
785
785
|
};
|
|
786
786
|
};
|
|
787
787
|
}
|
|
788
|
-
|
|
788
|
+
/** External system ID 2 */
|
|
789
|
+
export type ExternalID2 = number;
|
|
790
|
+
export interface OutputC6Zbeptre9 {
|
|
791
|
+
/** External system ID 2 */
|
|
792
|
+
userCount: ExternalID2;
|
|
793
|
+
transactionID?: string | null;
|
|
794
|
+
}
|
|
795
|
+
export interface OutputLdhu1O1Ukh {
|
|
789
796
|
/**
|
|
790
797
|
* Signed URL for the course file
|
|
791
798
|
* @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"
|
|
792
799
|
*/
|
|
793
800
|
fileURL: string;
|
|
794
801
|
}
|
|
795
|
-
export interface
|
|
802
|
+
export interface OutputNjpt2Hwj7U {
|
|
796
803
|
/**
|
|
797
804
|
* Amount to be refunded for the cancellation
|
|
798
805
|
* @example 0
|
|
@@ -1078,7 +1085,7 @@ export interface CourseResponseEntity {
|
|
|
1078
1085
|
/** Justifications for overridden course restrictions */
|
|
1079
1086
|
overwrittenJustification?: OverwrittenJustification;
|
|
1080
1087
|
}
|
|
1081
|
-
export interface
|
|
1088
|
+
export interface OutputVis5Wecmb6 {
|
|
1082
1089
|
/**
|
|
1083
1090
|
* Signed URL for the course file
|
|
1084
1091
|
* @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"
|
|
@@ -1096,7 +1103,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1096
1103
|
transactionID?: string | null;
|
|
1097
1104
|
}
|
|
1098
1105
|
/** Application Foreign Fill response type */
|
|
1099
|
-
export interface
|
|
1106
|
+
export interface OutputBl0Nmvx0Fl {
|
|
1100
1107
|
items: {
|
|
1101
1108
|
userID: string;
|
|
1102
1109
|
createdOn?: number;
|
|
@@ -1235,8 +1242,6 @@ export type PendingInvitations = string[];
|
|
|
1235
1242
|
export type IsSponsored = boolean;
|
|
1236
1243
|
/** External system ID 1 */
|
|
1237
1244
|
export type ExternalID = string;
|
|
1238
|
-
/** External system ID 2 */
|
|
1239
|
-
export type ExternalID2 = string;
|
|
1240
1245
|
/** Response schema for certification process data */
|
|
1241
1246
|
export interface CertificationProcessResponseEntity {
|
|
1242
1247
|
/** @example "abc123" */
|
|
@@ -1317,7 +1322,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1317
1322
|
applicationItems?: Record<string, any>[];
|
|
1318
1323
|
transactionID?: string | null;
|
|
1319
1324
|
}
|
|
1320
|
-
export interface
|
|
1325
|
+
export interface Input8Tmaavfxxb {
|
|
1321
1326
|
issuedOn?: number;
|
|
1322
1327
|
expiresOn?: number;
|
|
1323
1328
|
fileItems?: {
|
|
@@ -1326,14 +1331,14 @@ export interface InputJmsh67C6I {
|
|
|
1326
1331
|
}[];
|
|
1327
1332
|
additionalNotes?: string | null;
|
|
1328
1333
|
}
|
|
1329
|
-
export interface
|
|
1334
|
+
export interface OutputPcdo7909Xu {
|
|
1330
1335
|
/**
|
|
1331
1336
|
* Signed URL for the course file
|
|
1332
1337
|
* @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"
|
|
1333
1338
|
*/
|
|
1334
1339
|
fileURL: string;
|
|
1335
1340
|
}
|
|
1336
|
-
export interface
|
|
1341
|
+
export interface Input3M1P1Qx4Be {
|
|
1337
1342
|
/**
|
|
1338
1343
|
* Indicates whether the waiver is approved
|
|
1339
1344
|
* @example true
|
|
@@ -1345,14 +1350,14 @@ export interface InputEi9E1V7Rpe {
|
|
|
1345
1350
|
*/
|
|
1346
1351
|
additionalNotes?: string | null;
|
|
1347
1352
|
}
|
|
1348
|
-
export interface
|
|
1353
|
+
export interface InputYbre7T2Cxe {
|
|
1349
1354
|
/**
|
|
1350
1355
|
* Optional notes regarding the waiver
|
|
1351
1356
|
* @example "Waiver granted due to special circumstances."
|
|
1352
1357
|
*/
|
|
1353
1358
|
additionalNotes?: string | null;
|
|
1354
1359
|
}
|
|
1355
|
-
export interface
|
|
1360
|
+
export interface InputA0Hnvf0Nx2 {
|
|
1356
1361
|
students: {
|
|
1357
1362
|
/**
|
|
1358
1363
|
* User ID of the student to redeem the course for
|
|
@@ -1386,7 +1391,7 @@ export interface InputF6S7Tcgt9H {
|
|
|
1386
1391
|
*/
|
|
1387
1392
|
autoEnrolSessionID?: string;
|
|
1388
1393
|
}
|
|
1389
|
-
export interface
|
|
1394
|
+
export interface InputMigwi1Qi7G {
|
|
1390
1395
|
invites: {
|
|
1391
1396
|
/**
|
|
1392
1397
|
* Email address of the user to invite
|
|
@@ -1415,7 +1420,7 @@ export interface InputTahl1X2Wos {
|
|
|
1415
1420
|
*/
|
|
1416
1421
|
isReservedSeat: boolean;
|
|
1417
1422
|
}
|
|
1418
|
-
export interface
|
|
1423
|
+
export interface InputRgdzgwaso4 {
|
|
1419
1424
|
/**
|
|
1420
1425
|
* Indicates whether to waive the certification process
|
|
1421
1426
|
* @example true
|
|
@@ -1428,7 +1433,7 @@ export interface InputW0G08Trp2L {
|
|
|
1428
1433
|
comments?: string | null;
|
|
1429
1434
|
}
|
|
1430
1435
|
/** Certification move response schema */
|
|
1431
|
-
export interface
|
|
1436
|
+
export interface Output4I79T77Ric {
|
|
1432
1437
|
errors?: {
|
|
1433
1438
|
status: string;
|
|
1434
1439
|
object?: Record<string, any>;
|
|
@@ -1436,19 +1441,19 @@ export interface OutputSc6Zw56Dzq {
|
|
|
1436
1441
|
}[];
|
|
1437
1442
|
}
|
|
1438
1443
|
/** Schema for writing a certification trigger check. */
|
|
1439
|
-
export interface
|
|
1444
|
+
export interface InputF0Scbkkx2H {
|
|
1440
1445
|
/**
|
|
1441
1446
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1442
1447
|
* @example "CHECKED"
|
|
1443
1448
|
*/
|
|
1444
|
-
value:
|
|
1449
|
+
value: InputF0Scbkkx2HValueEnum;
|
|
1445
1450
|
/**
|
|
1446
1451
|
* List of course IDs that are blocked by this trigger check.
|
|
1447
1452
|
* @example ["course1","course2"]
|
|
1448
1453
|
*/
|
|
1449
1454
|
blockedCourses?: string[];
|
|
1450
1455
|
}
|
|
1451
|
-
export interface
|
|
1456
|
+
export interface Input4Hktu5Vloe {
|
|
1452
1457
|
/**
|
|
1453
1458
|
* Indicates whether the application item is approved
|
|
1454
1459
|
* @example true
|
|
@@ -1474,7 +1479,7 @@ export interface InputJusp9Jdhxl {
|
|
|
1474
1479
|
export interface StudentHistoryRequestSchema {
|
|
1475
1480
|
requirements: string[];
|
|
1476
1481
|
}
|
|
1477
|
-
export interface
|
|
1482
|
+
export interface InputL8Sf59Uzhm {
|
|
1478
1483
|
/**
|
|
1479
1484
|
* Optional activation key for the application
|
|
1480
1485
|
* @example "AK-123456"
|
|
@@ -1482,7 +1487,7 @@ export interface InputVb1Vnjw2Eg {
|
|
|
1482
1487
|
activationKey?: string;
|
|
1483
1488
|
}
|
|
1484
1489
|
/** Schema for course submission item details post request. */
|
|
1485
|
-
export interface
|
|
1490
|
+
export interface Input6Yt73Y2Qm0J {
|
|
1486
1491
|
/**
|
|
1487
1492
|
* The ID of the file being submitted.
|
|
1488
1493
|
* @example "fileID123"
|
|
@@ -1495,7 +1500,7 @@ export interface InputGby1J6Gkqr {
|
|
|
1495
1500
|
fileName: string;
|
|
1496
1501
|
}
|
|
1497
1502
|
/** Schema for the response to course submission item details post request. */
|
|
1498
|
-
export interface
|
|
1503
|
+
export interface Output6Yt73Y2Qm0J {
|
|
1499
1504
|
submissionItems: {
|
|
1500
1505
|
/**
|
|
1501
1506
|
* The ID of the file being submitted.
|
|
@@ -1510,7 +1515,7 @@ export interface OutputGby1J6Gkqr {
|
|
|
1510
1515
|
}[];
|
|
1511
1516
|
}
|
|
1512
1517
|
/** Pending approval submission parameters */
|
|
1513
|
-
export interface
|
|
1518
|
+
export interface InputQuioenmjqm {
|
|
1514
1519
|
/**
|
|
1515
1520
|
* Type of pending approval
|
|
1516
1521
|
* @example "certification"
|
|
@@ -1530,7 +1535,7 @@ export interface InputBkb7Btdukn {
|
|
|
1530
1535
|
fileName: string;
|
|
1531
1536
|
}[];
|
|
1532
1537
|
}
|
|
1533
|
-
export interface
|
|
1538
|
+
export interface InputX20Gr5Dswoh {
|
|
1534
1539
|
/**
|
|
1535
1540
|
* The ID of the course for which the license is being redeemed
|
|
1536
1541
|
* @example "courseID123"
|
|
@@ -1591,9 +1596,14 @@ export interface InputBchr75Oc4N {
|
|
|
1591
1596
|
* @example "autoEnrolSessionID678"
|
|
1592
1597
|
*/
|
|
1593
1598
|
autoEnrolSessionID?: string | null;
|
|
1599
|
+
/**
|
|
1600
|
+
* The response to the acknowledgement of terms or conditions
|
|
1601
|
+
* @example "Accepted"
|
|
1602
|
+
*/
|
|
1603
|
+
acknowledgement?: string | null;
|
|
1594
1604
|
}
|
|
1595
1605
|
/** Validate certification move response schema */
|
|
1596
|
-
export interface
|
|
1606
|
+
export interface OutputU05X7H42A4 {
|
|
1597
1607
|
courses: {
|
|
1598
1608
|
name: string;
|
|
1599
1609
|
status: string;
|
|
@@ -1604,21 +1614,21 @@ export interface OutputIwzp4Ltfkm {
|
|
|
1604
1614
|
validated: boolean;
|
|
1605
1615
|
mustCreateCP: boolean;
|
|
1606
1616
|
}
|
|
1607
|
-
export interface
|
|
1617
|
+
export interface Input84Yzg8N851 {
|
|
1608
1618
|
/**
|
|
1609
1619
|
* Comments regarding the end of the cooldown period
|
|
1610
1620
|
* @example "Cooldown period ended successfully."
|
|
1611
1621
|
*/
|
|
1612
1622
|
comments: string;
|
|
1613
1623
|
}
|
|
1614
|
-
export interface
|
|
1624
|
+
export interface Output15Dbnf1Bbf {
|
|
1615
1625
|
/**
|
|
1616
1626
|
* Signed URL for the course file
|
|
1617
1627
|
* @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"
|
|
1618
1628
|
*/
|
|
1619
1629
|
fileURL: string;
|
|
1620
1630
|
}
|
|
1621
|
-
export interface
|
|
1631
|
+
export interface InputMvudju017X {
|
|
1622
1632
|
/** @example true */
|
|
1623
1633
|
agreedWithCertTerms: boolean;
|
|
1624
1634
|
/** @example 1717230000000 */
|
|
@@ -1690,21 +1700,21 @@ export interface InputYa0N64R6Wk {
|
|
|
1690
1700
|
/** @example "EXT#999" */
|
|
1691
1701
|
externalID2?: string | null;
|
|
1692
1702
|
}
|
|
1693
|
-
export interface
|
|
1703
|
+
export interface InputDnhk6I4Mqw {
|
|
1694
1704
|
/**
|
|
1695
1705
|
* Comments regarding the course unlock action
|
|
1696
1706
|
* @example "Course unlocked successfully."
|
|
1697
1707
|
*/
|
|
1698
1708
|
comments: string;
|
|
1699
1709
|
}
|
|
1700
|
-
export interface
|
|
1710
|
+
export interface InputR5Dyvltvs4 {
|
|
1701
1711
|
/**
|
|
1702
1712
|
* ITA number to update for the user
|
|
1703
1713
|
* @example "ITA123456"
|
|
1704
1714
|
*/
|
|
1705
1715
|
itaNumber: string;
|
|
1706
1716
|
}
|
|
1707
|
-
export interface
|
|
1717
|
+
export interface InputQoo29Cdxrrf {
|
|
1708
1718
|
/** @example true */
|
|
1709
1719
|
agreedWithCertTerms: boolean;
|
|
1710
1720
|
/** @example 1717230000000 */
|
|
@@ -1776,7 +1786,7 @@ export interface InputCkiexmnlfz {
|
|
|
1776
1786
|
/** @example "EXT#999" */
|
|
1777
1787
|
externalID2?: string | null;
|
|
1778
1788
|
}
|
|
1779
|
-
export interface
|
|
1789
|
+
export interface InputWozo5Nmr6A {
|
|
1780
1790
|
/**
|
|
1781
1791
|
* The grade to override the course result with
|
|
1782
1792
|
* @example "A"
|
|
@@ -1784,7 +1794,7 @@ export interface InputQogzfpjg52 {
|
|
|
1784
1794
|
resultGrade: string;
|
|
1785
1795
|
}
|
|
1786
1796
|
/** Pending approval review parameters */
|
|
1787
|
-
export interface
|
|
1797
|
+
export interface InputG1Rfyng6Qw {
|
|
1788
1798
|
/**
|
|
1789
1799
|
* Notes provided by the reviewer for the pending approval
|
|
1790
1800
|
* @example "Please review the submitted documents."
|
|
@@ -1797,7 +1807,7 @@ export interface InputC53Kuyqnej {
|
|
|
1797
1807
|
approved: boolean;
|
|
1798
1808
|
}
|
|
1799
1809
|
/** Schema for overriding course result dates. */
|
|
1800
|
-
export interface
|
|
1810
|
+
export interface InputW9Rwp645Nq {
|
|
1801
1811
|
/**
|
|
1802
1812
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1803
1813
|
* @example 1735689600000
|
|
@@ -1809,14 +1819,14 @@ export interface Input7Kqbtz8S05 {
|
|
|
1809
1819
|
*/
|
|
1810
1820
|
completionDate?: number;
|
|
1811
1821
|
}
|
|
1812
|
-
export interface
|
|
1822
|
+
export interface InputSbgwv0Lrpq {
|
|
1813
1823
|
filter: {
|
|
1814
1824
|
from?: number;
|
|
1815
1825
|
sortOrder?: string;
|
|
1816
1826
|
sortField?: string;
|
|
1817
1827
|
};
|
|
1818
1828
|
}
|
|
1819
|
-
export interface
|
|
1829
|
+
export interface OutputSbgwv0Lrpq {
|
|
1820
1830
|
users: {
|
|
1821
1831
|
firstName: string;
|
|
1822
1832
|
lastName: string;
|
|
@@ -1836,7 +1846,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
1836
1846
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1837
1847
|
* @example "CHECKED"
|
|
1838
1848
|
*/
|
|
1839
|
-
export declare enum
|
|
1849
|
+
export declare enum InputF0Scbkkx2HValueEnum {
|
|
1840
1850
|
CHECKED = "CHECKED",
|
|
1841
1851
|
UNCHECKED = "UNCHECKED",
|
|
1842
1852
|
NOVALUE = "NOVALUE"
|
|
@@ -1873,9 +1883,9 @@ export type DeleteOrgData = any;
|
|
|
1873
1883
|
export type DeleteOrgError = ErrorResponse;
|
|
1874
1884
|
export interface ListReportAffiliateParams {
|
|
1875
1885
|
/** @example "1704067200" */
|
|
1876
|
-
|
|
1886
|
+
from: string;
|
|
1877
1887
|
/** @example "1704153600" */
|
|
1878
|
-
|
|
1888
|
+
to: string;
|
|
1879
1889
|
}
|
|
1880
1890
|
export type ListReportAffiliateData = any;
|
|
1881
1891
|
export type ListReportAffiliateError = ErrorResponse;
|
|
@@ -1897,17 +1907,17 @@ export type CreateCertificatesEmailData = any;
|
|
|
1897
1907
|
export type CreateCertificatesEmailError = ErrorResponse;
|
|
1898
1908
|
export interface CreateReportCompletedCertificationsPreviewParams {
|
|
1899
1909
|
/** @example "1704067200" */
|
|
1900
|
-
|
|
1910
|
+
from: string;
|
|
1901
1911
|
/** @example "1704153600" */
|
|
1902
|
-
|
|
1912
|
+
to: string;
|
|
1903
1913
|
}
|
|
1904
1914
|
export type CreateReportCompletedCertificationsPreviewData = any;
|
|
1905
1915
|
export type CreateReportCompletedCertificationsPreviewError = ErrorResponse;
|
|
1906
1916
|
export interface ListReportCompletedCertificationsParams {
|
|
1907
1917
|
/** @example "1704067200" */
|
|
1908
|
-
|
|
1918
|
+
from: string;
|
|
1909
1919
|
/** @example "1704153600" */
|
|
1910
|
-
|
|
1920
|
+
to: string;
|
|
1911
1921
|
}
|
|
1912
1922
|
export type ListReportCompletedCertificationsData = any;
|
|
1913
1923
|
export type ListReportCompletedCertificationsError = ErrorResponse;
|
|
@@ -1927,6 +1937,10 @@ export type CreateSearchUsersTermData = any;
|
|
|
1927
1937
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
1928
1938
|
export type CreateReportUsersSimpleData = any;
|
|
1929
1939
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
1940
|
+
export type CreateSearchUsersCountData = OutputC6Zbeptre9;
|
|
1941
|
+
export type CreateSearchUsersCountError = ErrorResponse;
|
|
1942
|
+
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
1943
|
+
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
1930
1944
|
export type DeleteCertificationApplicationItemData = any;
|
|
1931
1945
|
export type DeleteCertificationApplicationItemError = ErrorResponse;
|
|
1932
1946
|
export type CreateCertificationApplicationItemData = any;
|
|
@@ -1941,7 +1955,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
1941
1955
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
1942
1956
|
export type DeleteCertificationCourseFileSignData = any;
|
|
1943
1957
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
1944
|
-
export type GetCertificationCourseFileSignData =
|
|
1958
|
+
export type GetCertificationCourseFileSignData = OutputVis5Wecmb6;
|
|
1945
1959
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
1946
1960
|
export interface CreateCertificationCourseFileSignParams {
|
|
1947
1961
|
/** @example "pdf" */
|
|
@@ -1955,12 +1969,12 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
1955
1969
|
/** @example "fileID" */
|
|
1956
1970
|
fileId: string;
|
|
1957
1971
|
}
|
|
1958
|
-
export type CreateCertificationCourseFileSignData =
|
|
1972
|
+
export type CreateCertificationCourseFileSignData = Output15Dbnf1Bbf;
|
|
1959
1973
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
1960
1974
|
export type DeleteCertificationCourseDocumentData = any;
|
|
1961
1975
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
1962
|
-
export type
|
|
1963
|
-
export type
|
|
1976
|
+
export type CreateCertificationCourseDocumentData = Output6Yt73Y2Qm0J;
|
|
1977
|
+
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
1964
1978
|
export type DeleteUserData = any;
|
|
1965
1979
|
export type DeleteUserError = ErrorResponse;
|
|
1966
1980
|
export type GetUserResult = UserResponseEntity;
|
|
@@ -1971,7 +1985,7 @@ export type UpdateUserData = any;
|
|
|
1971
1985
|
export type UpdateUserError = ErrorResponse;
|
|
1972
1986
|
export type DeleteCertificationCourseData = any;
|
|
1973
1987
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
1974
|
-
export type GetCertificationApplicationItemFileData =
|
|
1988
|
+
export type GetCertificationApplicationItemFileData = OutputLdhu1O1Ukh;
|
|
1975
1989
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
1976
1990
|
export interface CreateCertificationApplicationItemFileParams {
|
|
1977
1991
|
/** @example "pdf" */
|
|
@@ -1985,9 +1999,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
1985
1999
|
/** @example "fileVersion" */
|
|
1986
2000
|
fileVersion: string;
|
|
1987
2001
|
}
|
|
1988
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2002
|
+
export type CreateCertificationApplicationItemFileData = OutputPcdo7909Xu;
|
|
1989
2003
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
1990
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2004
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputNjpt2Hwj7U;
|
|
1991
2005
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
1992
2006
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
1993
2007
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -1995,7 +2009,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
1995
2009
|
export type GetCourseError = ErrorResponse;
|
|
1996
2010
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
1997
2011
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
1998
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2012
|
+
export type GetCertificationApplicationForeignFillData = OutputBl0Nmvx0Fl;
|
|
1999
2013
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2000
2014
|
export type GetCertificationPrintData = any;
|
|
2001
2015
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2029,7 +2043,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2029
2043
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2030
2044
|
export type CreateCertificationWaiveData = any;
|
|
2031
2045
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2032
|
-
export type CreateCertificationMoveData =
|
|
2046
|
+
export type CreateCertificationMoveData = Output4I79T77Ric;
|
|
2033
2047
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2034
2048
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2035
2049
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2057,7 +2071,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2057
2071
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2058
2072
|
export type CreateCertificationCourseRedeemData = any;
|
|
2059
2073
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2060
|
-
export type CreateCertificationMoveValidateData =
|
|
2074
|
+
export type CreateCertificationMoveValidateData = OutputU05X7H42A4;
|
|
2061
2075
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2062
2076
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2063
2077
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2069,7 +2083,7 @@ export type UpdateCertificationCourseOverrideResultData = any;
|
|
|
2069
2083
|
export type UpdateCertificationCourseOverrideResultError = ErrorResponse;
|
|
2070
2084
|
export type UpdateCertificationSetDatesData = any;
|
|
2071
2085
|
export type UpdateCertificationSetDatesError = ErrorResponse;
|
|
2072
|
-
export type CreateCertificationResult =
|
|
2086
|
+
export type CreateCertificationResult = OutputSbgwv0Lrpq;
|
|
2073
2087
|
export type CreateCertificationFail = ErrorResponse;
|
|
2074
2088
|
import type { AxiosInstance, AxiosRequestConfig, ResponseType } from 'axios';
|
|
2075
2089
|
export type QueryParamsType = Record<string | number, any>;
|
|
@@ -2114,7 +2128,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2114
2128
|
}
|
|
2115
2129
|
/**
|
|
2116
2130
|
* @title BCCSA Program API
|
|
2117
|
-
* @version 3.0.
|
|
2131
|
+
* @version 3.0.3
|
|
2118
2132
|
* @baseUrl http://localhost:8080
|
|
2119
2133
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2120
2134
|
*/
|
|
@@ -2129,7 +2143,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2129
2143
|
* @request POST:/contactUs
|
|
2130
2144
|
* @secure
|
|
2131
2145
|
*/
|
|
2132
|
-
listContactUs: (data:
|
|
2146
|
+
listContactUs: (data: InputTvxwuv0Lzz, params?: RequestParams) => Promise<any>;
|
|
2133
2147
|
};
|
|
2134
2148
|
customer: {
|
|
2135
2149
|
/**
|
|
@@ -2233,7 +2247,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2233
2247
|
* @request POST:/tenant/report/applicationExport
|
|
2234
2248
|
* @secure
|
|
2235
2249
|
*/
|
|
2236
|
-
createReportApplicationExport: (data:
|
|
2250
|
+
createReportApplicationExport: (data: InputZ6Pi8Vxh7M, params?: RequestParams) => Promise<any>;
|
|
2237
2251
|
/**
|
|
2238
2252
|
* @description Export a report of applications based on the provided filters.
|
|
2239
2253
|
*
|
|
@@ -2243,7 +2257,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2243
2257
|
* @request POST:/tenant/report/applicationStatus
|
|
2244
2258
|
* @secure
|
|
2245
2259
|
*/
|
|
2246
|
-
listReportApplicationStatus: (data:
|
|
2260
|
+
listReportApplicationStatus: (data: InputGye2V8Ohmd, params?: RequestParams) => Promise<any>;
|
|
2247
2261
|
/**
|
|
2248
2262
|
* @description Export a report of applications based on the provided filters.
|
|
2249
2263
|
*
|
|
@@ -2253,7 +2267,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2253
2267
|
* @request POST:/tenant/report/applicationsReport
|
|
2254
2268
|
* @secure
|
|
2255
2269
|
*/
|
|
2256
|
-
createReportApplicationsReport: (data:
|
|
2270
|
+
createReportApplicationsReport: (data: InputOv5Fi8V7Spg, params?: RequestParams) => Promise<any>;
|
|
2257
2271
|
/**
|
|
2258
2272
|
* @description This route allows you to post certificates email for the tenant.
|
|
2259
2273
|
*
|
|
@@ -2263,7 +2277,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2263
2277
|
* @request POST:/tenant/certificates/email
|
|
2264
2278
|
* @secure
|
|
2265
2279
|
*/
|
|
2266
|
-
createCertificatesEmail: (data:
|
|
2280
|
+
createCertificatesEmail: (data: InputBkk90S004W, params?: RequestParams) => Promise<any>;
|
|
2267
2281
|
/**
|
|
2268
2282
|
* @description Generate a preview of the completed certifications report.
|
|
2269
2283
|
*
|
|
@@ -2293,7 +2307,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2293
2307
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2294
2308
|
* @secure
|
|
2295
2309
|
*/
|
|
2296
|
-
createLicenseRedeem: (userId: string, data:
|
|
2310
|
+
createLicenseRedeem: (userId: string, data: InputX2C1K65Gifl, params?: RequestParams) => Promise<any>;
|
|
2297
2311
|
/**
|
|
2298
2312
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2299
2313
|
*
|
|
@@ -2303,7 +2317,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2303
2317
|
* @request POST:/tenant/report/orglicenses/
|
|
2304
2318
|
* @secure
|
|
2305
2319
|
*/
|
|
2306
|
-
listReportOrglicenses: (data:
|
|
2320
|
+
listReportOrglicenses: (data: Input2Wsk314Pl5, params?: RequestParams) => Promise<any>;
|
|
2307
2321
|
/**
|
|
2308
2322
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2309
2323
|
*
|
|
@@ -2313,9 +2327,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2313
2327
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2314
2328
|
* @secure
|
|
2315
2329
|
*/
|
|
2316
|
-
createReportOrglicensesPreview: (data:
|
|
2330
|
+
createReportOrglicensesPreview: (data: InputTxggs7Woq6, params?: RequestParams) => Promise<any>;
|
|
2317
2331
|
/**
|
|
2318
|
-
* @description
|
|
2332
|
+
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2319
2333
|
*
|
|
2320
2334
|
* @tags Reports
|
|
2321
2335
|
* @name CreateReportNcsoReport
|
|
@@ -2333,7 +2347,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2333
2347
|
* @request POST:/tenant/report/users/advanced
|
|
2334
2348
|
* @secure
|
|
2335
2349
|
*/
|
|
2336
|
-
createReportUsersAdvanced: (data:
|
|
2350
|
+
createReportUsersAdvanced: (data: InputYq50Sx0V4B, params?: RequestParams) => Promise<any>;
|
|
2337
2351
|
/**
|
|
2338
2352
|
* @description Searches for users in the tenant by their IDs.
|
|
2339
2353
|
*
|
|
@@ -2343,7 +2357,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2343
2357
|
* @request POST:/tenant/search/users/ids
|
|
2344
2358
|
* @secure
|
|
2345
2359
|
*/
|
|
2346
|
-
listSearchUsersIds: (data:
|
|
2360
|
+
listSearchUsersIds: (data: InputTbhih4Yvyml, params?: RequestParams) => Promise<any>;
|
|
2347
2361
|
/**
|
|
2348
2362
|
* @description Searches for users in the tenant by term and filters.
|
|
2349
2363
|
*
|
|
@@ -2353,7 +2367,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2353
2367
|
* @request POST:/tenant/search/users/term
|
|
2354
2368
|
* @secure
|
|
2355
2369
|
*/
|
|
2356
|
-
createSearchUsersTerm: (data:
|
|
2370
|
+
createSearchUsersTerm: (data: InputO4A7I6Erux, params?: RequestParams) => Promise<any>;
|
|
2357
2371
|
/**
|
|
2358
2372
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2359
2373
|
*
|
|
@@ -2363,9 +2377,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2363
2377
|
* @request POST:/tenant/report/users/simple
|
|
2364
2378
|
* @secure
|
|
2365
2379
|
*/
|
|
2366
|
-
createReportUsersSimple: (data:
|
|
2380
|
+
createReportUsersSimple: (data: InputAvxn578Ayl, params?: RequestParams) => Promise<any>;
|
|
2381
|
+
/**
|
|
2382
|
+
* @description Retrieve user by ID.
|
|
2383
|
+
*
|
|
2384
|
+
* @tags User
|
|
2385
|
+
* @name CreateSearchUsersCount
|
|
2386
|
+
* @summary Retrieve tenant user count
|
|
2387
|
+
* @request POST:/tenant/search/users/count
|
|
2388
|
+
* @secure
|
|
2389
|
+
*/
|
|
2390
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputC6Zbeptre9>;
|
|
2367
2391
|
};
|
|
2368
2392
|
user: {
|
|
2393
|
+
/**
|
|
2394
|
+
* @description This route allows you to acknowledge a pre approval review for a certification application for a user. This is used to acknowledge the decision made during the pre approval review.
|
|
2395
|
+
*
|
|
2396
|
+
* @tags Application
|
|
2397
|
+
* @name CreateCertificationApplicationAcknowledge
|
|
2398
|
+
* @summary Acknowledge Certification Application Pre Approval Review
|
|
2399
|
+
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/acknowledge
|
|
2400
|
+
* @secure
|
|
2401
|
+
*/
|
|
2402
|
+
createCertificationApplicationAcknowledge: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<any>;
|
|
2369
2403
|
/**
|
|
2370
2404
|
* @description Delete application item by type.
|
|
2371
2405
|
*
|
|
@@ -2385,7 +2419,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2385
2419
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2386
2420
|
* @secure
|
|
2387
2421
|
*/
|
|
2388
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2422
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: Input8Tmaavfxxb, params?: RequestParams) => Promise<any>;
|
|
2389
2423
|
/**
|
|
2390
2424
|
* @description Delete a certification process application by type.
|
|
2391
2425
|
*
|
|
@@ -2445,7 +2479,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2445
2479
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2446
2480
|
* @secure
|
|
2447
2481
|
*/
|
|
2448
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2482
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputVis5Wecmb6>;
|
|
2449
2483
|
/**
|
|
2450
2484
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2451
2485
|
*
|
|
@@ -2455,7 +2489,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2455
2489
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2456
2490
|
* @secure
|
|
2457
2491
|
*/
|
|
2458
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2492
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<Output15Dbnf1Bbf>;
|
|
2459
2493
|
/**
|
|
2460
2494
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2461
2495
|
*
|
|
@@ -2470,12 +2504,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2470
2504
|
* @description This route allows you to set or override a course submission item (file) for a user in a specific course.
|
|
2471
2505
|
*
|
|
2472
2506
|
* @tags Course
|
|
2473
|
-
* @name
|
|
2507
|
+
* @name CreateCertificationCourseDocument
|
|
2474
2508
|
* @summary Set Course Submission Item
|
|
2475
|
-
* @request
|
|
2509
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2476
2510
|
* @secure
|
|
2477
2511
|
*/
|
|
2478
|
-
|
|
2512
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: Input6Yt73Y2Qm0J, params?: RequestParams) => Promise<Output6Yt73Y2Qm0J>;
|
|
2479
2513
|
/**
|
|
2480
2514
|
* @description Delete user by ID.
|
|
2481
2515
|
*
|
|
@@ -2505,7 +2539,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2505
2539
|
* @request POST:/user/{userID}
|
|
2506
2540
|
* @secure
|
|
2507
2541
|
*/
|
|
2508
|
-
createUser: (userId: string, data:
|
|
2542
|
+
createUser: (userId: string, data: InputMvudju017X, params?: RequestParams) => Promise<any>;
|
|
2509
2543
|
/**
|
|
2510
2544
|
* @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.
|
|
2511
2545
|
*
|
|
@@ -2515,7 +2549,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2515
2549
|
* @request PUT:/user/{userID}
|
|
2516
2550
|
* @secure
|
|
2517
2551
|
*/
|
|
2518
|
-
updateUser: (userId: string, data:
|
|
2552
|
+
updateUser: (userId: string, data: InputQoo29Cdxrrf, params?: RequestParams) => Promise<any>;
|
|
2519
2553
|
/**
|
|
2520
2554
|
* @description Delete course from user
|
|
2521
2555
|
*
|
|
@@ -2535,7 +2569,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2535
2569
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2536
2570
|
* @secure
|
|
2537
2571
|
*/
|
|
2538
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2572
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputLdhu1O1Ukh>;
|
|
2539
2573
|
/**
|
|
2540
2574
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2541
2575
|
*
|
|
@@ -2545,7 +2579,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2545
2579
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2546
2580
|
* @secure
|
|
2547
2581
|
*/
|
|
2548
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2582
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputPcdo7909Xu>;
|
|
2549
2583
|
/**
|
|
2550
2584
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2551
2585
|
*
|
|
@@ -2555,7 +2589,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2555
2589
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2556
2590
|
* @secure
|
|
2557
2591
|
*/
|
|
2558
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2592
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputNjpt2Hwj7U>;
|
|
2559
2593
|
/**
|
|
2560
2594
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2561
2595
|
*
|
|
@@ -2595,7 +2629,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2595
2629
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2596
2630
|
* @secure
|
|
2597
2631
|
*/
|
|
2598
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2632
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputBl0Nmvx0Fl>;
|
|
2599
2633
|
/**
|
|
2600
2634
|
* @description This endpoint will print certificate
|
|
2601
2635
|
*
|
|
@@ -2685,7 +2719,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2685
2719
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2686
2720
|
* @secure
|
|
2687
2721
|
*/
|
|
2688
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2722
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: Input3M1P1Qx4Be, params?: RequestParams) => Promise<any>;
|
|
2689
2723
|
/**
|
|
2690
2724
|
* @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.
|
|
2691
2725
|
*
|
|
@@ -2695,7 +2729,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2695
2729
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2696
2730
|
* @secure
|
|
2697
2731
|
*/
|
|
2698
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2732
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputYbre7T2Cxe, params?: RequestParams) => Promise<any>;
|
|
2699
2733
|
/**
|
|
2700
2734
|
* @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.
|
|
2701
2735
|
*
|
|
@@ -2705,7 +2739,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2705
2739
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2706
2740
|
* @secure
|
|
2707
2741
|
*/
|
|
2708
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2742
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputA0Hnvf0Nx2, params?: RequestParams) => Promise<any>;
|
|
2709
2743
|
/**
|
|
2710
2744
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2711
2745
|
*
|
|
@@ -2715,7 +2749,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2715
2749
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2716
2750
|
* @secure
|
|
2717
2751
|
*/
|
|
2718
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2752
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputMigwi1Qi7G, params?: RequestParams) => Promise<any>;
|
|
2719
2753
|
/**
|
|
2720
2754
|
* @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.
|
|
2721
2755
|
*
|
|
@@ -2755,7 +2789,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2755
2789
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2756
2790
|
* @secure
|
|
2757
2791
|
*/
|
|
2758
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2792
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputRgdzgwaso4, params?: RequestParams) => Promise<any>;
|
|
2759
2793
|
/**
|
|
2760
2794
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
2761
2795
|
*
|
|
@@ -2765,7 +2799,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2765
2799
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2766
2800
|
* @secure
|
|
2767
2801
|
*/
|
|
2768
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2802
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<Output4I79T77Ric>;
|
|
2769
2803
|
/**
|
|
2770
2804
|
* @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.
|
|
2771
2805
|
*
|
|
@@ -2795,7 +2829,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2795
2829
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2796
2830
|
* @secure
|
|
2797
2831
|
*/
|
|
2798
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
2832
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputF0Scbkkx2H, params?: RequestParams) => Promise<any>;
|
|
2799
2833
|
/**
|
|
2800
2834
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
2801
2835
|
*
|
|
@@ -2835,7 +2869,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2835
2869
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/remove/{itemVersion}
|
|
2836
2870
|
* @secure
|
|
2837
2871
|
*/
|
|
2838
|
-
createCertificationApplicationItemRemove: (userId: string, certProcId: string, sourceId: string, itemVersion:
|
|
2872
|
+
createCertificationApplicationItemRemove: (userId: string, certProcId: string, sourceId: string, itemVersion: string, params?: RequestParams) => Promise<any>;
|
|
2839
2873
|
/**
|
|
2840
2874
|
* @description Remove a specific version of an application item for a user in a certification process.
|
|
2841
2875
|
*
|
|
@@ -2845,7 +2879,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2845
2879
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
2846
2880
|
* @secure
|
|
2847
2881
|
*/
|
|
2848
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion:
|
|
2882
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: Input4Hktu5Vloe, params?: RequestParams) => Promise<any>;
|
|
2849
2883
|
/**
|
|
2850
2884
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
2851
2885
|
*
|
|
@@ -2865,7 +2899,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2865
2899
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
2866
2900
|
* @secure
|
|
2867
2901
|
*/
|
|
2868
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
2902
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputL8Sf59Uzhm, params?: RequestParams) => Promise<any>;
|
|
2869
2903
|
/**
|
|
2870
2904
|
* @description This route allows you to submit a pending approval.
|
|
2871
2905
|
*
|
|
@@ -2875,7 +2909,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2875
2909
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
2876
2910
|
* @secure
|
|
2877
2911
|
*/
|
|
2878
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
2912
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputQuioenmjqm, params?: RequestParams) => Promise<any>;
|
|
2879
2913
|
/**
|
|
2880
2914
|
* @description This route allows you to review a pending approval.
|
|
2881
2915
|
*
|
|
@@ -2885,7 +2919,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2885
2919
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
2886
2920
|
* @secure
|
|
2887
2921
|
*/
|
|
2888
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
2922
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputG1Rfyng6Qw, params?: RequestParams) => Promise<any>;
|
|
2889
2923
|
/**
|
|
2890
2924
|
* @description Redeems a license for a user by product ID.
|
|
2891
2925
|
*
|
|
@@ -2895,7 +2929,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2895
2929
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
2896
2930
|
* @secure
|
|
2897
2931
|
*/
|
|
2898
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
2932
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputX20Gr5Dswoh, params?: RequestParams) => Promise<any>;
|
|
2899
2933
|
/**
|
|
2900
2934
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
2901
2935
|
*
|
|
@@ -2905,7 +2939,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2905
2939
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
2906
2940
|
* @secure
|
|
2907
2941
|
*/
|
|
2908
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2942
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputU05X7H42A4>;
|
|
2909
2943
|
/**
|
|
2910
2944
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
2911
2945
|
*
|
|
@@ -2915,7 +2949,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2915
2949
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
2916
2950
|
* @secure
|
|
2917
2951
|
*/
|
|
2918
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
2952
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: Input84Yzg8N851, params?: RequestParams) => Promise<any>;
|
|
2919
2953
|
/**
|
|
2920
2954
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
2921
2955
|
*
|
|
@@ -2925,7 +2959,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2925
2959
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
2926
2960
|
* @secure
|
|
2927
2961
|
*/
|
|
2928
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
2962
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputDnhk6I4Mqw, params?: RequestParams) => Promise<any>;
|
|
2929
2963
|
/**
|
|
2930
2964
|
* @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.
|
|
2931
2965
|
*
|
|
@@ -2935,7 +2969,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2935
2969
|
* @request POST:/user/{userID}/updateITA
|
|
2936
2970
|
* @secure
|
|
2937
2971
|
*/
|
|
2938
|
-
createUpdateIta: (userId: string, data:
|
|
2972
|
+
createUpdateIta: (userId: string, data: InputR5Dyvltvs4, params?: RequestParams) => Promise<any>;
|
|
2939
2973
|
/**
|
|
2940
2974
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
2941
2975
|
*
|
|
@@ -2945,7 +2979,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2945
2979
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
2946
2980
|
* @secure
|
|
2947
2981
|
*/
|
|
2948
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
2982
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputWozo5Nmr6A, params?: RequestParams) => Promise<any>;
|
|
2949
2983
|
/**
|
|
2950
2984
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
2951
2985
|
*
|
|
@@ -2955,7 +2989,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2955
2989
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
2956
2990
|
* @secure
|
|
2957
2991
|
*/
|
|
2958
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
2992
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputW9Rwp645Nq, params?: RequestParams) => Promise<any>;
|
|
2959
2993
|
};
|
|
2960
2994
|
users: {
|
|
2961
2995
|
/**
|
|
@@ -2967,6 +3001,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2967
3001
|
* @request POST:/users/certification/{certSpecID}
|
|
2968
3002
|
* @secure
|
|
2969
3003
|
*/
|
|
2970
|
-
createCertification: (certSpecId: string, data:
|
|
3004
|
+
createCertification: (certSpecId: string, data: InputSbgwv0Lrpq, params?: RequestParams) => Promise<OutputSbgwv0Lrpq>;
|
|
2971
3005
|
};
|
|
2972
3006
|
}
|