@ikonintegration/bccsa-program-api 3.0.2 → 3.0.5
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 +159 -99
- package/dist/Api.d.ts +164 -105
- package/dist/Api.js +14 -14
- package/dist/Api.js.map +1 -1
- package/package.json +3 -3
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 InputKnuumtoryb {
|
|
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 Input58N3R9D0Hlk {
|
|
453
453
|
/**
|
|
454
454
|
* ID of the certification to filter applications by
|
|
455
455
|
* @example "certification123"
|
|
@@ -506,14 +506,64 @@ export interface InputDumukbklse {
|
|
|
506
506
|
*/
|
|
507
507
|
ignoreCompletedCertifications?: boolean | null;
|
|
508
508
|
}
|
|
509
|
-
export interface
|
|
509
|
+
export interface Input2Zvokn7Zsc {
|
|
510
510
|
/**
|
|
511
511
|
* ID of the certification to filter applications by
|
|
512
512
|
* @example "certification123"
|
|
513
513
|
*/
|
|
514
514
|
certificationID: string;
|
|
515
|
+
/**
|
|
516
|
+
* Type of application, can be null or omitted
|
|
517
|
+
* @example "typeA"
|
|
518
|
+
*/
|
|
519
|
+
type?: string | null;
|
|
520
|
+
/**
|
|
521
|
+
* State of the application
|
|
522
|
+
* @example "submitted"
|
|
523
|
+
*/
|
|
524
|
+
state?: string | null;
|
|
525
|
+
/**
|
|
526
|
+
* Timestamp for the start of the submission date range
|
|
527
|
+
* @example 1672531200
|
|
528
|
+
*/
|
|
529
|
+
submittedFrom?: number | null;
|
|
530
|
+
/**
|
|
531
|
+
* Timestamp for the end of the submission date range
|
|
532
|
+
* @example 1672617600
|
|
533
|
+
*/
|
|
534
|
+
submittedTo?: number | null;
|
|
535
|
+
/**
|
|
536
|
+
* Timestamp for the start of the review date range
|
|
537
|
+
* @example 1672704000
|
|
538
|
+
*/
|
|
539
|
+
reviewedFrom?: number | null;
|
|
540
|
+
/**
|
|
541
|
+
* Timestamp for the end of the review date range
|
|
542
|
+
* @example 1672790400
|
|
543
|
+
*/
|
|
544
|
+
reviewedTo?: number | null;
|
|
545
|
+
/**
|
|
546
|
+
* Timestamp for the start of the creation date range
|
|
547
|
+
* @example 1672876800
|
|
548
|
+
*/
|
|
549
|
+
createdFrom?: number | null;
|
|
550
|
+
/**
|
|
551
|
+
* Timestamp for the end of the creation date range
|
|
552
|
+
* @example 1672963200
|
|
553
|
+
*/
|
|
554
|
+
createdTo?: number | null;
|
|
555
|
+
/**
|
|
556
|
+
* User course status, can be null or omitted. Used to filter applications based on user course status.
|
|
557
|
+
* @example "completed"
|
|
558
|
+
*/
|
|
559
|
+
userCourseStatus?: string | null;
|
|
560
|
+
/**
|
|
561
|
+
* Flag to ignore completed certifications when filtering applications. Defaults to false if not provided.
|
|
562
|
+
* @example true
|
|
563
|
+
*/
|
|
564
|
+
ignoreCompletedCertifications?: boolean | null;
|
|
515
565
|
}
|
|
516
|
-
export interface
|
|
566
|
+
export interface InputMibedikiflf {
|
|
517
567
|
/**
|
|
518
568
|
* ID of the certification to filter applications by
|
|
519
569
|
* @example "certification123"
|
|
@@ -570,7 +620,7 @@ export interface InputUq7B65Nv6O {
|
|
|
570
620
|
*/
|
|
571
621
|
ignoreCompletedCertifications?: boolean | null;
|
|
572
622
|
}
|
|
573
|
-
export interface
|
|
623
|
+
export interface Input4Jtrsbxrdn {
|
|
574
624
|
/**
|
|
575
625
|
* The ID of the certificate specifications to be used for the email
|
|
576
626
|
* @example "certSpecsID123"
|
|
@@ -611,7 +661,7 @@ export interface InputCv7Dbpazyrk {
|
|
|
611
661
|
emailAddress: string;
|
|
612
662
|
}[];
|
|
613
663
|
}
|
|
614
|
-
export interface
|
|
664
|
+
export interface InputG8Iry71He2G {
|
|
615
665
|
/**
|
|
616
666
|
* The ID of the product for which the license is being redeemed
|
|
617
667
|
* @example "productID123"
|
|
@@ -623,7 +673,7 @@ export interface InputJk3Bw1Tint {
|
|
|
623
673
|
*/
|
|
624
674
|
sessionID?: string;
|
|
625
675
|
}
|
|
626
|
-
export interface
|
|
676
|
+
export interface InputQe1Swbpk8M {
|
|
627
677
|
/**
|
|
628
678
|
* Search term to filter licenses
|
|
629
679
|
* @example "active"
|
|
@@ -640,7 +690,7 @@ export interface InputWzettp4290I {
|
|
|
640
690
|
*/
|
|
641
691
|
sortField?: any;
|
|
642
692
|
}
|
|
643
|
-
export interface
|
|
693
|
+
export interface InputI60Jg79Zrm {
|
|
644
694
|
/**
|
|
645
695
|
* Search term to filter licenses
|
|
646
696
|
* @example "active"
|
|
@@ -679,7 +729,7 @@ export interface ReportXLSXSchema {
|
|
|
679
729
|
xlsxStream: any;
|
|
680
730
|
contentType: ReportXlsxSchemaContentTypeEnum;
|
|
681
731
|
}
|
|
682
|
-
export interface
|
|
732
|
+
export interface InputC01M49Qi3N {
|
|
683
733
|
/**
|
|
684
734
|
* Start date for the report
|
|
685
735
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -701,11 +751,11 @@ export interface Input892Rn0Dcsi {
|
|
|
701
751
|
*/
|
|
702
752
|
dateType?: string;
|
|
703
753
|
}
|
|
704
|
-
export interface
|
|
754
|
+
export interface Input6Xo2Me4Iia {
|
|
705
755
|
/** List of user IDs to search for in the tenant. */
|
|
706
756
|
IDs: (string | null)[];
|
|
707
757
|
}
|
|
708
|
-
export interface
|
|
758
|
+
export interface InputMltabt6Bdi {
|
|
709
759
|
/** The term to search for in the user profiles. */
|
|
710
760
|
searchTerm?: string | null;
|
|
711
761
|
/** Filter criteria for the user search. */
|
|
@@ -745,7 +795,7 @@ export interface InputV6E8Mdcsrog {
|
|
|
745
795
|
};
|
|
746
796
|
};
|
|
747
797
|
}
|
|
748
|
-
export interface
|
|
798
|
+
export interface InputP86L56U2Wu {
|
|
749
799
|
/** The term to search for in the user profiles. */
|
|
750
800
|
searchTerm?: string | null;
|
|
751
801
|
/** Filter criteria for the user search. */
|
|
@@ -787,19 +837,19 @@ export interface InputRh1Mxhpymzi {
|
|
|
787
837
|
}
|
|
788
838
|
/** External system ID 2 */
|
|
789
839
|
export type ExternalID2 = number;
|
|
790
|
-
export interface
|
|
840
|
+
export interface OutputDqtgkultb3 {
|
|
791
841
|
/** External system ID 2 */
|
|
792
842
|
userCount: ExternalID2;
|
|
793
843
|
transactionID?: string | null;
|
|
794
844
|
}
|
|
795
|
-
export interface
|
|
845
|
+
export interface OutputW9T30Z2Vgph {
|
|
796
846
|
/**
|
|
797
847
|
* Signed URL for the course file
|
|
798
848
|
* @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"
|
|
799
849
|
*/
|
|
800
850
|
fileURL: string;
|
|
801
851
|
}
|
|
802
|
-
export interface
|
|
852
|
+
export interface OutputRoqx7Mq8Cc {
|
|
803
853
|
/**
|
|
804
854
|
* Amount to be refunded for the cancellation
|
|
805
855
|
* @example 0
|
|
@@ -1004,6 +1054,8 @@ export interface CertificationApplicationResponseEntity {
|
|
|
1004
1054
|
blacklistedItems?: string[];
|
|
1005
1055
|
};
|
|
1006
1056
|
}
|
|
1057
|
+
/** Label of the course enrolled (course version) */
|
|
1058
|
+
export type OnlineCourseLabel = string;
|
|
1007
1059
|
/** Single course object */
|
|
1008
1060
|
export interface CourseResponseEntity {
|
|
1009
1061
|
/** Timestamp of when the record was created */
|
|
@@ -1082,10 +1134,12 @@ export interface CourseResponseEntity {
|
|
|
1082
1134
|
waivedBy?: WaivedBy;
|
|
1083
1135
|
/** Date when course was waived */
|
|
1084
1136
|
waivedOn?: WaivedOn;
|
|
1137
|
+
/** Label of the course enrolled (course version) */
|
|
1138
|
+
onlineCourseLabel?: OnlineCourseLabel;
|
|
1085
1139
|
/** Justifications for overridden course restrictions */
|
|
1086
1140
|
overwrittenJustification?: OverwrittenJustification;
|
|
1087
1141
|
}
|
|
1088
|
-
export interface
|
|
1142
|
+
export interface OutputPj1Libfxjy {
|
|
1089
1143
|
/**
|
|
1090
1144
|
* Signed URL for the course file
|
|
1091
1145
|
* @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"
|
|
@@ -1103,7 +1157,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1103
1157
|
transactionID?: string | null;
|
|
1104
1158
|
}
|
|
1105
1159
|
/** Application Foreign Fill response type */
|
|
1106
|
-
export interface
|
|
1160
|
+
export interface OutputOtlb4Xkc5V {
|
|
1107
1161
|
items: {
|
|
1108
1162
|
userID: string;
|
|
1109
1163
|
createdOn?: number;
|
|
@@ -1322,7 +1376,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1322
1376
|
applicationItems?: Record<string, any>[];
|
|
1323
1377
|
transactionID?: string | null;
|
|
1324
1378
|
}
|
|
1325
|
-
export interface
|
|
1379
|
+
export interface Input910Qqt41Uy {
|
|
1326
1380
|
issuedOn?: number;
|
|
1327
1381
|
expiresOn?: number;
|
|
1328
1382
|
fileItems?: {
|
|
@@ -1331,14 +1385,14 @@ export interface InputNcjglx3Tjm {
|
|
|
1331
1385
|
}[];
|
|
1332
1386
|
additionalNotes?: string | null;
|
|
1333
1387
|
}
|
|
1334
|
-
export interface
|
|
1388
|
+
export interface Output9Lpi8Suzg4 {
|
|
1335
1389
|
/**
|
|
1336
1390
|
* Signed URL for the course file
|
|
1337
1391
|
* @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"
|
|
1338
1392
|
*/
|
|
1339
1393
|
fileURL: string;
|
|
1340
1394
|
}
|
|
1341
|
-
export interface
|
|
1395
|
+
export interface InputHrl12Mqk8D {
|
|
1342
1396
|
/**
|
|
1343
1397
|
* Indicates whether the waiver is approved
|
|
1344
1398
|
* @example true
|
|
@@ -1350,14 +1404,14 @@ export interface InputUa9Yvagjrf {
|
|
|
1350
1404
|
*/
|
|
1351
1405
|
additionalNotes?: string | null;
|
|
1352
1406
|
}
|
|
1353
|
-
export interface
|
|
1407
|
+
export interface InputU2Z4Sy5Jrk {
|
|
1354
1408
|
/**
|
|
1355
1409
|
* Optional notes regarding the waiver
|
|
1356
1410
|
* @example "Waiver granted due to special circumstances."
|
|
1357
1411
|
*/
|
|
1358
1412
|
additionalNotes?: string | null;
|
|
1359
1413
|
}
|
|
1360
|
-
export interface
|
|
1414
|
+
export interface InputKhen4Tc17I {
|
|
1361
1415
|
students: {
|
|
1362
1416
|
/**
|
|
1363
1417
|
* User ID of the student to redeem the course for
|
|
@@ -1391,7 +1445,7 @@ export interface InputNrbtc45Gm6 {
|
|
|
1391
1445
|
*/
|
|
1392
1446
|
autoEnrolSessionID?: string;
|
|
1393
1447
|
}
|
|
1394
|
-
export interface
|
|
1448
|
+
export interface InputCdlvkv26J5 {
|
|
1395
1449
|
invites: {
|
|
1396
1450
|
/**
|
|
1397
1451
|
* Email address of the user to invite
|
|
@@ -1420,7 +1474,7 @@ export interface InputClawl8Syhe {
|
|
|
1420
1474
|
*/
|
|
1421
1475
|
isReservedSeat: boolean;
|
|
1422
1476
|
}
|
|
1423
|
-
export interface
|
|
1477
|
+
export interface InputEw6Kdi4Rw5 {
|
|
1424
1478
|
/**
|
|
1425
1479
|
* Indicates whether to waive the certification process
|
|
1426
1480
|
* @example true
|
|
@@ -1433,7 +1487,7 @@ export interface Input11Ltvrwz24 {
|
|
|
1433
1487
|
comments?: string | null;
|
|
1434
1488
|
}
|
|
1435
1489
|
/** Certification move response schema */
|
|
1436
|
-
export interface
|
|
1490
|
+
export interface OutputPqbr8Nb69N {
|
|
1437
1491
|
errors?: {
|
|
1438
1492
|
status: string;
|
|
1439
1493
|
object?: Record<string, any>;
|
|
@@ -1441,19 +1495,19 @@ export interface OutputSkawtoyaw {
|
|
|
1441
1495
|
}[];
|
|
1442
1496
|
}
|
|
1443
1497
|
/** Schema for writing a certification trigger check. */
|
|
1444
|
-
export interface
|
|
1498
|
+
export interface InputV2Kmeh77Cb {
|
|
1445
1499
|
/**
|
|
1446
1500
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1447
1501
|
* @example "CHECKED"
|
|
1448
1502
|
*/
|
|
1449
|
-
value:
|
|
1503
|
+
value: InputV2Kmeh77CbValueEnum;
|
|
1450
1504
|
/**
|
|
1451
1505
|
* List of course IDs that are blocked by this trigger check.
|
|
1452
1506
|
* @example ["course1","course2"]
|
|
1453
1507
|
*/
|
|
1454
1508
|
blockedCourses?: string[];
|
|
1455
1509
|
}
|
|
1456
|
-
export interface
|
|
1510
|
+
export interface InputWhhy0Y04T4 {
|
|
1457
1511
|
/**
|
|
1458
1512
|
* Indicates whether the application item is approved
|
|
1459
1513
|
* @example true
|
|
@@ -1479,7 +1533,7 @@ export interface Input8Z0Atlua8P {
|
|
|
1479
1533
|
export interface StudentHistoryRequestSchema {
|
|
1480
1534
|
requirements: string[];
|
|
1481
1535
|
}
|
|
1482
|
-
export interface
|
|
1536
|
+
export interface Input45Mtt5Uufu {
|
|
1483
1537
|
/**
|
|
1484
1538
|
* Optional activation key for the application
|
|
1485
1539
|
* @example "AK-123456"
|
|
@@ -1487,7 +1541,7 @@ export interface InputAaqdabpog5 {
|
|
|
1487
1541
|
activationKey?: string;
|
|
1488
1542
|
}
|
|
1489
1543
|
/** Schema for course submission item details post request. */
|
|
1490
|
-
export interface
|
|
1544
|
+
export interface InputKs6L7Xdq9Sj {
|
|
1491
1545
|
/**
|
|
1492
1546
|
* The ID of the file being submitted.
|
|
1493
1547
|
* @example "fileID123"
|
|
@@ -1500,7 +1554,7 @@ export interface InputNwou315U97 {
|
|
|
1500
1554
|
fileName: string;
|
|
1501
1555
|
}
|
|
1502
1556
|
/** Schema for the response to course submission item details post request. */
|
|
1503
|
-
export interface
|
|
1557
|
+
export interface OutputKs6L7Xdq9Sj {
|
|
1504
1558
|
submissionItems: {
|
|
1505
1559
|
/**
|
|
1506
1560
|
* The ID of the file being submitted.
|
|
@@ -1515,7 +1569,7 @@ export interface OutputNwou315U97 {
|
|
|
1515
1569
|
}[];
|
|
1516
1570
|
}
|
|
1517
1571
|
/** Pending approval submission parameters */
|
|
1518
|
-
export interface
|
|
1572
|
+
export interface InputOf3Htunvpd {
|
|
1519
1573
|
/**
|
|
1520
1574
|
* Type of pending approval
|
|
1521
1575
|
* @example "certification"
|
|
@@ -1535,7 +1589,7 @@ export interface InputBa5J0Xro42 {
|
|
|
1535
1589
|
fileName: string;
|
|
1536
1590
|
}[];
|
|
1537
1591
|
}
|
|
1538
|
-
export interface
|
|
1592
|
+
export interface InputDvfjpfaioq {
|
|
1539
1593
|
/**
|
|
1540
1594
|
* The ID of the course for which the license is being redeemed
|
|
1541
1595
|
* @example "courseID123"
|
|
@@ -1596,9 +1650,14 @@ export interface InputSm8Kytz15Q {
|
|
|
1596
1650
|
* @example "autoEnrolSessionID678"
|
|
1597
1651
|
*/
|
|
1598
1652
|
autoEnrolSessionID?: string | null;
|
|
1653
|
+
/**
|
|
1654
|
+
* The response to the acknowledgement of terms or conditions
|
|
1655
|
+
* @example "Accepted"
|
|
1656
|
+
*/
|
|
1657
|
+
acknowledgement?: string | null;
|
|
1599
1658
|
}
|
|
1600
1659
|
/** Validate certification move response schema */
|
|
1601
|
-
export interface
|
|
1660
|
+
export interface Output00U8E0Orpf {
|
|
1602
1661
|
courses: {
|
|
1603
1662
|
name: string;
|
|
1604
1663
|
status: string;
|
|
@@ -1609,21 +1668,21 @@ export interface OutputUhpj06T58M {
|
|
|
1609
1668
|
validated: boolean;
|
|
1610
1669
|
mustCreateCP: boolean;
|
|
1611
1670
|
}
|
|
1612
|
-
export interface
|
|
1671
|
+
export interface InputFl5R2Mdg95I {
|
|
1613
1672
|
/**
|
|
1614
1673
|
* Comments regarding the end of the cooldown period
|
|
1615
1674
|
* @example "Cooldown period ended successfully."
|
|
1616
1675
|
*/
|
|
1617
1676
|
comments: string;
|
|
1618
1677
|
}
|
|
1619
|
-
export interface
|
|
1678
|
+
export interface Output3Ouk2Vvxz1 {
|
|
1620
1679
|
/**
|
|
1621
1680
|
* Signed URL for the course file
|
|
1622
1681
|
* @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"
|
|
1623
1682
|
*/
|
|
1624
1683
|
fileURL: string;
|
|
1625
1684
|
}
|
|
1626
|
-
export interface
|
|
1685
|
+
export interface InputIeabvj9Veq {
|
|
1627
1686
|
/** @example true */
|
|
1628
1687
|
agreedWithCertTerms: boolean;
|
|
1629
1688
|
/** @example 1717230000000 */
|
|
@@ -1695,21 +1754,21 @@ export interface InputSlux1Wdv32 {
|
|
|
1695
1754
|
/** @example "EXT#999" */
|
|
1696
1755
|
externalID2?: string | null;
|
|
1697
1756
|
}
|
|
1698
|
-
export interface
|
|
1757
|
+
export interface InputJ5Qctb4Y7E {
|
|
1699
1758
|
/**
|
|
1700
1759
|
* Comments regarding the course unlock action
|
|
1701
1760
|
* @example "Course unlocked successfully."
|
|
1702
1761
|
*/
|
|
1703
1762
|
comments: string;
|
|
1704
1763
|
}
|
|
1705
|
-
export interface
|
|
1764
|
+
export interface InputKm2206Jv5A {
|
|
1706
1765
|
/**
|
|
1707
1766
|
* ITA number to update for the user
|
|
1708
1767
|
* @example "ITA123456"
|
|
1709
1768
|
*/
|
|
1710
1769
|
itaNumber: string;
|
|
1711
1770
|
}
|
|
1712
|
-
export interface
|
|
1771
|
+
export interface Input1Gx25Yczit {
|
|
1713
1772
|
/** @example true */
|
|
1714
1773
|
agreedWithCertTerms: boolean;
|
|
1715
1774
|
/** @example 1717230000000 */
|
|
@@ -1781,7 +1840,7 @@ export interface InputE8Hrkb3574 {
|
|
|
1781
1840
|
/** @example "EXT#999" */
|
|
1782
1841
|
externalID2?: string | null;
|
|
1783
1842
|
}
|
|
1784
|
-
export interface
|
|
1843
|
+
export interface InputCombt1Tfcq {
|
|
1785
1844
|
/**
|
|
1786
1845
|
* The grade to override the course result with
|
|
1787
1846
|
* @example "A"
|
|
@@ -1789,7 +1848,7 @@ export interface Input07W55Khdfh {
|
|
|
1789
1848
|
resultGrade: string;
|
|
1790
1849
|
}
|
|
1791
1850
|
/** Pending approval review parameters */
|
|
1792
|
-
export interface
|
|
1851
|
+
export interface InputQ55Qauxwcw {
|
|
1793
1852
|
/**
|
|
1794
1853
|
* Notes provided by the reviewer for the pending approval
|
|
1795
1854
|
* @example "Please review the submitted documents."
|
|
@@ -1802,7 +1861,7 @@ export interface InputIsb9Rfgqkbh {
|
|
|
1802
1861
|
approved: boolean;
|
|
1803
1862
|
}
|
|
1804
1863
|
/** Schema for overriding course result dates. */
|
|
1805
|
-
export interface
|
|
1864
|
+
export interface InputToiyqfdk2I {
|
|
1806
1865
|
/**
|
|
1807
1866
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1808
1867
|
* @example 1735689600000
|
|
@@ -1814,14 +1873,14 @@ export interface Input1Vc8C8B4Ug {
|
|
|
1814
1873
|
*/
|
|
1815
1874
|
completionDate?: number;
|
|
1816
1875
|
}
|
|
1817
|
-
export interface
|
|
1876
|
+
export interface Input46O2J2Jyav {
|
|
1818
1877
|
filter: {
|
|
1819
1878
|
from?: number;
|
|
1820
1879
|
sortOrder?: string;
|
|
1821
1880
|
sortField?: string;
|
|
1822
1881
|
};
|
|
1823
1882
|
}
|
|
1824
|
-
export interface
|
|
1883
|
+
export interface Output46O2J2Jyav {
|
|
1825
1884
|
users: {
|
|
1826
1885
|
firstName: string;
|
|
1827
1886
|
lastName: string;
|
|
@@ -1841,7 +1900,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
1841
1900
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1842
1901
|
* @example "CHECKED"
|
|
1843
1902
|
*/
|
|
1844
|
-
export declare enum
|
|
1903
|
+
export declare enum InputV2Kmeh77CbValueEnum {
|
|
1845
1904
|
CHECKED = "CHECKED",
|
|
1846
1905
|
UNCHECKED = "UNCHECKED",
|
|
1847
1906
|
NOVALUE = "NOVALUE"
|
|
@@ -1932,7 +1991,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
1932
1991
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
1933
1992
|
export type CreateReportUsersSimpleData = any;
|
|
1934
1993
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
1935
|
-
export type CreateSearchUsersCountData =
|
|
1994
|
+
export type CreateSearchUsersCountData = OutputDqtgkultb3;
|
|
1936
1995
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
1937
1996
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
1938
1997
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -1950,7 +2009,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
1950
2009
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
1951
2010
|
export type DeleteCertificationCourseFileSignData = any;
|
|
1952
2011
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
1953
|
-
export type GetCertificationCourseFileSignData =
|
|
2012
|
+
export type GetCertificationCourseFileSignData = OutputPj1Libfxjy;
|
|
1954
2013
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
1955
2014
|
export interface CreateCertificationCourseFileSignParams {
|
|
1956
2015
|
/** @example "pdf" */
|
|
@@ -1964,12 +2023,12 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
1964
2023
|
/** @example "fileID" */
|
|
1965
2024
|
fileId: string;
|
|
1966
2025
|
}
|
|
1967
|
-
export type CreateCertificationCourseFileSignData =
|
|
2026
|
+
export type CreateCertificationCourseFileSignData = Output3Ouk2Vvxz1;
|
|
1968
2027
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
1969
2028
|
export type DeleteCertificationCourseDocumentData = any;
|
|
1970
2029
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
1971
|
-
export type
|
|
1972
|
-
export type
|
|
2030
|
+
export type CreateCertificationCourseDocumentData = OutputKs6L7Xdq9Sj;
|
|
2031
|
+
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
1973
2032
|
export type DeleteUserData = any;
|
|
1974
2033
|
export type DeleteUserError = ErrorResponse;
|
|
1975
2034
|
export type GetUserResult = UserResponseEntity;
|
|
@@ -1980,7 +2039,7 @@ export type UpdateUserData = any;
|
|
|
1980
2039
|
export type UpdateUserError = ErrorResponse;
|
|
1981
2040
|
export type DeleteCertificationCourseData = any;
|
|
1982
2041
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
1983
|
-
export type GetCertificationApplicationItemFileData =
|
|
2042
|
+
export type GetCertificationApplicationItemFileData = OutputW9T30Z2Vgph;
|
|
1984
2043
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
1985
2044
|
export interface CreateCertificationApplicationItemFileParams {
|
|
1986
2045
|
/** @example "pdf" */
|
|
@@ -1994,9 +2053,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
1994
2053
|
/** @example "fileVersion" */
|
|
1995
2054
|
fileVersion: string;
|
|
1996
2055
|
}
|
|
1997
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2056
|
+
export type CreateCertificationApplicationItemFileData = Output9Lpi8Suzg4;
|
|
1998
2057
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
1999
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2058
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputRoqx7Mq8Cc;
|
|
2000
2059
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2001
2060
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2002
2061
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2004,7 +2063,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2004
2063
|
export type GetCourseError = ErrorResponse;
|
|
2005
2064
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2006
2065
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2007
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2066
|
+
export type GetCertificationApplicationForeignFillData = OutputOtlb4Xkc5V;
|
|
2008
2067
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2009
2068
|
export type GetCertificationPrintData = any;
|
|
2010
2069
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2038,7 +2097,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2038
2097
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2039
2098
|
export type CreateCertificationWaiveData = any;
|
|
2040
2099
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2041
|
-
export type CreateCertificationMoveData =
|
|
2100
|
+
export type CreateCertificationMoveData = OutputPqbr8Nb69N;
|
|
2042
2101
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2043
2102
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2044
2103
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2066,7 +2125,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2066
2125
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2067
2126
|
export type CreateCertificationCourseRedeemData = any;
|
|
2068
2127
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2069
|
-
export type CreateCertificationMoveValidateData =
|
|
2128
|
+
export type CreateCertificationMoveValidateData = Output00U8E0Orpf;
|
|
2070
2129
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2071
2130
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2072
2131
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2078,7 +2137,7 @@ export type UpdateCertificationCourseOverrideResultData = any;
|
|
|
2078
2137
|
export type UpdateCertificationCourseOverrideResultError = ErrorResponse;
|
|
2079
2138
|
export type UpdateCertificationSetDatesData = any;
|
|
2080
2139
|
export type UpdateCertificationSetDatesError = ErrorResponse;
|
|
2081
|
-
export type CreateCertificationResult =
|
|
2140
|
+
export type CreateCertificationResult = Output46O2J2Jyav;
|
|
2082
2141
|
export type CreateCertificationFail = ErrorResponse;
|
|
2083
2142
|
import type { AxiosInstance, AxiosRequestConfig, ResponseType } from 'axios';
|
|
2084
2143
|
export type QueryParamsType = Record<string | number, any>;
|
|
@@ -2123,7 +2182,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2123
2182
|
}
|
|
2124
2183
|
/**
|
|
2125
2184
|
* @title BCCSA Program API
|
|
2126
|
-
* @version 3.0.
|
|
2185
|
+
* @version 3.0.5
|
|
2127
2186
|
* @baseUrl http://localhost:8080
|
|
2128
2187
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2129
2188
|
*/
|
|
@@ -2138,7 +2197,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2138
2197
|
* @request POST:/contactUs
|
|
2139
2198
|
* @secure
|
|
2140
2199
|
*/
|
|
2141
|
-
listContactUs: (data:
|
|
2200
|
+
listContactUs: (data: InputKnuumtoryb, params?: RequestParams) => Promise<any>;
|
|
2142
2201
|
};
|
|
2143
2202
|
customer: {
|
|
2144
2203
|
/**
|
|
@@ -2242,7 +2301,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2242
2301
|
* @request POST:/tenant/report/applicationExport
|
|
2243
2302
|
* @secure
|
|
2244
2303
|
*/
|
|
2245
|
-
createReportApplicationExport: (data:
|
|
2304
|
+
createReportApplicationExport: (data: Input58N3R9D0Hlk, params?: RequestParams) => Promise<any>;
|
|
2246
2305
|
/**
|
|
2247
2306
|
* @description Export a report of applications based on the provided filters.
|
|
2248
2307
|
*
|
|
@@ -2252,7 +2311,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2252
2311
|
* @request POST:/tenant/report/applicationStatus
|
|
2253
2312
|
* @secure
|
|
2254
2313
|
*/
|
|
2255
|
-
listReportApplicationStatus: (data:
|
|
2314
|
+
listReportApplicationStatus: (data: Input2Zvokn7Zsc, params?: RequestParams) => Promise<any>;
|
|
2256
2315
|
/**
|
|
2257
2316
|
* @description Export a report of applications based on the provided filters.
|
|
2258
2317
|
*
|
|
@@ -2262,7 +2321,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2262
2321
|
* @request POST:/tenant/report/applicationsReport
|
|
2263
2322
|
* @secure
|
|
2264
2323
|
*/
|
|
2265
|
-
createReportApplicationsReport: (data:
|
|
2324
|
+
createReportApplicationsReport: (data: InputMibedikiflf, params?: RequestParams) => Promise<any>;
|
|
2266
2325
|
/**
|
|
2267
2326
|
* @description This route allows you to post certificates email for the tenant.
|
|
2268
2327
|
*
|
|
@@ -2272,7 +2331,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2272
2331
|
* @request POST:/tenant/certificates/email
|
|
2273
2332
|
* @secure
|
|
2274
2333
|
*/
|
|
2275
|
-
createCertificatesEmail: (data:
|
|
2334
|
+
createCertificatesEmail: (data: Input4Jtrsbxrdn, params?: RequestParams) => Promise<any>;
|
|
2276
2335
|
/**
|
|
2277
2336
|
* @description Generate a preview of the completed certifications report.
|
|
2278
2337
|
*
|
|
@@ -2302,7 +2361,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2302
2361
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2303
2362
|
* @secure
|
|
2304
2363
|
*/
|
|
2305
|
-
createLicenseRedeem: (userId: string, data:
|
|
2364
|
+
createLicenseRedeem: (userId: string, data: InputG8Iry71He2G, params?: RequestParams) => Promise<any>;
|
|
2306
2365
|
/**
|
|
2307
2366
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2308
2367
|
*
|
|
@@ -2312,7 +2371,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2312
2371
|
* @request POST:/tenant/report/orglicenses/
|
|
2313
2372
|
* @secure
|
|
2314
2373
|
*/
|
|
2315
|
-
listReportOrglicenses: (data:
|
|
2374
|
+
listReportOrglicenses: (data: InputQe1Swbpk8M, params?: RequestParams) => Promise<any>;
|
|
2316
2375
|
/**
|
|
2317
2376
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2318
2377
|
*
|
|
@@ -2322,7 +2381,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2322
2381
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2323
2382
|
* @secure
|
|
2324
2383
|
*/
|
|
2325
|
-
createReportOrglicensesPreview: (data:
|
|
2384
|
+
createReportOrglicensesPreview: (data: InputI60Jg79Zrm, params?: RequestParams) => Promise<any>;
|
|
2326
2385
|
/**
|
|
2327
2386
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2328
2387
|
*
|
|
@@ -2342,7 +2401,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2342
2401
|
* @request POST:/tenant/report/users/advanced
|
|
2343
2402
|
* @secure
|
|
2344
2403
|
*/
|
|
2345
|
-
createReportUsersAdvanced: (data:
|
|
2404
|
+
createReportUsersAdvanced: (data: InputC01M49Qi3N, params?: RequestParams) => Promise<any>;
|
|
2346
2405
|
/**
|
|
2347
2406
|
* @description Searches for users in the tenant by their IDs.
|
|
2348
2407
|
*
|
|
@@ -2352,7 +2411,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2352
2411
|
* @request POST:/tenant/search/users/ids
|
|
2353
2412
|
* @secure
|
|
2354
2413
|
*/
|
|
2355
|
-
listSearchUsersIds: (data:
|
|
2414
|
+
listSearchUsersIds: (data: Input6Xo2Me4Iia, params?: RequestParams) => Promise<any>;
|
|
2356
2415
|
/**
|
|
2357
2416
|
* @description Searches for users in the tenant by term and filters.
|
|
2358
2417
|
*
|
|
@@ -2362,7 +2421,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2362
2421
|
* @request POST:/tenant/search/users/term
|
|
2363
2422
|
* @secure
|
|
2364
2423
|
*/
|
|
2365
|
-
createSearchUsersTerm: (data:
|
|
2424
|
+
createSearchUsersTerm: (data: InputMltabt6Bdi, params?: RequestParams) => Promise<any>;
|
|
2366
2425
|
/**
|
|
2367
2426
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2368
2427
|
*
|
|
@@ -2372,7 +2431,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2372
2431
|
* @request POST:/tenant/report/users/simple
|
|
2373
2432
|
* @secure
|
|
2374
2433
|
*/
|
|
2375
|
-
createReportUsersSimple: (data:
|
|
2434
|
+
createReportUsersSimple: (data: InputP86L56U2Wu, params?: RequestParams) => Promise<any>;
|
|
2376
2435
|
/**
|
|
2377
2436
|
* @description Retrieve user by ID.
|
|
2378
2437
|
*
|
|
@@ -2382,7 +2441,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2382
2441
|
* @request POST:/tenant/search/users/count
|
|
2383
2442
|
* @secure
|
|
2384
2443
|
*/
|
|
2385
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2444
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputDqtgkultb3>;
|
|
2386
2445
|
};
|
|
2387
2446
|
user: {
|
|
2388
2447
|
/**
|
|
@@ -2414,7 +2473,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2414
2473
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2415
2474
|
* @secure
|
|
2416
2475
|
*/
|
|
2417
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2476
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: Input910Qqt41Uy, params?: RequestParams) => Promise<any>;
|
|
2418
2477
|
/**
|
|
2419
2478
|
* @description Delete a certification process application by type.
|
|
2420
2479
|
*
|
|
@@ -2474,7 +2533,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2474
2533
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2475
2534
|
* @secure
|
|
2476
2535
|
*/
|
|
2477
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2536
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputPj1Libfxjy>;
|
|
2478
2537
|
/**
|
|
2479
2538
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2480
2539
|
*
|
|
@@ -2484,7 +2543,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2484
2543
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2485
2544
|
* @secure
|
|
2486
2545
|
*/
|
|
2487
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2546
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<Output3Ouk2Vvxz1>;
|
|
2488
2547
|
/**
|
|
2489
2548
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2490
2549
|
*
|
|
@@ -2499,12 +2558,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2499
2558
|
* @description This route allows you to set or override a course submission item (file) for a user in a specific course.
|
|
2500
2559
|
*
|
|
2501
2560
|
* @tags Course
|
|
2502
|
-
* @name
|
|
2561
|
+
* @name CreateCertificationCourseDocument
|
|
2503
2562
|
* @summary Set Course Submission Item
|
|
2504
|
-
* @request
|
|
2563
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2505
2564
|
* @secure
|
|
2506
2565
|
*/
|
|
2507
|
-
|
|
2566
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputKs6L7Xdq9Sj, params?: RequestParams) => Promise<OutputKs6L7Xdq9Sj>;
|
|
2508
2567
|
/**
|
|
2509
2568
|
* @description Delete user by ID.
|
|
2510
2569
|
*
|
|
@@ -2534,7 +2593,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2534
2593
|
* @request POST:/user/{userID}
|
|
2535
2594
|
* @secure
|
|
2536
2595
|
*/
|
|
2537
|
-
createUser: (userId: string, data:
|
|
2596
|
+
createUser: (userId: string, data: InputIeabvj9Veq, params?: RequestParams) => Promise<any>;
|
|
2538
2597
|
/**
|
|
2539
2598
|
* @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.
|
|
2540
2599
|
*
|
|
@@ -2544,7 +2603,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2544
2603
|
* @request PUT:/user/{userID}
|
|
2545
2604
|
* @secure
|
|
2546
2605
|
*/
|
|
2547
|
-
updateUser: (userId: string, data:
|
|
2606
|
+
updateUser: (userId: string, data: Input1Gx25Yczit, params?: RequestParams) => Promise<any>;
|
|
2548
2607
|
/**
|
|
2549
2608
|
* @description Delete course from user
|
|
2550
2609
|
*
|
|
@@ -2556,7 +2615,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2556
2615
|
*/
|
|
2557
2616
|
deleteCertificationCourse: (userId: string, certProcId: string, courseId: string, params?: RequestParams) => Promise<any>;
|
|
2558
2617
|
/**
|
|
2559
|
-
* @description
|
|
2618
|
+
* @description Generate a signed url to download a specific file version of an application item for a user in a certification process.
|
|
2560
2619
|
*
|
|
2561
2620
|
* @tags Application
|
|
2562
2621
|
* @name GetCertificationApplicationItemFile
|
|
@@ -2564,7 +2623,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2564
2623
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2565
2624
|
* @secure
|
|
2566
2625
|
*/
|
|
2567
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2626
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputW9T30Z2Vgph>;
|
|
2568
2627
|
/**
|
|
2569
2628
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2570
2629
|
*
|
|
@@ -2574,7 +2633,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2574
2633
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2575
2634
|
* @secure
|
|
2576
2635
|
*/
|
|
2577
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2636
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<Output9Lpi8Suzg4>;
|
|
2578
2637
|
/**
|
|
2579
2638
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2580
2639
|
*
|
|
@@ -2584,7 +2643,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2584
2643
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2585
2644
|
* @secure
|
|
2586
2645
|
*/
|
|
2587
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2646
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputRoqx7Mq8Cc>;
|
|
2588
2647
|
/**
|
|
2589
2648
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2590
2649
|
*
|
|
@@ -2624,7 +2683,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2624
2683
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2625
2684
|
* @secure
|
|
2626
2685
|
*/
|
|
2627
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2686
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputOtlb4Xkc5V>;
|
|
2628
2687
|
/**
|
|
2629
2688
|
* @description This endpoint will print certificate
|
|
2630
2689
|
*
|
|
@@ -2714,7 +2773,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2714
2773
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2715
2774
|
* @secure
|
|
2716
2775
|
*/
|
|
2717
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2776
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputHrl12Mqk8D, params?: RequestParams) => Promise<any>;
|
|
2718
2777
|
/**
|
|
2719
2778
|
* @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.
|
|
2720
2779
|
*
|
|
@@ -2724,7 +2783,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2724
2783
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2725
2784
|
* @secure
|
|
2726
2785
|
*/
|
|
2727
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2786
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputU2Z4Sy5Jrk, params?: RequestParams) => Promise<any>;
|
|
2728
2787
|
/**
|
|
2729
2788
|
* @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.
|
|
2730
2789
|
*
|
|
@@ -2734,7 +2793,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2734
2793
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2735
2794
|
* @secure
|
|
2736
2795
|
*/
|
|
2737
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2796
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputKhen4Tc17I, params?: RequestParams) => Promise<any>;
|
|
2738
2797
|
/**
|
|
2739
2798
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2740
2799
|
*
|
|
@@ -2744,7 +2803,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2744
2803
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2745
2804
|
* @secure
|
|
2746
2805
|
*/
|
|
2747
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2806
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputCdlvkv26J5, params?: RequestParams) => Promise<any>;
|
|
2748
2807
|
/**
|
|
2749
2808
|
* @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.
|
|
2750
2809
|
*
|
|
@@ -2784,7 +2843,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2784
2843
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2785
2844
|
* @secure
|
|
2786
2845
|
*/
|
|
2787
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2846
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputEw6Kdi4Rw5, params?: RequestParams) => Promise<any>;
|
|
2788
2847
|
/**
|
|
2789
2848
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
2790
2849
|
*
|
|
@@ -2794,7 +2853,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2794
2853
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2795
2854
|
* @secure
|
|
2796
2855
|
*/
|
|
2797
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2856
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputPqbr8Nb69N>;
|
|
2798
2857
|
/**
|
|
2799
2858
|
* @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.
|
|
2800
2859
|
*
|
|
@@ -2804,7 +2863,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2804
2863
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/replace/{secUserID}
|
|
2805
2864
|
* @secure
|
|
2806
2865
|
*/
|
|
2807
|
-
createCertificationCourseSessionReplace: (userId: string, certProcId: string,
|
|
2866
|
+
createCertificationCourseSessionReplace: (userId: string, certProcId: string, courseId: string, sessionId: string, secUserId: string, params?: RequestParams) => Promise<any>;
|
|
2808
2867
|
/**
|
|
2809
2868
|
* @description This route allows you to set a trigger check for a certification process, such as blocking courses.
|
|
2810
2869
|
*
|
|
@@ -2824,7 +2883,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2824
2883
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2825
2884
|
* @secure
|
|
2826
2885
|
*/
|
|
2827
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
2886
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputV2Kmeh77Cb, params?: RequestParams) => Promise<any>;
|
|
2828
2887
|
/**
|
|
2829
2888
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
2830
2889
|
*
|
|
@@ -2874,7 +2933,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2874
2933
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
2875
2934
|
* @secure
|
|
2876
2935
|
*/
|
|
2877
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
2936
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: InputWhhy0Y04T4, params?: RequestParams) => Promise<any>;
|
|
2878
2937
|
/**
|
|
2879
2938
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
2880
2939
|
*
|
|
@@ -2894,7 +2953,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2894
2953
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
2895
2954
|
* @secure
|
|
2896
2955
|
*/
|
|
2897
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
2956
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: Input45Mtt5Uufu, params?: RequestParams) => Promise<any>;
|
|
2898
2957
|
/**
|
|
2899
2958
|
* @description This route allows you to submit a pending approval.
|
|
2900
2959
|
*
|
|
@@ -2904,7 +2963,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2904
2963
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
2905
2964
|
* @secure
|
|
2906
2965
|
*/
|
|
2907
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
2966
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputOf3Htunvpd, params?: RequestParams) => Promise<any>;
|
|
2908
2967
|
/**
|
|
2909
2968
|
* @description This route allows you to review a pending approval.
|
|
2910
2969
|
*
|
|
@@ -2914,7 +2973,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2914
2973
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
2915
2974
|
* @secure
|
|
2916
2975
|
*/
|
|
2917
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
2976
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputQ55Qauxwcw, params?: RequestParams) => Promise<any>;
|
|
2918
2977
|
/**
|
|
2919
2978
|
* @description Redeems a license for a user by product ID.
|
|
2920
2979
|
*
|
|
@@ -2924,7 +2983,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2924
2983
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
2925
2984
|
* @secure
|
|
2926
2985
|
*/
|
|
2927
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
2986
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputDvfjpfaioq, params?: RequestParams) => Promise<any>;
|
|
2928
2987
|
/**
|
|
2929
2988
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
2930
2989
|
*
|
|
@@ -2934,7 +2993,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2934
2993
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
2935
2994
|
* @secure
|
|
2936
2995
|
*/
|
|
2937
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2996
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<Output00U8E0Orpf>;
|
|
2938
2997
|
/**
|
|
2939
2998
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
2940
2999
|
*
|
|
@@ -2944,7 +3003,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2944
3003
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
2945
3004
|
* @secure
|
|
2946
3005
|
*/
|
|
2947
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3006
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputFl5R2Mdg95I, params?: RequestParams) => Promise<any>;
|
|
2948
3007
|
/**
|
|
2949
3008
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
2950
3009
|
*
|
|
@@ -2954,7 +3013,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2954
3013
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
2955
3014
|
* @secure
|
|
2956
3015
|
*/
|
|
2957
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3016
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputJ5Qctb4Y7E, params?: RequestParams) => Promise<any>;
|
|
2958
3017
|
/**
|
|
2959
3018
|
* @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.
|
|
2960
3019
|
*
|
|
@@ -2964,7 +3023,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2964
3023
|
* @request POST:/user/{userID}/updateITA
|
|
2965
3024
|
* @secure
|
|
2966
3025
|
*/
|
|
2967
|
-
createUpdateIta: (userId: string, data:
|
|
3026
|
+
createUpdateIta: (userId: string, data: InputKm2206Jv5A, params?: RequestParams) => Promise<any>;
|
|
2968
3027
|
/**
|
|
2969
3028
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
2970
3029
|
*
|
|
@@ -2974,7 +3033,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2974
3033
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
2975
3034
|
* @secure
|
|
2976
3035
|
*/
|
|
2977
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3036
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputCombt1Tfcq, params?: RequestParams) => Promise<any>;
|
|
2978
3037
|
/**
|
|
2979
3038
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
2980
3039
|
*
|
|
@@ -2984,7 +3043,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2984
3043
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
2985
3044
|
* @secure
|
|
2986
3045
|
*/
|
|
2987
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3046
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputToiyqfdk2I, params?: RequestParams) => Promise<any>;
|
|
2988
3047
|
};
|
|
2989
3048
|
users: {
|
|
2990
3049
|
/**
|
|
@@ -2996,6 +3055,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2996
3055
|
* @request POST:/users/certification/{certSpecID}
|
|
2997
3056
|
* @secure
|
|
2998
3057
|
*/
|
|
2999
|
-
createCertification: (certSpecId: string, data:
|
|
3058
|
+
createCertification: (certSpecId: string, data: Input46O2J2Jyav, params?: RequestParams) => Promise<Output46O2J2Jyav>;
|
|
3000
3059
|
};
|
|
3001
3060
|
}
|