@ikonintegration/bccsa-program-api 3.0.31 → 3.0.33
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 +137 -109
- package/dist/Api.d.ts +143 -119
- package/dist/Api.js +8 -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 InputSol3K0Ly82 {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -439,6 +439,8 @@ export interface PendingApprovalResponseSchema {
|
|
|
439
439
|
reviewedBy?: ReviewedBy;
|
|
440
440
|
/** Timestamp of the review */
|
|
441
441
|
reviewedOn?: ReviewedOn;
|
|
442
|
+
/** Point-in-time sponsor snapshot for SPONSOR_ATTESTATION pending approvals */
|
|
443
|
+
sponsor?: Sponsor;
|
|
442
444
|
/** Pending sponsorship request reminders sent to the user (array with reminder IDs, where reminderID is template-numdays) */
|
|
443
445
|
sponsorshipRemindersStudent?: SponsorshipRemindersStudent;
|
|
444
446
|
/** Pending sponsorship request reminders sent to the sponsor (array with reminder IDs, where reminderID is template-numdays) */
|
|
@@ -455,11 +457,32 @@ export type CertTitle = string;
|
|
|
455
457
|
export type DisplayName = string;
|
|
456
458
|
/** Email address of the user who submitted the pending approval */
|
|
457
459
|
export type Email = string;
|
|
460
|
+
/** Point-in-time sponsor snapshot for SPONSOR_ATTESTATION pending approvals */
|
|
461
|
+
export interface Sponsor {
|
|
462
|
+
/** Name of the sponsor of the student in the tenant */
|
|
463
|
+
name?: Name;
|
|
464
|
+
/** Phone number of the sponsor of the student in the tenant */
|
|
465
|
+
phone?: Phone;
|
|
466
|
+
/** Email address of sponsor for the attestation process */
|
|
467
|
+
email?: Email;
|
|
468
|
+
/** Title of the sponsor of the student in the tenant */
|
|
469
|
+
title?: Title;
|
|
470
|
+
}
|
|
471
|
+
/**
|
|
472
|
+
* Phone number of the sponsor of the student in the tenant
|
|
473
|
+
* @maxLength 255
|
|
474
|
+
*/
|
|
475
|
+
export type Phone = string;
|
|
476
|
+
/**
|
|
477
|
+
* Title of the sponsor of the student in the tenant
|
|
478
|
+
* @maxLength 255
|
|
479
|
+
*/
|
|
480
|
+
export type Title = string;
|
|
458
481
|
/** Pending sponsorship request reminders sent to the user (array with reminder IDs, where reminderID is template-numdays) */
|
|
459
482
|
export type SponsorshipRemindersStudent = string[];
|
|
460
483
|
/** Pending sponsorship request reminders sent to the sponsor (array with reminder IDs, where reminderID is template-numdays) */
|
|
461
484
|
export type SponsorshipRemindersSponsor = string[];
|
|
462
|
-
export interface
|
|
485
|
+
export interface InputHtrrxf8Yp9K {
|
|
463
486
|
/**
|
|
464
487
|
* ID of the certification to filter applications by
|
|
465
488
|
* @example "certification123"
|
|
@@ -516,7 +539,7 @@ export interface InputLafd3A50Ir {
|
|
|
516
539
|
*/
|
|
517
540
|
ignoreCompletedCertifications?: boolean | null;
|
|
518
541
|
}
|
|
519
|
-
export interface
|
|
542
|
+
export interface InputTq7O0B5F3S {
|
|
520
543
|
/**
|
|
521
544
|
* ID of the certification to filter applications by
|
|
522
545
|
* @example "certification123"
|
|
@@ -573,7 +596,7 @@ export interface InputJj4T48To4I {
|
|
|
573
596
|
*/
|
|
574
597
|
ignoreCompletedCertifications?: boolean | null;
|
|
575
598
|
}
|
|
576
|
-
export interface
|
|
599
|
+
export interface InputVeillj4Rt0L {
|
|
577
600
|
/**
|
|
578
601
|
* ID of the certification to filter applications by
|
|
579
602
|
* @example "certification123"
|
|
@@ -630,7 +653,7 @@ export interface Input4299E0Qghu {
|
|
|
630
653
|
*/
|
|
631
654
|
ignoreCompletedCertifications?: boolean | null;
|
|
632
655
|
}
|
|
633
|
-
export interface
|
|
656
|
+
export interface InputOaldjlebnx {
|
|
634
657
|
/**
|
|
635
658
|
* The ID of the certificate specifications to be used for the email
|
|
636
659
|
* @example "certSpecsID123"
|
|
@@ -671,7 +694,7 @@ export interface Input22An4Alkhlg {
|
|
|
671
694
|
emailAddress: string;
|
|
672
695
|
}[];
|
|
673
696
|
}
|
|
674
|
-
export interface
|
|
697
|
+
export interface InputKkyamupnlt {
|
|
675
698
|
/**
|
|
676
699
|
* The ID of the product for which the license is being redeemed
|
|
677
700
|
* @example "productID123"
|
|
@@ -683,7 +706,7 @@ export interface Input7K2Sgvn13T {
|
|
|
683
706
|
*/
|
|
684
707
|
sessionID?: string;
|
|
685
708
|
}
|
|
686
|
-
export interface
|
|
709
|
+
export interface InputUkvmhdqu3Zh {
|
|
687
710
|
/**
|
|
688
711
|
* Search term to filter licenses
|
|
689
712
|
* @example "active"
|
|
@@ -700,7 +723,7 @@ export interface Input5Bwr4N40Es {
|
|
|
700
723
|
*/
|
|
701
724
|
sortField?: any;
|
|
702
725
|
}
|
|
703
|
-
export interface
|
|
726
|
+
export interface Input0Hxcnrsc8S {
|
|
704
727
|
/**
|
|
705
728
|
* Search term to filter licenses
|
|
706
729
|
* @example "active"
|
|
@@ -823,13 +846,15 @@ export interface SearchPendingApprovalsResponseSchema {
|
|
|
823
846
|
reviewedBy?: ReviewedBy;
|
|
824
847
|
/** Timestamp of the review */
|
|
825
848
|
reviewedOn?: ReviewedOn;
|
|
849
|
+
/** Point-in-time sponsor snapshot for SPONSOR_ATTESTATION pending approvals */
|
|
850
|
+
sponsor?: Sponsor;
|
|
826
851
|
/** Pending sponsorship request reminders sent to the user (array with reminder IDs, where reminderID is template-numdays) */
|
|
827
852
|
sponsorshipRemindersStudent?: SponsorshipRemindersStudent;
|
|
828
853
|
/** Pending sponsorship request reminders sent to the sponsor (array with reminder IDs, where reminderID is template-numdays) */
|
|
829
854
|
sponsorshipRemindersSponsor?: SponsorshipRemindersSponsor;
|
|
830
855
|
}[];
|
|
831
856
|
}
|
|
832
|
-
export interface
|
|
857
|
+
export interface Input7Il0Lvxsvl {
|
|
833
858
|
/**
|
|
834
859
|
* Start date for the report
|
|
835
860
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -851,11 +876,11 @@ export interface InputG6Hsraotyi {
|
|
|
851
876
|
*/
|
|
852
877
|
dateType?: string;
|
|
853
878
|
}
|
|
854
|
-
export interface
|
|
879
|
+
export interface InputJ0Hrmeexdj {
|
|
855
880
|
/** List of user IDs to search for in the tenant. */
|
|
856
881
|
IDs: (string | null)[];
|
|
857
882
|
}
|
|
858
|
-
export interface
|
|
883
|
+
export interface InputVawcwl0959 {
|
|
859
884
|
/** The term to search for in the user profiles. */
|
|
860
885
|
searchTerm?: string | null;
|
|
861
886
|
/** Filter criteria for the user search. */
|
|
@@ -895,7 +920,7 @@ export interface Input8Vhcnzx2B7 {
|
|
|
895
920
|
};
|
|
896
921
|
};
|
|
897
922
|
}
|
|
898
|
-
export interface
|
|
923
|
+
export interface InputHlghz0Fmyni {
|
|
899
924
|
/** The term to search for in the user profiles. */
|
|
900
925
|
searchTerm?: string | null;
|
|
901
926
|
/** Filter criteria for the user search. */
|
|
@@ -935,21 +960,21 @@ export interface InputTi43Il2Vlv {
|
|
|
935
960
|
};
|
|
936
961
|
};
|
|
937
962
|
}
|
|
938
|
-
export interface
|
|
963
|
+
export interface OutputCd7158Kel5 {
|
|
939
964
|
/** External system ID 2 */
|
|
940
965
|
userCount: ExternalID2;
|
|
941
966
|
transactionID?: string | null;
|
|
942
967
|
}
|
|
943
968
|
/** External system ID 2 */
|
|
944
969
|
export type ExternalID2 = number;
|
|
945
|
-
export interface
|
|
970
|
+
export interface Output3O35Fw2D54 {
|
|
946
971
|
/**
|
|
947
972
|
* Signed URL for the course file
|
|
948
973
|
* @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"
|
|
949
974
|
*/
|
|
950
975
|
fileURL: string;
|
|
951
976
|
}
|
|
952
|
-
export interface
|
|
977
|
+
export interface Output50Y5W4Go7Uk {
|
|
953
978
|
/**
|
|
954
979
|
* Amount to be refunded for the cancellation
|
|
955
980
|
* @example 0
|
|
@@ -1249,7 +1274,7 @@ export interface CourseResponseEntity {
|
|
|
1249
1274
|
}
|
|
1250
1275
|
/** Label of the course enrolled (course version) */
|
|
1251
1276
|
export type OnlineCourseLabel = string;
|
|
1252
|
-
export interface
|
|
1277
|
+
export interface OutputEm74Prnnzq {
|
|
1253
1278
|
/**
|
|
1254
1279
|
* Signed URL for the course file
|
|
1255
1280
|
* @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"
|
|
@@ -1267,7 +1292,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1267
1292
|
transactionID?: string | null;
|
|
1268
1293
|
}
|
|
1269
1294
|
/** Application Foreign Fill response type */
|
|
1270
|
-
export interface
|
|
1295
|
+
export interface OutputXqrs2Wd9Tkl {
|
|
1271
1296
|
items: {
|
|
1272
1297
|
userID: string;
|
|
1273
1298
|
createdOn?: number;
|
|
@@ -1455,7 +1480,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1455
1480
|
applicationItems?: Record<string, any>[];
|
|
1456
1481
|
transactionID?: string | null;
|
|
1457
1482
|
}
|
|
1458
|
-
export interface
|
|
1483
|
+
export interface InputZe9R08Tm0T {
|
|
1459
1484
|
issuedOn?: number;
|
|
1460
1485
|
expiresOn?: number;
|
|
1461
1486
|
fileItems?: {
|
|
@@ -1464,21 +1489,21 @@ export interface Input0Unqmff7Xg {
|
|
|
1464
1489
|
}[];
|
|
1465
1490
|
additionalNotes?: string | null;
|
|
1466
1491
|
}
|
|
1467
|
-
export interface
|
|
1492
|
+
export interface Input5Xqw5Xwyot {
|
|
1468
1493
|
/**
|
|
1469
1494
|
* Indicates whether the application is locked
|
|
1470
1495
|
* @example true
|
|
1471
1496
|
*/
|
|
1472
1497
|
isApplicationLocked: boolean;
|
|
1473
1498
|
}
|
|
1474
|
-
export interface
|
|
1499
|
+
export interface OutputZe2P71Jl4Ph {
|
|
1475
1500
|
/**
|
|
1476
1501
|
* Signed URL for the course file
|
|
1477
1502
|
* @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"
|
|
1478
1503
|
*/
|
|
1479
1504
|
fileURL: string;
|
|
1480
1505
|
}
|
|
1481
|
-
export interface
|
|
1506
|
+
export interface InputKc1Ehdb5Ps {
|
|
1482
1507
|
/**
|
|
1483
1508
|
* Indicates whether the waiver is approved
|
|
1484
1509
|
* @example true
|
|
@@ -1490,14 +1515,14 @@ export interface InputUh7Kaccbqsi {
|
|
|
1490
1515
|
*/
|
|
1491
1516
|
additionalNotes?: string | null;
|
|
1492
1517
|
}
|
|
1493
|
-
export interface
|
|
1518
|
+
export interface InputFrbe30I85S {
|
|
1494
1519
|
/**
|
|
1495
1520
|
* Optional notes regarding the waiver
|
|
1496
1521
|
* @example "Waiver granted due to special circumstances."
|
|
1497
1522
|
*/
|
|
1498
1523
|
additionalNotes?: string | null;
|
|
1499
1524
|
}
|
|
1500
|
-
export interface
|
|
1525
|
+
export interface Input5L25G7Qxfo {
|
|
1501
1526
|
students: {
|
|
1502
1527
|
/**
|
|
1503
1528
|
* User ID of the student to redeem the course for
|
|
@@ -1531,7 +1556,7 @@ export interface InputW1Acknrh35 {
|
|
|
1531
1556
|
*/
|
|
1532
1557
|
autoEnrolSessionID?: string;
|
|
1533
1558
|
}
|
|
1534
|
-
export interface
|
|
1559
|
+
export interface InputLkqgxr42Ux {
|
|
1535
1560
|
invites: {
|
|
1536
1561
|
/**
|
|
1537
1562
|
* Email address of the user to invite
|
|
@@ -1560,7 +1585,7 @@ export interface Input49Kewdueod {
|
|
|
1560
1585
|
*/
|
|
1561
1586
|
isReservedSeat: boolean;
|
|
1562
1587
|
}
|
|
1563
|
-
export interface
|
|
1588
|
+
export interface InputHvql6Tv30P {
|
|
1564
1589
|
/**
|
|
1565
1590
|
* Indicates whether to waive the certification process
|
|
1566
1591
|
* @example true
|
|
@@ -1573,7 +1598,7 @@ export interface InputPv8Afi38Gj {
|
|
|
1573
1598
|
comments?: string | null;
|
|
1574
1599
|
}
|
|
1575
1600
|
/** Certification move response schema */
|
|
1576
|
-
export interface
|
|
1601
|
+
export interface OutputIpk3Gr4Jn2 {
|
|
1577
1602
|
errors?: {
|
|
1578
1603
|
status: string;
|
|
1579
1604
|
object?: Record<string, any>;
|
|
@@ -1581,19 +1606,19 @@ export interface OutputN55H9Dq7Jg {
|
|
|
1581
1606
|
}[];
|
|
1582
1607
|
}
|
|
1583
1608
|
/** Schema for writing a certification trigger check. */
|
|
1584
|
-
export interface
|
|
1609
|
+
export interface InputIccc9Wkdt9 {
|
|
1585
1610
|
/**
|
|
1586
1611
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1587
1612
|
* @example "CHECKED"
|
|
1588
1613
|
*/
|
|
1589
|
-
value:
|
|
1614
|
+
value: InputIccc9Wkdt9ValueEnum;
|
|
1590
1615
|
/**
|
|
1591
1616
|
* List of course IDs that are blocked by this trigger check.
|
|
1592
1617
|
* @example ["course1","course2"]
|
|
1593
1618
|
*/
|
|
1594
1619
|
blockedCourses?: string[];
|
|
1595
1620
|
}
|
|
1596
|
-
export interface
|
|
1621
|
+
export interface InputWk711Xrjeq {
|
|
1597
1622
|
/**
|
|
1598
1623
|
* Indicates whether the application item is approved
|
|
1599
1624
|
* @example true
|
|
@@ -1619,7 +1644,7 @@ export interface Input38X1Tu13M6 {
|
|
|
1619
1644
|
export interface StudentHistoryRequestSchema {
|
|
1620
1645
|
requirements: string[];
|
|
1621
1646
|
}
|
|
1622
|
-
export interface
|
|
1647
|
+
export interface InputTtdoeespbb {
|
|
1623
1648
|
/**
|
|
1624
1649
|
* Optional activation key for the application
|
|
1625
1650
|
* @example "AK-123456"
|
|
@@ -1627,7 +1652,7 @@ export interface InputI7Wxaw8I1P {
|
|
|
1627
1652
|
activationKey?: string;
|
|
1628
1653
|
}
|
|
1629
1654
|
/** Schema for course submission item details post request. */
|
|
1630
|
-
export interface
|
|
1655
|
+
export interface InputCvqczxrsu6 {
|
|
1631
1656
|
/**
|
|
1632
1657
|
* The ID of the file being submitted.
|
|
1633
1658
|
* @example "fileID123"
|
|
@@ -1640,7 +1665,7 @@ export interface InputFqm4Xqhert {
|
|
|
1640
1665
|
fileName: string;
|
|
1641
1666
|
}
|
|
1642
1667
|
/** Schema for the response to course submission item details post request. */
|
|
1643
|
-
export interface
|
|
1668
|
+
export interface OutputCvqczxrsu6 {
|
|
1644
1669
|
submissionItems: {
|
|
1645
1670
|
/**
|
|
1646
1671
|
* The ID of the file being submitted.
|
|
@@ -1655,7 +1680,7 @@ export interface OutputFqm4Xqhert {
|
|
|
1655
1680
|
}[];
|
|
1656
1681
|
}
|
|
1657
1682
|
/** Pending approval submission parameters */
|
|
1658
|
-
export interface
|
|
1683
|
+
export interface InputPmeud0A4Jo {
|
|
1659
1684
|
/**
|
|
1660
1685
|
* Type of pending approval
|
|
1661
1686
|
* @example "certification"
|
|
@@ -1675,7 +1700,7 @@ export interface Input3Felz7Mi9Yf {
|
|
|
1675
1700
|
fileName: string;
|
|
1676
1701
|
}[];
|
|
1677
1702
|
}
|
|
1678
|
-
export interface
|
|
1703
|
+
export interface Input92Ud3Ap8Ee {
|
|
1679
1704
|
/**
|
|
1680
1705
|
* The ID of the course for which the license is being redeemed
|
|
1681
1706
|
* @example "courseID123"
|
|
@@ -1743,7 +1768,7 @@ export interface InputUhe8Fii9R5I {
|
|
|
1743
1768
|
acknowledgement?: string | null;
|
|
1744
1769
|
}
|
|
1745
1770
|
/** Validate certification move response schema */
|
|
1746
|
-
export interface
|
|
1771
|
+
export interface OutputZ780Quci3Tj {
|
|
1747
1772
|
courses: {
|
|
1748
1773
|
name: string;
|
|
1749
1774
|
status: string;
|
|
@@ -1754,21 +1779,21 @@ export interface OutputPukzjwkc5A {
|
|
|
1754
1779
|
validated: boolean;
|
|
1755
1780
|
mustCreateCP: boolean;
|
|
1756
1781
|
}
|
|
1757
|
-
export interface
|
|
1782
|
+
export interface InputAyclmizttx {
|
|
1758
1783
|
/**
|
|
1759
1784
|
* Comments regarding the end of the cooldown period
|
|
1760
1785
|
* @example "Cooldown period ended successfully."
|
|
1761
1786
|
*/
|
|
1762
1787
|
comments: string;
|
|
1763
1788
|
}
|
|
1764
|
-
export interface
|
|
1789
|
+
export interface OutputKqxt1Tamp1K {
|
|
1765
1790
|
/**
|
|
1766
1791
|
* Signed URL for the course file
|
|
1767
1792
|
* @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"
|
|
1768
1793
|
*/
|
|
1769
1794
|
fileURL: string;
|
|
1770
1795
|
}
|
|
1771
|
-
export interface
|
|
1796
|
+
export interface InputQeh5M92Xpeh {
|
|
1772
1797
|
/** @example true */
|
|
1773
1798
|
agreedWithCertTerms: boolean;
|
|
1774
1799
|
/** @example 1717230000000 */
|
|
@@ -1839,30 +1864,35 @@ export interface Input5Ati3Iec5T {
|
|
|
1839
1864
|
externalID?: string | null;
|
|
1840
1865
|
/** @example "EXT#999" */
|
|
1841
1866
|
externalID2?: string | null;
|
|
1842
|
-
/**
|
|
1843
|
-
|
|
1844
|
-
|
|
1845
|
-
|
|
1846
|
-
|
|
1847
|
-
|
|
1848
|
-
|
|
1849
|
-
|
|
1850
|
-
|
|
1851
|
-
|
|
1867
|
+
/** Sponsor information for a student in the tenant */
|
|
1868
|
+
sponsor?: Sponsor;
|
|
1869
|
+
}
|
|
1870
|
+
/** Sponsor information for a student in the tenant */
|
|
1871
|
+
export interface Sponsor {
|
|
1872
|
+
/** Name of the sponsor of the student in the tenant */
|
|
1873
|
+
name?: Name;
|
|
1874
|
+
/** Phone number of the sponsor of the student in the tenant */
|
|
1875
|
+
phone?: Phone;
|
|
1876
|
+
/** Email address of sponsor for the attestation process */
|
|
1877
|
+
email?: Email;
|
|
1878
|
+
/** Title of the sponsor of the student in the tenant */
|
|
1879
|
+
title?: Title;
|
|
1880
|
+
}
|
|
1881
|
+
export interface Input7Tzs0Tv2Q5 {
|
|
1852
1882
|
/**
|
|
1853
1883
|
* Comments regarding the course unlock action
|
|
1854
1884
|
* @example "Course unlocked successfully."
|
|
1855
1885
|
*/
|
|
1856
1886
|
comments: string;
|
|
1857
1887
|
}
|
|
1858
|
-
export interface
|
|
1888
|
+
export interface Input0J4N9Uwfcb {
|
|
1859
1889
|
/**
|
|
1860
1890
|
* ITA number to update for the user
|
|
1861
1891
|
* @example "ITA123456"
|
|
1862
1892
|
*/
|
|
1863
1893
|
itaNumber: string;
|
|
1864
1894
|
}
|
|
1865
|
-
export interface
|
|
1895
|
+
export interface InputCe5785R8Zs {
|
|
1866
1896
|
/** @example true */
|
|
1867
1897
|
agreedWithCertTerms: boolean;
|
|
1868
1898
|
/** @example 1717230000000 */
|
|
@@ -1933,16 +1963,10 @@ export interface InputJavmrm0L1Jf {
|
|
|
1933
1963
|
externalID?: string | null;
|
|
1934
1964
|
/** @example "EXT#999" */
|
|
1935
1965
|
externalID2?: string | null;
|
|
1936
|
-
/**
|
|
1937
|
-
|
|
1938
|
-
/** @example "+1-555-5555" */
|
|
1939
|
-
attestSponsorPhone?: string;
|
|
1940
|
-
/** @example "jane.smith@example.com" */
|
|
1941
|
-
attestSponsorEmail?: string;
|
|
1942
|
-
/** @example "HR Manager" */
|
|
1943
|
-
attestSponsorTitle?: string;
|
|
1966
|
+
/** Sponsor information for a student in the tenant */
|
|
1967
|
+
sponsor?: Sponsor;
|
|
1944
1968
|
}
|
|
1945
|
-
export interface
|
|
1969
|
+
export interface InputFih2S2Mlabl {
|
|
1946
1970
|
/**
|
|
1947
1971
|
* The grade to override the course result with
|
|
1948
1972
|
* @example "A"
|
|
@@ -1950,7 +1974,7 @@ export interface InputM24Ojes5Ofk {
|
|
|
1950
1974
|
resultGrade: string;
|
|
1951
1975
|
}
|
|
1952
1976
|
/** Pending approval review parameters */
|
|
1953
|
-
export interface
|
|
1977
|
+
export interface Input711J32K5Lx {
|
|
1954
1978
|
/**
|
|
1955
1979
|
* Notes provided by the reviewer for the pending approval
|
|
1956
1980
|
* @example "Please review the submitted documents."
|
|
@@ -1963,7 +1987,7 @@ export interface InputGay28Hqm3C {
|
|
|
1963
1987
|
approved: boolean;
|
|
1964
1988
|
}
|
|
1965
1989
|
/** Schema for overriding course result dates. */
|
|
1966
|
-
export interface
|
|
1990
|
+
export interface InputLwd5Q9Dzkoi {
|
|
1967
1991
|
/**
|
|
1968
1992
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1969
1993
|
* @example 1735689600000
|
|
@@ -1975,14 +1999,14 @@ export interface InputQufs4U2Pbk {
|
|
|
1975
1999
|
*/
|
|
1976
2000
|
completionDate?: number;
|
|
1977
2001
|
}
|
|
1978
|
-
export interface
|
|
2002
|
+
export interface InputF71Vj36Lnw {
|
|
1979
2003
|
filter: {
|
|
1980
2004
|
from?: number;
|
|
1981
2005
|
sortOrder?: string;
|
|
1982
2006
|
sortField?: string;
|
|
1983
2007
|
};
|
|
1984
2008
|
}
|
|
1985
|
-
export interface
|
|
2009
|
+
export interface OutputF71Vj36Lnw {
|
|
1986
2010
|
users: {
|
|
1987
2011
|
firstName: string;
|
|
1988
2012
|
lastName: string;
|
|
@@ -2006,7 +2030,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
2006
2030
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
2007
2031
|
* @example "CHECKED"
|
|
2008
2032
|
*/
|
|
2009
|
-
export declare enum
|
|
2033
|
+
export declare enum InputIccc9Wkdt9ValueEnum {
|
|
2010
2034
|
CHECKED = "CHECKED",
|
|
2011
2035
|
UNCHECKED = "UNCHECKED",
|
|
2012
2036
|
NOVALUE = "NOVALUE"
|
|
@@ -2105,7 +2129,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2105
2129
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2106
2130
|
export type CreateReportUsersSimpleData = any;
|
|
2107
2131
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2108
|
-
export type CreateSearchUsersCountData =
|
|
2132
|
+
export type CreateSearchUsersCountData = OutputCd7158Kel5;
|
|
2109
2133
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2110
2134
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2111
2135
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2129,7 +2153,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2129
2153
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2130
2154
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2131
2155
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2132
|
-
export type GetCertificationCourseFileSignData =
|
|
2156
|
+
export type GetCertificationCourseFileSignData = OutputEm74Prnnzq;
|
|
2133
2157
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2134
2158
|
export interface CreateCertificationCourseFileSignParams {
|
|
2135
2159
|
/** @example "pdf" */
|
|
@@ -2143,11 +2167,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2143
2167
|
/** @example "fileID" */
|
|
2144
2168
|
fileId: string;
|
|
2145
2169
|
}
|
|
2146
|
-
export type CreateCertificationCourseFileSignData =
|
|
2170
|
+
export type CreateCertificationCourseFileSignData = OutputKqxt1Tamp1K;
|
|
2147
2171
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2148
2172
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2149
2173
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2150
|
-
export type CreateCertificationCourseDocumentData =
|
|
2174
|
+
export type CreateCertificationCourseDocumentData = OutputCvqczxrsu6;
|
|
2151
2175
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2152
2176
|
export type DeleteUserData = any;
|
|
2153
2177
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2159,7 +2183,7 @@ export type UpdateUserData = any;
|
|
|
2159
2183
|
export type UpdateUserError = ErrorResponse;
|
|
2160
2184
|
export type DeleteCertificationCourseData = any;
|
|
2161
2185
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2162
|
-
export type GetCertificationApplicationItemFileData =
|
|
2186
|
+
export type GetCertificationApplicationItemFileData = Output3O35Fw2D54;
|
|
2163
2187
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2164
2188
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2165
2189
|
/** @example "pdf" */
|
|
@@ -2173,9 +2197,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2173
2197
|
/** @example "fileVersion" */
|
|
2174
2198
|
fileVersion: string;
|
|
2175
2199
|
}
|
|
2176
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2200
|
+
export type CreateCertificationApplicationItemFileData = OutputZe2P71Jl4Ph;
|
|
2177
2201
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2178
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2202
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = Output50Y5W4Go7Uk;
|
|
2179
2203
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2180
2204
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2181
2205
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2183,7 +2207,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2183
2207
|
export type GetCourseError = ErrorResponse;
|
|
2184
2208
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2185
2209
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2186
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2210
|
+
export type GetCertificationApplicationForeignFillData = OutputXqrs2Wd9Tkl;
|
|
2187
2211
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2188
2212
|
export type GetCertificationPrintData = any;
|
|
2189
2213
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2217,7 +2241,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2217
2241
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2218
2242
|
export type CreateCertificationWaiveData = any;
|
|
2219
2243
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2220
|
-
export type CreateCertificationMoveData =
|
|
2244
|
+
export type CreateCertificationMoveData = OutputIpk3Gr4Jn2;
|
|
2221
2245
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2222
2246
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2223
2247
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2249,7 +2273,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2249
2273
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2250
2274
|
export type CreateCertificationCourseRedeemData = any;
|
|
2251
2275
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2252
|
-
export type CreateCertificationMoveValidateData =
|
|
2276
|
+
export type CreateCertificationMoveValidateData = OutputZ780Quci3Tj;
|
|
2253
2277
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2254
2278
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2255
2279
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2265,7 +2289,7 @@ export type CreateCertificationPublishInfoData = any;
|
|
|
2265
2289
|
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2266
2290
|
export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
2267
2291
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2268
|
-
export type CreateCertificationResult =
|
|
2292
|
+
export type CreateCertificationResult = OutputF71Vj36Lnw;
|
|
2269
2293
|
export type CreateCertificationFail = ErrorResponse;
|
|
2270
2294
|
export type CreateCertificationPublishInfoResult = any;
|
|
2271
2295
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2312,7 +2336,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2312
2336
|
}
|
|
2313
2337
|
/**
|
|
2314
2338
|
* @title BCCSA Program API
|
|
2315
|
-
* @version 3.0.
|
|
2339
|
+
* @version 3.0.33
|
|
2316
2340
|
* @baseUrl http://localhost:8080
|
|
2317
2341
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2318
2342
|
*/
|
|
@@ -2327,7 +2351,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2327
2351
|
* @request POST:/contactUs
|
|
2328
2352
|
* @secure
|
|
2329
2353
|
*/
|
|
2330
|
-
listContactUs: (data:
|
|
2354
|
+
listContactUs: (data: InputSol3K0Ly82, params?: RequestParams) => Promise<any>;
|
|
2331
2355
|
};
|
|
2332
2356
|
customer: {
|
|
2333
2357
|
/**
|
|
@@ -2431,7 +2455,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2431
2455
|
* @request POST:/tenant/report/applicationExport
|
|
2432
2456
|
* @secure
|
|
2433
2457
|
*/
|
|
2434
|
-
createReportApplicationExport: (data:
|
|
2458
|
+
createReportApplicationExport: (data: InputHtrrxf8Yp9K, params?: RequestParams) => Promise<any>;
|
|
2435
2459
|
/**
|
|
2436
2460
|
* @description Export a report of applications based on the provided filters.
|
|
2437
2461
|
*
|
|
@@ -2441,7 +2465,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2441
2465
|
* @request POST:/tenant/report/applicationStatus
|
|
2442
2466
|
* @secure
|
|
2443
2467
|
*/
|
|
2444
|
-
listReportApplicationStatus: (data:
|
|
2468
|
+
listReportApplicationStatus: (data: InputTq7O0B5F3S, params?: RequestParams) => Promise<any>;
|
|
2445
2469
|
/**
|
|
2446
2470
|
* @description Export a report of applications based on the provided filters.
|
|
2447
2471
|
*
|
|
@@ -2451,7 +2475,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2451
2475
|
* @request POST:/tenant/report/applicationsReport
|
|
2452
2476
|
* @secure
|
|
2453
2477
|
*/
|
|
2454
|
-
createReportApplicationsReport: (data:
|
|
2478
|
+
createReportApplicationsReport: (data: InputVeillj4Rt0L, params?: RequestParams) => Promise<any>;
|
|
2455
2479
|
/**
|
|
2456
2480
|
* @description This route allows you to post certificates email for the tenant.
|
|
2457
2481
|
*
|
|
@@ -2461,7 +2485,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2461
2485
|
* @request POST:/tenant/certificates/email
|
|
2462
2486
|
* @secure
|
|
2463
2487
|
*/
|
|
2464
|
-
createCertificatesEmail: (data:
|
|
2488
|
+
createCertificatesEmail: (data: InputOaldjlebnx, params?: RequestParams) => Promise<any>;
|
|
2465
2489
|
/**
|
|
2466
2490
|
* @description Generate a preview of the completed certifications report.
|
|
2467
2491
|
*
|
|
@@ -2491,7 +2515,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2491
2515
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2492
2516
|
* @secure
|
|
2493
2517
|
*/
|
|
2494
|
-
createLicenseRedeem: (userId: string, data:
|
|
2518
|
+
createLicenseRedeem: (userId: string, data: InputKkyamupnlt, params?: RequestParams) => Promise<any>;
|
|
2495
2519
|
/**
|
|
2496
2520
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2497
2521
|
*
|
|
@@ -2501,7 +2525,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2501
2525
|
* @request POST:/tenant/report/orglicenses/
|
|
2502
2526
|
* @secure
|
|
2503
2527
|
*/
|
|
2504
|
-
listReportOrglicenses: (data:
|
|
2528
|
+
listReportOrglicenses: (data: InputUkvmhdqu3Zh, params?: RequestParams) => Promise<any>;
|
|
2505
2529
|
/**
|
|
2506
2530
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2507
2531
|
*
|
|
@@ -2511,7 +2535,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2511
2535
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2512
2536
|
* @secure
|
|
2513
2537
|
*/
|
|
2514
|
-
createReportOrglicensesPreview: (data:
|
|
2538
|
+
createReportOrglicensesPreview: (data: Input0Hxcnrsc8S, params?: RequestParams) => Promise<any>;
|
|
2515
2539
|
/**
|
|
2516
2540
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2517
2541
|
*
|
|
@@ -2551,7 +2575,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2551
2575
|
* @request POST:/tenant/report/users/advanced
|
|
2552
2576
|
* @secure
|
|
2553
2577
|
*/
|
|
2554
|
-
createReportUsersAdvanced: (data:
|
|
2578
|
+
createReportUsersAdvanced: (data: Input7Il0Lvxsvl, params?: RequestParams) => Promise<any>;
|
|
2555
2579
|
/**
|
|
2556
2580
|
* @description Searches for users in the tenant by their IDs.
|
|
2557
2581
|
*
|
|
@@ -2561,7 +2585,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2561
2585
|
* @request POST:/tenant/search/users/ids
|
|
2562
2586
|
* @secure
|
|
2563
2587
|
*/
|
|
2564
|
-
listSearchUsersIds: (data:
|
|
2588
|
+
listSearchUsersIds: (data: InputJ0Hrmeexdj, params?: RequestParams) => Promise<any>;
|
|
2565
2589
|
/**
|
|
2566
2590
|
* @description Searches for users in the tenant by term and filters.
|
|
2567
2591
|
*
|
|
@@ -2571,7 +2595,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2571
2595
|
* @request POST:/tenant/search/users/term
|
|
2572
2596
|
* @secure
|
|
2573
2597
|
*/
|
|
2574
|
-
createSearchUsersTerm: (data:
|
|
2598
|
+
createSearchUsersTerm: (data: InputVawcwl0959, params?: RequestParams) => Promise<any>;
|
|
2575
2599
|
/**
|
|
2576
2600
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2577
2601
|
*
|
|
@@ -2581,7 +2605,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2581
2605
|
* @request POST:/tenant/report/users/simple
|
|
2582
2606
|
* @secure
|
|
2583
2607
|
*/
|
|
2584
|
-
createReportUsersSimple: (data:
|
|
2608
|
+
createReportUsersSimple: (data: InputHlghz0Fmyni, params?: RequestParams) => Promise<any>;
|
|
2585
2609
|
/**
|
|
2586
2610
|
* @description Retrieve user by ID.
|
|
2587
2611
|
*
|
|
@@ -2591,7 +2615,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2591
2615
|
* @request POST:/tenant/search/users/count
|
|
2592
2616
|
* @secure
|
|
2593
2617
|
*/
|
|
2594
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2618
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputCd7158Kel5>;
|
|
2595
2619
|
};
|
|
2596
2620
|
user: {
|
|
2597
2621
|
/**
|
|
@@ -2623,7 +2647,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2623
2647
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2624
2648
|
* @secure
|
|
2625
2649
|
*/
|
|
2626
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2650
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: InputZe9R08Tm0T, params?: RequestParams) => Promise<any>;
|
|
2627
2651
|
/**
|
|
2628
2652
|
* @description Delete a certification process application by type.
|
|
2629
2653
|
*
|
|
@@ -2713,7 +2737,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2713
2737
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2714
2738
|
* @secure
|
|
2715
2739
|
*/
|
|
2716
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2740
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputEm74Prnnzq>;
|
|
2717
2741
|
/**
|
|
2718
2742
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2719
2743
|
*
|
|
@@ -2723,7 +2747,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2723
2747
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2724
2748
|
* @secure
|
|
2725
2749
|
*/
|
|
2726
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2750
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputKqxt1Tamp1K>;
|
|
2727
2751
|
/**
|
|
2728
2752
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2729
2753
|
*
|
|
@@ -2743,7 +2767,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2743
2767
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2744
2768
|
* @secure
|
|
2745
2769
|
*/
|
|
2746
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2770
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputCvqczxrsu6, params?: RequestParams) => Promise<OutputCvqczxrsu6>;
|
|
2747
2771
|
/**
|
|
2748
2772
|
* @description Delete user by ID.
|
|
2749
2773
|
*
|
|
@@ -2773,7 +2797,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2773
2797
|
* @request POST:/user/{userID}
|
|
2774
2798
|
* @secure
|
|
2775
2799
|
*/
|
|
2776
|
-
createUser: (userId: string, data:
|
|
2800
|
+
createUser: (userId: string, data: InputQeh5M92Xpeh, params?: RequestParams) => Promise<any>;
|
|
2777
2801
|
/**
|
|
2778
2802
|
* @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.
|
|
2779
2803
|
*
|
|
@@ -2783,7 +2807,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2783
2807
|
* @request PUT:/user/{userID}
|
|
2784
2808
|
* @secure
|
|
2785
2809
|
*/
|
|
2786
|
-
updateUser: (userId: string, data:
|
|
2810
|
+
updateUser: (userId: string, data: InputCe5785R8Zs, params?: RequestParams) => Promise<any>;
|
|
2787
2811
|
/**
|
|
2788
2812
|
* @description Delete course from user
|
|
2789
2813
|
*
|
|
@@ -2803,7 +2827,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2803
2827
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2804
2828
|
* @secure
|
|
2805
2829
|
*/
|
|
2806
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2830
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<Output3O35Fw2D54>;
|
|
2807
2831
|
/**
|
|
2808
2832
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2809
2833
|
*
|
|
@@ -2813,7 +2837,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2813
2837
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2814
2838
|
* @secure
|
|
2815
2839
|
*/
|
|
2816
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2840
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputZe2P71Jl4Ph>;
|
|
2817
2841
|
/**
|
|
2818
2842
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2819
2843
|
*
|
|
@@ -2823,7 +2847,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2823
2847
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2824
2848
|
* @secure
|
|
2825
2849
|
*/
|
|
2826
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2850
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<Output50Y5W4Go7Uk>;
|
|
2827
2851
|
/**
|
|
2828
2852
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2829
2853
|
*
|
|
@@ -2863,7 +2887,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2863
2887
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2864
2888
|
* @secure
|
|
2865
2889
|
*/
|
|
2866
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2890
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputXqrs2Wd9Tkl>;
|
|
2867
2891
|
/**
|
|
2868
2892
|
* @description This endpoint will print certificate
|
|
2869
2893
|
*
|
|
@@ -2923,7 +2947,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2923
2947
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2924
2948
|
* @secure
|
|
2925
2949
|
*/
|
|
2926
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2950
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: Input5Xqw5Xwyot, params?: RequestParams) => Promise<any>;
|
|
2927
2951
|
/**
|
|
2928
2952
|
* @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.
|
|
2929
2953
|
*
|
|
@@ -2953,7 +2977,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2953
2977
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2954
2978
|
* @secure
|
|
2955
2979
|
*/
|
|
2956
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2980
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputKc1Ehdb5Ps, params?: RequestParams) => Promise<any>;
|
|
2957
2981
|
/**
|
|
2958
2982
|
* @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.
|
|
2959
2983
|
*
|
|
@@ -2963,7 +2987,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2963
2987
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2964
2988
|
* @secure
|
|
2965
2989
|
*/
|
|
2966
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2990
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputFrbe30I85S, params?: RequestParams) => Promise<any>;
|
|
2967
2991
|
/**
|
|
2968
2992
|
* @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.
|
|
2969
2993
|
*
|
|
@@ -2973,7 +2997,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2973
2997
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2974
2998
|
* @secure
|
|
2975
2999
|
*/
|
|
2976
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
3000
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: Input5L25G7Qxfo, params?: RequestParams) => Promise<any>;
|
|
2977
3001
|
/**
|
|
2978
3002
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2979
3003
|
*
|
|
@@ -2983,7 +3007,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2983
3007
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2984
3008
|
* @secure
|
|
2985
3009
|
*/
|
|
2986
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
3010
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputLkqgxr42Ux, params?: RequestParams) => Promise<any>;
|
|
2987
3011
|
/**
|
|
2988
3012
|
* @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.
|
|
2989
3013
|
*
|
|
@@ -3023,7 +3047,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3023
3047
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
3024
3048
|
* @secure
|
|
3025
3049
|
*/
|
|
3026
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
3050
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputHvql6Tv30P, params?: RequestParams) => Promise<any>;
|
|
3027
3051
|
/**
|
|
3028
3052
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
3029
3053
|
*
|
|
@@ -3033,7 +3057,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3033
3057
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
3034
3058
|
* @secure
|
|
3035
3059
|
*/
|
|
3036
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3060
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputIpk3Gr4Jn2>;
|
|
3037
3061
|
/**
|
|
3038
3062
|
* @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.
|
|
3039
3063
|
*
|
|
@@ -3073,7 +3097,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3073
3097
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
3074
3098
|
* @secure
|
|
3075
3099
|
*/
|
|
3076
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
3100
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputIccc9Wkdt9, params?: RequestParams) => Promise<any>;
|
|
3077
3101
|
/**
|
|
3078
3102
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
3079
3103
|
*
|
|
@@ -3133,7 +3157,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3133
3157
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3134
3158
|
* @secure
|
|
3135
3159
|
*/
|
|
3136
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
3160
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: InputWk711Xrjeq, params?: RequestParams) => Promise<any>;
|
|
3137
3161
|
/**
|
|
3138
3162
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3139
3163
|
*
|
|
@@ -3153,7 +3177,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3153
3177
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3154
3178
|
* @secure
|
|
3155
3179
|
*/
|
|
3156
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3180
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputTtdoeespbb, params?: RequestParams) => Promise<any>;
|
|
3157
3181
|
/**
|
|
3158
3182
|
* @description This route allows you to submit a pending approval.
|
|
3159
3183
|
*
|
|
@@ -3163,7 +3187,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3163
3187
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3164
3188
|
* @secure
|
|
3165
3189
|
*/
|
|
3166
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3190
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputPmeud0A4Jo, params?: RequestParams) => Promise<any>;
|
|
3167
3191
|
/**
|
|
3168
3192
|
* @description This route allows you to review a pending approval.
|
|
3169
3193
|
*
|
|
@@ -3173,7 +3197,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3173
3197
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3174
3198
|
* @secure
|
|
3175
3199
|
*/
|
|
3176
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3200
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: Input711J32K5Lx, params?: RequestParams) => Promise<any>;
|
|
3177
3201
|
/**
|
|
3178
3202
|
* @description Redeems a license for a user by product ID.
|
|
3179
3203
|
*
|
|
@@ -3183,7 +3207,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3183
3207
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3184
3208
|
* @secure
|
|
3185
3209
|
*/
|
|
3186
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3210
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: Input92Ud3Ap8Ee, params?: RequestParams) => Promise<any>;
|
|
3187
3211
|
/**
|
|
3188
3212
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3189
3213
|
*
|
|
@@ -3193,7 +3217,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3193
3217
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3194
3218
|
* @secure
|
|
3195
3219
|
*/
|
|
3196
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3220
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputZ780Quci3Tj>;
|
|
3197
3221
|
/**
|
|
3198
3222
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3199
3223
|
*
|
|
@@ -3203,7 +3227,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3203
3227
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3204
3228
|
* @secure
|
|
3205
3229
|
*/
|
|
3206
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3230
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputAyclmizttx, params?: RequestParams) => Promise<any>;
|
|
3207
3231
|
/**
|
|
3208
3232
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3209
3233
|
*
|
|
@@ -3213,7 +3237,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3213
3237
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3214
3238
|
* @secure
|
|
3215
3239
|
*/
|
|
3216
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3240
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input7Tzs0Tv2Q5, params?: RequestParams) => Promise<any>;
|
|
3217
3241
|
/**
|
|
3218
3242
|
* @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.
|
|
3219
3243
|
*
|
|
@@ -3223,7 +3247,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3223
3247
|
* @request POST:/user/{userID}/updateITA
|
|
3224
3248
|
* @secure
|
|
3225
3249
|
*/
|
|
3226
|
-
createUpdateIta: (userId: string, data:
|
|
3250
|
+
createUpdateIta: (userId: string, data: Input0J4N9Uwfcb, params?: RequestParams) => Promise<any>;
|
|
3227
3251
|
/**
|
|
3228
3252
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3229
3253
|
*
|
|
@@ -3233,7 +3257,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3233
3257
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3234
3258
|
* @secure
|
|
3235
3259
|
*/
|
|
3236
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3260
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputFih2S2Mlabl, params?: RequestParams) => Promise<any>;
|
|
3237
3261
|
/**
|
|
3238
3262
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3239
3263
|
*
|
|
@@ -3243,7 +3267,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3243
3267
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3244
3268
|
* @secure
|
|
3245
3269
|
*/
|
|
3246
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3270
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputLwd5Q9Dzkoi, params?: RequestParams) => Promise<any>;
|
|
3247
3271
|
/**
|
|
3248
3272
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3249
3273
|
*
|
|
@@ -3275,7 +3299,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3275
3299
|
* @request POST:/users/certification/{certSpecID}
|
|
3276
3300
|
* @secure
|
|
3277
3301
|
*/
|
|
3278
|
-
createCertification: (certSpecId: string, data:
|
|
3302
|
+
createCertification: (certSpecId: string, data: InputF71Vj36Lnw, params?: RequestParams) => Promise<OutputF71Vj36Lnw>;
|
|
3279
3303
|
/**
|
|
3280
3304
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3281
3305
|
*
|