@ikonintegration/bccsa-program-api 3.0.30 → 3.0.31
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 +107 -93
- package/dist/Api.d.ts +114 -102
- 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 Input7507I6Pbqck {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -439,6 +439,10 @@ export interface PendingApprovalResponseSchema {
|
|
|
439
439
|
reviewedBy?: ReviewedBy;
|
|
440
440
|
/** Timestamp of the review */
|
|
441
441
|
reviewedOn?: ReviewedOn;
|
|
442
|
+
/** Pending sponsorship request reminders sent to the user (array with reminder IDs, where reminderID is template-numdays) */
|
|
443
|
+
sponsorshipRemindersStudent?: SponsorshipRemindersStudent;
|
|
444
|
+
/** Pending sponsorship request reminders sent to the sponsor (array with reminder IDs, where reminderID is template-numdays) */
|
|
445
|
+
sponsorshipRemindersSponsor?: SponsorshipRemindersSponsor;
|
|
442
446
|
}[] | null;
|
|
443
447
|
}
|
|
444
448
|
/** Timestamp when the entry was last updated */
|
|
@@ -451,7 +455,11 @@ export type CertTitle = string;
|
|
|
451
455
|
export type DisplayName = string;
|
|
452
456
|
/** Email address of the user who submitted the pending approval */
|
|
453
457
|
export type Email = string;
|
|
454
|
-
|
|
458
|
+
/** Pending sponsorship request reminders sent to the user (array with reminder IDs, where reminderID is template-numdays) */
|
|
459
|
+
export type SponsorshipRemindersStudent = string[];
|
|
460
|
+
/** Pending sponsorship request reminders sent to the sponsor (array with reminder IDs, where reminderID is template-numdays) */
|
|
461
|
+
export type SponsorshipRemindersSponsor = string[];
|
|
462
|
+
export interface InputLafd3A50Ir {
|
|
455
463
|
/**
|
|
456
464
|
* ID of the certification to filter applications by
|
|
457
465
|
* @example "certification123"
|
|
@@ -508,7 +516,7 @@ export interface InputTldp01Tqpe {
|
|
|
508
516
|
*/
|
|
509
517
|
ignoreCompletedCertifications?: boolean | null;
|
|
510
518
|
}
|
|
511
|
-
export interface
|
|
519
|
+
export interface InputJj4T48To4I {
|
|
512
520
|
/**
|
|
513
521
|
* ID of the certification to filter applications by
|
|
514
522
|
* @example "certification123"
|
|
@@ -565,7 +573,7 @@ export interface InputO85Nshtnnn {
|
|
|
565
573
|
*/
|
|
566
574
|
ignoreCompletedCertifications?: boolean | null;
|
|
567
575
|
}
|
|
568
|
-
export interface
|
|
576
|
+
export interface Input4299E0Qghu {
|
|
569
577
|
/**
|
|
570
578
|
* ID of the certification to filter applications by
|
|
571
579
|
* @example "certification123"
|
|
@@ -622,7 +630,7 @@ export interface InputArmifxit2C {
|
|
|
622
630
|
*/
|
|
623
631
|
ignoreCompletedCertifications?: boolean | null;
|
|
624
632
|
}
|
|
625
|
-
export interface
|
|
633
|
+
export interface Input22An4Alkhlg {
|
|
626
634
|
/**
|
|
627
635
|
* The ID of the certificate specifications to be used for the email
|
|
628
636
|
* @example "certSpecsID123"
|
|
@@ -663,7 +671,7 @@ export interface InputQ7Wjegukdf {
|
|
|
663
671
|
emailAddress: string;
|
|
664
672
|
}[];
|
|
665
673
|
}
|
|
666
|
-
export interface
|
|
674
|
+
export interface Input7K2Sgvn13T {
|
|
667
675
|
/**
|
|
668
676
|
* The ID of the product for which the license is being redeemed
|
|
669
677
|
* @example "productID123"
|
|
@@ -675,7 +683,7 @@ export interface InputIp3Nvtih64 {
|
|
|
675
683
|
*/
|
|
676
684
|
sessionID?: string;
|
|
677
685
|
}
|
|
678
|
-
export interface
|
|
686
|
+
export interface Input5Bwr4N40Es {
|
|
679
687
|
/**
|
|
680
688
|
* Search term to filter licenses
|
|
681
689
|
* @example "active"
|
|
@@ -692,7 +700,7 @@ export interface InputVu2Wjfonubg {
|
|
|
692
700
|
*/
|
|
693
701
|
sortField?: any;
|
|
694
702
|
}
|
|
695
|
-
export interface
|
|
703
|
+
export interface InputRe7Pqpm29Il {
|
|
696
704
|
/**
|
|
697
705
|
* Search term to filter licenses
|
|
698
706
|
* @example "active"
|
|
@@ -815,9 +823,13 @@ export interface SearchPendingApprovalsResponseSchema {
|
|
|
815
823
|
reviewedBy?: ReviewedBy;
|
|
816
824
|
/** Timestamp of the review */
|
|
817
825
|
reviewedOn?: ReviewedOn;
|
|
826
|
+
/** Pending sponsorship request reminders sent to the user (array with reminder IDs, where reminderID is template-numdays) */
|
|
827
|
+
sponsorshipRemindersStudent?: SponsorshipRemindersStudent;
|
|
828
|
+
/** Pending sponsorship request reminders sent to the sponsor (array with reminder IDs, where reminderID is template-numdays) */
|
|
829
|
+
sponsorshipRemindersSponsor?: SponsorshipRemindersSponsor;
|
|
818
830
|
}[];
|
|
819
831
|
}
|
|
820
|
-
export interface
|
|
832
|
+
export interface InputG6Hsraotyi {
|
|
821
833
|
/**
|
|
822
834
|
* Start date for the report
|
|
823
835
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -839,11 +851,11 @@ export interface Input3Zazta850I {
|
|
|
839
851
|
*/
|
|
840
852
|
dateType?: string;
|
|
841
853
|
}
|
|
842
|
-
export interface
|
|
854
|
+
export interface Input35Hgedfe72 {
|
|
843
855
|
/** List of user IDs to search for in the tenant. */
|
|
844
856
|
IDs: (string | null)[];
|
|
845
857
|
}
|
|
846
|
-
export interface
|
|
858
|
+
export interface Input8Vhcnzx2B7 {
|
|
847
859
|
/** The term to search for in the user profiles. */
|
|
848
860
|
searchTerm?: string | null;
|
|
849
861
|
/** Filter criteria for the user search. */
|
|
@@ -883,7 +895,7 @@ export interface InputLql0Xy8Xud {
|
|
|
883
895
|
};
|
|
884
896
|
};
|
|
885
897
|
}
|
|
886
|
-
export interface
|
|
898
|
+
export interface InputTi43Il2Vlv {
|
|
887
899
|
/** The term to search for in the user profiles. */
|
|
888
900
|
searchTerm?: string | null;
|
|
889
901
|
/** Filter criteria for the user search. */
|
|
@@ -923,21 +935,21 @@ export interface InputHrhzv6Pfn3 {
|
|
|
923
935
|
};
|
|
924
936
|
};
|
|
925
937
|
}
|
|
926
|
-
export interface
|
|
938
|
+
export interface Output0Nfmfqq0R5 {
|
|
927
939
|
/** External system ID 2 */
|
|
928
940
|
userCount: ExternalID2;
|
|
929
941
|
transactionID?: string | null;
|
|
930
942
|
}
|
|
931
943
|
/** External system ID 2 */
|
|
932
944
|
export type ExternalID2 = number;
|
|
933
|
-
export interface
|
|
945
|
+
export interface OutputPx59Htkllg {
|
|
934
946
|
/**
|
|
935
947
|
* Signed URL for the course file
|
|
936
948
|
* @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"
|
|
937
949
|
*/
|
|
938
950
|
fileURL: string;
|
|
939
951
|
}
|
|
940
|
-
export interface
|
|
952
|
+
export interface Output4Cpyw88Dfth {
|
|
941
953
|
/**
|
|
942
954
|
* Amount to be refunded for the cancellation
|
|
943
955
|
* @example 0
|
|
@@ -1237,7 +1249,7 @@ export interface CourseResponseEntity {
|
|
|
1237
1249
|
}
|
|
1238
1250
|
/** Label of the course enrolled (course version) */
|
|
1239
1251
|
export type OnlineCourseLabel = string;
|
|
1240
|
-
export interface
|
|
1252
|
+
export interface OutputImjjo7Tgi4 {
|
|
1241
1253
|
/**
|
|
1242
1254
|
* Signed URL for the course file
|
|
1243
1255
|
* @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"
|
|
@@ -1255,7 +1267,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1255
1267
|
transactionID?: string | null;
|
|
1256
1268
|
}
|
|
1257
1269
|
/** Application Foreign Fill response type */
|
|
1258
|
-
export interface
|
|
1270
|
+
export interface OutputBrg51Gh4B5G {
|
|
1259
1271
|
items: {
|
|
1260
1272
|
userID: string;
|
|
1261
1273
|
createdOn?: number;
|
|
@@ -1443,7 +1455,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1443
1455
|
applicationItems?: Record<string, any>[];
|
|
1444
1456
|
transactionID?: string | null;
|
|
1445
1457
|
}
|
|
1446
|
-
export interface
|
|
1458
|
+
export interface Input0Unqmff7Xg {
|
|
1447
1459
|
issuedOn?: number;
|
|
1448
1460
|
expiresOn?: number;
|
|
1449
1461
|
fileItems?: {
|
|
@@ -1452,21 +1464,21 @@ export interface InputSvcbcj9U4Nl {
|
|
|
1452
1464
|
}[];
|
|
1453
1465
|
additionalNotes?: string | null;
|
|
1454
1466
|
}
|
|
1455
|
-
export interface
|
|
1467
|
+
export interface Input4Xas31Gffbk {
|
|
1456
1468
|
/**
|
|
1457
1469
|
* Indicates whether the application is locked
|
|
1458
1470
|
* @example true
|
|
1459
1471
|
*/
|
|
1460
1472
|
isApplicationLocked: boolean;
|
|
1461
1473
|
}
|
|
1462
|
-
export interface
|
|
1474
|
+
export interface OutputUxoq3Zwn6I {
|
|
1463
1475
|
/**
|
|
1464
1476
|
* Signed URL for the course file
|
|
1465
1477
|
* @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"
|
|
1466
1478
|
*/
|
|
1467
1479
|
fileURL: string;
|
|
1468
1480
|
}
|
|
1469
|
-
export interface
|
|
1481
|
+
export interface InputUh7Kaccbqsi {
|
|
1470
1482
|
/**
|
|
1471
1483
|
* Indicates whether the waiver is approved
|
|
1472
1484
|
* @example true
|
|
@@ -1478,14 +1490,14 @@ export interface Input4Imt7Nwuyj {
|
|
|
1478
1490
|
*/
|
|
1479
1491
|
additionalNotes?: string | null;
|
|
1480
1492
|
}
|
|
1481
|
-
export interface
|
|
1493
|
+
export interface InputUxt59Ezr2X {
|
|
1482
1494
|
/**
|
|
1483
1495
|
* Optional notes regarding the waiver
|
|
1484
1496
|
* @example "Waiver granted due to special circumstances."
|
|
1485
1497
|
*/
|
|
1486
1498
|
additionalNotes?: string | null;
|
|
1487
1499
|
}
|
|
1488
|
-
export interface
|
|
1500
|
+
export interface InputW1Acknrh35 {
|
|
1489
1501
|
students: {
|
|
1490
1502
|
/**
|
|
1491
1503
|
* User ID of the student to redeem the course for
|
|
@@ -1519,7 +1531,7 @@ export interface Input3Ojx43T74E {
|
|
|
1519
1531
|
*/
|
|
1520
1532
|
autoEnrolSessionID?: string;
|
|
1521
1533
|
}
|
|
1522
|
-
export interface
|
|
1534
|
+
export interface Input49Kewdueod {
|
|
1523
1535
|
invites: {
|
|
1524
1536
|
/**
|
|
1525
1537
|
* Email address of the user to invite
|
|
@@ -1548,7 +1560,7 @@ export interface InputKdxzbl2Hdl {
|
|
|
1548
1560
|
*/
|
|
1549
1561
|
isReservedSeat: boolean;
|
|
1550
1562
|
}
|
|
1551
|
-
export interface
|
|
1563
|
+
export interface InputPv8Afi38Gj {
|
|
1552
1564
|
/**
|
|
1553
1565
|
* Indicates whether to waive the certification process
|
|
1554
1566
|
* @example true
|
|
@@ -1561,7 +1573,7 @@ export interface Input05Xv7Tp3Cm {
|
|
|
1561
1573
|
comments?: string | null;
|
|
1562
1574
|
}
|
|
1563
1575
|
/** Certification move response schema */
|
|
1564
|
-
export interface
|
|
1576
|
+
export interface OutputN55H9Dq7Jg {
|
|
1565
1577
|
errors?: {
|
|
1566
1578
|
status: string;
|
|
1567
1579
|
object?: Record<string, any>;
|
|
@@ -1569,19 +1581,19 @@ export interface OutputNay5O217Dt {
|
|
|
1569
1581
|
}[];
|
|
1570
1582
|
}
|
|
1571
1583
|
/** Schema for writing a certification trigger check. */
|
|
1572
|
-
export interface
|
|
1584
|
+
export interface InputY8Rgeghq8D {
|
|
1573
1585
|
/**
|
|
1574
1586
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1575
1587
|
* @example "CHECKED"
|
|
1576
1588
|
*/
|
|
1577
|
-
value:
|
|
1589
|
+
value: InputY8Rgeghq8DValueEnum;
|
|
1578
1590
|
/**
|
|
1579
1591
|
* List of course IDs that are blocked by this trigger check.
|
|
1580
1592
|
* @example ["course1","course2"]
|
|
1581
1593
|
*/
|
|
1582
1594
|
blockedCourses?: string[];
|
|
1583
1595
|
}
|
|
1584
|
-
export interface
|
|
1596
|
+
export interface Input38X1Tu13M6 {
|
|
1585
1597
|
/**
|
|
1586
1598
|
* Indicates whether the application item is approved
|
|
1587
1599
|
* @example true
|
|
@@ -1607,7 +1619,7 @@ export interface InputYf5Wppp1S4 {
|
|
|
1607
1619
|
export interface StudentHistoryRequestSchema {
|
|
1608
1620
|
requirements: string[];
|
|
1609
1621
|
}
|
|
1610
|
-
export interface
|
|
1622
|
+
export interface InputI7Wxaw8I1P {
|
|
1611
1623
|
/**
|
|
1612
1624
|
* Optional activation key for the application
|
|
1613
1625
|
* @example "AK-123456"
|
|
@@ -1615,7 +1627,7 @@ export interface InputN4Yrfbmcfp {
|
|
|
1615
1627
|
activationKey?: string;
|
|
1616
1628
|
}
|
|
1617
1629
|
/** Schema for course submission item details post request. */
|
|
1618
|
-
export interface
|
|
1630
|
+
export interface InputFqm4Xqhert {
|
|
1619
1631
|
/**
|
|
1620
1632
|
* The ID of the file being submitted.
|
|
1621
1633
|
* @example "fileID123"
|
|
@@ -1628,7 +1640,7 @@ export interface Input1Pdxtyrqq3 {
|
|
|
1628
1640
|
fileName: string;
|
|
1629
1641
|
}
|
|
1630
1642
|
/** Schema for the response to course submission item details post request. */
|
|
1631
|
-
export interface
|
|
1643
|
+
export interface OutputFqm4Xqhert {
|
|
1632
1644
|
submissionItems: {
|
|
1633
1645
|
/**
|
|
1634
1646
|
* The ID of the file being submitted.
|
|
@@ -1643,7 +1655,7 @@ export interface Output1Pdxtyrqq3 {
|
|
|
1643
1655
|
}[];
|
|
1644
1656
|
}
|
|
1645
1657
|
/** Pending approval submission parameters */
|
|
1646
|
-
export interface
|
|
1658
|
+
export interface Input3Felz7Mi9Yf {
|
|
1647
1659
|
/**
|
|
1648
1660
|
* Type of pending approval
|
|
1649
1661
|
* @example "certification"
|
|
@@ -1663,7 +1675,7 @@ export interface InputHxl0Fp63H1 {
|
|
|
1663
1675
|
fileName: string;
|
|
1664
1676
|
}[];
|
|
1665
1677
|
}
|
|
1666
|
-
export interface
|
|
1678
|
+
export interface InputUhe8Fii9R5I {
|
|
1667
1679
|
/**
|
|
1668
1680
|
* The ID of the course for which the license is being redeemed
|
|
1669
1681
|
* @example "courseID123"
|
|
@@ -1731,7 +1743,7 @@ export interface InputNbxrj0Y5Mj {
|
|
|
1731
1743
|
acknowledgement?: string | null;
|
|
1732
1744
|
}
|
|
1733
1745
|
/** Validate certification move response schema */
|
|
1734
|
-
export interface
|
|
1746
|
+
export interface OutputPukzjwkc5A {
|
|
1735
1747
|
courses: {
|
|
1736
1748
|
name: string;
|
|
1737
1749
|
status: string;
|
|
@@ -1742,21 +1754,21 @@ export interface OutputVppeb5Xojh {
|
|
|
1742
1754
|
validated: boolean;
|
|
1743
1755
|
mustCreateCP: boolean;
|
|
1744
1756
|
}
|
|
1745
|
-
export interface
|
|
1757
|
+
export interface InputCczxplinv7 {
|
|
1746
1758
|
/**
|
|
1747
1759
|
* Comments regarding the end of the cooldown period
|
|
1748
1760
|
* @example "Cooldown period ended successfully."
|
|
1749
1761
|
*/
|
|
1750
1762
|
comments: string;
|
|
1751
1763
|
}
|
|
1752
|
-
export interface
|
|
1764
|
+
export interface OutputNu2F49Jqcp {
|
|
1753
1765
|
/**
|
|
1754
1766
|
* Signed URL for the course file
|
|
1755
1767
|
* @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"
|
|
1756
1768
|
*/
|
|
1757
1769
|
fileURL: string;
|
|
1758
1770
|
}
|
|
1759
|
-
export interface
|
|
1771
|
+
export interface Input5Ati3Iec5T {
|
|
1760
1772
|
/** @example true */
|
|
1761
1773
|
agreedWithCertTerms: boolean;
|
|
1762
1774
|
/** @example 1717230000000 */
|
|
@@ -1836,21 +1848,21 @@ export interface Input8Z5Hchem2Z {
|
|
|
1836
1848
|
/** @example "HR Manager" */
|
|
1837
1849
|
attestSponsorTitle?: string;
|
|
1838
1850
|
}
|
|
1839
|
-
export interface
|
|
1851
|
+
export interface Input0P8X0F4T55 {
|
|
1840
1852
|
/**
|
|
1841
1853
|
* Comments regarding the course unlock action
|
|
1842
1854
|
* @example "Course unlocked successfully."
|
|
1843
1855
|
*/
|
|
1844
1856
|
comments: string;
|
|
1845
1857
|
}
|
|
1846
|
-
export interface
|
|
1858
|
+
export interface InputQ8Luhamicz {
|
|
1847
1859
|
/**
|
|
1848
1860
|
* ITA number to update for the user
|
|
1849
1861
|
* @example "ITA123456"
|
|
1850
1862
|
*/
|
|
1851
1863
|
itaNumber: string;
|
|
1852
1864
|
}
|
|
1853
|
-
export interface
|
|
1865
|
+
export interface InputJavmrm0L1Jf {
|
|
1854
1866
|
/** @example true */
|
|
1855
1867
|
agreedWithCertTerms: boolean;
|
|
1856
1868
|
/** @example 1717230000000 */
|
|
@@ -1930,7 +1942,7 @@ export interface Input6Nzldsilg9 {
|
|
|
1930
1942
|
/** @example "HR Manager" */
|
|
1931
1943
|
attestSponsorTitle?: string;
|
|
1932
1944
|
}
|
|
1933
|
-
export interface
|
|
1945
|
+
export interface InputM24Ojes5Ofk {
|
|
1934
1946
|
/**
|
|
1935
1947
|
* The grade to override the course result with
|
|
1936
1948
|
* @example "A"
|
|
@@ -1938,7 +1950,7 @@ export interface InputU8Q9Uo7E87 {
|
|
|
1938
1950
|
resultGrade: string;
|
|
1939
1951
|
}
|
|
1940
1952
|
/** Pending approval review parameters */
|
|
1941
|
-
export interface
|
|
1953
|
+
export interface InputGay28Hqm3C {
|
|
1942
1954
|
/**
|
|
1943
1955
|
* Notes provided by the reviewer for the pending approval
|
|
1944
1956
|
* @example "Please review the submitted documents."
|
|
@@ -1951,7 +1963,7 @@ export interface InputSs3Cxez2D2L {
|
|
|
1951
1963
|
approved: boolean;
|
|
1952
1964
|
}
|
|
1953
1965
|
/** Schema for overriding course result dates. */
|
|
1954
|
-
export interface
|
|
1966
|
+
export interface InputQufs4U2Pbk {
|
|
1955
1967
|
/**
|
|
1956
1968
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1957
1969
|
* @example 1735689600000
|
|
@@ -1963,14 +1975,14 @@ export interface InputViomzw0H9O {
|
|
|
1963
1975
|
*/
|
|
1964
1976
|
completionDate?: number;
|
|
1965
1977
|
}
|
|
1966
|
-
export interface
|
|
1978
|
+
export interface InputQ7Ovg862Fr {
|
|
1967
1979
|
filter: {
|
|
1968
1980
|
from?: number;
|
|
1969
1981
|
sortOrder?: string;
|
|
1970
1982
|
sortField?: string;
|
|
1971
1983
|
};
|
|
1972
1984
|
}
|
|
1973
|
-
export interface
|
|
1985
|
+
export interface OutputQ7Ovg862Fr {
|
|
1974
1986
|
users: {
|
|
1975
1987
|
firstName: string;
|
|
1976
1988
|
lastName: string;
|
|
@@ -1994,7 +2006,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
1994
2006
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1995
2007
|
* @example "CHECKED"
|
|
1996
2008
|
*/
|
|
1997
|
-
export declare enum
|
|
2009
|
+
export declare enum InputY8Rgeghq8DValueEnum {
|
|
1998
2010
|
CHECKED = "CHECKED",
|
|
1999
2011
|
UNCHECKED = "UNCHECKED",
|
|
2000
2012
|
NOVALUE = "NOVALUE"
|
|
@@ -2093,7 +2105,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2093
2105
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2094
2106
|
export type CreateReportUsersSimpleData = any;
|
|
2095
2107
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2096
|
-
export type CreateSearchUsersCountData =
|
|
2108
|
+
export type CreateSearchUsersCountData = Output0Nfmfqq0R5;
|
|
2097
2109
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2098
2110
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2099
2111
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2117,7 +2129,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2117
2129
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2118
2130
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2119
2131
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2120
|
-
export type GetCertificationCourseFileSignData =
|
|
2132
|
+
export type GetCertificationCourseFileSignData = OutputImjjo7Tgi4;
|
|
2121
2133
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2122
2134
|
export interface CreateCertificationCourseFileSignParams {
|
|
2123
2135
|
/** @example "pdf" */
|
|
@@ -2131,11 +2143,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2131
2143
|
/** @example "fileID" */
|
|
2132
2144
|
fileId: string;
|
|
2133
2145
|
}
|
|
2134
|
-
export type CreateCertificationCourseFileSignData =
|
|
2146
|
+
export type CreateCertificationCourseFileSignData = OutputNu2F49Jqcp;
|
|
2135
2147
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2136
2148
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2137
2149
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2138
|
-
export type CreateCertificationCourseDocumentData =
|
|
2150
|
+
export type CreateCertificationCourseDocumentData = OutputFqm4Xqhert;
|
|
2139
2151
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2140
2152
|
export type DeleteUserData = any;
|
|
2141
2153
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2147,7 +2159,7 @@ export type UpdateUserData = any;
|
|
|
2147
2159
|
export type UpdateUserError = ErrorResponse;
|
|
2148
2160
|
export type DeleteCertificationCourseData = any;
|
|
2149
2161
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2150
|
-
export type GetCertificationApplicationItemFileData =
|
|
2162
|
+
export type GetCertificationApplicationItemFileData = OutputPx59Htkllg;
|
|
2151
2163
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2152
2164
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2153
2165
|
/** @example "pdf" */
|
|
@@ -2161,9 +2173,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2161
2173
|
/** @example "fileVersion" */
|
|
2162
2174
|
fileVersion: string;
|
|
2163
2175
|
}
|
|
2164
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2176
|
+
export type CreateCertificationApplicationItemFileData = OutputUxoq3Zwn6I;
|
|
2165
2177
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2166
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2178
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = Output4Cpyw88Dfth;
|
|
2167
2179
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2168
2180
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2169
2181
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2171,7 +2183,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2171
2183
|
export type GetCourseError = ErrorResponse;
|
|
2172
2184
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2173
2185
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2174
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2186
|
+
export type GetCertificationApplicationForeignFillData = OutputBrg51Gh4B5G;
|
|
2175
2187
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2176
2188
|
export type GetCertificationPrintData = any;
|
|
2177
2189
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2205,7 +2217,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2205
2217
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2206
2218
|
export type CreateCertificationWaiveData = any;
|
|
2207
2219
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2208
|
-
export type CreateCertificationMoveData =
|
|
2220
|
+
export type CreateCertificationMoveData = OutputN55H9Dq7Jg;
|
|
2209
2221
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2210
2222
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2211
2223
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2237,7 +2249,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2237
2249
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2238
2250
|
export type CreateCertificationCourseRedeemData = any;
|
|
2239
2251
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2240
|
-
export type CreateCertificationMoveValidateData =
|
|
2252
|
+
export type CreateCertificationMoveValidateData = OutputPukzjwkc5A;
|
|
2241
2253
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2242
2254
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2243
2255
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2253,7 +2265,7 @@ export type CreateCertificationPublishInfoData = any;
|
|
|
2253
2265
|
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2254
2266
|
export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
2255
2267
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2256
|
-
export type CreateCertificationResult =
|
|
2268
|
+
export type CreateCertificationResult = OutputQ7Ovg862Fr;
|
|
2257
2269
|
export type CreateCertificationFail = ErrorResponse;
|
|
2258
2270
|
export type CreateCertificationPublishInfoResult = any;
|
|
2259
2271
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2300,7 +2312,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2300
2312
|
}
|
|
2301
2313
|
/**
|
|
2302
2314
|
* @title BCCSA Program API
|
|
2303
|
-
* @version 3.0.
|
|
2315
|
+
* @version 3.0.31
|
|
2304
2316
|
* @baseUrl http://localhost:8080
|
|
2305
2317
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2306
2318
|
*/
|
|
@@ -2315,7 +2327,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2315
2327
|
* @request POST:/contactUs
|
|
2316
2328
|
* @secure
|
|
2317
2329
|
*/
|
|
2318
|
-
listContactUs: (data:
|
|
2330
|
+
listContactUs: (data: Input7507I6Pbqck, params?: RequestParams) => Promise<any>;
|
|
2319
2331
|
};
|
|
2320
2332
|
customer: {
|
|
2321
2333
|
/**
|
|
@@ -2419,7 +2431,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2419
2431
|
* @request POST:/tenant/report/applicationExport
|
|
2420
2432
|
* @secure
|
|
2421
2433
|
*/
|
|
2422
|
-
createReportApplicationExport: (data:
|
|
2434
|
+
createReportApplicationExport: (data: InputLafd3A50Ir, params?: RequestParams) => Promise<any>;
|
|
2423
2435
|
/**
|
|
2424
2436
|
* @description Export a report of applications based on the provided filters.
|
|
2425
2437
|
*
|
|
@@ -2429,7 +2441,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2429
2441
|
* @request POST:/tenant/report/applicationStatus
|
|
2430
2442
|
* @secure
|
|
2431
2443
|
*/
|
|
2432
|
-
listReportApplicationStatus: (data:
|
|
2444
|
+
listReportApplicationStatus: (data: InputJj4T48To4I, params?: RequestParams) => Promise<any>;
|
|
2433
2445
|
/**
|
|
2434
2446
|
* @description Export a report of applications based on the provided filters.
|
|
2435
2447
|
*
|
|
@@ -2439,7 +2451,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2439
2451
|
* @request POST:/tenant/report/applicationsReport
|
|
2440
2452
|
* @secure
|
|
2441
2453
|
*/
|
|
2442
|
-
createReportApplicationsReport: (data:
|
|
2454
|
+
createReportApplicationsReport: (data: Input4299E0Qghu, params?: RequestParams) => Promise<any>;
|
|
2443
2455
|
/**
|
|
2444
2456
|
* @description This route allows you to post certificates email for the tenant.
|
|
2445
2457
|
*
|
|
@@ -2449,7 +2461,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2449
2461
|
* @request POST:/tenant/certificates/email
|
|
2450
2462
|
* @secure
|
|
2451
2463
|
*/
|
|
2452
|
-
createCertificatesEmail: (data:
|
|
2464
|
+
createCertificatesEmail: (data: Input22An4Alkhlg, params?: RequestParams) => Promise<any>;
|
|
2453
2465
|
/**
|
|
2454
2466
|
* @description Generate a preview of the completed certifications report.
|
|
2455
2467
|
*
|
|
@@ -2479,7 +2491,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2479
2491
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2480
2492
|
* @secure
|
|
2481
2493
|
*/
|
|
2482
|
-
createLicenseRedeem: (userId: string, data:
|
|
2494
|
+
createLicenseRedeem: (userId: string, data: Input7K2Sgvn13T, params?: RequestParams) => Promise<any>;
|
|
2483
2495
|
/**
|
|
2484
2496
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2485
2497
|
*
|
|
@@ -2489,7 +2501,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2489
2501
|
* @request POST:/tenant/report/orglicenses/
|
|
2490
2502
|
* @secure
|
|
2491
2503
|
*/
|
|
2492
|
-
listReportOrglicenses: (data:
|
|
2504
|
+
listReportOrglicenses: (data: Input5Bwr4N40Es, params?: RequestParams) => Promise<any>;
|
|
2493
2505
|
/**
|
|
2494
2506
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2495
2507
|
*
|
|
@@ -2499,7 +2511,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2499
2511
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2500
2512
|
* @secure
|
|
2501
2513
|
*/
|
|
2502
|
-
createReportOrglicensesPreview: (data:
|
|
2514
|
+
createReportOrglicensesPreview: (data: InputRe7Pqpm29Il, params?: RequestParams) => Promise<any>;
|
|
2503
2515
|
/**
|
|
2504
2516
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2505
2517
|
*
|
|
@@ -2539,7 +2551,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2539
2551
|
* @request POST:/tenant/report/users/advanced
|
|
2540
2552
|
* @secure
|
|
2541
2553
|
*/
|
|
2542
|
-
createReportUsersAdvanced: (data:
|
|
2554
|
+
createReportUsersAdvanced: (data: InputG6Hsraotyi, params?: RequestParams) => Promise<any>;
|
|
2543
2555
|
/**
|
|
2544
2556
|
* @description Searches for users in the tenant by their IDs.
|
|
2545
2557
|
*
|
|
@@ -2549,7 +2561,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2549
2561
|
* @request POST:/tenant/search/users/ids
|
|
2550
2562
|
* @secure
|
|
2551
2563
|
*/
|
|
2552
|
-
listSearchUsersIds: (data:
|
|
2564
|
+
listSearchUsersIds: (data: Input35Hgedfe72, params?: RequestParams) => Promise<any>;
|
|
2553
2565
|
/**
|
|
2554
2566
|
* @description Searches for users in the tenant by term and filters.
|
|
2555
2567
|
*
|
|
@@ -2559,7 +2571,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2559
2571
|
* @request POST:/tenant/search/users/term
|
|
2560
2572
|
* @secure
|
|
2561
2573
|
*/
|
|
2562
|
-
createSearchUsersTerm: (data:
|
|
2574
|
+
createSearchUsersTerm: (data: Input8Vhcnzx2B7, params?: RequestParams) => Promise<any>;
|
|
2563
2575
|
/**
|
|
2564
2576
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2565
2577
|
*
|
|
@@ -2569,7 +2581,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2569
2581
|
* @request POST:/tenant/report/users/simple
|
|
2570
2582
|
* @secure
|
|
2571
2583
|
*/
|
|
2572
|
-
createReportUsersSimple: (data:
|
|
2584
|
+
createReportUsersSimple: (data: InputTi43Il2Vlv, params?: RequestParams) => Promise<any>;
|
|
2573
2585
|
/**
|
|
2574
2586
|
* @description Retrieve user by ID.
|
|
2575
2587
|
*
|
|
@@ -2579,7 +2591,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2579
2591
|
* @request POST:/tenant/search/users/count
|
|
2580
2592
|
* @secure
|
|
2581
2593
|
*/
|
|
2582
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2594
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<Output0Nfmfqq0R5>;
|
|
2583
2595
|
};
|
|
2584
2596
|
user: {
|
|
2585
2597
|
/**
|
|
@@ -2611,7 +2623,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2611
2623
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2612
2624
|
* @secure
|
|
2613
2625
|
*/
|
|
2614
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2626
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: Input0Unqmff7Xg, params?: RequestParams) => Promise<any>;
|
|
2615
2627
|
/**
|
|
2616
2628
|
* @description Delete a certification process application by type.
|
|
2617
2629
|
*
|
|
@@ -2701,7 +2713,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2701
2713
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2702
2714
|
* @secure
|
|
2703
2715
|
*/
|
|
2704
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2716
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputImjjo7Tgi4>;
|
|
2705
2717
|
/**
|
|
2706
2718
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2707
2719
|
*
|
|
@@ -2711,7 +2723,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2711
2723
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2712
2724
|
* @secure
|
|
2713
2725
|
*/
|
|
2714
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2726
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputNu2F49Jqcp>;
|
|
2715
2727
|
/**
|
|
2716
2728
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2717
2729
|
*
|
|
@@ -2731,7 +2743,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2731
2743
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2732
2744
|
* @secure
|
|
2733
2745
|
*/
|
|
2734
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2746
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputFqm4Xqhert, params?: RequestParams) => Promise<OutputFqm4Xqhert>;
|
|
2735
2747
|
/**
|
|
2736
2748
|
* @description Delete user by ID.
|
|
2737
2749
|
*
|
|
@@ -2761,7 +2773,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2761
2773
|
* @request POST:/user/{userID}
|
|
2762
2774
|
* @secure
|
|
2763
2775
|
*/
|
|
2764
|
-
createUser: (userId: string, data:
|
|
2776
|
+
createUser: (userId: string, data: Input5Ati3Iec5T, params?: RequestParams) => Promise<any>;
|
|
2765
2777
|
/**
|
|
2766
2778
|
* @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.
|
|
2767
2779
|
*
|
|
@@ -2771,7 +2783,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2771
2783
|
* @request PUT:/user/{userID}
|
|
2772
2784
|
* @secure
|
|
2773
2785
|
*/
|
|
2774
|
-
updateUser: (userId: string, data:
|
|
2786
|
+
updateUser: (userId: string, data: InputJavmrm0L1Jf, params?: RequestParams) => Promise<any>;
|
|
2775
2787
|
/**
|
|
2776
2788
|
* @description Delete course from user
|
|
2777
2789
|
*
|
|
@@ -2791,7 +2803,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2791
2803
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2792
2804
|
* @secure
|
|
2793
2805
|
*/
|
|
2794
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2806
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputPx59Htkllg>;
|
|
2795
2807
|
/**
|
|
2796
2808
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2797
2809
|
*
|
|
@@ -2801,7 +2813,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2801
2813
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2802
2814
|
* @secure
|
|
2803
2815
|
*/
|
|
2804
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2816
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputUxoq3Zwn6I>;
|
|
2805
2817
|
/**
|
|
2806
2818
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2807
2819
|
*
|
|
@@ -2811,7 +2823,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2811
2823
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2812
2824
|
* @secure
|
|
2813
2825
|
*/
|
|
2814
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2826
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<Output4Cpyw88Dfth>;
|
|
2815
2827
|
/**
|
|
2816
2828
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2817
2829
|
*
|
|
@@ -2851,7 +2863,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2851
2863
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2852
2864
|
* @secure
|
|
2853
2865
|
*/
|
|
2854
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2866
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputBrg51Gh4B5G>;
|
|
2855
2867
|
/**
|
|
2856
2868
|
* @description This endpoint will print certificate
|
|
2857
2869
|
*
|
|
@@ -2911,7 +2923,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2911
2923
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2912
2924
|
* @secure
|
|
2913
2925
|
*/
|
|
2914
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2926
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: Input4Xas31Gffbk, params?: RequestParams) => Promise<any>;
|
|
2915
2927
|
/**
|
|
2916
2928
|
* @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.
|
|
2917
2929
|
*
|
|
@@ -2941,7 +2953,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2941
2953
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2942
2954
|
* @secure
|
|
2943
2955
|
*/
|
|
2944
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2956
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputUh7Kaccbqsi, params?: RequestParams) => Promise<any>;
|
|
2945
2957
|
/**
|
|
2946
2958
|
* @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.
|
|
2947
2959
|
*
|
|
@@ -2951,7 +2963,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2951
2963
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2952
2964
|
* @secure
|
|
2953
2965
|
*/
|
|
2954
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2966
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputUxt59Ezr2X, params?: RequestParams) => Promise<any>;
|
|
2955
2967
|
/**
|
|
2956
2968
|
* @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.
|
|
2957
2969
|
*
|
|
@@ -2961,7 +2973,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2961
2973
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2962
2974
|
* @secure
|
|
2963
2975
|
*/
|
|
2964
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2976
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputW1Acknrh35, params?: RequestParams) => Promise<any>;
|
|
2965
2977
|
/**
|
|
2966
2978
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2967
2979
|
*
|
|
@@ -2971,7 +2983,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2971
2983
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2972
2984
|
* @secure
|
|
2973
2985
|
*/
|
|
2974
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2986
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: Input49Kewdueod, params?: RequestParams) => Promise<any>;
|
|
2975
2987
|
/**
|
|
2976
2988
|
* @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.
|
|
2977
2989
|
*
|
|
@@ -3011,7 +3023,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3011
3023
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
3012
3024
|
* @secure
|
|
3013
3025
|
*/
|
|
3014
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
3026
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputPv8Afi38Gj, params?: RequestParams) => Promise<any>;
|
|
3015
3027
|
/**
|
|
3016
3028
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
3017
3029
|
*
|
|
@@ -3021,7 +3033,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3021
3033
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
3022
3034
|
* @secure
|
|
3023
3035
|
*/
|
|
3024
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3036
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputN55H9Dq7Jg>;
|
|
3025
3037
|
/**
|
|
3026
3038
|
* @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.
|
|
3027
3039
|
*
|
|
@@ -3061,7 +3073,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3061
3073
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
3062
3074
|
* @secure
|
|
3063
3075
|
*/
|
|
3064
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
3076
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputY8Rgeghq8D, params?: RequestParams) => Promise<any>;
|
|
3065
3077
|
/**
|
|
3066
3078
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
3067
3079
|
*
|
|
@@ -3121,7 +3133,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3121
3133
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3122
3134
|
* @secure
|
|
3123
3135
|
*/
|
|
3124
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
3136
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: Input38X1Tu13M6, params?: RequestParams) => Promise<any>;
|
|
3125
3137
|
/**
|
|
3126
3138
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3127
3139
|
*
|
|
@@ -3141,7 +3153,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3141
3153
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3142
3154
|
* @secure
|
|
3143
3155
|
*/
|
|
3144
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3156
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputI7Wxaw8I1P, params?: RequestParams) => Promise<any>;
|
|
3145
3157
|
/**
|
|
3146
3158
|
* @description This route allows you to submit a pending approval.
|
|
3147
3159
|
*
|
|
@@ -3151,7 +3163,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3151
3163
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3152
3164
|
* @secure
|
|
3153
3165
|
*/
|
|
3154
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3166
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: Input3Felz7Mi9Yf, params?: RequestParams) => Promise<any>;
|
|
3155
3167
|
/**
|
|
3156
3168
|
* @description This route allows you to review a pending approval.
|
|
3157
3169
|
*
|
|
@@ -3161,7 +3173,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3161
3173
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3162
3174
|
* @secure
|
|
3163
3175
|
*/
|
|
3164
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3176
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputGay28Hqm3C, params?: RequestParams) => Promise<any>;
|
|
3165
3177
|
/**
|
|
3166
3178
|
* @description Redeems a license for a user by product ID.
|
|
3167
3179
|
*
|
|
@@ -3171,7 +3183,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3171
3183
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3172
3184
|
* @secure
|
|
3173
3185
|
*/
|
|
3174
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3186
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputUhe8Fii9R5I, params?: RequestParams) => Promise<any>;
|
|
3175
3187
|
/**
|
|
3176
3188
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3177
3189
|
*
|
|
@@ -3181,7 +3193,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3181
3193
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3182
3194
|
* @secure
|
|
3183
3195
|
*/
|
|
3184
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3196
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputPukzjwkc5A>;
|
|
3185
3197
|
/**
|
|
3186
3198
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3187
3199
|
*
|
|
@@ -3191,7 +3203,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3191
3203
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3192
3204
|
* @secure
|
|
3193
3205
|
*/
|
|
3194
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3206
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputCczxplinv7, params?: RequestParams) => Promise<any>;
|
|
3195
3207
|
/**
|
|
3196
3208
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3197
3209
|
*
|
|
@@ -3201,7 +3213,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3201
3213
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3202
3214
|
* @secure
|
|
3203
3215
|
*/
|
|
3204
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3216
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input0P8X0F4T55, params?: RequestParams) => Promise<any>;
|
|
3205
3217
|
/**
|
|
3206
3218
|
* @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.
|
|
3207
3219
|
*
|
|
@@ -3211,7 +3223,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3211
3223
|
* @request POST:/user/{userID}/updateITA
|
|
3212
3224
|
* @secure
|
|
3213
3225
|
*/
|
|
3214
|
-
createUpdateIta: (userId: string, data:
|
|
3226
|
+
createUpdateIta: (userId: string, data: InputQ8Luhamicz, params?: RequestParams) => Promise<any>;
|
|
3215
3227
|
/**
|
|
3216
3228
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3217
3229
|
*
|
|
@@ -3221,7 +3233,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3221
3233
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3222
3234
|
* @secure
|
|
3223
3235
|
*/
|
|
3224
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3236
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputM24Ojes5Ofk, params?: RequestParams) => Promise<any>;
|
|
3225
3237
|
/**
|
|
3226
3238
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3227
3239
|
*
|
|
@@ -3231,7 +3243,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3231
3243
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3232
3244
|
* @secure
|
|
3233
3245
|
*/
|
|
3234
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3246
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputQufs4U2Pbk, params?: RequestParams) => Promise<any>;
|
|
3235
3247
|
/**
|
|
3236
3248
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3237
3249
|
*
|
|
@@ -3263,7 +3275,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3263
3275
|
* @request POST:/users/certification/{certSpecID}
|
|
3264
3276
|
* @secure
|
|
3265
3277
|
*/
|
|
3266
|
-
createCertification: (certSpecId: string, data:
|
|
3278
|
+
createCertification: (certSpecId: string, data: InputQ7Ovg862Fr, params?: RequestParams) => Promise<OutputQ7Ovg862Fr>;
|
|
3267
3279
|
/**
|
|
3268
3280
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3269
3281
|
*
|