@ikonintegration/bccsa-program-api 3.0.32 → 3.0.35
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 +160 -100
- package/dist/Api.d.ts +148 -107
- package/dist/Api.js +26 -9
- package/dist/Api.js.map +1 -1
- package/package.json +1 -1
package/dist/Api.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ export interface ErrorResponse {
|
|
|
5
5
|
/** Error code */
|
|
6
6
|
errCode: string;
|
|
7
7
|
}
|
|
8
|
-
export interface
|
|
8
|
+
export interface InputRr9Kp8P5Qu {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -439,10 +439,14 @@ 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) */
|
|
445
447
|
sponsorshipRemindersSponsor?: SponsorshipRemindersSponsor;
|
|
448
|
+
/** Timestamp when the current sponsorship reminder schedule started (set on create and on reset). Reminder dueness is measured from it; when absent, from createdOn. */
|
|
449
|
+
remindersStartedOn?: RemindersStartedOn;
|
|
446
450
|
}[] | null;
|
|
447
451
|
}
|
|
448
452
|
/** Timestamp when the entry was last updated */
|
|
@@ -455,11 +459,34 @@ export type CertTitle = string;
|
|
|
455
459
|
export type DisplayName = string;
|
|
456
460
|
/** Email address of the user who submitted the pending approval */
|
|
457
461
|
export type Email = string;
|
|
462
|
+
/** Point-in-time sponsor snapshot for SPONSOR_ATTESTATION pending approvals */
|
|
463
|
+
export interface Sponsor {
|
|
464
|
+
/** Name of the sponsor of the student in the tenant */
|
|
465
|
+
name?: Name;
|
|
466
|
+
/** Phone number of the sponsor of the student in the tenant */
|
|
467
|
+
phone?: Phone;
|
|
468
|
+
/** Email address of sponsor for the attestation process */
|
|
469
|
+
email?: Email;
|
|
470
|
+
/** Title of the sponsor of the student in the tenant */
|
|
471
|
+
title?: Title;
|
|
472
|
+
}
|
|
473
|
+
/**
|
|
474
|
+
* Phone number of the sponsor of the student in the tenant
|
|
475
|
+
* @maxLength 255
|
|
476
|
+
*/
|
|
477
|
+
export type Phone = string;
|
|
478
|
+
/**
|
|
479
|
+
* Title of the sponsor of the student in the tenant
|
|
480
|
+
* @maxLength 255
|
|
481
|
+
*/
|
|
482
|
+
export type Title = string;
|
|
458
483
|
/** Pending sponsorship request reminders sent to the user (array with reminder IDs, where reminderID is template-numdays) */
|
|
459
484
|
export type SponsorshipRemindersStudent = string[];
|
|
460
485
|
/** Pending sponsorship request reminders sent to the sponsor (array with reminder IDs, where reminderID is template-numdays) */
|
|
461
486
|
export type SponsorshipRemindersSponsor = string[];
|
|
462
|
-
|
|
487
|
+
/** Timestamp when the current sponsorship reminder schedule started (set on create and on reset). Reminder dueness is measured from it; when absent, from createdOn. */
|
|
488
|
+
export type RemindersStartedOn = number;
|
|
489
|
+
export interface InputHvh2Rhjuk6 {
|
|
463
490
|
/**
|
|
464
491
|
* ID of the certification to filter applications by
|
|
465
492
|
* @example "certification123"
|
|
@@ -516,7 +543,7 @@ export interface Input5Lrgzuealdg {
|
|
|
516
543
|
*/
|
|
517
544
|
ignoreCompletedCertifications?: boolean | null;
|
|
518
545
|
}
|
|
519
|
-
export interface
|
|
546
|
+
export interface Input5K8X950Ztg {
|
|
520
547
|
/**
|
|
521
548
|
* ID of the certification to filter applications by
|
|
522
549
|
* @example "certification123"
|
|
@@ -573,7 +600,7 @@ export interface InputL8Cedzpr7 {
|
|
|
573
600
|
*/
|
|
574
601
|
ignoreCompletedCertifications?: boolean | null;
|
|
575
602
|
}
|
|
576
|
-
export interface
|
|
603
|
+
export interface InputV73Gd5K2S3 {
|
|
577
604
|
/**
|
|
578
605
|
* ID of the certification to filter applications by
|
|
579
606
|
* @example "certification123"
|
|
@@ -630,7 +657,7 @@ export interface InputJinaq520Gy {
|
|
|
630
657
|
*/
|
|
631
658
|
ignoreCompletedCertifications?: boolean | null;
|
|
632
659
|
}
|
|
633
|
-
export interface
|
|
660
|
+
export interface InputYuucneuxkg {
|
|
634
661
|
/**
|
|
635
662
|
* The ID of the certificate specifications to be used for the email
|
|
636
663
|
* @example "certSpecsID123"
|
|
@@ -671,7 +698,7 @@ export interface InputJeh2Hvhda6 {
|
|
|
671
698
|
emailAddress: string;
|
|
672
699
|
}[];
|
|
673
700
|
}
|
|
674
|
-
export interface
|
|
701
|
+
export interface InputIc5N9Ldrci {
|
|
675
702
|
/**
|
|
676
703
|
* The ID of the product for which the license is being redeemed
|
|
677
704
|
* @example "productID123"
|
|
@@ -683,7 +710,7 @@ export interface InputFvuuc37U4Sj {
|
|
|
683
710
|
*/
|
|
684
711
|
sessionID?: string;
|
|
685
712
|
}
|
|
686
|
-
export interface
|
|
713
|
+
export interface InputJu8Q7Jd4Rm {
|
|
687
714
|
/**
|
|
688
715
|
* Search term to filter licenses
|
|
689
716
|
* @example "active"
|
|
@@ -700,7 +727,7 @@ export interface InputWywcrrou7T {
|
|
|
700
727
|
*/
|
|
701
728
|
sortField?: any;
|
|
702
729
|
}
|
|
703
|
-
export interface
|
|
730
|
+
export interface InputU8Srhwp84Ch {
|
|
704
731
|
/**
|
|
705
732
|
* Search term to filter licenses
|
|
706
733
|
* @example "active"
|
|
@@ -823,13 +850,17 @@ export interface SearchPendingApprovalsResponseSchema {
|
|
|
823
850
|
reviewedBy?: ReviewedBy;
|
|
824
851
|
/** Timestamp of the review */
|
|
825
852
|
reviewedOn?: ReviewedOn;
|
|
853
|
+
/** Point-in-time sponsor snapshot for SPONSOR_ATTESTATION pending approvals */
|
|
854
|
+
sponsor?: Sponsor;
|
|
826
855
|
/** Pending sponsorship request reminders sent to the user (array with reminder IDs, where reminderID is template-numdays) */
|
|
827
856
|
sponsorshipRemindersStudent?: SponsorshipRemindersStudent;
|
|
828
857
|
/** Pending sponsorship request reminders sent to the sponsor (array with reminder IDs, where reminderID is template-numdays) */
|
|
829
858
|
sponsorshipRemindersSponsor?: SponsorshipRemindersSponsor;
|
|
859
|
+
/** Timestamp when the current sponsorship reminder schedule started (set on create and on reset). Reminder dueness is measured from it; when absent, from createdOn. */
|
|
860
|
+
remindersStartedOn?: RemindersStartedOn;
|
|
830
861
|
}[];
|
|
831
862
|
}
|
|
832
|
-
export interface
|
|
863
|
+
export interface InputF5Jjnrfmt7I {
|
|
833
864
|
/**
|
|
834
865
|
* Start date for the report
|
|
835
866
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -851,11 +882,11 @@ export interface Input57Cc5Xh6Ev {
|
|
|
851
882
|
*/
|
|
852
883
|
dateType?: string;
|
|
853
884
|
}
|
|
854
|
-
export interface
|
|
885
|
+
export interface Input5Nynw58Ws1 {
|
|
855
886
|
/** List of user IDs to search for in the tenant. */
|
|
856
887
|
IDs: (string | null)[];
|
|
857
888
|
}
|
|
858
|
-
export interface
|
|
889
|
+
export interface Input4H67Nuuo8P {
|
|
859
890
|
/** The term to search for in the user profiles. */
|
|
860
891
|
searchTerm?: string | null;
|
|
861
892
|
/** Filter criteria for the user search. */
|
|
@@ -895,7 +926,7 @@ export interface Input49938Uolq3 {
|
|
|
895
926
|
};
|
|
896
927
|
};
|
|
897
928
|
}
|
|
898
|
-
export interface
|
|
929
|
+
export interface Input2Mihdr2Tcif {
|
|
899
930
|
/** The term to search for in the user profiles. */
|
|
900
931
|
searchTerm?: string | null;
|
|
901
932
|
/** Filter criteria for the user search. */
|
|
@@ -935,21 +966,21 @@ export interface Input5K4Prrsjbl {
|
|
|
935
966
|
};
|
|
936
967
|
};
|
|
937
968
|
}
|
|
938
|
-
export interface
|
|
969
|
+
export interface OutputJqh0F2Rq94L {
|
|
939
970
|
/** External system ID 2 */
|
|
940
971
|
userCount: ExternalID2;
|
|
941
972
|
transactionID?: string | null;
|
|
942
973
|
}
|
|
943
974
|
/** External system ID 2 */
|
|
944
975
|
export type ExternalID2 = number;
|
|
945
|
-
export interface
|
|
976
|
+
export interface Output5Qmmfjb7J6 {
|
|
946
977
|
/**
|
|
947
978
|
* Signed URL for the course file
|
|
948
979
|
* @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
980
|
*/
|
|
950
981
|
fileURL: string;
|
|
951
982
|
}
|
|
952
|
-
export interface
|
|
983
|
+
export interface Output7Jte254C0P {
|
|
953
984
|
/**
|
|
954
985
|
* Amount to be refunded for the cancellation
|
|
955
986
|
* @example 0
|
|
@@ -1249,7 +1280,7 @@ export interface CourseResponseEntity {
|
|
|
1249
1280
|
}
|
|
1250
1281
|
/** Label of the course enrolled (course version) */
|
|
1251
1282
|
export type OnlineCourseLabel = string;
|
|
1252
|
-
export interface
|
|
1283
|
+
export interface Output6Lxou5Wadvl {
|
|
1253
1284
|
/**
|
|
1254
1285
|
* Signed URL for the course file
|
|
1255
1286
|
* @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 +1298,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1267
1298
|
transactionID?: string | null;
|
|
1268
1299
|
}
|
|
1269
1300
|
/** Application Foreign Fill response type */
|
|
1270
|
-
export interface
|
|
1301
|
+
export interface OutputDrnp2Yirpi {
|
|
1271
1302
|
items: {
|
|
1272
1303
|
userID: string;
|
|
1273
1304
|
createdOn?: number;
|
|
@@ -1455,7 +1486,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1455
1486
|
applicationItems?: Record<string, any>[];
|
|
1456
1487
|
transactionID?: string | null;
|
|
1457
1488
|
}
|
|
1458
|
-
export interface
|
|
1489
|
+
export interface InputUdco8Yiz4U {
|
|
1459
1490
|
issuedOn?: number;
|
|
1460
1491
|
expiresOn?: number;
|
|
1461
1492
|
fileItems?: {
|
|
@@ -1464,21 +1495,21 @@ export interface InputFb648Yto9A {
|
|
|
1464
1495
|
}[];
|
|
1465
1496
|
additionalNotes?: string | null;
|
|
1466
1497
|
}
|
|
1467
|
-
export interface
|
|
1498
|
+
export interface InputWkff4Yaywy {
|
|
1468
1499
|
/**
|
|
1469
1500
|
* Indicates whether the application is locked
|
|
1470
1501
|
* @example true
|
|
1471
1502
|
*/
|
|
1472
1503
|
isApplicationLocked: boolean;
|
|
1473
1504
|
}
|
|
1474
|
-
export interface
|
|
1505
|
+
export interface Output6S8Rfzxiuf {
|
|
1475
1506
|
/**
|
|
1476
1507
|
* Signed URL for the course file
|
|
1477
1508
|
* @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
1509
|
*/
|
|
1479
1510
|
fileURL: string;
|
|
1480
1511
|
}
|
|
1481
|
-
export interface
|
|
1512
|
+
export interface InputKa30H4Ner6 {
|
|
1482
1513
|
/**
|
|
1483
1514
|
* Indicates whether the waiver is approved
|
|
1484
1515
|
* @example true
|
|
@@ -1490,14 +1521,14 @@ export interface InputLh9Blhr36S {
|
|
|
1490
1521
|
*/
|
|
1491
1522
|
additionalNotes?: string | null;
|
|
1492
1523
|
}
|
|
1493
|
-
export interface
|
|
1524
|
+
export interface InputP7Rzxtpwwc {
|
|
1494
1525
|
/**
|
|
1495
1526
|
* Optional notes regarding the waiver
|
|
1496
1527
|
* @example "Waiver granted due to special circumstances."
|
|
1497
1528
|
*/
|
|
1498
1529
|
additionalNotes?: string | null;
|
|
1499
1530
|
}
|
|
1500
|
-
export interface
|
|
1531
|
+
export interface InputY2D9S4Qy4S {
|
|
1501
1532
|
students: {
|
|
1502
1533
|
/**
|
|
1503
1534
|
* User ID of the student to redeem the course for
|
|
@@ -1531,7 +1562,7 @@ export interface Input5Emfi0Jsxl {
|
|
|
1531
1562
|
*/
|
|
1532
1563
|
autoEnrolSessionID?: string;
|
|
1533
1564
|
}
|
|
1534
|
-
export interface
|
|
1565
|
+
export interface Input62Nyiggonmh {
|
|
1535
1566
|
invites: {
|
|
1536
1567
|
/**
|
|
1537
1568
|
* Email address of the user to invite
|
|
@@ -1560,7 +1591,7 @@ export interface InputZczt279Cke {
|
|
|
1560
1591
|
*/
|
|
1561
1592
|
isReservedSeat: boolean;
|
|
1562
1593
|
}
|
|
1563
|
-
export interface
|
|
1594
|
+
export interface InputXqdgr5Oa5Vh {
|
|
1564
1595
|
/**
|
|
1565
1596
|
* Indicates whether to waive the certification process
|
|
1566
1597
|
* @example true
|
|
@@ -1573,7 +1604,7 @@ export interface InputFotlckvfsn {
|
|
|
1573
1604
|
comments?: string | null;
|
|
1574
1605
|
}
|
|
1575
1606
|
/** Certification move response schema */
|
|
1576
|
-
export interface
|
|
1607
|
+
export interface Output6D4Ct52Qpe {
|
|
1577
1608
|
errors?: {
|
|
1578
1609
|
status: string;
|
|
1579
1610
|
object?: Record<string, any>;
|
|
@@ -1581,19 +1612,19 @@ export interface Output0Uprr93Ove {
|
|
|
1581
1612
|
}[];
|
|
1582
1613
|
}
|
|
1583
1614
|
/** Schema for writing a certification trigger check. */
|
|
1584
|
-
export interface
|
|
1615
|
+
export interface InputUysjux8Zp4 {
|
|
1585
1616
|
/**
|
|
1586
1617
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1587
1618
|
* @example "CHECKED"
|
|
1588
1619
|
*/
|
|
1589
|
-
value:
|
|
1620
|
+
value: InputUysjux8Zp4ValueEnum;
|
|
1590
1621
|
/**
|
|
1591
1622
|
* List of course IDs that are blocked by this trigger check.
|
|
1592
1623
|
* @example ["course1","course2"]
|
|
1593
1624
|
*/
|
|
1594
1625
|
blockedCourses?: string[];
|
|
1595
1626
|
}
|
|
1596
|
-
export interface
|
|
1627
|
+
export interface Input1Lghooas4I {
|
|
1597
1628
|
/**
|
|
1598
1629
|
* Indicates whether the application item is approved
|
|
1599
1630
|
* @example true
|
|
@@ -1619,7 +1650,7 @@ export interface InputW4Bzhb0Jn2 {
|
|
|
1619
1650
|
export interface StudentHistoryRequestSchema {
|
|
1620
1651
|
requirements: string[];
|
|
1621
1652
|
}
|
|
1622
|
-
export interface
|
|
1653
|
+
export interface InputCgletgibfvi {
|
|
1623
1654
|
/**
|
|
1624
1655
|
* Optional activation key for the application
|
|
1625
1656
|
* @example "AK-123456"
|
|
@@ -1627,7 +1658,7 @@ export interface InputPdsupvwuex {
|
|
|
1627
1658
|
activationKey?: string;
|
|
1628
1659
|
}
|
|
1629
1660
|
/** Schema for course submission item details post request. */
|
|
1630
|
-
export interface
|
|
1661
|
+
export interface InputOszbc2Lfht {
|
|
1631
1662
|
/**
|
|
1632
1663
|
* The ID of the file being submitted.
|
|
1633
1664
|
* @example "fileID123"
|
|
@@ -1640,7 +1671,7 @@ export interface InputU8Djx2Rfyy {
|
|
|
1640
1671
|
fileName: string;
|
|
1641
1672
|
}
|
|
1642
1673
|
/** Schema for the response to course submission item details post request. */
|
|
1643
|
-
export interface
|
|
1674
|
+
export interface OutputOszbc2Lfht {
|
|
1644
1675
|
submissionItems: {
|
|
1645
1676
|
/**
|
|
1646
1677
|
* The ID of the file being submitted.
|
|
@@ -1655,7 +1686,7 @@ export interface OutputU8Djx2Rfyy {
|
|
|
1655
1686
|
}[];
|
|
1656
1687
|
}
|
|
1657
1688
|
/** Pending approval submission parameters */
|
|
1658
|
-
export interface
|
|
1689
|
+
export interface InputDv9Ni3Aar5 {
|
|
1659
1690
|
/**
|
|
1660
1691
|
* Type of pending approval
|
|
1661
1692
|
* @example "certification"
|
|
@@ -1675,7 +1706,7 @@ export interface Input9Leiwz4Acpk {
|
|
|
1675
1706
|
fileName: string;
|
|
1676
1707
|
}[];
|
|
1677
1708
|
}
|
|
1678
|
-
export interface
|
|
1709
|
+
export interface InputGhxoi4I6V8 {
|
|
1679
1710
|
/**
|
|
1680
1711
|
* The ID of the course for which the license is being redeemed
|
|
1681
1712
|
* @example "courseID123"
|
|
@@ -1743,7 +1774,7 @@ export interface Input7C1Shzarlo {
|
|
|
1743
1774
|
acknowledgement?: string | null;
|
|
1744
1775
|
}
|
|
1745
1776
|
/** Validate certification move response schema */
|
|
1746
|
-
export interface
|
|
1777
|
+
export interface OutputMlk3Y0Sufr {
|
|
1747
1778
|
courses: {
|
|
1748
1779
|
name: string;
|
|
1749
1780
|
status: string;
|
|
@@ -1754,21 +1785,21 @@ export interface Output53N3I00Djb {
|
|
|
1754
1785
|
validated: boolean;
|
|
1755
1786
|
mustCreateCP: boolean;
|
|
1756
1787
|
}
|
|
1757
|
-
export interface
|
|
1788
|
+
export interface InputHod6Xcmzr8 {
|
|
1758
1789
|
/**
|
|
1759
1790
|
* Comments regarding the end of the cooldown period
|
|
1760
1791
|
* @example "Cooldown period ended successfully."
|
|
1761
1792
|
*/
|
|
1762
1793
|
comments: string;
|
|
1763
1794
|
}
|
|
1764
|
-
export interface
|
|
1795
|
+
export interface OutputFn02Htoomy {
|
|
1765
1796
|
/**
|
|
1766
1797
|
* Signed URL for the course file
|
|
1767
1798
|
* @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
1799
|
*/
|
|
1769
1800
|
fileURL: string;
|
|
1770
1801
|
}
|
|
1771
|
-
export interface
|
|
1802
|
+
export interface Input4S9Bu0T1Ng {
|
|
1772
1803
|
/** @example true */
|
|
1773
1804
|
agreedWithCertTerms: boolean;
|
|
1774
1805
|
/** @example 1717230000000 */
|
|
@@ -1853,25 +1884,21 @@ export interface Sponsor {
|
|
|
1853
1884
|
/** Title of the sponsor of the student in the tenant */
|
|
1854
1885
|
title?: Title;
|
|
1855
1886
|
}
|
|
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 {
|
|
1887
|
+
export interface InputX4U7C4Jq36 {
|
|
1861
1888
|
/**
|
|
1862
1889
|
* Comments regarding the course unlock action
|
|
1863
1890
|
* @example "Course unlocked successfully."
|
|
1864
1891
|
*/
|
|
1865
1892
|
comments: string;
|
|
1866
1893
|
}
|
|
1867
|
-
export interface
|
|
1894
|
+
export interface InputBmpgyhghyb {
|
|
1868
1895
|
/**
|
|
1869
1896
|
* ITA number to update for the user
|
|
1870
1897
|
* @example "ITA123456"
|
|
1871
1898
|
*/
|
|
1872
1899
|
itaNumber: string;
|
|
1873
1900
|
}
|
|
1874
|
-
export interface
|
|
1901
|
+
export interface Input3Q79Al8T06 {
|
|
1875
1902
|
/** @example true */
|
|
1876
1903
|
agreedWithCertTerms: boolean;
|
|
1877
1904
|
/** @example 1717230000000 */
|
|
@@ -1945,7 +1972,7 @@ export interface InputUacendfs0U {
|
|
|
1945
1972
|
/** Sponsor information for a student in the tenant */
|
|
1946
1973
|
sponsor?: Sponsor;
|
|
1947
1974
|
}
|
|
1948
|
-
export interface
|
|
1975
|
+
export interface InputW1Qz7Aegx2 {
|
|
1949
1976
|
/**
|
|
1950
1977
|
* The grade to override the course result with
|
|
1951
1978
|
* @example "A"
|
|
@@ -1953,7 +1980,7 @@ export interface InputQs3Jyyi0Fx {
|
|
|
1953
1980
|
resultGrade: string;
|
|
1954
1981
|
}
|
|
1955
1982
|
/** Pending approval review parameters */
|
|
1956
|
-
export interface
|
|
1983
|
+
export interface InputAihldyxydl {
|
|
1957
1984
|
/**
|
|
1958
1985
|
* Notes provided by the reviewer for the pending approval
|
|
1959
1986
|
* @example "Please review the submitted documents."
|
|
@@ -1966,7 +1993,7 @@ export interface InputR6Itgrxd2B {
|
|
|
1966
1993
|
approved: boolean;
|
|
1967
1994
|
}
|
|
1968
1995
|
/** Schema for overriding course result dates. */
|
|
1969
|
-
export interface
|
|
1996
|
+
export interface InputL5Uvh80Jwdh {
|
|
1970
1997
|
/**
|
|
1971
1998
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1972
1999
|
* @example 1735689600000
|
|
@@ -1978,14 +2005,16 @@ export interface Input25X5L4Vd6Y {
|
|
|
1978
2005
|
*/
|
|
1979
2006
|
completionDate?: number;
|
|
1980
2007
|
}
|
|
1981
|
-
|
|
2008
|
+
/** Reset sponsorship request takes no body */
|
|
2009
|
+
export type ResetSponsorshipBody = object;
|
|
2010
|
+
export interface InputWmysx72Yqg {
|
|
1982
2011
|
filter: {
|
|
1983
2012
|
from?: number;
|
|
1984
2013
|
sortOrder?: string;
|
|
1985
2014
|
sortField?: string;
|
|
1986
2015
|
};
|
|
1987
2016
|
}
|
|
1988
|
-
export interface
|
|
2017
|
+
export interface OutputWmysx72Yqg {
|
|
1989
2018
|
users: {
|
|
1990
2019
|
firstName: string;
|
|
1991
2020
|
lastName: string;
|
|
@@ -2009,7 +2038,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
2009
2038
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
2010
2039
|
* @example "CHECKED"
|
|
2011
2040
|
*/
|
|
2012
|
-
export declare enum
|
|
2041
|
+
export declare enum InputUysjux8Zp4ValueEnum {
|
|
2013
2042
|
CHECKED = "CHECKED",
|
|
2014
2043
|
UNCHECKED = "UNCHECKED",
|
|
2015
2044
|
NOVALUE = "NOVALUE"
|
|
@@ -2108,7 +2137,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2108
2137
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2109
2138
|
export type CreateReportUsersSimpleData = any;
|
|
2110
2139
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2111
|
-
export type CreateSearchUsersCountData =
|
|
2140
|
+
export type CreateSearchUsersCountData = OutputJqh0F2Rq94L;
|
|
2112
2141
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2113
2142
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2114
2143
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2132,7 +2161,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2132
2161
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2133
2162
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2134
2163
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2135
|
-
export type GetCertificationCourseFileSignData =
|
|
2164
|
+
export type GetCertificationCourseFileSignData = Output6Lxou5Wadvl;
|
|
2136
2165
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2137
2166
|
export interface CreateCertificationCourseFileSignParams {
|
|
2138
2167
|
/** @example "pdf" */
|
|
@@ -2146,11 +2175,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2146
2175
|
/** @example "fileID" */
|
|
2147
2176
|
fileId: string;
|
|
2148
2177
|
}
|
|
2149
|
-
export type CreateCertificationCourseFileSignData =
|
|
2178
|
+
export type CreateCertificationCourseFileSignData = OutputFn02Htoomy;
|
|
2150
2179
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2151
2180
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2152
2181
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2153
|
-
export type CreateCertificationCourseDocumentData =
|
|
2182
|
+
export type CreateCertificationCourseDocumentData = OutputOszbc2Lfht;
|
|
2154
2183
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2155
2184
|
export type DeleteUserData = any;
|
|
2156
2185
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2162,7 +2191,7 @@ export type UpdateUserData = any;
|
|
|
2162
2191
|
export type UpdateUserError = ErrorResponse;
|
|
2163
2192
|
export type DeleteCertificationCourseData = any;
|
|
2164
2193
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2165
|
-
export type GetCertificationApplicationItemFileData =
|
|
2194
|
+
export type GetCertificationApplicationItemFileData = Output5Qmmfjb7J6;
|
|
2166
2195
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2167
2196
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2168
2197
|
/** @example "pdf" */
|
|
@@ -2176,9 +2205,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2176
2205
|
/** @example "fileVersion" */
|
|
2177
2206
|
fileVersion: string;
|
|
2178
2207
|
}
|
|
2179
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2208
|
+
export type CreateCertificationApplicationItemFileData = Output6S8Rfzxiuf;
|
|
2180
2209
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2181
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2210
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = Output7Jte254C0P;
|
|
2182
2211
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2183
2212
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2184
2213
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2186,7 +2215,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2186
2215
|
export type GetCourseError = ErrorResponse;
|
|
2187
2216
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2188
2217
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2189
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2218
|
+
export type GetCertificationApplicationForeignFillData = OutputDrnp2Yirpi;
|
|
2190
2219
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2191
2220
|
export type GetCertificationPrintData = any;
|
|
2192
2221
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2220,7 +2249,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2220
2249
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2221
2250
|
export type CreateCertificationWaiveData = any;
|
|
2222
2251
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2223
|
-
export type CreateCertificationMoveData =
|
|
2252
|
+
export type CreateCertificationMoveData = Output6D4Ct52Qpe;
|
|
2224
2253
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2225
2254
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2226
2255
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2252,7 +2281,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2252
2281
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2253
2282
|
export type CreateCertificationCourseRedeemData = any;
|
|
2254
2283
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2255
|
-
export type CreateCertificationMoveValidateData =
|
|
2284
|
+
export type CreateCertificationMoveValidateData = OutputMlk3Y0Sufr;
|
|
2256
2285
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2257
2286
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2258
2287
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2268,7 +2297,9 @@ export type CreateCertificationPublishInfoData = any;
|
|
|
2268
2297
|
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2269
2298
|
export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
2270
2299
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2271
|
-
export type
|
|
2300
|
+
export type CreateSponsorshipResetData = any;
|
|
2301
|
+
export type CreateSponsorshipResetError = ErrorResponse;
|
|
2302
|
+
export type CreateCertificationResult = OutputWmysx72Yqg;
|
|
2272
2303
|
export type CreateCertificationFail = ErrorResponse;
|
|
2273
2304
|
export type CreateCertificationPublishInfoResult = any;
|
|
2274
2305
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2315,7 +2346,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2315
2346
|
}
|
|
2316
2347
|
/**
|
|
2317
2348
|
* @title BCCSA Program API
|
|
2318
|
-
* @version 3.0.
|
|
2349
|
+
* @version 3.0.35
|
|
2319
2350
|
* @baseUrl http://localhost:8080
|
|
2320
2351
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2321
2352
|
*/
|
|
@@ -2330,7 +2361,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2330
2361
|
* @request POST:/contactUs
|
|
2331
2362
|
* @secure
|
|
2332
2363
|
*/
|
|
2333
|
-
listContactUs: (data:
|
|
2364
|
+
listContactUs: (data: InputRr9Kp8P5Qu, params?: RequestParams) => Promise<any>;
|
|
2334
2365
|
};
|
|
2335
2366
|
customer: {
|
|
2336
2367
|
/**
|
|
@@ -2434,7 +2465,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2434
2465
|
* @request POST:/tenant/report/applicationExport
|
|
2435
2466
|
* @secure
|
|
2436
2467
|
*/
|
|
2437
|
-
createReportApplicationExport: (data:
|
|
2468
|
+
createReportApplicationExport: (data: InputHvh2Rhjuk6, params?: RequestParams) => Promise<any>;
|
|
2438
2469
|
/**
|
|
2439
2470
|
* @description Export a report of applications based on the provided filters.
|
|
2440
2471
|
*
|
|
@@ -2444,7 +2475,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2444
2475
|
* @request POST:/tenant/report/applicationStatus
|
|
2445
2476
|
* @secure
|
|
2446
2477
|
*/
|
|
2447
|
-
listReportApplicationStatus: (data:
|
|
2478
|
+
listReportApplicationStatus: (data: Input5K8X950Ztg, params?: RequestParams) => Promise<any>;
|
|
2448
2479
|
/**
|
|
2449
2480
|
* @description Export a report of applications based on the provided filters.
|
|
2450
2481
|
*
|
|
@@ -2454,7 +2485,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2454
2485
|
* @request POST:/tenant/report/applicationsReport
|
|
2455
2486
|
* @secure
|
|
2456
2487
|
*/
|
|
2457
|
-
createReportApplicationsReport: (data:
|
|
2488
|
+
createReportApplicationsReport: (data: InputV73Gd5K2S3, params?: RequestParams) => Promise<any>;
|
|
2458
2489
|
/**
|
|
2459
2490
|
* @description This route allows you to post certificates email for the tenant.
|
|
2460
2491
|
*
|
|
@@ -2464,7 +2495,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2464
2495
|
* @request POST:/tenant/certificates/email
|
|
2465
2496
|
* @secure
|
|
2466
2497
|
*/
|
|
2467
|
-
createCertificatesEmail: (data:
|
|
2498
|
+
createCertificatesEmail: (data: InputYuucneuxkg, params?: RequestParams) => Promise<any>;
|
|
2468
2499
|
/**
|
|
2469
2500
|
* @description Generate a preview of the completed certifications report.
|
|
2470
2501
|
*
|
|
@@ -2494,7 +2525,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2494
2525
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2495
2526
|
* @secure
|
|
2496
2527
|
*/
|
|
2497
|
-
createLicenseRedeem: (userId: string, data:
|
|
2528
|
+
createLicenseRedeem: (userId: string, data: InputIc5N9Ldrci, params?: RequestParams) => Promise<any>;
|
|
2498
2529
|
/**
|
|
2499
2530
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2500
2531
|
*
|
|
@@ -2504,7 +2535,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2504
2535
|
* @request POST:/tenant/report/orglicenses/
|
|
2505
2536
|
* @secure
|
|
2506
2537
|
*/
|
|
2507
|
-
listReportOrglicenses: (data:
|
|
2538
|
+
listReportOrglicenses: (data: InputJu8Q7Jd4Rm, params?: RequestParams) => Promise<any>;
|
|
2508
2539
|
/**
|
|
2509
2540
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2510
2541
|
*
|
|
@@ -2514,7 +2545,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2514
2545
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2515
2546
|
* @secure
|
|
2516
2547
|
*/
|
|
2517
|
-
createReportOrglicensesPreview: (data:
|
|
2548
|
+
createReportOrglicensesPreview: (data: InputU8Srhwp84Ch, params?: RequestParams) => Promise<any>;
|
|
2518
2549
|
/**
|
|
2519
2550
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2520
2551
|
*
|
|
@@ -2554,7 +2585,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2554
2585
|
* @request POST:/tenant/report/users/advanced
|
|
2555
2586
|
* @secure
|
|
2556
2587
|
*/
|
|
2557
|
-
createReportUsersAdvanced: (data:
|
|
2588
|
+
createReportUsersAdvanced: (data: InputF5Jjnrfmt7I, params?: RequestParams) => Promise<any>;
|
|
2558
2589
|
/**
|
|
2559
2590
|
* @description Searches for users in the tenant by their IDs.
|
|
2560
2591
|
*
|
|
@@ -2564,7 +2595,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2564
2595
|
* @request POST:/tenant/search/users/ids
|
|
2565
2596
|
* @secure
|
|
2566
2597
|
*/
|
|
2567
|
-
listSearchUsersIds: (data:
|
|
2598
|
+
listSearchUsersIds: (data: Input5Nynw58Ws1, params?: RequestParams) => Promise<any>;
|
|
2568
2599
|
/**
|
|
2569
2600
|
* @description Searches for users in the tenant by term and filters.
|
|
2570
2601
|
*
|
|
@@ -2574,7 +2605,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2574
2605
|
* @request POST:/tenant/search/users/term
|
|
2575
2606
|
* @secure
|
|
2576
2607
|
*/
|
|
2577
|
-
createSearchUsersTerm: (data:
|
|
2608
|
+
createSearchUsersTerm: (data: Input4H67Nuuo8P, params?: RequestParams) => Promise<any>;
|
|
2578
2609
|
/**
|
|
2579
2610
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2580
2611
|
*
|
|
@@ -2584,7 +2615,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2584
2615
|
* @request POST:/tenant/report/users/simple
|
|
2585
2616
|
* @secure
|
|
2586
2617
|
*/
|
|
2587
|
-
createReportUsersSimple: (data:
|
|
2618
|
+
createReportUsersSimple: (data: Input2Mihdr2Tcif, params?: RequestParams) => Promise<any>;
|
|
2588
2619
|
/**
|
|
2589
2620
|
* @description Retrieve user by ID.
|
|
2590
2621
|
*
|
|
@@ -2594,7 +2625,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2594
2625
|
* @request POST:/tenant/search/users/count
|
|
2595
2626
|
* @secure
|
|
2596
2627
|
*/
|
|
2597
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2628
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputJqh0F2Rq94L>;
|
|
2598
2629
|
};
|
|
2599
2630
|
user: {
|
|
2600
2631
|
/**
|
|
@@ -2626,7 +2657,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2626
2657
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2627
2658
|
* @secure
|
|
2628
2659
|
*/
|
|
2629
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2660
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: InputUdco8Yiz4U, params?: RequestParams) => Promise<any>;
|
|
2630
2661
|
/**
|
|
2631
2662
|
* @description Delete a certification process application by type.
|
|
2632
2663
|
*
|
|
@@ -2716,7 +2747,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2716
2747
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2717
2748
|
* @secure
|
|
2718
2749
|
*/
|
|
2719
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2750
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<Output6Lxou5Wadvl>;
|
|
2720
2751
|
/**
|
|
2721
2752
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2722
2753
|
*
|
|
@@ -2726,7 +2757,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2726
2757
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2727
2758
|
* @secure
|
|
2728
2759
|
*/
|
|
2729
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2760
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputFn02Htoomy>;
|
|
2730
2761
|
/**
|
|
2731
2762
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2732
2763
|
*
|
|
@@ -2746,7 +2777,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2746
2777
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2747
2778
|
* @secure
|
|
2748
2779
|
*/
|
|
2749
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2780
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputOszbc2Lfht, params?: RequestParams) => Promise<OutputOszbc2Lfht>;
|
|
2750
2781
|
/**
|
|
2751
2782
|
* @description Delete user by ID.
|
|
2752
2783
|
*
|
|
@@ -2776,9 +2807,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2776
2807
|
* @request POST:/user/{userID}
|
|
2777
2808
|
* @secure
|
|
2778
2809
|
*/
|
|
2779
|
-
createUser: (userId: string, data:
|
|
2810
|
+
createUser: (userId: string, data: Input4S9Bu0T1Ng, params?: RequestParams) => Promise<any>;
|
|
2780
2811
|
/**
|
|
2781
|
-
* @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.
|
|
2812
|
+
* @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. When provided, the sponsor is saved on the user only; this does not update the pending sponsorship request or email the sponsor. Use POST /user/{userID}/sponsorship/reset to refresh the pending request from the stored sponsor and re-send the request.
|
|
2782
2813
|
*
|
|
2783
2814
|
* @tags User
|
|
2784
2815
|
* @name UpdateUser
|
|
@@ -2786,7 +2817,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2786
2817
|
* @request PUT:/user/{userID}
|
|
2787
2818
|
* @secure
|
|
2788
2819
|
*/
|
|
2789
|
-
updateUser: (userId: string, data:
|
|
2820
|
+
updateUser: (userId: string, data: Input3Q79Al8T06, params?: RequestParams) => Promise<any>;
|
|
2790
2821
|
/**
|
|
2791
2822
|
* @description Delete course from user
|
|
2792
2823
|
*
|
|
@@ -2806,7 +2837,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2806
2837
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2807
2838
|
* @secure
|
|
2808
2839
|
*/
|
|
2809
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2840
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<Output5Qmmfjb7J6>;
|
|
2810
2841
|
/**
|
|
2811
2842
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2812
2843
|
*
|
|
@@ -2816,7 +2847,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2816
2847
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2817
2848
|
* @secure
|
|
2818
2849
|
*/
|
|
2819
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2850
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<Output6S8Rfzxiuf>;
|
|
2820
2851
|
/**
|
|
2821
2852
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2822
2853
|
*
|
|
@@ -2826,7 +2857,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2826
2857
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2827
2858
|
* @secure
|
|
2828
2859
|
*/
|
|
2829
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2860
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<Output7Jte254C0P>;
|
|
2830
2861
|
/**
|
|
2831
2862
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2832
2863
|
*
|
|
@@ -2866,7 +2897,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2866
2897
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2867
2898
|
* @secure
|
|
2868
2899
|
*/
|
|
2869
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2900
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputDrnp2Yirpi>;
|
|
2870
2901
|
/**
|
|
2871
2902
|
* @description This endpoint will print certificate
|
|
2872
2903
|
*
|
|
@@ -2926,7 +2957,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2926
2957
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2927
2958
|
* @secure
|
|
2928
2959
|
*/
|
|
2929
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2960
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputWkff4Yaywy, params?: RequestParams) => Promise<any>;
|
|
2930
2961
|
/**
|
|
2931
2962
|
* @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
2963
|
*
|
|
@@ -2956,7 +2987,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2956
2987
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2957
2988
|
* @secure
|
|
2958
2989
|
*/
|
|
2959
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2990
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputKa30H4Ner6, params?: RequestParams) => Promise<any>;
|
|
2960
2991
|
/**
|
|
2961
2992
|
* @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
2993
|
*
|
|
@@ -2966,7 +2997,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2966
2997
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2967
2998
|
* @secure
|
|
2968
2999
|
*/
|
|
2969
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3000
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputP7Rzxtpwwc, params?: RequestParams) => Promise<any>;
|
|
2970
3001
|
/**
|
|
2971
3002
|
* @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
3003
|
*
|
|
@@ -2976,7 +3007,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2976
3007
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2977
3008
|
* @secure
|
|
2978
3009
|
*/
|
|
2979
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
3010
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputY2D9S4Qy4S, params?: RequestParams) => Promise<any>;
|
|
2980
3011
|
/**
|
|
2981
3012
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2982
3013
|
*
|
|
@@ -2986,7 +3017,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2986
3017
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2987
3018
|
* @secure
|
|
2988
3019
|
*/
|
|
2989
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
3020
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: Input62Nyiggonmh, params?: RequestParams) => Promise<any>;
|
|
2990
3021
|
/**
|
|
2991
3022
|
* @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
3023
|
*
|
|
@@ -3026,7 +3057,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3026
3057
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
3027
3058
|
* @secure
|
|
3028
3059
|
*/
|
|
3029
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
3060
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputXqdgr5Oa5Vh, params?: RequestParams) => Promise<any>;
|
|
3030
3061
|
/**
|
|
3031
3062
|
* @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
3063
|
*
|
|
@@ -3036,7 +3067,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3036
3067
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
3037
3068
|
* @secure
|
|
3038
3069
|
*/
|
|
3039
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3070
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<Output6D4Ct52Qpe>;
|
|
3040
3071
|
/**
|
|
3041
3072
|
* @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
3073
|
*
|
|
@@ -3076,7 +3107,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3076
3107
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
3077
3108
|
* @secure
|
|
3078
3109
|
*/
|
|
3079
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
3110
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputUysjux8Zp4, params?: RequestParams) => Promise<any>;
|
|
3080
3111
|
/**
|
|
3081
3112
|
* @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
3113
|
*
|
|
@@ -3136,7 +3167,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3136
3167
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3137
3168
|
* @secure
|
|
3138
3169
|
*/
|
|
3139
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
3170
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: Input1Lghooas4I, params?: RequestParams) => Promise<any>;
|
|
3140
3171
|
/**
|
|
3141
3172
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3142
3173
|
*
|
|
@@ -3156,7 +3187,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3156
3187
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3157
3188
|
* @secure
|
|
3158
3189
|
*/
|
|
3159
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3190
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputCgletgibfvi, params?: RequestParams) => Promise<any>;
|
|
3160
3191
|
/**
|
|
3161
3192
|
* @description This route allows you to submit a pending approval.
|
|
3162
3193
|
*
|
|
@@ -3166,7 +3197,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3166
3197
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3167
3198
|
* @secure
|
|
3168
3199
|
*/
|
|
3169
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3200
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputDv9Ni3Aar5, params?: RequestParams) => Promise<any>;
|
|
3170
3201
|
/**
|
|
3171
3202
|
* @description This route allows you to review a pending approval.
|
|
3172
3203
|
*
|
|
@@ -3176,7 +3207,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3176
3207
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3177
3208
|
* @secure
|
|
3178
3209
|
*/
|
|
3179
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3210
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputAihldyxydl, params?: RequestParams) => Promise<any>;
|
|
3180
3211
|
/**
|
|
3181
3212
|
* @description Redeems a license for a user by product ID.
|
|
3182
3213
|
*
|
|
@@ -3186,7 +3217,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3186
3217
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3187
3218
|
* @secure
|
|
3188
3219
|
*/
|
|
3189
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3220
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputGhxoi4I6V8, params?: RequestParams) => Promise<any>;
|
|
3190
3221
|
/**
|
|
3191
3222
|
* @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
3223
|
*
|
|
@@ -3196,7 +3227,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3196
3227
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3197
3228
|
* @secure
|
|
3198
3229
|
*/
|
|
3199
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3230
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputMlk3Y0Sufr>;
|
|
3200
3231
|
/**
|
|
3201
3232
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3202
3233
|
*
|
|
@@ -3206,7 +3237,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3206
3237
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3207
3238
|
* @secure
|
|
3208
3239
|
*/
|
|
3209
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3240
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputHod6Xcmzr8, params?: RequestParams) => Promise<any>;
|
|
3210
3241
|
/**
|
|
3211
3242
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3212
3243
|
*
|
|
@@ -3216,7 +3247,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3216
3247
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3217
3248
|
* @secure
|
|
3218
3249
|
*/
|
|
3219
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3250
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputX4U7C4Jq36, params?: RequestParams) => Promise<any>;
|
|
3220
3251
|
/**
|
|
3221
3252
|
* @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
3253
|
*
|
|
@@ -3226,7 +3257,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3226
3257
|
* @request POST:/user/{userID}/updateITA
|
|
3227
3258
|
* @secure
|
|
3228
3259
|
*/
|
|
3229
|
-
createUpdateIta: (userId: string, data:
|
|
3260
|
+
createUpdateIta: (userId: string, data: InputBmpgyhghyb, params?: RequestParams) => Promise<any>;
|
|
3230
3261
|
/**
|
|
3231
3262
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3232
3263
|
*
|
|
@@ -3236,7 +3267,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3236
3267
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3237
3268
|
* @secure
|
|
3238
3269
|
*/
|
|
3239
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3270
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputW1Qz7Aegx2, params?: RequestParams) => Promise<any>;
|
|
3240
3271
|
/**
|
|
3241
3272
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3242
3273
|
*
|
|
@@ -3246,7 +3277,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3246
3277
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3247
3278
|
* @secure
|
|
3248
3279
|
*/
|
|
3249
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3280
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputL5Uvh80Jwdh, params?: RequestParams) => Promise<any>;
|
|
3250
3281
|
/**
|
|
3251
3282
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3252
3283
|
*
|
|
@@ -3267,6 +3298,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3267
3298
|
* @secure
|
|
3268
3299
|
*/
|
|
3269
3300
|
createCertificationCourseRequestEnrolment: (userId: string, certProcId: string, courseId: string, params?: RequestParams) => Promise<any>;
|
|
3301
|
+
/**
|
|
3302
|
+
* @description Restart a user sponsorship / attestation request from the user's currently stored sponsor data. Refreshes an existing pending request in place, or creates a new request when the previous one is completed or missing, and re-sends the sponsor request email.
|
|
3303
|
+
*
|
|
3304
|
+
* @tags Sponsorship
|
|
3305
|
+
* @name CreateSponsorshipReset
|
|
3306
|
+
* @summary ResetSponsorshipRequest
|
|
3307
|
+
* @request POST:/user/{userID}/sponsorship/reset
|
|
3308
|
+
* @secure
|
|
3309
|
+
*/
|
|
3310
|
+
createSponsorshipReset: (userId: string, data: ResetSponsorshipBody, params?: RequestParams) => Promise<any>;
|
|
3270
3311
|
};
|
|
3271
3312
|
users: {
|
|
3272
3313
|
/**
|
|
@@ -3278,7 +3319,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3278
3319
|
* @request POST:/users/certification/{certSpecID}
|
|
3279
3320
|
* @secure
|
|
3280
3321
|
*/
|
|
3281
|
-
createCertification: (certSpecId: string, data:
|
|
3322
|
+
createCertification: (certSpecId: string, data: InputWmysx72Yqg, params?: RequestParams) => Promise<OutputWmysx72Yqg>;
|
|
3282
3323
|
/**
|
|
3283
3324
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3284
3325
|
*
|