@ikonintegration/bccsa-program-api 3.0.26 → 3.0.28
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 +191 -93
- package/dist/Api.d.ts +183 -102
- package/dist/Api.js +26 -8
- package/dist/Api.js.map +1 -1
- package/package.json +1 -1
package/dist/Api.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ export interface ErrorResponse {
|
|
|
5
5
|
/** Error code */
|
|
6
6
|
errCode: string;
|
|
7
7
|
}
|
|
8
|
-
export interface
|
|
8
|
+
export interface InputPvbucaddf5 {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -451,7 +451,7 @@ export type CertTitle = string;
|
|
|
451
451
|
export type DisplayName = string;
|
|
452
452
|
/** Email address of the user who submitted the pending approval */
|
|
453
453
|
export type Email = string;
|
|
454
|
-
export interface
|
|
454
|
+
export interface InputG0Cepaoj72 {
|
|
455
455
|
/**
|
|
456
456
|
* ID of the certification to filter applications by
|
|
457
457
|
* @example "certification123"
|
|
@@ -508,7 +508,7 @@ export interface InputWjvhhwwjzj {
|
|
|
508
508
|
*/
|
|
509
509
|
ignoreCompletedCertifications?: boolean | null;
|
|
510
510
|
}
|
|
511
|
-
export interface
|
|
511
|
+
export interface InputSsp9Tp64Hs {
|
|
512
512
|
/**
|
|
513
513
|
* ID of the certification to filter applications by
|
|
514
514
|
* @example "certification123"
|
|
@@ -565,7 +565,7 @@ export interface InputBxo37Hanrg {
|
|
|
565
565
|
*/
|
|
566
566
|
ignoreCompletedCertifications?: boolean | null;
|
|
567
567
|
}
|
|
568
|
-
export interface
|
|
568
|
+
export interface InputRc3O6Ti8R3I {
|
|
569
569
|
/**
|
|
570
570
|
* ID of the certification to filter applications by
|
|
571
571
|
* @example "certification123"
|
|
@@ -622,7 +622,7 @@ export interface InputV4Xhzdev06J {
|
|
|
622
622
|
*/
|
|
623
623
|
ignoreCompletedCertifications?: boolean | null;
|
|
624
624
|
}
|
|
625
|
-
export interface
|
|
625
|
+
export interface InputJcy0Ne1Wfs {
|
|
626
626
|
/**
|
|
627
627
|
* The ID of the certificate specifications to be used for the email
|
|
628
628
|
* @example "certSpecsID123"
|
|
@@ -663,7 +663,7 @@ export interface InputAljvvm66Ck {
|
|
|
663
663
|
emailAddress: string;
|
|
664
664
|
}[];
|
|
665
665
|
}
|
|
666
|
-
export interface
|
|
666
|
+
export interface InputPuba68Ylll {
|
|
667
667
|
/**
|
|
668
668
|
* The ID of the product for which the license is being redeemed
|
|
669
669
|
* @example "productID123"
|
|
@@ -675,7 +675,7 @@ export interface InputU67Bq82Arc {
|
|
|
675
675
|
*/
|
|
676
676
|
sessionID?: string;
|
|
677
677
|
}
|
|
678
|
-
export interface
|
|
678
|
+
export interface Input2Z20Omtaj8I {
|
|
679
679
|
/**
|
|
680
680
|
* Search term to filter licenses
|
|
681
681
|
* @example "active"
|
|
@@ -692,7 +692,7 @@ export interface InputYqle553Hqv {
|
|
|
692
692
|
*/
|
|
693
693
|
sortField?: any;
|
|
694
694
|
}
|
|
695
|
-
export interface
|
|
695
|
+
export interface InputAivcl5Kwb5L {
|
|
696
696
|
/**
|
|
697
697
|
* Search term to filter licenses
|
|
698
698
|
* @example "active"
|
|
@@ -748,7 +748,76 @@ export interface ReportXLSXSchema {
|
|
|
748
748
|
xlsxStream: File;
|
|
749
749
|
contentType: ReportXlsxSchemaContentTypeEnum;
|
|
750
750
|
}
|
|
751
|
-
|
|
751
|
+
/** Request body for searching pending approval review history */
|
|
752
|
+
export interface SearchPendingApprovalsWriteSchema {
|
|
753
|
+
/** Filter for searching pending approval review history */
|
|
754
|
+
filter: SearchPendingApprovalsFilter;
|
|
755
|
+
}
|
|
756
|
+
/** Filter for searching pending approval review history */
|
|
757
|
+
export interface SearchPendingApprovalsFilter {
|
|
758
|
+
/** Lower bound (inclusive) of the reviewedOn timestamp range */
|
|
759
|
+
dateFrom?: DateFrom;
|
|
760
|
+
/** Upper bound (inclusive) of the reviewedOn timestamp range */
|
|
761
|
+
dateTo?: DateTo;
|
|
762
|
+
/** User ID to scope the review history search to */
|
|
763
|
+
userID?: UserID;
|
|
764
|
+
}
|
|
765
|
+
/**
|
|
766
|
+
* Lower bound (inclusive) of the reviewedOn timestamp range
|
|
767
|
+
* @example 1704067200000
|
|
768
|
+
*/
|
|
769
|
+
export type DateFrom = number;
|
|
770
|
+
/**
|
|
771
|
+
* Upper bound (inclusive) of the reviewedOn timestamp range
|
|
772
|
+
* @example 1735689600000
|
|
773
|
+
*/
|
|
774
|
+
export type DateTo = number;
|
|
775
|
+
/** Response schema for pending approval review history search */
|
|
776
|
+
export interface SearchPendingApprovalsResponseSchema {
|
|
777
|
+
reviewHistory: {
|
|
778
|
+
/** User who created the pending approval entry */
|
|
779
|
+
createdBy: CreatedBy;
|
|
780
|
+
/** Timestamp when the pending approval was created */
|
|
781
|
+
createdOn: CreatedOn;
|
|
782
|
+
/** User who last updated the entry */
|
|
783
|
+
updatedBy?: UpdatedBy;
|
|
784
|
+
/** Timestamp when the entry was last updated */
|
|
785
|
+
updatedOn?: UpdatedOn;
|
|
786
|
+
/** Static identifier for the entity type */
|
|
787
|
+
dbEntity: DbEntity;
|
|
788
|
+
/** ID of the pending approval */
|
|
789
|
+
id: Id;
|
|
790
|
+
/** Type of pending approval */
|
|
791
|
+
type: Type;
|
|
792
|
+
/** User ID associated with the pending approval */
|
|
793
|
+
userID: UserID;
|
|
794
|
+
/** Name of the user or entity */
|
|
795
|
+
name?: Name;
|
|
796
|
+
/** Certification Process ID */
|
|
797
|
+
certProcID?: CertProcID;
|
|
798
|
+
/** Title of the certification process */
|
|
799
|
+
certTitle?: CertTitle;
|
|
800
|
+
/** Tenant ID */
|
|
801
|
+
tenantID: TenantID;
|
|
802
|
+
/** Course ID if applicable */
|
|
803
|
+
courseID?: CourseID;
|
|
804
|
+
/** User display name */
|
|
805
|
+
displayName?: DisplayName;
|
|
806
|
+
/** Email address of the user who submitted the pending approval */
|
|
807
|
+
email?: Email;
|
|
808
|
+
/** List of submitted files for approval */
|
|
809
|
+
submissionItems?: SubmissionItems;
|
|
810
|
+
/** Current review state of the request (PENDING, APPROVED, REJECTED) */
|
|
811
|
+
approvalState?: ApprovalState;
|
|
812
|
+
/** Notes entered by the admin during approval/rejection */
|
|
813
|
+
approvalNotes?: ApprovalNotes;
|
|
814
|
+
/** User ID of the admin that reviewed the request */
|
|
815
|
+
reviewedBy?: ReviewedBy;
|
|
816
|
+
/** Timestamp of the review */
|
|
817
|
+
reviewedOn?: ReviewedOn;
|
|
818
|
+
}[];
|
|
819
|
+
}
|
|
820
|
+
export interface InputEaqpxgb94O {
|
|
752
821
|
/**
|
|
753
822
|
* Start date for the report
|
|
754
823
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -770,11 +839,11 @@ export interface Input2Scuq3Q9Gql {
|
|
|
770
839
|
*/
|
|
771
840
|
dateType?: string;
|
|
772
841
|
}
|
|
773
|
-
export interface
|
|
842
|
+
export interface Input8P6Wn0Rsvm {
|
|
774
843
|
/** List of user IDs to search for in the tenant. */
|
|
775
844
|
IDs: (string | null)[];
|
|
776
845
|
}
|
|
777
|
-
export interface
|
|
846
|
+
export interface InputW1Muuiafip {
|
|
778
847
|
/** The term to search for in the user profiles. */
|
|
779
848
|
searchTerm?: string | null;
|
|
780
849
|
/** Filter criteria for the user search. */
|
|
@@ -814,7 +883,7 @@ export interface InputUz71Dia4Xk {
|
|
|
814
883
|
};
|
|
815
884
|
};
|
|
816
885
|
}
|
|
817
|
-
export interface
|
|
886
|
+
export interface InputSyy54Bhhpw {
|
|
818
887
|
/** The term to search for in the user profiles. */
|
|
819
888
|
searchTerm?: string | null;
|
|
820
889
|
/** Filter criteria for the user search. */
|
|
@@ -854,21 +923,21 @@ export interface InputEqeac55Z21K {
|
|
|
854
923
|
};
|
|
855
924
|
};
|
|
856
925
|
}
|
|
857
|
-
export interface
|
|
926
|
+
export interface Output5Dzws3Xlb1 {
|
|
858
927
|
/** External system ID 2 */
|
|
859
928
|
userCount: ExternalID2;
|
|
860
929
|
transactionID?: string | null;
|
|
861
930
|
}
|
|
862
931
|
/** External system ID 2 */
|
|
863
932
|
export type ExternalID2 = number;
|
|
864
|
-
export interface
|
|
933
|
+
export interface OutputAt13P3Mi35 {
|
|
865
934
|
/**
|
|
866
935
|
* Signed URL for the course file
|
|
867
936
|
* @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"
|
|
868
937
|
*/
|
|
869
938
|
fileURL: string;
|
|
870
939
|
}
|
|
871
|
-
export interface
|
|
940
|
+
export interface Output6Cq3W70Gx1 {
|
|
872
941
|
/**
|
|
873
942
|
* Amount to be refunded for the cancellation
|
|
874
943
|
* @example 0
|
|
@@ -1168,7 +1237,7 @@ export interface CourseResponseEntity {
|
|
|
1168
1237
|
}
|
|
1169
1238
|
/** Label of the course enrolled (course version) */
|
|
1170
1239
|
export type OnlineCourseLabel = string;
|
|
1171
|
-
export interface
|
|
1240
|
+
export interface OutputH3Al9V0E6X {
|
|
1172
1241
|
/**
|
|
1173
1242
|
* Signed URL for the course file
|
|
1174
1243
|
* @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"
|
|
@@ -1186,7 +1255,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1186
1255
|
transactionID?: string | null;
|
|
1187
1256
|
}
|
|
1188
1257
|
/** Application Foreign Fill response type */
|
|
1189
|
-
export interface
|
|
1258
|
+
export interface Output3Aonfmwetl {
|
|
1190
1259
|
items: {
|
|
1191
1260
|
userID: string;
|
|
1192
1261
|
createdOn?: number;
|
|
@@ -1374,7 +1443,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1374
1443
|
applicationItems?: Record<string, any>[];
|
|
1375
1444
|
transactionID?: string | null;
|
|
1376
1445
|
}
|
|
1377
|
-
export interface
|
|
1446
|
+
export interface Input9Wblq49Y5F {
|
|
1378
1447
|
issuedOn?: number;
|
|
1379
1448
|
expiresOn?: number;
|
|
1380
1449
|
fileItems?: {
|
|
@@ -1383,21 +1452,21 @@ export interface Input3023Uh956Ji {
|
|
|
1383
1452
|
}[];
|
|
1384
1453
|
additionalNotes?: string | null;
|
|
1385
1454
|
}
|
|
1386
|
-
export interface
|
|
1455
|
+
export interface InputVelwazpnf6 {
|
|
1387
1456
|
/**
|
|
1388
1457
|
* Indicates whether the application is locked
|
|
1389
1458
|
* @example true
|
|
1390
1459
|
*/
|
|
1391
1460
|
isApplicationLocked: boolean;
|
|
1392
1461
|
}
|
|
1393
|
-
export interface
|
|
1462
|
+
export interface Output7V0C4Ojr08 {
|
|
1394
1463
|
/**
|
|
1395
1464
|
* Signed URL for the course file
|
|
1396
1465
|
* @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"
|
|
1397
1466
|
*/
|
|
1398
1467
|
fileURL: string;
|
|
1399
1468
|
}
|
|
1400
|
-
export interface
|
|
1469
|
+
export interface Input8Zbphib1Bp {
|
|
1401
1470
|
/**
|
|
1402
1471
|
* Indicates whether the waiver is approved
|
|
1403
1472
|
* @example true
|
|
@@ -1409,14 +1478,14 @@ export interface InputMl9Cx7Bruk {
|
|
|
1409
1478
|
*/
|
|
1410
1479
|
additionalNotes?: string | null;
|
|
1411
1480
|
}
|
|
1412
|
-
export interface
|
|
1481
|
+
export interface InputMker1Xtkzxl {
|
|
1413
1482
|
/**
|
|
1414
1483
|
* Optional notes regarding the waiver
|
|
1415
1484
|
* @example "Waiver granted due to special circumstances."
|
|
1416
1485
|
*/
|
|
1417
1486
|
additionalNotes?: string | null;
|
|
1418
1487
|
}
|
|
1419
|
-
export interface
|
|
1488
|
+
export interface InputY6007M76Zb {
|
|
1420
1489
|
students: {
|
|
1421
1490
|
/**
|
|
1422
1491
|
* User ID of the student to redeem the course for
|
|
@@ -1450,7 +1519,7 @@ export interface InputJtyee7Eb8 {
|
|
|
1450
1519
|
*/
|
|
1451
1520
|
autoEnrolSessionID?: string;
|
|
1452
1521
|
}
|
|
1453
|
-
export interface
|
|
1522
|
+
export interface InputRvv6An47F8I {
|
|
1454
1523
|
invites: {
|
|
1455
1524
|
/**
|
|
1456
1525
|
* Email address of the user to invite
|
|
@@ -1479,7 +1548,7 @@ export interface Input8Htjpriowr {
|
|
|
1479
1548
|
*/
|
|
1480
1549
|
isReservedSeat: boolean;
|
|
1481
1550
|
}
|
|
1482
|
-
export interface
|
|
1551
|
+
export interface InputPqplzyab0W {
|
|
1483
1552
|
/**
|
|
1484
1553
|
* Indicates whether to waive the certification process
|
|
1485
1554
|
* @example true
|
|
@@ -1492,7 +1561,7 @@ export interface Input7Nmaq3Dpgg {
|
|
|
1492
1561
|
comments?: string | null;
|
|
1493
1562
|
}
|
|
1494
1563
|
/** Certification move response schema */
|
|
1495
|
-
export interface
|
|
1564
|
+
export interface OutputVqygq7Onkl {
|
|
1496
1565
|
errors?: {
|
|
1497
1566
|
status: string;
|
|
1498
1567
|
object?: Record<string, any>;
|
|
@@ -1500,19 +1569,19 @@ export interface OutputDfv06H0Dmfg {
|
|
|
1500
1569
|
}[];
|
|
1501
1570
|
}
|
|
1502
1571
|
/** Schema for writing a certification trigger check. */
|
|
1503
|
-
export interface
|
|
1572
|
+
export interface Input95Iyjglnxs {
|
|
1504
1573
|
/**
|
|
1505
1574
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1506
1575
|
* @example "CHECKED"
|
|
1507
1576
|
*/
|
|
1508
|
-
value:
|
|
1577
|
+
value: Input95IyjglnxsValueEnum;
|
|
1509
1578
|
/**
|
|
1510
1579
|
* List of course IDs that are blocked by this trigger check.
|
|
1511
1580
|
* @example ["course1","course2"]
|
|
1512
1581
|
*/
|
|
1513
1582
|
blockedCourses?: string[];
|
|
1514
1583
|
}
|
|
1515
|
-
export interface
|
|
1584
|
+
export interface Input2Wmcdq98Nff {
|
|
1516
1585
|
/**
|
|
1517
1586
|
* Indicates whether the application item is approved
|
|
1518
1587
|
* @example true
|
|
@@ -1538,7 +1607,7 @@ export interface InputQkmwx5Xpx {
|
|
|
1538
1607
|
export interface StudentHistoryRequestSchema {
|
|
1539
1608
|
requirements: string[];
|
|
1540
1609
|
}
|
|
1541
|
-
export interface
|
|
1610
|
+
export interface Input0Wkmzwu09N {
|
|
1542
1611
|
/**
|
|
1543
1612
|
* Optional activation key for the application
|
|
1544
1613
|
* @example "AK-123456"
|
|
@@ -1546,7 +1615,7 @@ export interface InputEeq11Ik9Uq {
|
|
|
1546
1615
|
activationKey?: string;
|
|
1547
1616
|
}
|
|
1548
1617
|
/** Schema for course submission item details post request. */
|
|
1549
|
-
export interface
|
|
1618
|
+
export interface InputD91Mnyduu1I {
|
|
1550
1619
|
/**
|
|
1551
1620
|
* The ID of the file being submitted.
|
|
1552
1621
|
* @example "fileID123"
|
|
@@ -1559,7 +1628,7 @@ export interface InputP0Vxxq5Lvtl {
|
|
|
1559
1628
|
fileName: string;
|
|
1560
1629
|
}
|
|
1561
1630
|
/** Schema for the response to course submission item details post request. */
|
|
1562
|
-
export interface
|
|
1631
|
+
export interface OutputD91Mnyduu1I {
|
|
1563
1632
|
submissionItems: {
|
|
1564
1633
|
/**
|
|
1565
1634
|
* The ID of the file being submitted.
|
|
@@ -1574,7 +1643,7 @@ export interface OutputP0Vxxq5Lvtl {
|
|
|
1574
1643
|
}[];
|
|
1575
1644
|
}
|
|
1576
1645
|
/** Pending approval submission parameters */
|
|
1577
|
-
export interface
|
|
1646
|
+
export interface InputB147Al69Jz {
|
|
1578
1647
|
/**
|
|
1579
1648
|
* Type of pending approval
|
|
1580
1649
|
* @example "certification"
|
|
@@ -1594,7 +1663,7 @@ export interface InputP4C7Z75Art {
|
|
|
1594
1663
|
fileName: string;
|
|
1595
1664
|
}[];
|
|
1596
1665
|
}
|
|
1597
|
-
export interface
|
|
1666
|
+
export interface Input8Csj3Zf5Pb {
|
|
1598
1667
|
/**
|
|
1599
1668
|
* The ID of the course for which the license is being redeemed
|
|
1600
1669
|
* @example "courseID123"
|
|
@@ -1662,7 +1731,7 @@ export interface InputZk6Mvqgvde {
|
|
|
1662
1731
|
acknowledgement?: string | null;
|
|
1663
1732
|
}
|
|
1664
1733
|
/** Validate certification move response schema */
|
|
1665
|
-
export interface
|
|
1734
|
+
export interface OutputRf6Nc81I97 {
|
|
1666
1735
|
courses: {
|
|
1667
1736
|
name: string;
|
|
1668
1737
|
status: string;
|
|
@@ -1673,21 +1742,21 @@ export interface OutputAdwnctqt8E {
|
|
|
1673
1742
|
validated: boolean;
|
|
1674
1743
|
mustCreateCP: boolean;
|
|
1675
1744
|
}
|
|
1676
|
-
export interface
|
|
1745
|
+
export interface InputZqtdzcpfy0H {
|
|
1677
1746
|
/**
|
|
1678
1747
|
* Comments regarding the end of the cooldown period
|
|
1679
1748
|
* @example "Cooldown period ended successfully."
|
|
1680
1749
|
*/
|
|
1681
1750
|
comments: string;
|
|
1682
1751
|
}
|
|
1683
|
-
export interface
|
|
1752
|
+
export interface OutputSclsu8Dkbc {
|
|
1684
1753
|
/**
|
|
1685
1754
|
* Signed URL for the course file
|
|
1686
1755
|
* @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"
|
|
1687
1756
|
*/
|
|
1688
1757
|
fileURL: string;
|
|
1689
1758
|
}
|
|
1690
|
-
export interface
|
|
1759
|
+
export interface Input70Lemo2094I {
|
|
1691
1760
|
/** @example true */
|
|
1692
1761
|
agreedWithCertTerms: boolean;
|
|
1693
1762
|
/** @example 1717230000000 */
|
|
@@ -1759,21 +1828,21 @@ export interface InputGm3D7Dw52V {
|
|
|
1759
1828
|
/** @example "EXT#999" */
|
|
1760
1829
|
externalID2?: string | null;
|
|
1761
1830
|
}
|
|
1762
|
-
export interface
|
|
1831
|
+
export interface Input4C7Ab05Hvd {
|
|
1763
1832
|
/**
|
|
1764
1833
|
* Comments regarding the course unlock action
|
|
1765
1834
|
* @example "Course unlocked successfully."
|
|
1766
1835
|
*/
|
|
1767
1836
|
comments: string;
|
|
1768
1837
|
}
|
|
1769
|
-
export interface
|
|
1838
|
+
export interface Input0Xjfgi5Vfh {
|
|
1770
1839
|
/**
|
|
1771
1840
|
* ITA number to update for the user
|
|
1772
1841
|
* @example "ITA123456"
|
|
1773
1842
|
*/
|
|
1774
1843
|
itaNumber: string;
|
|
1775
1844
|
}
|
|
1776
|
-
export interface
|
|
1845
|
+
export interface Input2Sv3Uf1J5R {
|
|
1777
1846
|
/** @example true */
|
|
1778
1847
|
agreedWithCertTerms: boolean;
|
|
1779
1848
|
/** @example 1717230000000 */
|
|
@@ -1845,7 +1914,7 @@ export interface InputTf8Yi2E7Fh {
|
|
|
1845
1914
|
/** @example "EXT#999" */
|
|
1846
1915
|
externalID2?: string | null;
|
|
1847
1916
|
}
|
|
1848
|
-
export interface
|
|
1917
|
+
export interface InputMsfpsqzz5F {
|
|
1849
1918
|
/**
|
|
1850
1919
|
* The grade to override the course result with
|
|
1851
1920
|
* @example "A"
|
|
@@ -1853,7 +1922,7 @@ export interface InputMmshaoqcp4 {
|
|
|
1853
1922
|
resultGrade: string;
|
|
1854
1923
|
}
|
|
1855
1924
|
/** Pending approval review parameters */
|
|
1856
|
-
export interface
|
|
1925
|
+
export interface InputG5Kruym78U {
|
|
1857
1926
|
/**
|
|
1858
1927
|
* Notes provided by the reviewer for the pending approval
|
|
1859
1928
|
* @example "Please review the submitted documents."
|
|
@@ -1866,7 +1935,7 @@ export interface InputAx226Ufgd5 {
|
|
|
1866
1935
|
approved: boolean;
|
|
1867
1936
|
}
|
|
1868
1937
|
/** Schema for overriding course result dates. */
|
|
1869
|
-
export interface
|
|
1938
|
+
export interface Input6Zf937Iiq9 {
|
|
1870
1939
|
/**
|
|
1871
1940
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1872
1941
|
* @example 1735689600000
|
|
@@ -1878,14 +1947,14 @@ export interface InputN3Ihay0Vxz {
|
|
|
1878
1947
|
*/
|
|
1879
1948
|
completionDate?: number;
|
|
1880
1949
|
}
|
|
1881
|
-
export interface
|
|
1950
|
+
export interface Input5Tz2Rxu8B9 {
|
|
1882
1951
|
filter: {
|
|
1883
1952
|
from?: number;
|
|
1884
1953
|
sortOrder?: string;
|
|
1885
1954
|
sortField?: string;
|
|
1886
1955
|
};
|
|
1887
1956
|
}
|
|
1888
|
-
export interface
|
|
1957
|
+
export interface Output5Tz2Rxu8B9 {
|
|
1889
1958
|
users: {
|
|
1890
1959
|
firstName: string;
|
|
1891
1960
|
lastName: string;
|
|
@@ -1909,7 +1978,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
1909
1978
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1910
1979
|
* @example "CHECKED"
|
|
1911
1980
|
*/
|
|
1912
|
-
export declare enum
|
|
1981
|
+
export declare enum Input95IyjglnxsValueEnum {
|
|
1913
1982
|
CHECKED = "CHECKED",
|
|
1914
1983
|
UNCHECKED = "UNCHECKED",
|
|
1915
1984
|
NOVALUE = "NOVALUE"
|
|
@@ -1997,6 +2066,8 @@ export type CreateReportNcsoReportExportData = NcsoReportExportRequestSchema;
|
|
|
1997
2066
|
export type CreateReportNcsoReportExportError = ErrorResponse;
|
|
1998
2067
|
export type CreateReportNcsoReportData = ReportXLSXSchema;
|
|
1999
2068
|
export type CreateReportNcsoReportError = ErrorResponse;
|
|
2069
|
+
export type CreatePendingApprovalsSearchData = SearchPendingApprovalsResponseSchema;
|
|
2070
|
+
export type CreatePendingApprovalsSearchError = ErrorResponse;
|
|
2000
2071
|
export type CreateReportUsersAdvancedData = any;
|
|
2001
2072
|
export type CreateReportUsersAdvancedError = ErrorResponse;
|
|
2002
2073
|
export type ListSearchUsersIdsData = any;
|
|
@@ -2005,7 +2076,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2005
2076
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2006
2077
|
export type CreateReportUsersSimpleData = any;
|
|
2007
2078
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2008
|
-
export type CreateSearchUsersCountData =
|
|
2079
|
+
export type CreateSearchUsersCountData = Output5Dzws3Xlb1;
|
|
2009
2080
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2010
2081
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2011
2082
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2029,7 +2100,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2029
2100
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2030
2101
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2031
2102
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2032
|
-
export type GetCertificationCourseFileSignData =
|
|
2103
|
+
export type GetCertificationCourseFileSignData = OutputH3Al9V0E6X;
|
|
2033
2104
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2034
2105
|
export interface CreateCertificationCourseFileSignParams {
|
|
2035
2106
|
/** @example "pdf" */
|
|
@@ -2043,11 +2114,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2043
2114
|
/** @example "fileID" */
|
|
2044
2115
|
fileId: string;
|
|
2045
2116
|
}
|
|
2046
|
-
export type CreateCertificationCourseFileSignData =
|
|
2117
|
+
export type CreateCertificationCourseFileSignData = OutputSclsu8Dkbc;
|
|
2047
2118
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2048
2119
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2049
2120
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2050
|
-
export type CreateCertificationCourseDocumentData =
|
|
2121
|
+
export type CreateCertificationCourseDocumentData = OutputD91Mnyduu1I;
|
|
2051
2122
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2052
2123
|
export type DeleteUserData = any;
|
|
2053
2124
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2059,7 +2130,7 @@ export type UpdateUserData = any;
|
|
|
2059
2130
|
export type UpdateUserError = ErrorResponse;
|
|
2060
2131
|
export type DeleteCertificationCourseData = any;
|
|
2061
2132
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2062
|
-
export type GetCertificationApplicationItemFileData =
|
|
2133
|
+
export type GetCertificationApplicationItemFileData = OutputAt13P3Mi35;
|
|
2063
2134
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2064
2135
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2065
2136
|
/** @example "pdf" */
|
|
@@ -2073,9 +2144,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2073
2144
|
/** @example "fileVersion" */
|
|
2074
2145
|
fileVersion: string;
|
|
2075
2146
|
}
|
|
2076
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2147
|
+
export type CreateCertificationApplicationItemFileData = Output7V0C4Ojr08;
|
|
2077
2148
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2078
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2149
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = Output6Cq3W70Gx1;
|
|
2079
2150
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2080
2151
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2081
2152
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2083,7 +2154,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2083
2154
|
export type GetCourseError = ErrorResponse;
|
|
2084
2155
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2085
2156
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2086
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2157
|
+
export type GetCertificationApplicationForeignFillData = Output3Aonfmwetl;
|
|
2087
2158
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2088
2159
|
export type GetCertificationPrintData = any;
|
|
2089
2160
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2117,7 +2188,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2117
2188
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2118
2189
|
export type CreateCertificationWaiveData = any;
|
|
2119
2190
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2120
|
-
export type CreateCertificationMoveData =
|
|
2191
|
+
export type CreateCertificationMoveData = OutputVqygq7Onkl;
|
|
2121
2192
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2122
2193
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2123
2194
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2149,7 +2220,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2149
2220
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2150
2221
|
export type CreateCertificationCourseRedeemData = any;
|
|
2151
2222
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2152
|
-
export type CreateCertificationMoveValidateData =
|
|
2223
|
+
export type CreateCertificationMoveValidateData = OutputRf6Nc81I97;
|
|
2153
2224
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2154
2225
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2155
2226
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2165,7 +2236,7 @@ export type CreateCertificationPublishInfoData = any;
|
|
|
2165
2236
|
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2166
2237
|
export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
2167
2238
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2168
|
-
export type CreateCertificationResult =
|
|
2239
|
+
export type CreateCertificationResult = Output5Tz2Rxu8B9;
|
|
2169
2240
|
export type CreateCertificationFail = ErrorResponse;
|
|
2170
2241
|
export type CreateCertificationPublishInfoResult = any;
|
|
2171
2242
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2212,7 +2283,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2212
2283
|
}
|
|
2213
2284
|
/**
|
|
2214
2285
|
* @title BCCSA Program API
|
|
2215
|
-
* @version 3.0.
|
|
2286
|
+
* @version 3.0.28
|
|
2216
2287
|
* @baseUrl http://localhost:8080
|
|
2217
2288
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2218
2289
|
*/
|
|
@@ -2227,7 +2298,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2227
2298
|
* @request POST:/contactUs
|
|
2228
2299
|
* @secure
|
|
2229
2300
|
*/
|
|
2230
|
-
listContactUs: (data:
|
|
2301
|
+
listContactUs: (data: InputPvbucaddf5, params?: RequestParams) => Promise<any>;
|
|
2231
2302
|
};
|
|
2232
2303
|
customer: {
|
|
2233
2304
|
/**
|
|
@@ -2331,7 +2402,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2331
2402
|
* @request POST:/tenant/report/applicationExport
|
|
2332
2403
|
* @secure
|
|
2333
2404
|
*/
|
|
2334
|
-
createReportApplicationExport: (data:
|
|
2405
|
+
createReportApplicationExport: (data: InputG0Cepaoj72, params?: RequestParams) => Promise<any>;
|
|
2335
2406
|
/**
|
|
2336
2407
|
* @description Export a report of applications based on the provided filters.
|
|
2337
2408
|
*
|
|
@@ -2341,7 +2412,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2341
2412
|
* @request POST:/tenant/report/applicationStatus
|
|
2342
2413
|
* @secure
|
|
2343
2414
|
*/
|
|
2344
|
-
listReportApplicationStatus: (data:
|
|
2415
|
+
listReportApplicationStatus: (data: InputSsp9Tp64Hs, params?: RequestParams) => Promise<any>;
|
|
2345
2416
|
/**
|
|
2346
2417
|
* @description Export a report of applications based on the provided filters.
|
|
2347
2418
|
*
|
|
@@ -2351,7 +2422,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2351
2422
|
* @request POST:/tenant/report/applicationsReport
|
|
2352
2423
|
* @secure
|
|
2353
2424
|
*/
|
|
2354
|
-
createReportApplicationsReport: (data:
|
|
2425
|
+
createReportApplicationsReport: (data: InputRc3O6Ti8R3I, params?: RequestParams) => Promise<any>;
|
|
2355
2426
|
/**
|
|
2356
2427
|
* @description This route allows you to post certificates email for the tenant.
|
|
2357
2428
|
*
|
|
@@ -2361,7 +2432,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2361
2432
|
* @request POST:/tenant/certificates/email
|
|
2362
2433
|
* @secure
|
|
2363
2434
|
*/
|
|
2364
|
-
createCertificatesEmail: (data:
|
|
2435
|
+
createCertificatesEmail: (data: InputJcy0Ne1Wfs, params?: RequestParams) => Promise<any>;
|
|
2365
2436
|
/**
|
|
2366
2437
|
* @description Generate a preview of the completed certifications report.
|
|
2367
2438
|
*
|
|
@@ -2391,7 +2462,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2391
2462
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2392
2463
|
* @secure
|
|
2393
2464
|
*/
|
|
2394
|
-
createLicenseRedeem: (userId: string, data:
|
|
2465
|
+
createLicenseRedeem: (userId: string, data: InputPuba68Ylll, params?: RequestParams) => Promise<any>;
|
|
2395
2466
|
/**
|
|
2396
2467
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2397
2468
|
*
|
|
@@ -2401,7 +2472,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2401
2472
|
* @request POST:/tenant/report/orglicenses/
|
|
2402
2473
|
* @secure
|
|
2403
2474
|
*/
|
|
2404
|
-
listReportOrglicenses: (data:
|
|
2475
|
+
listReportOrglicenses: (data: Input2Z20Omtaj8I, params?: RequestParams) => Promise<any>;
|
|
2405
2476
|
/**
|
|
2406
2477
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2407
2478
|
*
|
|
@@ -2411,7 +2482,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2411
2482
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2412
2483
|
* @secure
|
|
2413
2484
|
*/
|
|
2414
|
-
createReportOrglicensesPreview: (data:
|
|
2485
|
+
createReportOrglicensesPreview: (data: InputAivcl5Kwb5L, params?: RequestParams) => Promise<any>;
|
|
2415
2486
|
/**
|
|
2416
2487
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2417
2488
|
*
|
|
@@ -2432,6 +2503,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2432
2503
|
* @secure
|
|
2433
2504
|
*/
|
|
2434
2505
|
createReportNcsoReport: (data: NcsoReportRequestSchema, params?: RequestParams) => Promise<ReportXLSXSchema>;
|
|
2506
|
+
/**
|
|
2507
|
+
* @description Searches pending approval review history by user and/or reviewedOn date range. Regular users are restricted to their own records.
|
|
2508
|
+
*
|
|
2509
|
+
* @tags Tenant
|
|
2510
|
+
* @name CreatePendingApprovalsSearch
|
|
2511
|
+
* @summary Search Pending Approvals Review History
|
|
2512
|
+
* @request POST:/tenant/pendingApprovals/search
|
|
2513
|
+
* @secure
|
|
2514
|
+
*/
|
|
2515
|
+
createPendingApprovalsSearch: (data: SearchPendingApprovalsWriteSchema, params?: RequestParams) => Promise<SearchPendingApprovalsResponseSchema>;
|
|
2435
2516
|
/**
|
|
2436
2517
|
* @description Advanced search for users in the tenant by filters, with report generation.
|
|
2437
2518
|
*
|
|
@@ -2441,7 +2522,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2441
2522
|
* @request POST:/tenant/report/users/advanced
|
|
2442
2523
|
* @secure
|
|
2443
2524
|
*/
|
|
2444
|
-
createReportUsersAdvanced: (data:
|
|
2525
|
+
createReportUsersAdvanced: (data: InputEaqpxgb94O, params?: RequestParams) => Promise<any>;
|
|
2445
2526
|
/**
|
|
2446
2527
|
* @description Searches for users in the tenant by their IDs.
|
|
2447
2528
|
*
|
|
@@ -2451,7 +2532,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2451
2532
|
* @request POST:/tenant/search/users/ids
|
|
2452
2533
|
* @secure
|
|
2453
2534
|
*/
|
|
2454
|
-
listSearchUsersIds: (data:
|
|
2535
|
+
listSearchUsersIds: (data: Input8P6Wn0Rsvm, params?: RequestParams) => Promise<any>;
|
|
2455
2536
|
/**
|
|
2456
2537
|
* @description Searches for users in the tenant by term and filters.
|
|
2457
2538
|
*
|
|
@@ -2461,7 +2542,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2461
2542
|
* @request POST:/tenant/search/users/term
|
|
2462
2543
|
* @secure
|
|
2463
2544
|
*/
|
|
2464
|
-
createSearchUsersTerm: (data:
|
|
2545
|
+
createSearchUsersTerm: (data: InputW1Muuiafip, params?: RequestParams) => Promise<any>;
|
|
2465
2546
|
/**
|
|
2466
2547
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2467
2548
|
*
|
|
@@ -2471,7 +2552,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2471
2552
|
* @request POST:/tenant/report/users/simple
|
|
2472
2553
|
* @secure
|
|
2473
2554
|
*/
|
|
2474
|
-
createReportUsersSimple: (data:
|
|
2555
|
+
createReportUsersSimple: (data: InputSyy54Bhhpw, params?: RequestParams) => Promise<any>;
|
|
2475
2556
|
/**
|
|
2476
2557
|
* @description Retrieve user by ID.
|
|
2477
2558
|
*
|
|
@@ -2481,7 +2562,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2481
2562
|
* @request POST:/tenant/search/users/count
|
|
2482
2563
|
* @secure
|
|
2483
2564
|
*/
|
|
2484
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2565
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<Output5Dzws3Xlb1>;
|
|
2485
2566
|
};
|
|
2486
2567
|
user: {
|
|
2487
2568
|
/**
|
|
@@ -2513,7 +2594,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2513
2594
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2514
2595
|
* @secure
|
|
2515
2596
|
*/
|
|
2516
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2597
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: Input9Wblq49Y5F, params?: RequestParams) => Promise<any>;
|
|
2517
2598
|
/**
|
|
2518
2599
|
* @description Delete a certification process application by type.
|
|
2519
2600
|
*
|
|
@@ -2603,7 +2684,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2603
2684
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2604
2685
|
* @secure
|
|
2605
2686
|
*/
|
|
2606
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2687
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputH3Al9V0E6X>;
|
|
2607
2688
|
/**
|
|
2608
2689
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2609
2690
|
*
|
|
@@ -2613,7 +2694,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2613
2694
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2614
2695
|
* @secure
|
|
2615
2696
|
*/
|
|
2616
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2697
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputSclsu8Dkbc>;
|
|
2617
2698
|
/**
|
|
2618
2699
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2619
2700
|
*
|
|
@@ -2633,7 +2714,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2633
2714
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2634
2715
|
* @secure
|
|
2635
2716
|
*/
|
|
2636
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2717
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputD91Mnyduu1I, params?: RequestParams) => Promise<OutputD91Mnyduu1I>;
|
|
2637
2718
|
/**
|
|
2638
2719
|
* @description Delete user by ID.
|
|
2639
2720
|
*
|
|
@@ -2663,7 +2744,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2663
2744
|
* @request POST:/user/{userID}
|
|
2664
2745
|
* @secure
|
|
2665
2746
|
*/
|
|
2666
|
-
createUser: (userId: string, data:
|
|
2747
|
+
createUser: (userId: string, data: Input70Lemo2094I, params?: RequestParams) => Promise<any>;
|
|
2667
2748
|
/**
|
|
2668
2749
|
* @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.
|
|
2669
2750
|
*
|
|
@@ -2673,7 +2754,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2673
2754
|
* @request PUT:/user/{userID}
|
|
2674
2755
|
* @secure
|
|
2675
2756
|
*/
|
|
2676
|
-
updateUser: (userId: string, data:
|
|
2757
|
+
updateUser: (userId: string, data: Input2Sv3Uf1J5R, params?: RequestParams) => Promise<any>;
|
|
2677
2758
|
/**
|
|
2678
2759
|
* @description Delete course from user
|
|
2679
2760
|
*
|
|
@@ -2693,7 +2774,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2693
2774
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2694
2775
|
* @secure
|
|
2695
2776
|
*/
|
|
2696
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2777
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputAt13P3Mi35>;
|
|
2697
2778
|
/**
|
|
2698
2779
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2699
2780
|
*
|
|
@@ -2703,7 +2784,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2703
2784
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2704
2785
|
* @secure
|
|
2705
2786
|
*/
|
|
2706
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2787
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<Output7V0C4Ojr08>;
|
|
2707
2788
|
/**
|
|
2708
2789
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2709
2790
|
*
|
|
@@ -2713,7 +2794,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2713
2794
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2714
2795
|
* @secure
|
|
2715
2796
|
*/
|
|
2716
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2797
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<Output6Cq3W70Gx1>;
|
|
2717
2798
|
/**
|
|
2718
2799
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2719
2800
|
*
|
|
@@ -2753,7 +2834,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2753
2834
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2754
2835
|
* @secure
|
|
2755
2836
|
*/
|
|
2756
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2837
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<Output3Aonfmwetl>;
|
|
2757
2838
|
/**
|
|
2758
2839
|
* @description This endpoint will print certificate
|
|
2759
2840
|
*
|
|
@@ -2813,7 +2894,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2813
2894
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2814
2895
|
* @secure
|
|
2815
2896
|
*/
|
|
2816
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2897
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputVelwazpnf6, params?: RequestParams) => Promise<any>;
|
|
2817
2898
|
/**
|
|
2818
2899
|
* @description This endpoint allows you to add a user to a session in a certification process. It requires the user ID, certification process ID, secondary user ID, course ID, and session ID as path parameters.
|
|
2819
2900
|
*
|
|
@@ -2843,7 +2924,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2843
2924
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2844
2925
|
* @secure
|
|
2845
2926
|
*/
|
|
2846
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2927
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: Input8Zbphib1Bp, params?: RequestParams) => Promise<any>;
|
|
2847
2928
|
/**
|
|
2848
2929
|
* @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.
|
|
2849
2930
|
*
|
|
@@ -2853,7 +2934,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2853
2934
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2854
2935
|
* @secure
|
|
2855
2936
|
*/
|
|
2856
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2937
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputMker1Xtkzxl, params?: RequestParams) => Promise<any>;
|
|
2857
2938
|
/**
|
|
2858
2939
|
* @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.
|
|
2859
2940
|
*
|
|
@@ -2863,7 +2944,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2863
2944
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2864
2945
|
* @secure
|
|
2865
2946
|
*/
|
|
2866
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2947
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputY6007M76Zb, params?: RequestParams) => Promise<any>;
|
|
2867
2948
|
/**
|
|
2868
2949
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2869
2950
|
*
|
|
@@ -2873,7 +2954,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2873
2954
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2874
2955
|
* @secure
|
|
2875
2956
|
*/
|
|
2876
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2957
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputRvv6An47F8I, params?: RequestParams) => Promise<any>;
|
|
2877
2958
|
/**
|
|
2878
2959
|
* @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.
|
|
2879
2960
|
*
|
|
@@ -2913,7 +2994,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2913
2994
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2914
2995
|
* @secure
|
|
2915
2996
|
*/
|
|
2916
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2997
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputPqplzyab0W, params?: RequestParams) => Promise<any>;
|
|
2917
2998
|
/**
|
|
2918
2999
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
2919
3000
|
*
|
|
@@ -2923,7 +3004,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2923
3004
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2924
3005
|
* @secure
|
|
2925
3006
|
*/
|
|
2926
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3007
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputVqygq7Onkl>;
|
|
2927
3008
|
/**
|
|
2928
3009
|
* @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.
|
|
2929
3010
|
*
|
|
@@ -2963,7 +3044,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2963
3044
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2964
3045
|
* @secure
|
|
2965
3046
|
*/
|
|
2966
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
3047
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: Input95Iyjglnxs, params?: RequestParams) => Promise<any>;
|
|
2967
3048
|
/**
|
|
2968
3049
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
2969
3050
|
*
|
|
@@ -3023,7 +3104,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3023
3104
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3024
3105
|
* @secure
|
|
3025
3106
|
*/
|
|
3026
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
3107
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: Input2Wmcdq98Nff, params?: RequestParams) => Promise<any>;
|
|
3027
3108
|
/**
|
|
3028
3109
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3029
3110
|
*
|
|
@@ -3043,7 +3124,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3043
3124
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3044
3125
|
* @secure
|
|
3045
3126
|
*/
|
|
3046
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3127
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: Input0Wkmzwu09N, params?: RequestParams) => Promise<any>;
|
|
3047
3128
|
/**
|
|
3048
3129
|
* @description This route allows you to submit a pending approval.
|
|
3049
3130
|
*
|
|
@@ -3053,7 +3134,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3053
3134
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3054
3135
|
* @secure
|
|
3055
3136
|
*/
|
|
3056
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3137
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputB147Al69Jz, params?: RequestParams) => Promise<any>;
|
|
3057
3138
|
/**
|
|
3058
3139
|
* @description This route allows you to review a pending approval.
|
|
3059
3140
|
*
|
|
@@ -3063,7 +3144,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3063
3144
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3064
3145
|
* @secure
|
|
3065
3146
|
*/
|
|
3066
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3147
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputG5Kruym78U, params?: RequestParams) => Promise<any>;
|
|
3067
3148
|
/**
|
|
3068
3149
|
* @description Redeems a license for a user by product ID.
|
|
3069
3150
|
*
|
|
@@ -3073,7 +3154,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3073
3154
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3074
3155
|
* @secure
|
|
3075
3156
|
*/
|
|
3076
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3157
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: Input8Csj3Zf5Pb, params?: RequestParams) => Promise<any>;
|
|
3077
3158
|
/**
|
|
3078
3159
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3079
3160
|
*
|
|
@@ -3083,7 +3164,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3083
3164
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3084
3165
|
* @secure
|
|
3085
3166
|
*/
|
|
3086
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3167
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputRf6Nc81I97>;
|
|
3087
3168
|
/**
|
|
3088
3169
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3089
3170
|
*
|
|
@@ -3093,7 +3174,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3093
3174
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3094
3175
|
* @secure
|
|
3095
3176
|
*/
|
|
3096
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3177
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputZqtdzcpfy0H, params?: RequestParams) => Promise<any>;
|
|
3097
3178
|
/**
|
|
3098
3179
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3099
3180
|
*
|
|
@@ -3103,7 +3184,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3103
3184
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3104
3185
|
* @secure
|
|
3105
3186
|
*/
|
|
3106
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3187
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input4C7Ab05Hvd, params?: RequestParams) => Promise<any>;
|
|
3107
3188
|
/**
|
|
3108
3189
|
* @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.
|
|
3109
3190
|
*
|
|
@@ -3113,7 +3194,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3113
3194
|
* @request POST:/user/{userID}/updateITA
|
|
3114
3195
|
* @secure
|
|
3115
3196
|
*/
|
|
3116
|
-
createUpdateIta: (userId: string, data:
|
|
3197
|
+
createUpdateIta: (userId: string, data: Input0Xjfgi5Vfh, params?: RequestParams) => Promise<any>;
|
|
3117
3198
|
/**
|
|
3118
3199
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3119
3200
|
*
|
|
@@ -3123,7 +3204,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3123
3204
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3124
3205
|
* @secure
|
|
3125
3206
|
*/
|
|
3126
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3207
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputMsfpsqzz5F, params?: RequestParams) => Promise<any>;
|
|
3127
3208
|
/**
|
|
3128
3209
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3129
3210
|
*
|
|
@@ -3133,7 +3214,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3133
3214
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3134
3215
|
* @secure
|
|
3135
3216
|
*/
|
|
3136
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3217
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: Input6Zf937Iiq9, params?: RequestParams) => Promise<any>;
|
|
3137
3218
|
/**
|
|
3138
3219
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3139
3220
|
*
|
|
@@ -3165,7 +3246,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3165
3246
|
* @request POST:/users/certification/{certSpecID}
|
|
3166
3247
|
* @secure
|
|
3167
3248
|
*/
|
|
3168
|
-
createCertification: (certSpecId: string, data:
|
|
3249
|
+
createCertification: (certSpecId: string, data: Input5Tz2Rxu8B9, params?: RequestParams) => Promise<Output5Tz2Rxu8B9>;
|
|
3169
3250
|
/**
|
|
3170
3251
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3171
3252
|
*
|