@ikonintegration/bccsa-program-api 3.0.25 → 3.0.27
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 +197 -94
- package/dist/Api.d.ts +187 -103
- package/dist/Api.js +28 -9
- 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 InputUx6Ghp63U1F {
|
|
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 InputCvh6Zbzry6 {
|
|
455
455
|
/**
|
|
456
456
|
* ID of the certification to filter applications by
|
|
457
457
|
* @example "certification123"
|
|
@@ -508,7 +508,7 @@ export interface InputL5Mafsqfat {
|
|
|
508
508
|
*/
|
|
509
509
|
ignoreCompletedCertifications?: boolean | null;
|
|
510
510
|
}
|
|
511
|
-
export interface
|
|
511
|
+
export interface InputBj26Kjwvet {
|
|
512
512
|
/**
|
|
513
513
|
* ID of the certification to filter applications by
|
|
514
514
|
* @example "certification123"
|
|
@@ -565,7 +565,7 @@ export interface InputF4Q99Ghr8W {
|
|
|
565
565
|
*/
|
|
566
566
|
ignoreCompletedCertifications?: boolean | null;
|
|
567
567
|
}
|
|
568
|
-
export interface
|
|
568
|
+
export interface InputCv70Q8Akww {
|
|
569
569
|
/**
|
|
570
570
|
* ID of the certification to filter applications by
|
|
571
571
|
* @example "certification123"
|
|
@@ -622,7 +622,7 @@ export interface Input51Kql6P0Xu {
|
|
|
622
622
|
*/
|
|
623
623
|
ignoreCompletedCertifications?: boolean | null;
|
|
624
624
|
}
|
|
625
|
-
export interface
|
|
625
|
+
export interface Input81A6Hr7Hkm {
|
|
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 Input2T5Dq39Ke9 {
|
|
|
663
663
|
emailAddress: string;
|
|
664
664
|
}[];
|
|
665
665
|
}
|
|
666
|
-
export interface
|
|
666
|
+
export interface InputZ7Y5J1Dr75 {
|
|
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 InputCryywuj0K5 {
|
|
|
675
675
|
*/
|
|
676
676
|
sessionID?: string;
|
|
677
677
|
}
|
|
678
|
-
export interface
|
|
678
|
+
export interface InputOy4V8Im0Kh {
|
|
679
679
|
/**
|
|
680
680
|
* Search term to filter licenses
|
|
681
681
|
* @example "active"
|
|
@@ -692,7 +692,7 @@ export interface Input7Fm6Ar6Ikc {
|
|
|
692
692
|
*/
|
|
693
693
|
sortField?: any;
|
|
694
694
|
}
|
|
695
|
-
export interface
|
|
695
|
+
export interface InputStgqlja7Xt {
|
|
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 InputEglu9M4Vmj {
|
|
752
821
|
/**
|
|
753
822
|
* Start date for the report
|
|
754
823
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -770,11 +839,11 @@ export interface Input4O1N8Cqdn6J {
|
|
|
770
839
|
*/
|
|
771
840
|
dateType?: string;
|
|
772
841
|
}
|
|
773
|
-
export interface
|
|
842
|
+
export interface Input8R2A93Snv2F {
|
|
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 Input0Gcdrfrad0K {
|
|
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 Input4Bmr5Tztvtf {
|
|
|
814
883
|
};
|
|
815
884
|
};
|
|
816
885
|
}
|
|
817
|
-
export interface
|
|
886
|
+
export interface InputNwfxg6Mnx6K {
|
|
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 Input14Wsadu67R {
|
|
|
854
923
|
};
|
|
855
924
|
};
|
|
856
925
|
}
|
|
857
|
-
export interface
|
|
926
|
+
export interface OutputCeu3Cbjle7 {
|
|
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 OutputTwbrusyi5D {
|
|
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 OutputDalfsjzegc {
|
|
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 OutputLmj3Egxsgw {
|
|
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 OutputJurcooq49A {
|
|
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 Input2Sq1Ggl8Flf {
|
|
1378
1447
|
issuedOn?: number;
|
|
1379
1448
|
expiresOn?: number;
|
|
1380
1449
|
fileItems?: {
|
|
@@ -1383,21 +1452,21 @@ export interface InputCbpydyfecl {
|
|
|
1383
1452
|
}[];
|
|
1384
1453
|
additionalNotes?: string | null;
|
|
1385
1454
|
}
|
|
1386
|
-
export interface
|
|
1455
|
+
export interface InputA1Ue47Tc5S {
|
|
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 Output4Iblwyq6Ah {
|
|
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 InputRkf87Bvk4R {
|
|
1401
1470
|
/**
|
|
1402
1471
|
* Indicates whether the waiver is approved
|
|
1403
1472
|
* @example true
|
|
@@ -1409,14 +1478,14 @@ export interface InputKg4Xkqwj57 {
|
|
|
1409
1478
|
*/
|
|
1410
1479
|
additionalNotes?: string | null;
|
|
1411
1480
|
}
|
|
1412
|
-
export interface
|
|
1481
|
+
export interface InputZg9Ekdlhnb {
|
|
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 InputXszlgox1Xx {
|
|
1420
1489
|
students: {
|
|
1421
1490
|
/**
|
|
1422
1491
|
* User ID of the student to redeem the course for
|
|
@@ -1450,7 +1519,7 @@ export interface InputM6R3Wh6Pxz {
|
|
|
1450
1519
|
*/
|
|
1451
1520
|
autoEnrolSessionID?: string;
|
|
1452
1521
|
}
|
|
1453
|
-
export interface
|
|
1522
|
+
export interface InputHbwwop8Qyt {
|
|
1454
1523
|
invites: {
|
|
1455
1524
|
/**
|
|
1456
1525
|
* Email address of the user to invite
|
|
@@ -1479,7 +1548,7 @@ export interface InputVsn945Yctpi {
|
|
|
1479
1548
|
*/
|
|
1480
1549
|
isReservedSeat: boolean;
|
|
1481
1550
|
}
|
|
1482
|
-
export interface
|
|
1551
|
+
export interface Input3Euijgfoac {
|
|
1483
1552
|
/**
|
|
1484
1553
|
* Indicates whether to waive the certification process
|
|
1485
1554
|
* @example true
|
|
@@ -1492,7 +1561,7 @@ export interface Input3Zzy8W1Fuh {
|
|
|
1492
1561
|
comments?: string | null;
|
|
1493
1562
|
}
|
|
1494
1563
|
/** Certification move response schema */
|
|
1495
|
-
export interface
|
|
1564
|
+
export interface OutputFly8V39N47 {
|
|
1496
1565
|
errors?: {
|
|
1497
1566
|
status: string;
|
|
1498
1567
|
object?: Record<string, any>;
|
|
@@ -1500,19 +1569,19 @@ export interface OutputAiche6Pi4W {
|
|
|
1500
1569
|
}[];
|
|
1501
1570
|
}
|
|
1502
1571
|
/** Schema for writing a certification trigger check. */
|
|
1503
|
-
export interface
|
|
1572
|
+
export interface InputRzff22Tkc {
|
|
1504
1573
|
/**
|
|
1505
1574
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1506
1575
|
* @example "CHECKED"
|
|
1507
1576
|
*/
|
|
1508
|
-
value:
|
|
1577
|
+
value: InputRzff22TkcValueEnum;
|
|
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 InputMnsqq1Ejho {
|
|
1516
1585
|
/**
|
|
1517
1586
|
* Indicates whether the application item is approved
|
|
1518
1587
|
* @example true
|
|
@@ -1538,7 +1607,7 @@ export interface InputT1Po2Bcy2H {
|
|
|
1538
1607
|
export interface StudentHistoryRequestSchema {
|
|
1539
1608
|
requirements: string[];
|
|
1540
1609
|
}
|
|
1541
|
-
export interface
|
|
1610
|
+
export interface Input2N620Uctjn {
|
|
1542
1611
|
/**
|
|
1543
1612
|
* Optional activation key for the application
|
|
1544
1613
|
* @example "AK-123456"
|
|
@@ -1546,7 +1615,7 @@ export interface InputIhqbjgfwmwf {
|
|
|
1546
1615
|
activationKey?: string;
|
|
1547
1616
|
}
|
|
1548
1617
|
/** Schema for course submission item details post request. */
|
|
1549
|
-
export interface
|
|
1618
|
+
export interface InputMmv9D3Rl8W {
|
|
1550
1619
|
/**
|
|
1551
1620
|
* The ID of the file being submitted.
|
|
1552
1621
|
* @example "fileID123"
|
|
@@ -1559,7 +1628,7 @@ export interface InputNkt1M0Sigg {
|
|
|
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 OutputMmv9D3Rl8W {
|
|
1563
1632
|
submissionItems: {
|
|
1564
1633
|
/**
|
|
1565
1634
|
* The ID of the file being submitted.
|
|
@@ -1574,7 +1643,7 @@ export interface OutputNkt1M0Sigg {
|
|
|
1574
1643
|
}[];
|
|
1575
1644
|
}
|
|
1576
1645
|
/** Pending approval submission parameters */
|
|
1577
|
-
export interface
|
|
1646
|
+
export interface InputD6Psozp2I3 {
|
|
1578
1647
|
/**
|
|
1579
1648
|
* Type of pending approval
|
|
1580
1649
|
* @example "certification"
|
|
@@ -1594,7 +1663,7 @@ export interface InputSkwo64Irm8 {
|
|
|
1594
1663
|
fileName: string;
|
|
1595
1664
|
}[];
|
|
1596
1665
|
}
|
|
1597
|
-
export interface
|
|
1666
|
+
export interface InputMeztvunaev {
|
|
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 InputGjqi82Rf9D {
|
|
|
1662
1731
|
acknowledgement?: string | null;
|
|
1663
1732
|
}
|
|
1664
1733
|
/** Validate certification move response schema */
|
|
1665
|
-
export interface
|
|
1734
|
+
export interface OutputGrqe1Ahq5A {
|
|
1666
1735
|
courses: {
|
|
1667
1736
|
name: string;
|
|
1668
1737
|
status: string;
|
|
@@ -1673,21 +1742,21 @@ export interface OutputSrmupesvlu {
|
|
|
1673
1742
|
validated: boolean;
|
|
1674
1743
|
mustCreateCP: boolean;
|
|
1675
1744
|
}
|
|
1676
|
-
export interface
|
|
1745
|
+
export interface InputP4Xruevr6T {
|
|
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 Output89F1Ccxlsj {
|
|
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 Input2D83W8G4Knl {
|
|
1691
1760
|
/** @example true */
|
|
1692
1761
|
agreedWithCertTerms: boolean;
|
|
1693
1762
|
/** @example 1717230000000 */
|
|
@@ -1759,21 +1828,21 @@ export interface InputL6Dd6Jvc4X {
|
|
|
1759
1828
|
/** @example "EXT#999" */
|
|
1760
1829
|
externalID2?: string | null;
|
|
1761
1830
|
}
|
|
1762
|
-
export interface
|
|
1831
|
+
export interface InputR6N63Ewm71 {
|
|
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 InputLqqytpg8Jk {
|
|
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 Input3Kkaz78N51 {
|
|
1777
1846
|
/** @example true */
|
|
1778
1847
|
agreedWithCertTerms: boolean;
|
|
1779
1848
|
/** @example 1717230000000 */
|
|
@@ -1845,7 +1914,7 @@ export interface InputZ1Gwnuie45 {
|
|
|
1845
1914
|
/** @example "EXT#999" */
|
|
1846
1915
|
externalID2?: string | null;
|
|
1847
1916
|
}
|
|
1848
|
-
export interface
|
|
1917
|
+
export interface InputG9Q1Ctgc13 {
|
|
1849
1918
|
/**
|
|
1850
1919
|
* The grade to override the course result with
|
|
1851
1920
|
* @example "A"
|
|
@@ -1853,7 +1922,7 @@ export interface InputBdyz7Wbn8D {
|
|
|
1853
1922
|
resultGrade: string;
|
|
1854
1923
|
}
|
|
1855
1924
|
/** Pending approval review parameters */
|
|
1856
|
-
export interface
|
|
1925
|
+
export interface InputIc0Bc2Eq1W {
|
|
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 InputTl132Xl4De {
|
|
|
1866
1935
|
approved: boolean;
|
|
1867
1936
|
}
|
|
1868
1937
|
/** Schema for overriding course result dates. */
|
|
1869
|
-
export interface
|
|
1938
|
+
export interface InputJ1Jc5Tm0Tl {
|
|
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 InputRqs0Srazmv {
|
|
|
1878
1947
|
*/
|
|
1879
1948
|
completionDate?: number;
|
|
1880
1949
|
}
|
|
1881
|
-
export interface
|
|
1950
|
+
export interface Input44B69Di6Zjj {
|
|
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 Output44B69Di6Zjj {
|
|
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 InputRzff22TkcValueEnum {
|
|
1913
1982
|
CHECKED = "CHECKED",
|
|
1914
1983
|
UNCHECKED = "UNCHECKED",
|
|
1915
1984
|
NOVALUE = "NOVALUE"
|
|
@@ -1956,6 +2025,9 @@ export type ListReportCompletedWithConsentData = any;
|
|
|
1956
2025
|
export type ListReportCompletedWithConsentError = ErrorResponse;
|
|
1957
2026
|
export type ListPendingApplicationsData = ApplicationResponseSchema;
|
|
1958
2027
|
export type ListPendingApplicationsError = ErrorResponse;
|
|
2028
|
+
export interface ListPendingApprovalsParams {
|
|
2029
|
+
type?: string;
|
|
2030
|
+
}
|
|
1959
2031
|
export type ListPendingApprovalsData = PendingApprovalResponseSchema;
|
|
1960
2032
|
export type ListPendingApprovalsError = ErrorResponse;
|
|
1961
2033
|
export type ListConfigResult = any;
|
|
@@ -1994,6 +2066,8 @@ export type CreateReportNcsoReportExportData = NcsoReportExportRequestSchema;
|
|
|
1994
2066
|
export type CreateReportNcsoReportExportError = ErrorResponse;
|
|
1995
2067
|
export type CreateReportNcsoReportData = ReportXLSXSchema;
|
|
1996
2068
|
export type CreateReportNcsoReportError = ErrorResponse;
|
|
2069
|
+
export type CreatePendingApprovalsSearchData = SearchPendingApprovalsResponseSchema;
|
|
2070
|
+
export type CreatePendingApprovalsSearchError = ErrorResponse;
|
|
1997
2071
|
export type CreateReportUsersAdvancedData = any;
|
|
1998
2072
|
export type CreateReportUsersAdvancedError = ErrorResponse;
|
|
1999
2073
|
export type ListSearchUsersIdsData = any;
|
|
@@ -2002,7 +2076,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2002
2076
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2003
2077
|
export type CreateReportUsersSimpleData = any;
|
|
2004
2078
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2005
|
-
export type CreateSearchUsersCountData =
|
|
2079
|
+
export type CreateSearchUsersCountData = OutputCeu3Cbjle7;
|
|
2006
2080
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2007
2081
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2008
2082
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2026,7 +2100,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2026
2100
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2027
2101
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2028
2102
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2029
|
-
export type GetCertificationCourseFileSignData =
|
|
2103
|
+
export type GetCertificationCourseFileSignData = OutputLmj3Egxsgw;
|
|
2030
2104
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2031
2105
|
export interface CreateCertificationCourseFileSignParams {
|
|
2032
2106
|
/** @example "pdf" */
|
|
@@ -2040,11 +2114,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2040
2114
|
/** @example "fileID" */
|
|
2041
2115
|
fileId: string;
|
|
2042
2116
|
}
|
|
2043
|
-
export type CreateCertificationCourseFileSignData =
|
|
2117
|
+
export type CreateCertificationCourseFileSignData = Output89F1Ccxlsj;
|
|
2044
2118
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2045
2119
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2046
2120
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2047
|
-
export type CreateCertificationCourseDocumentData =
|
|
2121
|
+
export type CreateCertificationCourseDocumentData = OutputMmv9D3Rl8W;
|
|
2048
2122
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2049
2123
|
export type DeleteUserData = any;
|
|
2050
2124
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2056,7 +2130,7 @@ export type UpdateUserData = any;
|
|
|
2056
2130
|
export type UpdateUserError = ErrorResponse;
|
|
2057
2131
|
export type DeleteCertificationCourseData = any;
|
|
2058
2132
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2059
|
-
export type GetCertificationApplicationItemFileData =
|
|
2133
|
+
export type GetCertificationApplicationItemFileData = OutputTwbrusyi5D;
|
|
2060
2134
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2061
2135
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2062
2136
|
/** @example "pdf" */
|
|
@@ -2070,9 +2144,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2070
2144
|
/** @example "fileVersion" */
|
|
2071
2145
|
fileVersion: string;
|
|
2072
2146
|
}
|
|
2073
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2147
|
+
export type CreateCertificationApplicationItemFileData = Output4Iblwyq6Ah;
|
|
2074
2148
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2075
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2149
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputDalfsjzegc;
|
|
2076
2150
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2077
2151
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2078
2152
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2080,7 +2154,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2080
2154
|
export type GetCourseError = ErrorResponse;
|
|
2081
2155
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2082
2156
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2083
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2157
|
+
export type GetCertificationApplicationForeignFillData = OutputJurcooq49A;
|
|
2084
2158
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2085
2159
|
export type GetCertificationPrintData = any;
|
|
2086
2160
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2114,7 +2188,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2114
2188
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2115
2189
|
export type CreateCertificationWaiveData = any;
|
|
2116
2190
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2117
|
-
export type CreateCertificationMoveData =
|
|
2191
|
+
export type CreateCertificationMoveData = OutputFly8V39N47;
|
|
2118
2192
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2119
2193
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2120
2194
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2146,7 +2220,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2146
2220
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2147
2221
|
export type CreateCertificationCourseRedeemData = any;
|
|
2148
2222
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2149
|
-
export type CreateCertificationMoveValidateData =
|
|
2223
|
+
export type CreateCertificationMoveValidateData = OutputGrqe1Ahq5A;
|
|
2150
2224
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2151
2225
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2152
2226
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2162,7 +2236,7 @@ export type CreateCertificationPublishInfoData = any;
|
|
|
2162
2236
|
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2163
2237
|
export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
2164
2238
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2165
|
-
export type CreateCertificationResult =
|
|
2239
|
+
export type CreateCertificationResult = Output44B69Di6Zjj;
|
|
2166
2240
|
export type CreateCertificationFail = ErrorResponse;
|
|
2167
2241
|
export type CreateCertificationPublishInfoResult = any;
|
|
2168
2242
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2209,7 +2283,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2209
2283
|
}
|
|
2210
2284
|
/**
|
|
2211
2285
|
* @title BCCSA Program API
|
|
2212
|
-
* @version 3.0.
|
|
2286
|
+
* @version 3.0.27
|
|
2213
2287
|
* @baseUrl http://localhost:8080
|
|
2214
2288
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2215
2289
|
*/
|
|
@@ -2224,7 +2298,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2224
2298
|
* @request POST:/contactUs
|
|
2225
2299
|
* @secure
|
|
2226
2300
|
*/
|
|
2227
|
-
listContactUs: (data:
|
|
2301
|
+
listContactUs: (data: InputUx6Ghp63U1F, params?: RequestParams) => Promise<any>;
|
|
2228
2302
|
};
|
|
2229
2303
|
customer: {
|
|
2230
2304
|
/**
|
|
@@ -2308,7 +2382,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2308
2382
|
* @request GET:/tenant/pendingApprovals
|
|
2309
2383
|
* @secure
|
|
2310
2384
|
*/
|
|
2311
|
-
listPendingApprovals: (params?: RequestParams) => Promise<PendingApprovalResponseSchema>;
|
|
2385
|
+
listPendingApprovals: (query: ListPendingApprovalsParams, params?: RequestParams) => Promise<PendingApprovalResponseSchema>;
|
|
2312
2386
|
/**
|
|
2313
2387
|
* @description Retrieve config for the tenant.
|
|
2314
2388
|
*
|
|
@@ -2328,7 +2402,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2328
2402
|
* @request POST:/tenant/report/applicationExport
|
|
2329
2403
|
* @secure
|
|
2330
2404
|
*/
|
|
2331
|
-
createReportApplicationExport: (data:
|
|
2405
|
+
createReportApplicationExport: (data: InputCvh6Zbzry6, params?: RequestParams) => Promise<any>;
|
|
2332
2406
|
/**
|
|
2333
2407
|
* @description Export a report of applications based on the provided filters.
|
|
2334
2408
|
*
|
|
@@ -2338,7 +2412,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2338
2412
|
* @request POST:/tenant/report/applicationStatus
|
|
2339
2413
|
* @secure
|
|
2340
2414
|
*/
|
|
2341
|
-
listReportApplicationStatus: (data:
|
|
2415
|
+
listReportApplicationStatus: (data: InputBj26Kjwvet, params?: RequestParams) => Promise<any>;
|
|
2342
2416
|
/**
|
|
2343
2417
|
* @description Export a report of applications based on the provided filters.
|
|
2344
2418
|
*
|
|
@@ -2348,7 +2422,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2348
2422
|
* @request POST:/tenant/report/applicationsReport
|
|
2349
2423
|
* @secure
|
|
2350
2424
|
*/
|
|
2351
|
-
createReportApplicationsReport: (data:
|
|
2425
|
+
createReportApplicationsReport: (data: InputCv70Q8Akww, params?: RequestParams) => Promise<any>;
|
|
2352
2426
|
/**
|
|
2353
2427
|
* @description This route allows you to post certificates email for the tenant.
|
|
2354
2428
|
*
|
|
@@ -2358,7 +2432,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2358
2432
|
* @request POST:/tenant/certificates/email
|
|
2359
2433
|
* @secure
|
|
2360
2434
|
*/
|
|
2361
|
-
createCertificatesEmail: (data:
|
|
2435
|
+
createCertificatesEmail: (data: Input81A6Hr7Hkm, params?: RequestParams) => Promise<any>;
|
|
2362
2436
|
/**
|
|
2363
2437
|
* @description Generate a preview of the completed certifications report.
|
|
2364
2438
|
*
|
|
@@ -2388,7 +2462,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2388
2462
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2389
2463
|
* @secure
|
|
2390
2464
|
*/
|
|
2391
|
-
createLicenseRedeem: (userId: string, data:
|
|
2465
|
+
createLicenseRedeem: (userId: string, data: InputZ7Y5J1Dr75, params?: RequestParams) => Promise<any>;
|
|
2392
2466
|
/**
|
|
2393
2467
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2394
2468
|
*
|
|
@@ -2398,7 +2472,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2398
2472
|
* @request POST:/tenant/report/orglicenses/
|
|
2399
2473
|
* @secure
|
|
2400
2474
|
*/
|
|
2401
|
-
listReportOrglicenses: (data:
|
|
2475
|
+
listReportOrglicenses: (data: InputOy4V8Im0Kh, params?: RequestParams) => Promise<any>;
|
|
2402
2476
|
/**
|
|
2403
2477
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2404
2478
|
*
|
|
@@ -2408,7 +2482,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2408
2482
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2409
2483
|
* @secure
|
|
2410
2484
|
*/
|
|
2411
|
-
createReportOrglicensesPreview: (data:
|
|
2485
|
+
createReportOrglicensesPreview: (data: InputStgqlja7Xt, params?: RequestParams) => Promise<any>;
|
|
2412
2486
|
/**
|
|
2413
2487
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2414
2488
|
*
|
|
@@ -2429,6 +2503,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2429
2503
|
* @secure
|
|
2430
2504
|
*/
|
|
2431
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>;
|
|
2432
2516
|
/**
|
|
2433
2517
|
* @description Advanced search for users in the tenant by filters, with report generation.
|
|
2434
2518
|
*
|
|
@@ -2438,7 +2522,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2438
2522
|
* @request POST:/tenant/report/users/advanced
|
|
2439
2523
|
* @secure
|
|
2440
2524
|
*/
|
|
2441
|
-
createReportUsersAdvanced: (data:
|
|
2525
|
+
createReportUsersAdvanced: (data: InputEglu9M4Vmj, params?: RequestParams) => Promise<any>;
|
|
2442
2526
|
/**
|
|
2443
2527
|
* @description Searches for users in the tenant by their IDs.
|
|
2444
2528
|
*
|
|
@@ -2448,7 +2532,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2448
2532
|
* @request POST:/tenant/search/users/ids
|
|
2449
2533
|
* @secure
|
|
2450
2534
|
*/
|
|
2451
|
-
listSearchUsersIds: (data:
|
|
2535
|
+
listSearchUsersIds: (data: Input8R2A93Snv2F, params?: RequestParams) => Promise<any>;
|
|
2452
2536
|
/**
|
|
2453
2537
|
* @description Searches for users in the tenant by term and filters.
|
|
2454
2538
|
*
|
|
@@ -2458,7 +2542,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2458
2542
|
* @request POST:/tenant/search/users/term
|
|
2459
2543
|
* @secure
|
|
2460
2544
|
*/
|
|
2461
|
-
createSearchUsersTerm: (data:
|
|
2545
|
+
createSearchUsersTerm: (data: Input0Gcdrfrad0K, params?: RequestParams) => Promise<any>;
|
|
2462
2546
|
/**
|
|
2463
2547
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2464
2548
|
*
|
|
@@ -2468,7 +2552,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2468
2552
|
* @request POST:/tenant/report/users/simple
|
|
2469
2553
|
* @secure
|
|
2470
2554
|
*/
|
|
2471
|
-
createReportUsersSimple: (data:
|
|
2555
|
+
createReportUsersSimple: (data: InputNwfxg6Mnx6K, params?: RequestParams) => Promise<any>;
|
|
2472
2556
|
/**
|
|
2473
2557
|
* @description Retrieve user by ID.
|
|
2474
2558
|
*
|
|
@@ -2478,7 +2562,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2478
2562
|
* @request POST:/tenant/search/users/count
|
|
2479
2563
|
* @secure
|
|
2480
2564
|
*/
|
|
2481
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2565
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputCeu3Cbjle7>;
|
|
2482
2566
|
};
|
|
2483
2567
|
user: {
|
|
2484
2568
|
/**
|
|
@@ -2510,7 +2594,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2510
2594
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2511
2595
|
* @secure
|
|
2512
2596
|
*/
|
|
2513
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2597
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: Input2Sq1Ggl8Flf, params?: RequestParams) => Promise<any>;
|
|
2514
2598
|
/**
|
|
2515
2599
|
* @description Delete a certification process application by type.
|
|
2516
2600
|
*
|
|
@@ -2600,7 +2684,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2600
2684
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2601
2685
|
* @secure
|
|
2602
2686
|
*/
|
|
2603
|
-
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<OutputLmj3Egxsgw>;
|
|
2604
2688
|
/**
|
|
2605
2689
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2606
2690
|
*
|
|
@@ -2610,7 +2694,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2610
2694
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2611
2695
|
* @secure
|
|
2612
2696
|
*/
|
|
2613
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2697
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<Output89F1Ccxlsj>;
|
|
2614
2698
|
/**
|
|
2615
2699
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2616
2700
|
*
|
|
@@ -2630,7 +2714,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2630
2714
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2631
2715
|
* @secure
|
|
2632
2716
|
*/
|
|
2633
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2717
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputMmv9D3Rl8W, params?: RequestParams) => Promise<OutputMmv9D3Rl8W>;
|
|
2634
2718
|
/**
|
|
2635
2719
|
* @description Delete user by ID.
|
|
2636
2720
|
*
|
|
@@ -2660,7 +2744,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2660
2744
|
* @request POST:/user/{userID}
|
|
2661
2745
|
* @secure
|
|
2662
2746
|
*/
|
|
2663
|
-
createUser: (userId: string, data:
|
|
2747
|
+
createUser: (userId: string, data: Input2D83W8G4Knl, params?: RequestParams) => Promise<any>;
|
|
2664
2748
|
/**
|
|
2665
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.
|
|
2666
2750
|
*
|
|
@@ -2670,7 +2754,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2670
2754
|
* @request PUT:/user/{userID}
|
|
2671
2755
|
* @secure
|
|
2672
2756
|
*/
|
|
2673
|
-
updateUser: (userId: string, data:
|
|
2757
|
+
updateUser: (userId: string, data: Input3Kkaz78N51, params?: RequestParams) => Promise<any>;
|
|
2674
2758
|
/**
|
|
2675
2759
|
* @description Delete course from user
|
|
2676
2760
|
*
|
|
@@ -2690,7 +2774,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2690
2774
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2691
2775
|
* @secure
|
|
2692
2776
|
*/
|
|
2693
|
-
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<OutputTwbrusyi5D>;
|
|
2694
2778
|
/**
|
|
2695
2779
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2696
2780
|
*
|
|
@@ -2700,7 +2784,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2700
2784
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2701
2785
|
* @secure
|
|
2702
2786
|
*/
|
|
2703
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2787
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<Output4Iblwyq6Ah>;
|
|
2704
2788
|
/**
|
|
2705
2789
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2706
2790
|
*
|
|
@@ -2710,7 +2794,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2710
2794
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2711
2795
|
* @secure
|
|
2712
2796
|
*/
|
|
2713
|
-
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<OutputDalfsjzegc>;
|
|
2714
2798
|
/**
|
|
2715
2799
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2716
2800
|
*
|
|
@@ -2750,7 +2834,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2750
2834
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2751
2835
|
* @secure
|
|
2752
2836
|
*/
|
|
2753
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2837
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputJurcooq49A>;
|
|
2754
2838
|
/**
|
|
2755
2839
|
* @description This endpoint will print certificate
|
|
2756
2840
|
*
|
|
@@ -2810,7 +2894,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2810
2894
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2811
2895
|
* @secure
|
|
2812
2896
|
*/
|
|
2813
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2897
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputA1Ue47Tc5S, params?: RequestParams) => Promise<any>;
|
|
2814
2898
|
/**
|
|
2815
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.
|
|
2816
2900
|
*
|
|
@@ -2840,7 +2924,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2840
2924
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2841
2925
|
* @secure
|
|
2842
2926
|
*/
|
|
2843
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2927
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputRkf87Bvk4R, params?: RequestParams) => Promise<any>;
|
|
2844
2928
|
/**
|
|
2845
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.
|
|
2846
2930
|
*
|
|
@@ -2850,7 +2934,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2850
2934
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2851
2935
|
* @secure
|
|
2852
2936
|
*/
|
|
2853
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2937
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputZg9Ekdlhnb, params?: RequestParams) => Promise<any>;
|
|
2854
2938
|
/**
|
|
2855
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.
|
|
2856
2940
|
*
|
|
@@ -2860,7 +2944,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2860
2944
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2861
2945
|
* @secure
|
|
2862
2946
|
*/
|
|
2863
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2947
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputXszlgox1Xx, params?: RequestParams) => Promise<any>;
|
|
2864
2948
|
/**
|
|
2865
2949
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2866
2950
|
*
|
|
@@ -2870,7 +2954,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2870
2954
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2871
2955
|
* @secure
|
|
2872
2956
|
*/
|
|
2873
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2957
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputHbwwop8Qyt, params?: RequestParams) => Promise<any>;
|
|
2874
2958
|
/**
|
|
2875
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.
|
|
2876
2960
|
*
|
|
@@ -2910,7 +2994,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2910
2994
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2911
2995
|
* @secure
|
|
2912
2996
|
*/
|
|
2913
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2997
|
+
createCertificationWaive: (userId: string, certProcId: string, data: Input3Euijgfoac, params?: RequestParams) => Promise<any>;
|
|
2914
2998
|
/**
|
|
2915
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.
|
|
2916
3000
|
*
|
|
@@ -2920,7 +3004,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2920
3004
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2921
3005
|
* @secure
|
|
2922
3006
|
*/
|
|
2923
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3007
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputFly8V39N47>;
|
|
2924
3008
|
/**
|
|
2925
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.
|
|
2926
3010
|
*
|
|
@@ -2960,7 +3044,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2960
3044
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2961
3045
|
* @secure
|
|
2962
3046
|
*/
|
|
2963
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
3047
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputRzff22Tkc, params?: RequestParams) => Promise<any>;
|
|
2964
3048
|
/**
|
|
2965
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.
|
|
2966
3050
|
*
|
|
@@ -3020,7 +3104,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3020
3104
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3021
3105
|
* @secure
|
|
3022
3106
|
*/
|
|
3023
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
3107
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: InputMnsqq1Ejho, params?: RequestParams) => Promise<any>;
|
|
3024
3108
|
/**
|
|
3025
3109
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3026
3110
|
*
|
|
@@ -3040,7 +3124,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3040
3124
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3041
3125
|
* @secure
|
|
3042
3126
|
*/
|
|
3043
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3127
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: Input2N620Uctjn, params?: RequestParams) => Promise<any>;
|
|
3044
3128
|
/**
|
|
3045
3129
|
* @description This route allows you to submit a pending approval.
|
|
3046
3130
|
*
|
|
@@ -3050,7 +3134,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3050
3134
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3051
3135
|
* @secure
|
|
3052
3136
|
*/
|
|
3053
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3137
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputD6Psozp2I3, params?: RequestParams) => Promise<any>;
|
|
3054
3138
|
/**
|
|
3055
3139
|
* @description This route allows you to review a pending approval.
|
|
3056
3140
|
*
|
|
@@ -3060,7 +3144,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3060
3144
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3061
3145
|
* @secure
|
|
3062
3146
|
*/
|
|
3063
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3147
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputIc0Bc2Eq1W, params?: RequestParams) => Promise<any>;
|
|
3064
3148
|
/**
|
|
3065
3149
|
* @description Redeems a license for a user by product ID.
|
|
3066
3150
|
*
|
|
@@ -3070,7 +3154,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3070
3154
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3071
3155
|
* @secure
|
|
3072
3156
|
*/
|
|
3073
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3157
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputMeztvunaev, params?: RequestParams) => Promise<any>;
|
|
3074
3158
|
/**
|
|
3075
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.
|
|
3076
3160
|
*
|
|
@@ -3080,7 +3164,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3080
3164
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3081
3165
|
* @secure
|
|
3082
3166
|
*/
|
|
3083
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3167
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputGrqe1Ahq5A>;
|
|
3084
3168
|
/**
|
|
3085
3169
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3086
3170
|
*
|
|
@@ -3090,7 +3174,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3090
3174
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3091
3175
|
* @secure
|
|
3092
3176
|
*/
|
|
3093
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3177
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputP4Xruevr6T, params?: RequestParams) => Promise<any>;
|
|
3094
3178
|
/**
|
|
3095
3179
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3096
3180
|
*
|
|
@@ -3100,7 +3184,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3100
3184
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3101
3185
|
* @secure
|
|
3102
3186
|
*/
|
|
3103
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3187
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputR6N63Ewm71, params?: RequestParams) => Promise<any>;
|
|
3104
3188
|
/**
|
|
3105
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.
|
|
3106
3190
|
*
|
|
@@ -3110,7 +3194,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3110
3194
|
* @request POST:/user/{userID}/updateITA
|
|
3111
3195
|
* @secure
|
|
3112
3196
|
*/
|
|
3113
|
-
createUpdateIta: (userId: string, data:
|
|
3197
|
+
createUpdateIta: (userId: string, data: InputLqqytpg8Jk, params?: RequestParams) => Promise<any>;
|
|
3114
3198
|
/**
|
|
3115
3199
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3116
3200
|
*
|
|
@@ -3120,7 +3204,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3120
3204
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3121
3205
|
* @secure
|
|
3122
3206
|
*/
|
|
3123
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3207
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputG9Q1Ctgc13, params?: RequestParams) => Promise<any>;
|
|
3124
3208
|
/**
|
|
3125
3209
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3126
3210
|
*
|
|
@@ -3130,7 +3214,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3130
3214
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3131
3215
|
* @secure
|
|
3132
3216
|
*/
|
|
3133
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3217
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputJ1Jc5Tm0Tl, params?: RequestParams) => Promise<any>;
|
|
3134
3218
|
/**
|
|
3135
3219
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3136
3220
|
*
|
|
@@ -3162,7 +3246,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3162
3246
|
* @request POST:/users/certification/{certSpecID}
|
|
3163
3247
|
* @secure
|
|
3164
3248
|
*/
|
|
3165
|
-
createCertification: (certSpecId: string, data:
|
|
3249
|
+
createCertification: (certSpecId: string, data: Input44B69Di6Zjj, params?: RequestParams) => Promise<Output44B69Di6Zjj>;
|
|
3166
3250
|
/**
|
|
3167
3251
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3168
3252
|
*
|