@ikonintegration/bccsa-program-api 3.0.3 → 3.0.8
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 +192 -93
- package/dist/Api.d.ts +186 -102
- package/dist/Api.js +23 -10
- 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 InputUdqbjoikg8 {
|
|
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 InputXpq62Ascd0K {
|
|
453
453
|
/**
|
|
454
454
|
* ID of the certification to filter applications by
|
|
455
455
|
* @example "certification123"
|
|
@@ -506,14 +506,64 @@ export interface InputZ6Pi8Vxh7M {
|
|
|
506
506
|
*/
|
|
507
507
|
ignoreCompletedCertifications?: boolean | null;
|
|
508
508
|
}
|
|
509
|
-
export interface
|
|
509
|
+
export interface InputXe2F8Lrpl3 {
|
|
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 InputZ5Zaihx1N8 {
|
|
517
567
|
/**
|
|
518
568
|
* ID of the certification to filter applications by
|
|
519
569
|
* @example "certification123"
|
|
@@ -570,7 +620,7 @@ export interface InputOv5Fi8V7Spg {
|
|
|
570
620
|
*/
|
|
571
621
|
ignoreCompletedCertifications?: boolean | null;
|
|
572
622
|
}
|
|
573
|
-
export interface
|
|
623
|
+
export interface Input7Dzemgbd5M {
|
|
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 InputBkk90S004W {
|
|
|
611
661
|
emailAddress: string;
|
|
612
662
|
}[];
|
|
613
663
|
}
|
|
614
|
-
export interface
|
|
664
|
+
export interface InputLcxw15F7Bp {
|
|
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 InputX2C1K65Gifl {
|
|
|
623
673
|
*/
|
|
624
674
|
sessionID?: string;
|
|
625
675
|
}
|
|
626
|
-
export interface
|
|
676
|
+
export interface InputO43S8Hm8Eqj {
|
|
627
677
|
/**
|
|
628
678
|
* Search term to filter licenses
|
|
629
679
|
* @example "active"
|
|
@@ -640,7 +690,7 @@ export interface Input2Wsk314Pl5 {
|
|
|
640
690
|
*/
|
|
641
691
|
sortField?: any;
|
|
642
692
|
}
|
|
643
|
-
export interface
|
|
693
|
+
export interface Input3Jh4Kbfsj7 {
|
|
644
694
|
/**
|
|
645
695
|
* Search term to filter licenses
|
|
646
696
|
* @example "active"
|
|
@@ -674,12 +724,28 @@ export interface NcsoReportRequestSchema {
|
|
|
674
724
|
hideExpired?: boolean;
|
|
675
725
|
};
|
|
676
726
|
}
|
|
727
|
+
/** Filters offered for NCSO export report */
|
|
728
|
+
export interface NcsoReportExportRequestSchema {
|
|
729
|
+
certifications: {
|
|
730
|
+
name: string;
|
|
731
|
+
email?: string;
|
|
732
|
+
city?: string;
|
|
733
|
+
phone?: string;
|
|
734
|
+
originalCompletionDate?: number;
|
|
735
|
+
completionDate?: number;
|
|
736
|
+
expiryDate?: number;
|
|
737
|
+
status?: string;
|
|
738
|
+
hasOtherCertifications?: boolean;
|
|
739
|
+
notes?: string;
|
|
740
|
+
listedOnWebsite?: boolean;
|
|
741
|
+
}[];
|
|
742
|
+
}
|
|
677
743
|
/** Report export as xlsx */
|
|
678
744
|
export interface ReportXLSXSchema {
|
|
679
745
|
xlsxStream: any;
|
|
680
746
|
contentType: ReportXlsxSchemaContentTypeEnum;
|
|
681
747
|
}
|
|
682
|
-
export interface
|
|
748
|
+
export interface InputBv0Jn7Awf6 {
|
|
683
749
|
/**
|
|
684
750
|
* Start date for the report
|
|
685
751
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -701,11 +767,11 @@ export interface InputYq50Sx0V4B {
|
|
|
701
767
|
*/
|
|
702
768
|
dateType?: string;
|
|
703
769
|
}
|
|
704
|
-
export interface
|
|
770
|
+
export interface Input15Sft3Rbpo {
|
|
705
771
|
/** List of user IDs to search for in the tenant. */
|
|
706
772
|
IDs: (string | null)[];
|
|
707
773
|
}
|
|
708
|
-
export interface
|
|
774
|
+
export interface Input3Ysqkyuvrdk {
|
|
709
775
|
/** The term to search for in the user profiles. */
|
|
710
776
|
searchTerm?: string | null;
|
|
711
777
|
/** Filter criteria for the user search. */
|
|
@@ -745,7 +811,7 @@ export interface InputO4A7I6Erux {
|
|
|
745
811
|
};
|
|
746
812
|
};
|
|
747
813
|
}
|
|
748
|
-
export interface
|
|
814
|
+
export interface Input2Vykd1Irlu {
|
|
749
815
|
/** The term to search for in the user profiles. */
|
|
750
816
|
searchTerm?: string | null;
|
|
751
817
|
/** Filter criteria for the user search. */
|
|
@@ -787,19 +853,19 @@ export interface InputAvxn578Ayl {
|
|
|
787
853
|
}
|
|
788
854
|
/** External system ID 2 */
|
|
789
855
|
export type ExternalID2 = number;
|
|
790
|
-
export interface
|
|
856
|
+
export interface OutputQqseh88M7Y {
|
|
791
857
|
/** External system ID 2 */
|
|
792
858
|
userCount: ExternalID2;
|
|
793
859
|
transactionID?: string | null;
|
|
794
860
|
}
|
|
795
|
-
export interface
|
|
861
|
+
export interface OutputSgogrr5Tu1 {
|
|
796
862
|
/**
|
|
797
863
|
* Signed URL for the course file
|
|
798
864
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
799
865
|
*/
|
|
800
866
|
fileURL: string;
|
|
801
867
|
}
|
|
802
|
-
export interface
|
|
868
|
+
export interface OutputW7Nmjwguf3 {
|
|
803
869
|
/**
|
|
804
870
|
* Amount to be refunded for the cancellation
|
|
805
871
|
* @example 0
|
|
@@ -1004,6 +1070,8 @@ export interface CertificationApplicationResponseEntity {
|
|
|
1004
1070
|
blacklistedItems?: string[];
|
|
1005
1071
|
};
|
|
1006
1072
|
}
|
|
1073
|
+
/** Label of the course enrolled (course version) */
|
|
1074
|
+
export type OnlineCourseLabel = string;
|
|
1007
1075
|
/** Single course object */
|
|
1008
1076
|
export interface CourseResponseEntity {
|
|
1009
1077
|
/** Timestamp of when the record was created */
|
|
@@ -1082,10 +1150,12 @@ export interface CourseResponseEntity {
|
|
|
1082
1150
|
waivedBy?: WaivedBy;
|
|
1083
1151
|
/** Date when course was waived */
|
|
1084
1152
|
waivedOn?: WaivedOn;
|
|
1153
|
+
/** Label of the course enrolled (course version) */
|
|
1154
|
+
onlineCourseLabel?: OnlineCourseLabel;
|
|
1085
1155
|
/** Justifications for overridden course restrictions */
|
|
1086
1156
|
overwrittenJustification?: OverwrittenJustification;
|
|
1087
1157
|
}
|
|
1088
|
-
export interface
|
|
1158
|
+
export interface Output5Ajgzl79Sl {
|
|
1089
1159
|
/**
|
|
1090
1160
|
* Signed URL for the course file
|
|
1091
1161
|
* @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 +1173,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1103
1173
|
transactionID?: string | null;
|
|
1104
1174
|
}
|
|
1105
1175
|
/** Application Foreign Fill response type */
|
|
1106
|
-
export interface
|
|
1176
|
+
export interface OutputJpidov74Q6 {
|
|
1107
1177
|
items: {
|
|
1108
1178
|
userID: string;
|
|
1109
1179
|
createdOn?: number;
|
|
@@ -1242,6 +1312,8 @@ export type PendingInvitations = string[];
|
|
|
1242
1312
|
export type IsSponsored = boolean;
|
|
1243
1313
|
/** External system ID 1 */
|
|
1244
1314
|
export type ExternalID = string;
|
|
1315
|
+
/** Whether the user is enabled */
|
|
1316
|
+
export type IsEnabled = boolean;
|
|
1245
1317
|
/** Response schema for certification process data */
|
|
1246
1318
|
export interface CertificationProcessResponseEntity {
|
|
1247
1319
|
/** @example "abc123" */
|
|
@@ -1322,7 +1394,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1322
1394
|
applicationItems?: Record<string, any>[];
|
|
1323
1395
|
transactionID?: string | null;
|
|
1324
1396
|
}
|
|
1325
|
-
export interface
|
|
1397
|
+
export interface Input5L747Svtte {
|
|
1326
1398
|
issuedOn?: number;
|
|
1327
1399
|
expiresOn?: number;
|
|
1328
1400
|
fileItems?: {
|
|
@@ -1331,14 +1403,14 @@ export interface Input8Tmaavfxxb {
|
|
|
1331
1403
|
}[];
|
|
1332
1404
|
additionalNotes?: string | null;
|
|
1333
1405
|
}
|
|
1334
|
-
export interface
|
|
1406
|
+
export interface OutputTuelm3V07I {
|
|
1335
1407
|
/**
|
|
1336
1408
|
* Signed URL for the course file
|
|
1337
1409
|
* @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
1410
|
*/
|
|
1339
1411
|
fileURL: string;
|
|
1340
1412
|
}
|
|
1341
|
-
export interface
|
|
1413
|
+
export interface InputHf5E0Y3H7A {
|
|
1342
1414
|
/**
|
|
1343
1415
|
* Indicates whether the waiver is approved
|
|
1344
1416
|
* @example true
|
|
@@ -1350,14 +1422,14 @@ export interface Input3M1P1Qx4Be {
|
|
|
1350
1422
|
*/
|
|
1351
1423
|
additionalNotes?: string | null;
|
|
1352
1424
|
}
|
|
1353
|
-
export interface
|
|
1425
|
+
export interface InputFi4Zljn1V {
|
|
1354
1426
|
/**
|
|
1355
1427
|
* Optional notes regarding the waiver
|
|
1356
1428
|
* @example "Waiver granted due to special circumstances."
|
|
1357
1429
|
*/
|
|
1358
1430
|
additionalNotes?: string | null;
|
|
1359
1431
|
}
|
|
1360
|
-
export interface
|
|
1432
|
+
export interface Input5N925Aol5U {
|
|
1361
1433
|
students: {
|
|
1362
1434
|
/**
|
|
1363
1435
|
* User ID of the student to redeem the course for
|
|
@@ -1391,7 +1463,7 @@ export interface InputA0Hnvf0Nx2 {
|
|
|
1391
1463
|
*/
|
|
1392
1464
|
autoEnrolSessionID?: string;
|
|
1393
1465
|
}
|
|
1394
|
-
export interface
|
|
1466
|
+
export interface InputW9T5S0Qkc1 {
|
|
1395
1467
|
invites: {
|
|
1396
1468
|
/**
|
|
1397
1469
|
* Email address of the user to invite
|
|
@@ -1420,7 +1492,7 @@ export interface InputMigwi1Qi7G {
|
|
|
1420
1492
|
*/
|
|
1421
1493
|
isReservedSeat: boolean;
|
|
1422
1494
|
}
|
|
1423
|
-
export interface
|
|
1495
|
+
export interface InputQoeh3Z4Mri {
|
|
1424
1496
|
/**
|
|
1425
1497
|
* Indicates whether to waive the certification process
|
|
1426
1498
|
* @example true
|
|
@@ -1433,7 +1505,7 @@ export interface InputRgdzgwaso4 {
|
|
|
1433
1505
|
comments?: string | null;
|
|
1434
1506
|
}
|
|
1435
1507
|
/** Certification move response schema */
|
|
1436
|
-
export interface
|
|
1508
|
+
export interface OutputC1R9Inz389 {
|
|
1437
1509
|
errors?: {
|
|
1438
1510
|
status: string;
|
|
1439
1511
|
object?: Record<string, any>;
|
|
@@ -1441,19 +1513,19 @@ export interface Output4I79T77Ric {
|
|
|
1441
1513
|
}[];
|
|
1442
1514
|
}
|
|
1443
1515
|
/** Schema for writing a certification trigger check. */
|
|
1444
|
-
export interface
|
|
1516
|
+
export interface Input7Oeauqekmqi {
|
|
1445
1517
|
/**
|
|
1446
1518
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1447
1519
|
* @example "CHECKED"
|
|
1448
1520
|
*/
|
|
1449
|
-
value:
|
|
1521
|
+
value: Input7OeauqekmqiValueEnum;
|
|
1450
1522
|
/**
|
|
1451
1523
|
* List of course IDs that are blocked by this trigger check.
|
|
1452
1524
|
* @example ["course1","course2"]
|
|
1453
1525
|
*/
|
|
1454
1526
|
blockedCourses?: string[];
|
|
1455
1527
|
}
|
|
1456
|
-
export interface
|
|
1528
|
+
export interface Input808Hbk2Ee1 {
|
|
1457
1529
|
/**
|
|
1458
1530
|
* Indicates whether the application item is approved
|
|
1459
1531
|
* @example true
|
|
@@ -1479,7 +1551,7 @@ export interface Input4Hktu5Vloe {
|
|
|
1479
1551
|
export interface StudentHistoryRequestSchema {
|
|
1480
1552
|
requirements: string[];
|
|
1481
1553
|
}
|
|
1482
|
-
export interface
|
|
1554
|
+
export interface Input5Urxlaw1Pb {
|
|
1483
1555
|
/**
|
|
1484
1556
|
* Optional activation key for the application
|
|
1485
1557
|
* @example "AK-123456"
|
|
@@ -1487,7 +1559,7 @@ export interface InputL8Sf59Uzhm {
|
|
|
1487
1559
|
activationKey?: string;
|
|
1488
1560
|
}
|
|
1489
1561
|
/** Schema for course submission item details post request. */
|
|
1490
|
-
export interface
|
|
1562
|
+
export interface InputI7O1Gt3Hlt {
|
|
1491
1563
|
/**
|
|
1492
1564
|
* The ID of the file being submitted.
|
|
1493
1565
|
* @example "fileID123"
|
|
@@ -1500,7 +1572,7 @@ export interface Input6Yt73Y2Qm0J {
|
|
|
1500
1572
|
fileName: string;
|
|
1501
1573
|
}
|
|
1502
1574
|
/** Schema for the response to course submission item details post request. */
|
|
1503
|
-
export interface
|
|
1575
|
+
export interface OutputI7O1Gt3Hlt {
|
|
1504
1576
|
submissionItems: {
|
|
1505
1577
|
/**
|
|
1506
1578
|
* The ID of the file being submitted.
|
|
@@ -1515,7 +1587,7 @@ export interface Output6Yt73Y2Qm0J {
|
|
|
1515
1587
|
}[];
|
|
1516
1588
|
}
|
|
1517
1589
|
/** Pending approval submission parameters */
|
|
1518
|
-
export interface
|
|
1590
|
+
export interface Input5Zby244H2U {
|
|
1519
1591
|
/**
|
|
1520
1592
|
* Type of pending approval
|
|
1521
1593
|
* @example "certification"
|
|
@@ -1535,7 +1607,7 @@ export interface InputQuioenmjqm {
|
|
|
1535
1607
|
fileName: string;
|
|
1536
1608
|
}[];
|
|
1537
1609
|
}
|
|
1538
|
-
export interface
|
|
1610
|
+
export interface InputFa9Yplrbpd {
|
|
1539
1611
|
/**
|
|
1540
1612
|
* The ID of the course for which the license is being redeemed
|
|
1541
1613
|
* @example "courseID123"
|
|
@@ -1603,7 +1675,7 @@ export interface InputX20Gr5Dswoh {
|
|
|
1603
1675
|
acknowledgement?: string | null;
|
|
1604
1676
|
}
|
|
1605
1677
|
/** Validate certification move response schema */
|
|
1606
|
-
export interface
|
|
1678
|
+
export interface Output2Fdgzhhdak {
|
|
1607
1679
|
courses: {
|
|
1608
1680
|
name: string;
|
|
1609
1681
|
status: string;
|
|
@@ -1614,21 +1686,21 @@ export interface OutputU05X7H42A4 {
|
|
|
1614
1686
|
validated: boolean;
|
|
1615
1687
|
mustCreateCP: boolean;
|
|
1616
1688
|
}
|
|
1617
|
-
export interface
|
|
1689
|
+
export interface Input7Ylulg305J {
|
|
1618
1690
|
/**
|
|
1619
1691
|
* Comments regarding the end of the cooldown period
|
|
1620
1692
|
* @example "Cooldown period ended successfully."
|
|
1621
1693
|
*/
|
|
1622
1694
|
comments: string;
|
|
1623
1695
|
}
|
|
1624
|
-
export interface
|
|
1696
|
+
export interface Output1Ur0Llh625 {
|
|
1625
1697
|
/**
|
|
1626
1698
|
* Signed URL for the course file
|
|
1627
1699
|
* @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"
|
|
1628
1700
|
*/
|
|
1629
1701
|
fileURL: string;
|
|
1630
1702
|
}
|
|
1631
|
-
export interface
|
|
1703
|
+
export interface Input3Gjuw93Sdm {
|
|
1632
1704
|
/** @example true */
|
|
1633
1705
|
agreedWithCertTerms: boolean;
|
|
1634
1706
|
/** @example 1717230000000 */
|
|
@@ -1700,21 +1772,21 @@ export interface InputMvudju017X {
|
|
|
1700
1772
|
/** @example "EXT#999" */
|
|
1701
1773
|
externalID2?: string | null;
|
|
1702
1774
|
}
|
|
1703
|
-
export interface
|
|
1775
|
+
export interface InputXz8W16Qblj {
|
|
1704
1776
|
/**
|
|
1705
1777
|
* Comments regarding the course unlock action
|
|
1706
1778
|
* @example "Course unlocked successfully."
|
|
1707
1779
|
*/
|
|
1708
1780
|
comments: string;
|
|
1709
1781
|
}
|
|
1710
|
-
export interface
|
|
1782
|
+
export interface InputV9M5Scmmbl {
|
|
1711
1783
|
/**
|
|
1712
1784
|
* ITA number to update for the user
|
|
1713
1785
|
* @example "ITA123456"
|
|
1714
1786
|
*/
|
|
1715
1787
|
itaNumber: string;
|
|
1716
1788
|
}
|
|
1717
|
-
export interface
|
|
1789
|
+
export interface InputSrvk5Bs97F {
|
|
1718
1790
|
/** @example true */
|
|
1719
1791
|
agreedWithCertTerms: boolean;
|
|
1720
1792
|
/** @example 1717230000000 */
|
|
@@ -1786,7 +1858,7 @@ export interface InputQoo29Cdxrrf {
|
|
|
1786
1858
|
/** @example "EXT#999" */
|
|
1787
1859
|
externalID2?: string | null;
|
|
1788
1860
|
}
|
|
1789
|
-
export interface
|
|
1861
|
+
export interface InputOc4Neuy2Al {
|
|
1790
1862
|
/**
|
|
1791
1863
|
* The grade to override the course result with
|
|
1792
1864
|
* @example "A"
|
|
@@ -1794,7 +1866,7 @@ export interface InputWozo5Nmr6A {
|
|
|
1794
1866
|
resultGrade: string;
|
|
1795
1867
|
}
|
|
1796
1868
|
/** Pending approval review parameters */
|
|
1797
|
-
export interface
|
|
1869
|
+
export interface InputStkzst7Ygo {
|
|
1798
1870
|
/**
|
|
1799
1871
|
* Notes provided by the reviewer for the pending approval
|
|
1800
1872
|
* @example "Please review the submitted documents."
|
|
@@ -1807,7 +1879,7 @@ export interface InputG1Rfyng6Qw {
|
|
|
1807
1879
|
approved: boolean;
|
|
1808
1880
|
}
|
|
1809
1881
|
/** Schema for overriding course result dates. */
|
|
1810
|
-
export interface
|
|
1882
|
+
export interface InputO567Nhdlpk {
|
|
1811
1883
|
/**
|
|
1812
1884
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1813
1885
|
* @example 1735689600000
|
|
@@ -1819,14 +1891,14 @@ export interface InputW9Rwp645Nq {
|
|
|
1819
1891
|
*/
|
|
1820
1892
|
completionDate?: number;
|
|
1821
1893
|
}
|
|
1822
|
-
export interface
|
|
1894
|
+
export interface InputKjrj4Kf0Lt {
|
|
1823
1895
|
filter: {
|
|
1824
1896
|
from?: number;
|
|
1825
1897
|
sortOrder?: string;
|
|
1826
1898
|
sortField?: string;
|
|
1827
1899
|
};
|
|
1828
1900
|
}
|
|
1829
|
-
export interface
|
|
1901
|
+
export interface OutputKjrj4Kf0Lt {
|
|
1830
1902
|
users: {
|
|
1831
1903
|
firstName: string;
|
|
1832
1904
|
lastName: string;
|
|
@@ -1846,7 +1918,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
1846
1918
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1847
1919
|
* @example "CHECKED"
|
|
1848
1920
|
*/
|
|
1849
|
-
export declare enum
|
|
1921
|
+
export declare enum Input7OeauqekmqiValueEnum {
|
|
1850
1922
|
CHECKED = "CHECKED",
|
|
1851
1923
|
UNCHECKED = "UNCHECKED",
|
|
1852
1924
|
NOVALUE = "NOVALUE"
|
|
@@ -1927,6 +1999,8 @@ export type ListReportOrglicensesData = any;
|
|
|
1927
1999
|
export type ListReportOrglicensesError = ErrorResponse;
|
|
1928
2000
|
export type CreateReportOrglicensesPreviewData = any;
|
|
1929
2001
|
export type CreateReportOrglicensesPreviewError = ErrorResponse;
|
|
2002
|
+
export type CreateReportNcsoReportExportData = NcsoReportExportRequestSchema;
|
|
2003
|
+
export type CreateReportNcsoReportExportError = ErrorResponse;
|
|
1930
2004
|
export type CreateReportNcsoReportData = ReportXLSXSchema;
|
|
1931
2005
|
export type CreateReportNcsoReportError = ErrorResponse;
|
|
1932
2006
|
export type CreateReportUsersAdvancedData = any;
|
|
@@ -1937,7 +2011,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
1937
2011
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
1938
2012
|
export type CreateReportUsersSimpleData = any;
|
|
1939
2013
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
1940
|
-
export type CreateSearchUsersCountData =
|
|
2014
|
+
export type CreateSearchUsersCountData = OutputQqseh88M7Y;
|
|
1941
2015
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
1942
2016
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
1943
2017
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -1955,7 +2029,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
1955
2029
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
1956
2030
|
export type DeleteCertificationCourseFileSignData = any;
|
|
1957
2031
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
1958
|
-
export type GetCertificationCourseFileSignData =
|
|
2032
|
+
export type GetCertificationCourseFileSignData = Output5Ajgzl79Sl;
|
|
1959
2033
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
1960
2034
|
export interface CreateCertificationCourseFileSignParams {
|
|
1961
2035
|
/** @example "pdf" */
|
|
@@ -1969,11 +2043,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
1969
2043
|
/** @example "fileID" */
|
|
1970
2044
|
fileId: string;
|
|
1971
2045
|
}
|
|
1972
|
-
export type CreateCertificationCourseFileSignData =
|
|
2046
|
+
export type CreateCertificationCourseFileSignData = Output1Ur0Llh625;
|
|
1973
2047
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
1974
2048
|
export type DeleteCertificationCourseDocumentData = any;
|
|
1975
2049
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
1976
|
-
export type CreateCertificationCourseDocumentData =
|
|
2050
|
+
export type CreateCertificationCourseDocumentData = OutputI7O1Gt3Hlt;
|
|
1977
2051
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
1978
2052
|
export type DeleteUserData = any;
|
|
1979
2053
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -1985,7 +2059,7 @@ export type UpdateUserData = any;
|
|
|
1985
2059
|
export type UpdateUserError = ErrorResponse;
|
|
1986
2060
|
export type DeleteCertificationCourseData = any;
|
|
1987
2061
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
1988
|
-
export type GetCertificationApplicationItemFileData =
|
|
2062
|
+
export type GetCertificationApplicationItemFileData = OutputSgogrr5Tu1;
|
|
1989
2063
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
1990
2064
|
export interface CreateCertificationApplicationItemFileParams {
|
|
1991
2065
|
/** @example "pdf" */
|
|
@@ -1999,9 +2073,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
1999
2073
|
/** @example "fileVersion" */
|
|
2000
2074
|
fileVersion: string;
|
|
2001
2075
|
}
|
|
2002
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2076
|
+
export type CreateCertificationApplicationItemFileData = OutputTuelm3V07I;
|
|
2003
2077
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2004
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2078
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputW7Nmjwguf3;
|
|
2005
2079
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2006
2080
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2007
2081
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2009,7 +2083,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2009
2083
|
export type GetCourseError = ErrorResponse;
|
|
2010
2084
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2011
2085
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2012
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2086
|
+
export type GetCertificationApplicationForeignFillData = OutputJpidov74Q6;
|
|
2013
2087
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2014
2088
|
export type GetCertificationPrintData = any;
|
|
2015
2089
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2043,7 +2117,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2043
2117
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2044
2118
|
export type CreateCertificationWaiveData = any;
|
|
2045
2119
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2046
|
-
export type CreateCertificationMoveData =
|
|
2120
|
+
export type CreateCertificationMoveData = OutputC1R9Inz389;
|
|
2047
2121
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2048
2122
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2049
2123
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2071,7 +2145,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2071
2145
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2072
2146
|
export type CreateCertificationCourseRedeemData = any;
|
|
2073
2147
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2074
|
-
export type CreateCertificationMoveValidateData =
|
|
2148
|
+
export type CreateCertificationMoveValidateData = Output2Fdgzhhdak;
|
|
2075
2149
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2076
2150
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2077
2151
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2083,7 +2157,7 @@ export type UpdateCertificationCourseOverrideResultData = any;
|
|
|
2083
2157
|
export type UpdateCertificationCourseOverrideResultError = ErrorResponse;
|
|
2084
2158
|
export type UpdateCertificationSetDatesData = any;
|
|
2085
2159
|
export type UpdateCertificationSetDatesError = ErrorResponse;
|
|
2086
|
-
export type CreateCertificationResult =
|
|
2160
|
+
export type CreateCertificationResult = OutputKjrj4Kf0Lt;
|
|
2087
2161
|
export type CreateCertificationFail = ErrorResponse;
|
|
2088
2162
|
import type { AxiosInstance, AxiosRequestConfig, ResponseType } from 'axios';
|
|
2089
2163
|
export type QueryParamsType = Record<string | number, any>;
|
|
@@ -2128,7 +2202,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2128
2202
|
}
|
|
2129
2203
|
/**
|
|
2130
2204
|
* @title BCCSA Program API
|
|
2131
|
-
* @version 3.0.
|
|
2205
|
+
* @version 3.0.8
|
|
2132
2206
|
* @baseUrl http://localhost:8080
|
|
2133
2207
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2134
2208
|
*/
|
|
@@ -2143,7 +2217,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2143
2217
|
* @request POST:/contactUs
|
|
2144
2218
|
* @secure
|
|
2145
2219
|
*/
|
|
2146
|
-
listContactUs: (data:
|
|
2220
|
+
listContactUs: (data: InputUdqbjoikg8, params?: RequestParams) => Promise<any>;
|
|
2147
2221
|
};
|
|
2148
2222
|
customer: {
|
|
2149
2223
|
/**
|
|
@@ -2247,7 +2321,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2247
2321
|
* @request POST:/tenant/report/applicationExport
|
|
2248
2322
|
* @secure
|
|
2249
2323
|
*/
|
|
2250
|
-
createReportApplicationExport: (data:
|
|
2324
|
+
createReportApplicationExport: (data: InputXpq62Ascd0K, params?: RequestParams) => Promise<any>;
|
|
2251
2325
|
/**
|
|
2252
2326
|
* @description Export a report of applications based on the provided filters.
|
|
2253
2327
|
*
|
|
@@ -2257,7 +2331,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2257
2331
|
* @request POST:/tenant/report/applicationStatus
|
|
2258
2332
|
* @secure
|
|
2259
2333
|
*/
|
|
2260
|
-
listReportApplicationStatus: (data:
|
|
2334
|
+
listReportApplicationStatus: (data: InputXe2F8Lrpl3, params?: RequestParams) => Promise<any>;
|
|
2261
2335
|
/**
|
|
2262
2336
|
* @description Export a report of applications based on the provided filters.
|
|
2263
2337
|
*
|
|
@@ -2267,7 +2341,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2267
2341
|
* @request POST:/tenant/report/applicationsReport
|
|
2268
2342
|
* @secure
|
|
2269
2343
|
*/
|
|
2270
|
-
createReportApplicationsReport: (data:
|
|
2344
|
+
createReportApplicationsReport: (data: InputZ5Zaihx1N8, params?: RequestParams) => Promise<any>;
|
|
2271
2345
|
/**
|
|
2272
2346
|
* @description This route allows you to post certificates email for the tenant.
|
|
2273
2347
|
*
|
|
@@ -2277,7 +2351,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2277
2351
|
* @request POST:/tenant/certificates/email
|
|
2278
2352
|
* @secure
|
|
2279
2353
|
*/
|
|
2280
|
-
createCertificatesEmail: (data:
|
|
2354
|
+
createCertificatesEmail: (data: Input7Dzemgbd5M, params?: RequestParams) => Promise<any>;
|
|
2281
2355
|
/**
|
|
2282
2356
|
* @description Generate a preview of the completed certifications report.
|
|
2283
2357
|
*
|
|
@@ -2307,7 +2381,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2307
2381
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2308
2382
|
* @secure
|
|
2309
2383
|
*/
|
|
2310
|
-
createLicenseRedeem: (userId: string, data:
|
|
2384
|
+
createLicenseRedeem: (userId: string, data: InputLcxw15F7Bp, params?: RequestParams) => Promise<any>;
|
|
2311
2385
|
/**
|
|
2312
2386
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2313
2387
|
*
|
|
@@ -2317,7 +2391,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2317
2391
|
* @request POST:/tenant/report/orglicenses/
|
|
2318
2392
|
* @secure
|
|
2319
2393
|
*/
|
|
2320
|
-
listReportOrglicenses: (data:
|
|
2394
|
+
listReportOrglicenses: (data: InputO43S8Hm8Eqj, params?: RequestParams) => Promise<any>;
|
|
2321
2395
|
/**
|
|
2322
2396
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2323
2397
|
*
|
|
@@ -2327,7 +2401,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2327
2401
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2328
2402
|
* @secure
|
|
2329
2403
|
*/
|
|
2330
|
-
createReportOrglicensesPreview: (data:
|
|
2404
|
+
createReportOrglicensesPreview: (data: Input3Jh4Kbfsj7, params?: RequestParams) => Promise<any>;
|
|
2405
|
+
/**
|
|
2406
|
+
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2407
|
+
*
|
|
2408
|
+
* @tags Reports
|
|
2409
|
+
* @name CreateReportNcsoReportExport
|
|
2410
|
+
* @summary NCSO Export report
|
|
2411
|
+
* @request POST:/tenant/report/ncsoReport/export
|
|
2412
|
+
* @secure
|
|
2413
|
+
*/
|
|
2414
|
+
createReportNcsoReportExport: (data: NcsoReportRequestSchema, params?: RequestParams) => Promise<NcsoReportExportRequestSchema>;
|
|
2331
2415
|
/**
|
|
2332
2416
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2333
2417
|
*
|
|
@@ -2347,7 +2431,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2347
2431
|
* @request POST:/tenant/report/users/advanced
|
|
2348
2432
|
* @secure
|
|
2349
2433
|
*/
|
|
2350
|
-
createReportUsersAdvanced: (data:
|
|
2434
|
+
createReportUsersAdvanced: (data: InputBv0Jn7Awf6, params?: RequestParams) => Promise<any>;
|
|
2351
2435
|
/**
|
|
2352
2436
|
* @description Searches for users in the tenant by their IDs.
|
|
2353
2437
|
*
|
|
@@ -2357,7 +2441,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2357
2441
|
* @request POST:/tenant/search/users/ids
|
|
2358
2442
|
* @secure
|
|
2359
2443
|
*/
|
|
2360
|
-
listSearchUsersIds: (data:
|
|
2444
|
+
listSearchUsersIds: (data: Input15Sft3Rbpo, params?: RequestParams) => Promise<any>;
|
|
2361
2445
|
/**
|
|
2362
2446
|
* @description Searches for users in the tenant by term and filters.
|
|
2363
2447
|
*
|
|
@@ -2367,7 +2451,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2367
2451
|
* @request POST:/tenant/search/users/term
|
|
2368
2452
|
* @secure
|
|
2369
2453
|
*/
|
|
2370
|
-
createSearchUsersTerm: (data:
|
|
2454
|
+
createSearchUsersTerm: (data: Input3Ysqkyuvrdk, params?: RequestParams) => Promise<any>;
|
|
2371
2455
|
/**
|
|
2372
2456
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2373
2457
|
*
|
|
@@ -2377,7 +2461,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2377
2461
|
* @request POST:/tenant/report/users/simple
|
|
2378
2462
|
* @secure
|
|
2379
2463
|
*/
|
|
2380
|
-
createReportUsersSimple: (data:
|
|
2464
|
+
createReportUsersSimple: (data: Input2Vykd1Irlu, params?: RequestParams) => Promise<any>;
|
|
2381
2465
|
/**
|
|
2382
2466
|
* @description Retrieve user by ID.
|
|
2383
2467
|
*
|
|
@@ -2387,7 +2471,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2387
2471
|
* @request POST:/tenant/search/users/count
|
|
2388
2472
|
* @secure
|
|
2389
2473
|
*/
|
|
2390
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2474
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputQqseh88M7Y>;
|
|
2391
2475
|
};
|
|
2392
2476
|
user: {
|
|
2393
2477
|
/**
|
|
@@ -2419,7 +2503,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2419
2503
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2420
2504
|
* @secure
|
|
2421
2505
|
*/
|
|
2422
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2506
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: Input5L747Svtte, params?: RequestParams) => Promise<any>;
|
|
2423
2507
|
/**
|
|
2424
2508
|
* @description Delete a certification process application by type.
|
|
2425
2509
|
*
|
|
@@ -2479,7 +2563,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2479
2563
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2480
2564
|
* @secure
|
|
2481
2565
|
*/
|
|
2482
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2566
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<Output5Ajgzl79Sl>;
|
|
2483
2567
|
/**
|
|
2484
2568
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2485
2569
|
*
|
|
@@ -2489,7 +2573,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2489
2573
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2490
2574
|
* @secure
|
|
2491
2575
|
*/
|
|
2492
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2576
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<Output1Ur0Llh625>;
|
|
2493
2577
|
/**
|
|
2494
2578
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2495
2579
|
*
|
|
@@ -2509,7 +2593,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2509
2593
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2510
2594
|
* @secure
|
|
2511
2595
|
*/
|
|
2512
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2596
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputI7O1Gt3Hlt, params?: RequestParams) => Promise<OutputI7O1Gt3Hlt>;
|
|
2513
2597
|
/**
|
|
2514
2598
|
* @description Delete user by ID.
|
|
2515
2599
|
*
|
|
@@ -2539,7 +2623,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2539
2623
|
* @request POST:/user/{userID}
|
|
2540
2624
|
* @secure
|
|
2541
2625
|
*/
|
|
2542
|
-
createUser: (userId: string, data:
|
|
2626
|
+
createUser: (userId: string, data: Input3Gjuw93Sdm, params?: RequestParams) => Promise<any>;
|
|
2543
2627
|
/**
|
|
2544
2628
|
* @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.
|
|
2545
2629
|
*
|
|
@@ -2549,7 +2633,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2549
2633
|
* @request PUT:/user/{userID}
|
|
2550
2634
|
* @secure
|
|
2551
2635
|
*/
|
|
2552
|
-
updateUser: (userId: string, data:
|
|
2636
|
+
updateUser: (userId: string, data: InputSrvk5Bs97F, params?: RequestParams) => Promise<any>;
|
|
2553
2637
|
/**
|
|
2554
2638
|
* @description Delete course from user
|
|
2555
2639
|
*
|
|
@@ -2561,7 +2645,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2561
2645
|
*/
|
|
2562
2646
|
deleteCertificationCourse: (userId: string, certProcId: string, courseId: string, params?: RequestParams) => Promise<any>;
|
|
2563
2647
|
/**
|
|
2564
|
-
* @description
|
|
2648
|
+
* @description Generate a signed url to download a specific file version of an application item for a user in a certification process.
|
|
2565
2649
|
*
|
|
2566
2650
|
* @tags Application
|
|
2567
2651
|
* @name GetCertificationApplicationItemFile
|
|
@@ -2569,7 +2653,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2569
2653
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2570
2654
|
* @secure
|
|
2571
2655
|
*/
|
|
2572
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2656
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputSgogrr5Tu1>;
|
|
2573
2657
|
/**
|
|
2574
2658
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2575
2659
|
*
|
|
@@ -2579,7 +2663,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2579
2663
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2580
2664
|
* @secure
|
|
2581
2665
|
*/
|
|
2582
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2666
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputTuelm3V07I>;
|
|
2583
2667
|
/**
|
|
2584
2668
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2585
2669
|
*
|
|
@@ -2589,7 +2673,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2589
2673
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2590
2674
|
* @secure
|
|
2591
2675
|
*/
|
|
2592
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2676
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputW7Nmjwguf3>;
|
|
2593
2677
|
/**
|
|
2594
2678
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2595
2679
|
*
|
|
@@ -2629,7 +2713,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2629
2713
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2630
2714
|
* @secure
|
|
2631
2715
|
*/
|
|
2632
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2716
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputJpidov74Q6>;
|
|
2633
2717
|
/**
|
|
2634
2718
|
* @description This endpoint will print certificate
|
|
2635
2719
|
*
|
|
@@ -2719,7 +2803,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2719
2803
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2720
2804
|
* @secure
|
|
2721
2805
|
*/
|
|
2722
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2806
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputHf5E0Y3H7A, params?: RequestParams) => Promise<any>;
|
|
2723
2807
|
/**
|
|
2724
2808
|
* @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.
|
|
2725
2809
|
*
|
|
@@ -2729,7 +2813,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2729
2813
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2730
2814
|
* @secure
|
|
2731
2815
|
*/
|
|
2732
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2816
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputFi4Zljn1V, params?: RequestParams) => Promise<any>;
|
|
2733
2817
|
/**
|
|
2734
2818
|
* @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.
|
|
2735
2819
|
*
|
|
@@ -2739,7 +2823,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2739
2823
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2740
2824
|
* @secure
|
|
2741
2825
|
*/
|
|
2742
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2826
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: Input5N925Aol5U, params?: RequestParams) => Promise<any>;
|
|
2743
2827
|
/**
|
|
2744
2828
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2745
2829
|
*
|
|
@@ -2749,7 +2833,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2749
2833
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2750
2834
|
* @secure
|
|
2751
2835
|
*/
|
|
2752
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2836
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputW9T5S0Qkc1, params?: RequestParams) => Promise<any>;
|
|
2753
2837
|
/**
|
|
2754
2838
|
* @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.
|
|
2755
2839
|
*
|
|
@@ -2789,7 +2873,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2789
2873
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2790
2874
|
* @secure
|
|
2791
2875
|
*/
|
|
2792
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2876
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputQoeh3Z4Mri, params?: RequestParams) => Promise<any>;
|
|
2793
2877
|
/**
|
|
2794
2878
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
2795
2879
|
*
|
|
@@ -2799,7 +2883,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2799
2883
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2800
2884
|
* @secure
|
|
2801
2885
|
*/
|
|
2802
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2886
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputC1R9Inz389>;
|
|
2803
2887
|
/**
|
|
2804
2888
|
* @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.
|
|
2805
2889
|
*
|
|
@@ -2809,7 +2893,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2809
2893
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/replace/{secUserID}
|
|
2810
2894
|
* @secure
|
|
2811
2895
|
*/
|
|
2812
|
-
createCertificationCourseSessionReplace: (userId: string, certProcId: string,
|
|
2896
|
+
createCertificationCourseSessionReplace: (userId: string, certProcId: string, courseId: string, sessionId: string, secUserId: string, params?: RequestParams) => Promise<any>;
|
|
2813
2897
|
/**
|
|
2814
2898
|
* @description This route allows you to set a trigger check for a certification process, such as blocking courses.
|
|
2815
2899
|
*
|
|
@@ -2829,7 +2913,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2829
2913
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2830
2914
|
* @secure
|
|
2831
2915
|
*/
|
|
2832
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
2916
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: Input7Oeauqekmqi, params?: RequestParams) => Promise<any>;
|
|
2833
2917
|
/**
|
|
2834
2918
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
2835
2919
|
*
|
|
@@ -2879,7 +2963,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2879
2963
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
2880
2964
|
* @secure
|
|
2881
2965
|
*/
|
|
2882
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
2966
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: Input808Hbk2Ee1, params?: RequestParams) => Promise<any>;
|
|
2883
2967
|
/**
|
|
2884
2968
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
2885
2969
|
*
|
|
@@ -2899,7 +2983,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2899
2983
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
2900
2984
|
* @secure
|
|
2901
2985
|
*/
|
|
2902
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
2986
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: Input5Urxlaw1Pb, params?: RequestParams) => Promise<any>;
|
|
2903
2987
|
/**
|
|
2904
2988
|
* @description This route allows you to submit a pending approval.
|
|
2905
2989
|
*
|
|
@@ -2909,7 +2993,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2909
2993
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
2910
2994
|
* @secure
|
|
2911
2995
|
*/
|
|
2912
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
2996
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: Input5Zby244H2U, params?: RequestParams) => Promise<any>;
|
|
2913
2997
|
/**
|
|
2914
2998
|
* @description This route allows you to review a pending approval.
|
|
2915
2999
|
*
|
|
@@ -2919,7 +3003,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2919
3003
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
2920
3004
|
* @secure
|
|
2921
3005
|
*/
|
|
2922
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3006
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputStkzst7Ygo, params?: RequestParams) => Promise<any>;
|
|
2923
3007
|
/**
|
|
2924
3008
|
* @description Redeems a license for a user by product ID.
|
|
2925
3009
|
*
|
|
@@ -2929,7 +3013,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2929
3013
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
2930
3014
|
* @secure
|
|
2931
3015
|
*/
|
|
2932
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3016
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputFa9Yplrbpd, params?: RequestParams) => Promise<any>;
|
|
2933
3017
|
/**
|
|
2934
3018
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
2935
3019
|
*
|
|
@@ -2939,7 +3023,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2939
3023
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
2940
3024
|
* @secure
|
|
2941
3025
|
*/
|
|
2942
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3026
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<Output2Fdgzhhdak>;
|
|
2943
3027
|
/**
|
|
2944
3028
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
2945
3029
|
*
|
|
@@ -2949,7 +3033,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2949
3033
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
2950
3034
|
* @secure
|
|
2951
3035
|
*/
|
|
2952
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3036
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: Input7Ylulg305J, params?: RequestParams) => Promise<any>;
|
|
2953
3037
|
/**
|
|
2954
3038
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
2955
3039
|
*
|
|
@@ -2959,7 +3043,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2959
3043
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
2960
3044
|
* @secure
|
|
2961
3045
|
*/
|
|
2962
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3046
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputXz8W16Qblj, params?: RequestParams) => Promise<any>;
|
|
2963
3047
|
/**
|
|
2964
3048
|
* @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.
|
|
2965
3049
|
*
|
|
@@ -2969,7 +3053,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2969
3053
|
* @request POST:/user/{userID}/updateITA
|
|
2970
3054
|
* @secure
|
|
2971
3055
|
*/
|
|
2972
|
-
createUpdateIta: (userId: string, data:
|
|
3056
|
+
createUpdateIta: (userId: string, data: InputV9M5Scmmbl, params?: RequestParams) => Promise<any>;
|
|
2973
3057
|
/**
|
|
2974
3058
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
2975
3059
|
*
|
|
@@ -2979,7 +3063,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2979
3063
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
2980
3064
|
* @secure
|
|
2981
3065
|
*/
|
|
2982
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3066
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputOc4Neuy2Al, params?: RequestParams) => Promise<any>;
|
|
2983
3067
|
/**
|
|
2984
3068
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
2985
3069
|
*
|
|
@@ -2989,7 +3073,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2989
3073
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
2990
3074
|
* @secure
|
|
2991
3075
|
*/
|
|
2992
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3076
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputO567Nhdlpk, params?: RequestParams) => Promise<any>;
|
|
2993
3077
|
};
|
|
2994
3078
|
users: {
|
|
2995
3079
|
/**
|
|
@@ -3001,6 +3085,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3001
3085
|
* @request POST:/users/certification/{certSpecID}
|
|
3002
3086
|
* @secure
|
|
3003
3087
|
*/
|
|
3004
|
-
createCertification: (certSpecId: string, data:
|
|
3088
|
+
createCertification: (certSpecId: string, data: InputKjrj4Kf0Lt, params?: RequestParams) => Promise<OutputKjrj4Kf0Lt>;
|
|
3005
3089
|
};
|
|
3006
3090
|
}
|