@ikonintegration/bccsa-program-api 3.0.32 → 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 +121 -99
- package/dist/Api.d.ts +127 -106
- 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 Input5Lrgzuealdg {
|
|
|
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 InputL8Cedzpr7 {
|
|
|
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 InputJinaq520Gy {
|
|
|
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 InputJeh2Hvhda6 {
|
|
|
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 InputFvuuc37U4Sj {
|
|
|
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 InputWywcrrou7T {
|
|
|
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 Input57Cc5Xh6Ev {
|
|
|
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 Input49938Uolq3 {
|
|
|
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 Input5K4Prrsjbl {
|
|
|
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 InputFb648Yto9A {
|
|
|
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 InputLh9Blhr36S {
|
|
|
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 Input5Emfi0Jsxl {
|
|
|
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 InputZczt279Cke {
|
|
|
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 InputFotlckvfsn {
|
|
|
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 Output0Uprr93Ove {
|
|
|
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 InputW4Bzhb0Jn2 {
|
|
|
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 InputPdsupvwuex {
|
|
|
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 InputU8Djx2Rfyy {
|
|
|
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 OutputU8Djx2Rfyy {
|
|
|
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 Input9Leiwz4Acpk {
|
|
|
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 Input7C1Shzarlo {
|
|
|
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 Output53N3I00Djb {
|
|
|
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 */
|
|
@@ -1853,25 +1878,21 @@ export interface Sponsor {
|
|
|
1853
1878
|
/** Title of the sponsor of the student in the tenant */
|
|
1854
1879
|
title?: Title;
|
|
1855
1880
|
}
|
|
1856
|
-
|
|
1857
|
-
export type Phone = string;
|
|
1858
|
-
/** Title of the sponsor of the student in the tenant */
|
|
1859
|
-
export type Title = string;
|
|
1860
|
-
export interface InputF1Kav0Zcww {
|
|
1881
|
+
export interface Input7Tzs0Tv2Q5 {
|
|
1861
1882
|
/**
|
|
1862
1883
|
* Comments regarding the course unlock action
|
|
1863
1884
|
* @example "Course unlocked successfully."
|
|
1864
1885
|
*/
|
|
1865
1886
|
comments: string;
|
|
1866
1887
|
}
|
|
1867
|
-
export interface
|
|
1888
|
+
export interface Input0J4N9Uwfcb {
|
|
1868
1889
|
/**
|
|
1869
1890
|
* ITA number to update for the user
|
|
1870
1891
|
* @example "ITA123456"
|
|
1871
1892
|
*/
|
|
1872
1893
|
itaNumber: string;
|
|
1873
1894
|
}
|
|
1874
|
-
export interface
|
|
1895
|
+
export interface InputCe5785R8Zs {
|
|
1875
1896
|
/** @example true */
|
|
1876
1897
|
agreedWithCertTerms: boolean;
|
|
1877
1898
|
/** @example 1717230000000 */
|
|
@@ -1945,7 +1966,7 @@ export interface InputUacendfs0U {
|
|
|
1945
1966
|
/** Sponsor information for a student in the tenant */
|
|
1946
1967
|
sponsor?: Sponsor;
|
|
1947
1968
|
}
|
|
1948
|
-
export interface
|
|
1969
|
+
export interface InputFih2S2Mlabl {
|
|
1949
1970
|
/**
|
|
1950
1971
|
* The grade to override the course result with
|
|
1951
1972
|
* @example "A"
|
|
@@ -1953,7 +1974,7 @@ export interface InputQs3Jyyi0Fx {
|
|
|
1953
1974
|
resultGrade: string;
|
|
1954
1975
|
}
|
|
1955
1976
|
/** Pending approval review parameters */
|
|
1956
|
-
export interface
|
|
1977
|
+
export interface Input711J32K5Lx {
|
|
1957
1978
|
/**
|
|
1958
1979
|
* Notes provided by the reviewer for the pending approval
|
|
1959
1980
|
* @example "Please review the submitted documents."
|
|
@@ -1966,7 +1987,7 @@ export interface InputR6Itgrxd2B {
|
|
|
1966
1987
|
approved: boolean;
|
|
1967
1988
|
}
|
|
1968
1989
|
/** Schema for overriding course result dates. */
|
|
1969
|
-
export interface
|
|
1990
|
+
export interface InputLwd5Q9Dzkoi {
|
|
1970
1991
|
/**
|
|
1971
1992
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1972
1993
|
* @example 1735689600000
|
|
@@ -1978,14 +1999,14 @@ export interface Input25X5L4Vd6Y {
|
|
|
1978
1999
|
*/
|
|
1979
2000
|
completionDate?: number;
|
|
1980
2001
|
}
|
|
1981
|
-
export interface
|
|
2002
|
+
export interface InputF71Vj36Lnw {
|
|
1982
2003
|
filter: {
|
|
1983
2004
|
from?: number;
|
|
1984
2005
|
sortOrder?: string;
|
|
1985
2006
|
sortField?: string;
|
|
1986
2007
|
};
|
|
1987
2008
|
}
|
|
1988
|
-
export interface
|
|
2009
|
+
export interface OutputF71Vj36Lnw {
|
|
1989
2010
|
users: {
|
|
1990
2011
|
firstName: string;
|
|
1991
2012
|
lastName: string;
|
|
@@ -2009,7 +2030,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
2009
2030
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
2010
2031
|
* @example "CHECKED"
|
|
2011
2032
|
*/
|
|
2012
|
-
export declare enum
|
|
2033
|
+
export declare enum InputIccc9Wkdt9ValueEnum {
|
|
2013
2034
|
CHECKED = "CHECKED",
|
|
2014
2035
|
UNCHECKED = "UNCHECKED",
|
|
2015
2036
|
NOVALUE = "NOVALUE"
|
|
@@ -2108,7 +2129,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2108
2129
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2109
2130
|
export type CreateReportUsersSimpleData = any;
|
|
2110
2131
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2111
|
-
export type CreateSearchUsersCountData =
|
|
2132
|
+
export type CreateSearchUsersCountData = OutputCd7158Kel5;
|
|
2112
2133
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2113
2134
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2114
2135
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2132,7 +2153,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2132
2153
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2133
2154
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2134
2155
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2135
|
-
export type GetCertificationCourseFileSignData =
|
|
2156
|
+
export type GetCertificationCourseFileSignData = OutputEm74Prnnzq;
|
|
2136
2157
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2137
2158
|
export interface CreateCertificationCourseFileSignParams {
|
|
2138
2159
|
/** @example "pdf" */
|
|
@@ -2146,11 +2167,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2146
2167
|
/** @example "fileID" */
|
|
2147
2168
|
fileId: string;
|
|
2148
2169
|
}
|
|
2149
|
-
export type CreateCertificationCourseFileSignData =
|
|
2170
|
+
export type CreateCertificationCourseFileSignData = OutputKqxt1Tamp1K;
|
|
2150
2171
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2151
2172
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2152
2173
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2153
|
-
export type CreateCertificationCourseDocumentData =
|
|
2174
|
+
export type CreateCertificationCourseDocumentData = OutputCvqczxrsu6;
|
|
2154
2175
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2155
2176
|
export type DeleteUserData = any;
|
|
2156
2177
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2162,7 +2183,7 @@ export type UpdateUserData = any;
|
|
|
2162
2183
|
export type UpdateUserError = ErrorResponse;
|
|
2163
2184
|
export type DeleteCertificationCourseData = any;
|
|
2164
2185
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2165
|
-
export type GetCertificationApplicationItemFileData =
|
|
2186
|
+
export type GetCertificationApplicationItemFileData = Output3O35Fw2D54;
|
|
2166
2187
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2167
2188
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2168
2189
|
/** @example "pdf" */
|
|
@@ -2176,9 +2197,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2176
2197
|
/** @example "fileVersion" */
|
|
2177
2198
|
fileVersion: string;
|
|
2178
2199
|
}
|
|
2179
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2200
|
+
export type CreateCertificationApplicationItemFileData = OutputZe2P71Jl4Ph;
|
|
2180
2201
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2181
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2202
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = Output50Y5W4Go7Uk;
|
|
2182
2203
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2183
2204
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2184
2205
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2186,7 +2207,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2186
2207
|
export type GetCourseError = ErrorResponse;
|
|
2187
2208
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2188
2209
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2189
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2210
|
+
export type GetCertificationApplicationForeignFillData = OutputXqrs2Wd9Tkl;
|
|
2190
2211
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2191
2212
|
export type GetCertificationPrintData = any;
|
|
2192
2213
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2220,7 +2241,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2220
2241
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2221
2242
|
export type CreateCertificationWaiveData = any;
|
|
2222
2243
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2223
|
-
export type CreateCertificationMoveData =
|
|
2244
|
+
export type CreateCertificationMoveData = OutputIpk3Gr4Jn2;
|
|
2224
2245
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2225
2246
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2226
2247
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2252,7 +2273,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2252
2273
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2253
2274
|
export type CreateCertificationCourseRedeemData = any;
|
|
2254
2275
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2255
|
-
export type CreateCertificationMoveValidateData =
|
|
2276
|
+
export type CreateCertificationMoveValidateData = OutputZ780Quci3Tj;
|
|
2256
2277
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2257
2278
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2258
2279
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2268,7 +2289,7 @@ export type CreateCertificationPublishInfoData = any;
|
|
|
2268
2289
|
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2269
2290
|
export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
2270
2291
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2271
|
-
export type CreateCertificationResult =
|
|
2292
|
+
export type CreateCertificationResult = OutputF71Vj36Lnw;
|
|
2272
2293
|
export type CreateCertificationFail = ErrorResponse;
|
|
2273
2294
|
export type CreateCertificationPublishInfoResult = any;
|
|
2274
2295
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2315,7 +2336,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2315
2336
|
}
|
|
2316
2337
|
/**
|
|
2317
2338
|
* @title BCCSA Program API
|
|
2318
|
-
* @version 3.0.
|
|
2339
|
+
* @version 3.0.33
|
|
2319
2340
|
* @baseUrl http://localhost:8080
|
|
2320
2341
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2321
2342
|
*/
|
|
@@ -2330,7 +2351,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2330
2351
|
* @request POST:/contactUs
|
|
2331
2352
|
* @secure
|
|
2332
2353
|
*/
|
|
2333
|
-
listContactUs: (data:
|
|
2354
|
+
listContactUs: (data: InputSol3K0Ly82, params?: RequestParams) => Promise<any>;
|
|
2334
2355
|
};
|
|
2335
2356
|
customer: {
|
|
2336
2357
|
/**
|
|
@@ -2434,7 +2455,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2434
2455
|
* @request POST:/tenant/report/applicationExport
|
|
2435
2456
|
* @secure
|
|
2436
2457
|
*/
|
|
2437
|
-
createReportApplicationExport: (data:
|
|
2458
|
+
createReportApplicationExport: (data: InputHtrrxf8Yp9K, params?: RequestParams) => Promise<any>;
|
|
2438
2459
|
/**
|
|
2439
2460
|
* @description Export a report of applications based on the provided filters.
|
|
2440
2461
|
*
|
|
@@ -2444,7 +2465,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2444
2465
|
* @request POST:/tenant/report/applicationStatus
|
|
2445
2466
|
* @secure
|
|
2446
2467
|
*/
|
|
2447
|
-
listReportApplicationStatus: (data:
|
|
2468
|
+
listReportApplicationStatus: (data: InputTq7O0B5F3S, params?: RequestParams) => Promise<any>;
|
|
2448
2469
|
/**
|
|
2449
2470
|
* @description Export a report of applications based on the provided filters.
|
|
2450
2471
|
*
|
|
@@ -2454,7 +2475,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2454
2475
|
* @request POST:/tenant/report/applicationsReport
|
|
2455
2476
|
* @secure
|
|
2456
2477
|
*/
|
|
2457
|
-
createReportApplicationsReport: (data:
|
|
2478
|
+
createReportApplicationsReport: (data: InputVeillj4Rt0L, params?: RequestParams) => Promise<any>;
|
|
2458
2479
|
/**
|
|
2459
2480
|
* @description This route allows you to post certificates email for the tenant.
|
|
2460
2481
|
*
|
|
@@ -2464,7 +2485,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2464
2485
|
* @request POST:/tenant/certificates/email
|
|
2465
2486
|
* @secure
|
|
2466
2487
|
*/
|
|
2467
|
-
createCertificatesEmail: (data:
|
|
2488
|
+
createCertificatesEmail: (data: InputOaldjlebnx, params?: RequestParams) => Promise<any>;
|
|
2468
2489
|
/**
|
|
2469
2490
|
* @description Generate a preview of the completed certifications report.
|
|
2470
2491
|
*
|
|
@@ -2494,7 +2515,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2494
2515
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2495
2516
|
* @secure
|
|
2496
2517
|
*/
|
|
2497
|
-
createLicenseRedeem: (userId: string, data:
|
|
2518
|
+
createLicenseRedeem: (userId: string, data: InputKkyamupnlt, params?: RequestParams) => Promise<any>;
|
|
2498
2519
|
/**
|
|
2499
2520
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2500
2521
|
*
|
|
@@ -2504,7 +2525,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2504
2525
|
* @request POST:/tenant/report/orglicenses/
|
|
2505
2526
|
* @secure
|
|
2506
2527
|
*/
|
|
2507
|
-
listReportOrglicenses: (data:
|
|
2528
|
+
listReportOrglicenses: (data: InputUkvmhdqu3Zh, params?: RequestParams) => Promise<any>;
|
|
2508
2529
|
/**
|
|
2509
2530
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2510
2531
|
*
|
|
@@ -2514,7 +2535,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2514
2535
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2515
2536
|
* @secure
|
|
2516
2537
|
*/
|
|
2517
|
-
createReportOrglicensesPreview: (data:
|
|
2538
|
+
createReportOrglicensesPreview: (data: Input0Hxcnrsc8S, params?: RequestParams) => Promise<any>;
|
|
2518
2539
|
/**
|
|
2519
2540
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2520
2541
|
*
|
|
@@ -2554,7 +2575,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2554
2575
|
* @request POST:/tenant/report/users/advanced
|
|
2555
2576
|
* @secure
|
|
2556
2577
|
*/
|
|
2557
|
-
createReportUsersAdvanced: (data:
|
|
2578
|
+
createReportUsersAdvanced: (data: Input7Il0Lvxsvl, params?: RequestParams) => Promise<any>;
|
|
2558
2579
|
/**
|
|
2559
2580
|
* @description Searches for users in the tenant by their IDs.
|
|
2560
2581
|
*
|
|
@@ -2564,7 +2585,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2564
2585
|
* @request POST:/tenant/search/users/ids
|
|
2565
2586
|
* @secure
|
|
2566
2587
|
*/
|
|
2567
|
-
listSearchUsersIds: (data:
|
|
2588
|
+
listSearchUsersIds: (data: InputJ0Hrmeexdj, params?: RequestParams) => Promise<any>;
|
|
2568
2589
|
/**
|
|
2569
2590
|
* @description Searches for users in the tenant by term and filters.
|
|
2570
2591
|
*
|
|
@@ -2574,7 +2595,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2574
2595
|
* @request POST:/tenant/search/users/term
|
|
2575
2596
|
* @secure
|
|
2576
2597
|
*/
|
|
2577
|
-
createSearchUsersTerm: (data:
|
|
2598
|
+
createSearchUsersTerm: (data: InputVawcwl0959, params?: RequestParams) => Promise<any>;
|
|
2578
2599
|
/**
|
|
2579
2600
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2580
2601
|
*
|
|
@@ -2584,7 +2605,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2584
2605
|
* @request POST:/tenant/report/users/simple
|
|
2585
2606
|
* @secure
|
|
2586
2607
|
*/
|
|
2587
|
-
createReportUsersSimple: (data:
|
|
2608
|
+
createReportUsersSimple: (data: InputHlghz0Fmyni, params?: RequestParams) => Promise<any>;
|
|
2588
2609
|
/**
|
|
2589
2610
|
* @description Retrieve user by ID.
|
|
2590
2611
|
*
|
|
@@ -2594,7 +2615,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2594
2615
|
* @request POST:/tenant/search/users/count
|
|
2595
2616
|
* @secure
|
|
2596
2617
|
*/
|
|
2597
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2618
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputCd7158Kel5>;
|
|
2598
2619
|
};
|
|
2599
2620
|
user: {
|
|
2600
2621
|
/**
|
|
@@ -2626,7 +2647,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2626
2647
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2627
2648
|
* @secure
|
|
2628
2649
|
*/
|
|
2629
|
-
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>;
|
|
2630
2651
|
/**
|
|
2631
2652
|
* @description Delete a certification process application by type.
|
|
2632
2653
|
*
|
|
@@ -2716,7 +2737,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2716
2737
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2717
2738
|
* @secure
|
|
2718
2739
|
*/
|
|
2719
|
-
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>;
|
|
2720
2741
|
/**
|
|
2721
2742
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2722
2743
|
*
|
|
@@ -2726,7 +2747,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2726
2747
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2727
2748
|
* @secure
|
|
2728
2749
|
*/
|
|
2729
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2750
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputKqxt1Tamp1K>;
|
|
2730
2751
|
/**
|
|
2731
2752
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2732
2753
|
*
|
|
@@ -2746,7 +2767,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2746
2767
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2747
2768
|
* @secure
|
|
2748
2769
|
*/
|
|
2749
|
-
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>;
|
|
2750
2771
|
/**
|
|
2751
2772
|
* @description Delete user by ID.
|
|
2752
2773
|
*
|
|
@@ -2776,7 +2797,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2776
2797
|
* @request POST:/user/{userID}
|
|
2777
2798
|
* @secure
|
|
2778
2799
|
*/
|
|
2779
|
-
createUser: (userId: string, data:
|
|
2800
|
+
createUser: (userId: string, data: InputQeh5M92Xpeh, params?: RequestParams) => Promise<any>;
|
|
2780
2801
|
/**
|
|
2781
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.
|
|
2782
2803
|
*
|
|
@@ -2786,7 +2807,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2786
2807
|
* @request PUT:/user/{userID}
|
|
2787
2808
|
* @secure
|
|
2788
2809
|
*/
|
|
2789
|
-
updateUser: (userId: string, data:
|
|
2810
|
+
updateUser: (userId: string, data: InputCe5785R8Zs, params?: RequestParams) => Promise<any>;
|
|
2790
2811
|
/**
|
|
2791
2812
|
* @description Delete course from user
|
|
2792
2813
|
*
|
|
@@ -2806,7 +2827,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2806
2827
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2807
2828
|
* @secure
|
|
2808
2829
|
*/
|
|
2809
|
-
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>;
|
|
2810
2831
|
/**
|
|
2811
2832
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2812
2833
|
*
|
|
@@ -2816,7 +2837,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2816
2837
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2817
2838
|
* @secure
|
|
2818
2839
|
*/
|
|
2819
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2840
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputZe2P71Jl4Ph>;
|
|
2820
2841
|
/**
|
|
2821
2842
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2822
2843
|
*
|
|
@@ -2826,7 +2847,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2826
2847
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2827
2848
|
* @secure
|
|
2828
2849
|
*/
|
|
2829
|
-
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>;
|
|
2830
2851
|
/**
|
|
2831
2852
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2832
2853
|
*
|
|
@@ -2866,7 +2887,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2866
2887
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2867
2888
|
* @secure
|
|
2868
2889
|
*/
|
|
2869
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2890
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputXqrs2Wd9Tkl>;
|
|
2870
2891
|
/**
|
|
2871
2892
|
* @description This endpoint will print certificate
|
|
2872
2893
|
*
|
|
@@ -2926,7 +2947,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2926
2947
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2927
2948
|
* @secure
|
|
2928
2949
|
*/
|
|
2929
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2950
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: Input5Xqw5Xwyot, params?: RequestParams) => Promise<any>;
|
|
2930
2951
|
/**
|
|
2931
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.
|
|
2932
2953
|
*
|
|
@@ -2956,7 +2977,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2956
2977
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2957
2978
|
* @secure
|
|
2958
2979
|
*/
|
|
2959
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2980
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputKc1Ehdb5Ps, params?: RequestParams) => Promise<any>;
|
|
2960
2981
|
/**
|
|
2961
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.
|
|
2962
2983
|
*
|
|
@@ -2966,7 +2987,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2966
2987
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2967
2988
|
* @secure
|
|
2968
2989
|
*/
|
|
2969
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2990
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputFrbe30I85S, params?: RequestParams) => Promise<any>;
|
|
2970
2991
|
/**
|
|
2971
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.
|
|
2972
2993
|
*
|
|
@@ -2976,7 +2997,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2976
2997
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2977
2998
|
* @secure
|
|
2978
2999
|
*/
|
|
2979
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
3000
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: Input5L25G7Qxfo, params?: RequestParams) => Promise<any>;
|
|
2980
3001
|
/**
|
|
2981
3002
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2982
3003
|
*
|
|
@@ -2986,7 +3007,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2986
3007
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2987
3008
|
* @secure
|
|
2988
3009
|
*/
|
|
2989
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
3010
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputLkqgxr42Ux, params?: RequestParams) => Promise<any>;
|
|
2990
3011
|
/**
|
|
2991
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.
|
|
2992
3013
|
*
|
|
@@ -3026,7 +3047,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3026
3047
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
3027
3048
|
* @secure
|
|
3028
3049
|
*/
|
|
3029
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
3050
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputHvql6Tv30P, params?: RequestParams) => Promise<any>;
|
|
3030
3051
|
/**
|
|
3031
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.
|
|
3032
3053
|
*
|
|
@@ -3036,7 +3057,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3036
3057
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
3037
3058
|
* @secure
|
|
3038
3059
|
*/
|
|
3039
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3060
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputIpk3Gr4Jn2>;
|
|
3040
3061
|
/**
|
|
3041
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.
|
|
3042
3063
|
*
|
|
@@ -3076,7 +3097,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3076
3097
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
3077
3098
|
* @secure
|
|
3078
3099
|
*/
|
|
3079
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
3100
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputIccc9Wkdt9, params?: RequestParams) => Promise<any>;
|
|
3080
3101
|
/**
|
|
3081
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.
|
|
3082
3103
|
*
|
|
@@ -3136,7 +3157,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3136
3157
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3137
3158
|
* @secure
|
|
3138
3159
|
*/
|
|
3139
|
-
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>;
|
|
3140
3161
|
/**
|
|
3141
3162
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3142
3163
|
*
|
|
@@ -3156,7 +3177,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3156
3177
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3157
3178
|
* @secure
|
|
3158
3179
|
*/
|
|
3159
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3180
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputTtdoeespbb, params?: RequestParams) => Promise<any>;
|
|
3160
3181
|
/**
|
|
3161
3182
|
* @description This route allows you to submit a pending approval.
|
|
3162
3183
|
*
|
|
@@ -3166,7 +3187,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3166
3187
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3167
3188
|
* @secure
|
|
3168
3189
|
*/
|
|
3169
|
-
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>;
|
|
3170
3191
|
/**
|
|
3171
3192
|
* @description This route allows you to review a pending approval.
|
|
3172
3193
|
*
|
|
@@ -3176,7 +3197,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3176
3197
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3177
3198
|
* @secure
|
|
3178
3199
|
*/
|
|
3179
|
-
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>;
|
|
3180
3201
|
/**
|
|
3181
3202
|
* @description Redeems a license for a user by product ID.
|
|
3182
3203
|
*
|
|
@@ -3186,7 +3207,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3186
3207
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3187
3208
|
* @secure
|
|
3188
3209
|
*/
|
|
3189
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3210
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: Input92Ud3Ap8Ee, params?: RequestParams) => Promise<any>;
|
|
3190
3211
|
/**
|
|
3191
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.
|
|
3192
3213
|
*
|
|
@@ -3196,7 +3217,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3196
3217
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3197
3218
|
* @secure
|
|
3198
3219
|
*/
|
|
3199
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3220
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputZ780Quci3Tj>;
|
|
3200
3221
|
/**
|
|
3201
3222
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3202
3223
|
*
|
|
@@ -3206,7 +3227,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3206
3227
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3207
3228
|
* @secure
|
|
3208
3229
|
*/
|
|
3209
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3230
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputAyclmizttx, params?: RequestParams) => Promise<any>;
|
|
3210
3231
|
/**
|
|
3211
3232
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3212
3233
|
*
|
|
@@ -3216,7 +3237,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3216
3237
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3217
3238
|
* @secure
|
|
3218
3239
|
*/
|
|
3219
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3240
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input7Tzs0Tv2Q5, params?: RequestParams) => Promise<any>;
|
|
3220
3241
|
/**
|
|
3221
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.
|
|
3222
3243
|
*
|
|
@@ -3226,7 +3247,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3226
3247
|
* @request POST:/user/{userID}/updateITA
|
|
3227
3248
|
* @secure
|
|
3228
3249
|
*/
|
|
3229
|
-
createUpdateIta: (userId: string, data:
|
|
3250
|
+
createUpdateIta: (userId: string, data: Input0J4N9Uwfcb, params?: RequestParams) => Promise<any>;
|
|
3230
3251
|
/**
|
|
3231
3252
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3232
3253
|
*
|
|
@@ -3236,7 +3257,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3236
3257
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3237
3258
|
* @secure
|
|
3238
3259
|
*/
|
|
3239
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3260
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputFih2S2Mlabl, params?: RequestParams) => Promise<any>;
|
|
3240
3261
|
/**
|
|
3241
3262
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3242
3263
|
*
|
|
@@ -3246,7 +3267,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3246
3267
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3247
3268
|
* @secure
|
|
3248
3269
|
*/
|
|
3249
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3270
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputLwd5Q9Dzkoi, params?: RequestParams) => Promise<any>;
|
|
3250
3271
|
/**
|
|
3251
3272
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3252
3273
|
*
|
|
@@ -3278,7 +3299,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3278
3299
|
* @request POST:/users/certification/{certSpecID}
|
|
3279
3300
|
* @secure
|
|
3280
3301
|
*/
|
|
3281
|
-
createCertification: (certSpecId: string, data:
|
|
3302
|
+
createCertification: (certSpecId: string, data: InputF71Vj36Lnw, params?: RequestParams) => Promise<OutputF71Vj36Lnw>;
|
|
3282
3303
|
/**
|
|
3283
3304
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3284
3305
|
*
|