@ikonintegration/bccsa-program-api 3.0.38 → 3.0.39
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 +180 -93
- package/dist/Api.d.ts +173 -102
- package/dist/Api.js +27 -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 InputDvpeshuco {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -328,6 +328,63 @@ export interface OverwrittenJustification {
|
|
|
328
328
|
export type RevokedByID = string;
|
|
329
329
|
/** Display name of the user who revoked the course */
|
|
330
330
|
export type RevokedByName = string;
|
|
331
|
+
/** Sponsorship approval parameters */
|
|
332
|
+
export interface InputVvmwfls90N {
|
|
333
|
+
/**
|
|
334
|
+
* Employer first name
|
|
335
|
+
* @maxLength 255
|
|
336
|
+
* @example "John"
|
|
337
|
+
*/
|
|
338
|
+
firstName?: string;
|
|
339
|
+
/**
|
|
340
|
+
* Employer last name
|
|
341
|
+
* @maxLength 255
|
|
342
|
+
* @example "Doe"
|
|
343
|
+
*/
|
|
344
|
+
lastName?: string;
|
|
345
|
+
/**
|
|
346
|
+
* Employer title
|
|
347
|
+
* @maxLength 255
|
|
348
|
+
* @example "Safety Manager"
|
|
349
|
+
*/
|
|
350
|
+
title?: string;
|
|
351
|
+
/**
|
|
352
|
+
* Employer email address
|
|
353
|
+
* @maxLength 255
|
|
354
|
+
* @example "john.doe@example.com"
|
|
355
|
+
*/
|
|
356
|
+
email?: string;
|
|
357
|
+
/**
|
|
358
|
+
* Employer phone number
|
|
359
|
+
* @maxLength 255
|
|
360
|
+
* @example "+1 604 555 0100"
|
|
361
|
+
*/
|
|
362
|
+
phone?: string;
|
|
363
|
+
/**
|
|
364
|
+
* Organization name
|
|
365
|
+
* @maxLength 255
|
|
366
|
+
* @example "Acme Construction Ltd."
|
|
367
|
+
*/
|
|
368
|
+
orgName?: string;
|
|
369
|
+
/**
|
|
370
|
+
* WorkSafeBC number
|
|
371
|
+
* @maxLength 255
|
|
372
|
+
* @example "123456"
|
|
373
|
+
*/
|
|
374
|
+
worksafeBCNumber?: string;
|
|
375
|
+
/**
|
|
376
|
+
* Employee name
|
|
377
|
+
* @maxLength 255
|
|
378
|
+
* @example "Jane Smith"
|
|
379
|
+
*/
|
|
380
|
+
employeeName?: string;
|
|
381
|
+
/**
|
|
382
|
+
* Employee title
|
|
383
|
+
* @maxLength 255
|
|
384
|
+
* @example "Labourer"
|
|
385
|
+
*/
|
|
386
|
+
employeeTitle?: string;
|
|
387
|
+
}
|
|
331
388
|
/** Response schema for applications */
|
|
332
389
|
export interface ApplicationResponseSchema {
|
|
333
390
|
applications: {
|
|
@@ -486,7 +543,7 @@ export type SponsorshipRemindersStudent = string[];
|
|
|
486
543
|
export type SponsorshipRemindersSponsor = string[];
|
|
487
544
|
/** 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
545
|
export type RemindersStartedOn = number;
|
|
489
|
-
export interface
|
|
546
|
+
export interface InputAo0Hmwpt3Z {
|
|
490
547
|
/**
|
|
491
548
|
* ID of the certification to filter applications by
|
|
492
549
|
* @example "certification123"
|
|
@@ -543,7 +600,7 @@ export interface InputI92Gs480Wi {
|
|
|
543
600
|
*/
|
|
544
601
|
ignoreCompletedCertifications?: boolean | null;
|
|
545
602
|
}
|
|
546
|
-
export interface
|
|
603
|
+
export interface InputSf456Uwm0Y {
|
|
547
604
|
/**
|
|
548
605
|
* ID of the certification to filter applications by
|
|
549
606
|
* @example "certification123"
|
|
@@ -600,7 +657,7 @@ export interface InputRhw4W336M4 {
|
|
|
600
657
|
*/
|
|
601
658
|
ignoreCompletedCertifications?: boolean | null;
|
|
602
659
|
}
|
|
603
|
-
export interface
|
|
660
|
+
export interface InputGk0V7Sd10D {
|
|
604
661
|
/**
|
|
605
662
|
* ID of the certification to filter applications by
|
|
606
663
|
* @example "certification123"
|
|
@@ -657,7 +714,7 @@ export interface InputDwl6Jshl2T {
|
|
|
657
714
|
*/
|
|
658
715
|
ignoreCompletedCertifications?: boolean | null;
|
|
659
716
|
}
|
|
660
|
-
export interface
|
|
717
|
+
export interface InputRw5C352Zh1 {
|
|
661
718
|
/**
|
|
662
719
|
* The ID of the certificate specifications to be used for the email
|
|
663
720
|
* @example "certSpecsID123"
|
|
@@ -698,7 +755,7 @@ export interface InputAadskx0R66 {
|
|
|
698
755
|
emailAddress: string;
|
|
699
756
|
}[];
|
|
700
757
|
}
|
|
701
|
-
export interface
|
|
758
|
+
export interface InputWq7Kc998Gu {
|
|
702
759
|
/**
|
|
703
760
|
* The ID of the product for which the license is being redeemed
|
|
704
761
|
* @example "productID123"
|
|
@@ -710,7 +767,7 @@ export interface InputFzsxnr61Gz {
|
|
|
710
767
|
*/
|
|
711
768
|
sessionID?: string;
|
|
712
769
|
}
|
|
713
|
-
export interface
|
|
770
|
+
export interface InputAohpyyjnf {
|
|
714
771
|
/**
|
|
715
772
|
* Search term to filter licenses
|
|
716
773
|
* @example "active"
|
|
@@ -727,7 +784,7 @@ export interface InputWb2Lmb2Fy7 {
|
|
|
727
784
|
*/
|
|
728
785
|
sortField?: any;
|
|
729
786
|
}
|
|
730
|
-
export interface
|
|
787
|
+
export interface InputAge25V1T74 {
|
|
731
788
|
/**
|
|
732
789
|
* Search term to filter licenses
|
|
733
790
|
* @example "active"
|
|
@@ -860,7 +917,7 @@ export interface SearchPendingApprovalsResponseSchema {
|
|
|
860
917
|
remindersStartedOn?: RemindersStartedOn;
|
|
861
918
|
}[];
|
|
862
919
|
}
|
|
863
|
-
export interface
|
|
920
|
+
export interface Input7U9Wc63O0Z {
|
|
864
921
|
/**
|
|
865
922
|
* Start date for the report
|
|
866
923
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -882,11 +939,11 @@ export interface Input1Ohda2Wgsh {
|
|
|
882
939
|
*/
|
|
883
940
|
dateType?: string;
|
|
884
941
|
}
|
|
885
|
-
export interface
|
|
942
|
+
export interface InputOer8Gvslkt {
|
|
886
943
|
/** List of user IDs to search for in the tenant. */
|
|
887
944
|
IDs: (string | null)[];
|
|
888
945
|
}
|
|
889
|
-
export interface
|
|
946
|
+
export interface InputRx2Of25Z1S {
|
|
890
947
|
/** The term to search for in the user profiles. */
|
|
891
948
|
searchTerm?: string | null;
|
|
892
949
|
/** Filter criteria for the user search. */
|
|
@@ -926,7 +983,7 @@ export interface InputRalyzixy0A {
|
|
|
926
983
|
};
|
|
927
984
|
};
|
|
928
985
|
}
|
|
929
|
-
export interface
|
|
986
|
+
export interface InputBwf6Vwqau4H {
|
|
930
987
|
/** The term to search for in the user profiles. */
|
|
931
988
|
searchTerm?: string | null;
|
|
932
989
|
/** Filter criteria for the user search. */
|
|
@@ -966,7 +1023,7 @@ export interface InputVll5Y8N7Fs {
|
|
|
966
1023
|
};
|
|
967
1024
|
};
|
|
968
1025
|
}
|
|
969
|
-
export interface
|
|
1026
|
+
export interface Output5Bph624559 {
|
|
970
1027
|
/** External system ID 2 */
|
|
971
1028
|
userCount: ExternalID2;
|
|
972
1029
|
transactionID?: string | null;
|
|
@@ -975,14 +1032,14 @@ export interface Output4Qe1Gsbbif {
|
|
|
975
1032
|
export type ExternalID2 = number;
|
|
976
1033
|
/** This endpoint accepts no request body */
|
|
977
1034
|
export type DeletePendingApprovalBody = object;
|
|
978
|
-
export interface
|
|
1035
|
+
export interface Output0Mvvp8Ezlc {
|
|
979
1036
|
/**
|
|
980
1037
|
* Signed URL for the course file
|
|
981
1038
|
* @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"
|
|
982
1039
|
*/
|
|
983
1040
|
fileURL: string;
|
|
984
1041
|
}
|
|
985
|
-
export interface
|
|
1042
|
+
export interface OutputR212F9Ykfn {
|
|
986
1043
|
/**
|
|
987
1044
|
* Amount to be refunded for the cancellation
|
|
988
1045
|
* @example 0
|
|
@@ -1282,7 +1339,7 @@ export interface CourseResponseEntity {
|
|
|
1282
1339
|
}
|
|
1283
1340
|
/** Label of the course enrolled (course version) */
|
|
1284
1341
|
export type OnlineCourseLabel = string;
|
|
1285
|
-
export interface
|
|
1342
|
+
export interface Output9Avku1Eafm {
|
|
1286
1343
|
/**
|
|
1287
1344
|
* Signed URL for the course file
|
|
1288
1345
|
* @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"
|
|
@@ -1300,7 +1357,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1300
1357
|
transactionID?: string | null;
|
|
1301
1358
|
}
|
|
1302
1359
|
/** Application Foreign Fill response type */
|
|
1303
|
-
export interface
|
|
1360
|
+
export interface OutputXbpkpl54M0I {
|
|
1304
1361
|
items: {
|
|
1305
1362
|
userID: string;
|
|
1306
1363
|
createdOn?: number;
|
|
@@ -1523,7 +1580,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1523
1580
|
applicationItems?: Record<string, any>[];
|
|
1524
1581
|
transactionID?: string | null;
|
|
1525
1582
|
}
|
|
1526
|
-
export interface
|
|
1583
|
+
export interface InputO6S14Hm8Ny {
|
|
1527
1584
|
issuedOn?: number;
|
|
1528
1585
|
expiresOn?: number;
|
|
1529
1586
|
fileItems?: {
|
|
@@ -1532,21 +1589,21 @@ export interface InputZnx3Yaudw0L {
|
|
|
1532
1589
|
}[];
|
|
1533
1590
|
additionalNotes?: string | null;
|
|
1534
1591
|
}
|
|
1535
|
-
export interface
|
|
1592
|
+
export interface InputA30Shinbjtk {
|
|
1536
1593
|
/**
|
|
1537
1594
|
* Indicates whether the application is locked
|
|
1538
1595
|
* @example true
|
|
1539
1596
|
*/
|
|
1540
1597
|
isApplicationLocked: boolean;
|
|
1541
1598
|
}
|
|
1542
|
-
export interface
|
|
1599
|
+
export interface OutputW7312H25Cc {
|
|
1543
1600
|
/**
|
|
1544
1601
|
* Signed URL for the course file
|
|
1545
1602
|
* @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"
|
|
1546
1603
|
*/
|
|
1547
1604
|
fileURL: string;
|
|
1548
1605
|
}
|
|
1549
|
-
export interface
|
|
1606
|
+
export interface InputHttuep0Xaa {
|
|
1550
1607
|
/**
|
|
1551
1608
|
* Indicates whether the waiver is approved
|
|
1552
1609
|
* @example true
|
|
@@ -1558,14 +1615,14 @@ export interface InputOke7Fx73Wa {
|
|
|
1558
1615
|
*/
|
|
1559
1616
|
additionalNotes?: string | null;
|
|
1560
1617
|
}
|
|
1561
|
-
export interface
|
|
1618
|
+
export interface InputR89Sd266I6 {
|
|
1562
1619
|
/**
|
|
1563
1620
|
* Optional notes regarding the waiver
|
|
1564
1621
|
* @example "Waiver granted due to special circumstances."
|
|
1565
1622
|
*/
|
|
1566
1623
|
additionalNotes?: string | null;
|
|
1567
1624
|
}
|
|
1568
|
-
export interface
|
|
1625
|
+
export interface InputS523Pjmwoa {
|
|
1569
1626
|
students: {
|
|
1570
1627
|
/**
|
|
1571
1628
|
* User ID of the student to redeem the course for
|
|
@@ -1599,7 +1656,7 @@ export interface Input78Oq3Ogocp {
|
|
|
1599
1656
|
*/
|
|
1600
1657
|
autoEnrolSessionID?: string;
|
|
1601
1658
|
}
|
|
1602
|
-
export interface
|
|
1659
|
+
export interface Input7Pkse4K1Q5 {
|
|
1603
1660
|
invites: {
|
|
1604
1661
|
/**
|
|
1605
1662
|
* Email address of the user to invite
|
|
@@ -1628,7 +1685,7 @@ export interface InputI19Hnqwxd9 {
|
|
|
1628
1685
|
*/
|
|
1629
1686
|
isReservedSeat: boolean;
|
|
1630
1687
|
}
|
|
1631
|
-
export interface
|
|
1688
|
+
export interface Input3Dqkxxnovwg {
|
|
1632
1689
|
/**
|
|
1633
1690
|
* Indicates whether to waive the certification process
|
|
1634
1691
|
* @example true
|
|
@@ -1641,7 +1698,7 @@ export interface Input0Rf8Rir2Wi {
|
|
|
1641
1698
|
comments?: string | null;
|
|
1642
1699
|
}
|
|
1643
1700
|
/** Certification move response schema */
|
|
1644
|
-
export interface
|
|
1701
|
+
export interface OutputLakap8U75H {
|
|
1645
1702
|
errors?: {
|
|
1646
1703
|
status: string;
|
|
1647
1704
|
object?: Record<string, any>;
|
|
@@ -1649,19 +1706,19 @@ export interface OutputCunolmrmg2 {
|
|
|
1649
1706
|
}[];
|
|
1650
1707
|
}
|
|
1651
1708
|
/** Schema for writing a certification trigger check. */
|
|
1652
|
-
export interface
|
|
1709
|
+
export interface InputO15Aanoemr {
|
|
1653
1710
|
/**
|
|
1654
1711
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1655
1712
|
* @example "CHECKED"
|
|
1656
1713
|
*/
|
|
1657
|
-
value:
|
|
1714
|
+
value: InputO15AanoemrValueEnum;
|
|
1658
1715
|
/**
|
|
1659
1716
|
* List of course IDs that are blocked by this trigger check.
|
|
1660
1717
|
* @example ["course1","course2"]
|
|
1661
1718
|
*/
|
|
1662
1719
|
blockedCourses?: string[];
|
|
1663
1720
|
}
|
|
1664
|
-
export interface
|
|
1721
|
+
export interface InputQ6D0Sejtsf {
|
|
1665
1722
|
/**
|
|
1666
1723
|
* Indicates whether the application item is approved
|
|
1667
1724
|
* @example true
|
|
@@ -1687,7 +1744,7 @@ export interface InputNsoff4Aqr6 {
|
|
|
1687
1744
|
export interface StudentHistoryRequestSchema {
|
|
1688
1745
|
requirements: string[];
|
|
1689
1746
|
}
|
|
1690
|
-
export interface
|
|
1747
|
+
export interface InputMzh8Dry519 {
|
|
1691
1748
|
/**
|
|
1692
1749
|
* Optional activation key for the application
|
|
1693
1750
|
* @example "AK-123456"
|
|
@@ -1695,7 +1752,7 @@ export interface InputW46Ry9Xsi5 {
|
|
|
1695
1752
|
activationKey?: string;
|
|
1696
1753
|
}
|
|
1697
1754
|
/** Schema for course submission item details post request. */
|
|
1698
|
-
export interface
|
|
1755
|
+
export interface Input907Bqms0Gd {
|
|
1699
1756
|
/**
|
|
1700
1757
|
* The ID of the file being submitted.
|
|
1701
1758
|
* @example "fileID123"
|
|
@@ -1708,7 +1765,7 @@ export interface Input1Q6Ejcokqh {
|
|
|
1708
1765
|
fileName: string;
|
|
1709
1766
|
}
|
|
1710
1767
|
/** Schema for the response to course submission item details post request. */
|
|
1711
|
-
export interface
|
|
1768
|
+
export interface Output907Bqms0Gd {
|
|
1712
1769
|
submissionItems: {
|
|
1713
1770
|
/**
|
|
1714
1771
|
* The ID of the file being submitted.
|
|
@@ -1723,7 +1780,7 @@ export interface Output1Q6Ejcokqh {
|
|
|
1723
1780
|
}[];
|
|
1724
1781
|
}
|
|
1725
1782
|
/** Pending approval submission parameters */
|
|
1726
|
-
export interface
|
|
1783
|
+
export interface InputIw7Hk3Mq5M {
|
|
1727
1784
|
/**
|
|
1728
1785
|
* Type of pending approval
|
|
1729
1786
|
* @example "certification"
|
|
@@ -1743,7 +1800,7 @@ export interface InputRxp3Oxn5Tn {
|
|
|
1743
1800
|
fileName: string;
|
|
1744
1801
|
}[];
|
|
1745
1802
|
}
|
|
1746
|
-
export interface
|
|
1803
|
+
export interface InputLh0T8171Wqg {
|
|
1747
1804
|
/**
|
|
1748
1805
|
* The ID of the course for which the license is being redeemed
|
|
1749
1806
|
* @example "courseID123"
|
|
@@ -1811,7 +1868,7 @@ export interface InputFpmobr2I5K {
|
|
|
1811
1868
|
acknowledgement?: string | null;
|
|
1812
1869
|
}
|
|
1813
1870
|
/** Validate certification move response schema */
|
|
1814
|
-
export interface
|
|
1871
|
+
export interface OutputHmffu9Hc2H {
|
|
1815
1872
|
courses: {
|
|
1816
1873
|
name: string;
|
|
1817
1874
|
status: string;
|
|
@@ -1822,21 +1879,21 @@ export interface Output68Gczuab0M {
|
|
|
1822
1879
|
validated: boolean;
|
|
1823
1880
|
mustCreateCP: boolean;
|
|
1824
1881
|
}
|
|
1825
|
-
export interface
|
|
1882
|
+
export interface InputLk5B7Priqt {
|
|
1826
1883
|
/**
|
|
1827
1884
|
* Comments regarding the end of the cooldown period
|
|
1828
1885
|
* @example "Cooldown period ended successfully."
|
|
1829
1886
|
*/
|
|
1830
1887
|
comments: string;
|
|
1831
1888
|
}
|
|
1832
|
-
export interface
|
|
1889
|
+
export interface OutputC61Yutxgkz {
|
|
1833
1890
|
/**
|
|
1834
1891
|
* Signed URL for the course file
|
|
1835
1892
|
* @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"
|
|
1836
1893
|
*/
|
|
1837
1894
|
fileURL: string;
|
|
1838
1895
|
}
|
|
1839
|
-
export interface
|
|
1896
|
+
export interface Input5Ajhwikstb {
|
|
1840
1897
|
/** @example true */
|
|
1841
1898
|
agreedWithCertTerms: boolean;
|
|
1842
1899
|
/** @example 1717230000000 */
|
|
@@ -1921,21 +1978,21 @@ export interface Sponsor {
|
|
|
1921
1978
|
/** Title of the sponsor of the student in the tenant */
|
|
1922
1979
|
title?: Title;
|
|
1923
1980
|
}
|
|
1924
|
-
export interface
|
|
1981
|
+
export interface Input90Jd0Xyanx {
|
|
1925
1982
|
/**
|
|
1926
1983
|
* Comments regarding the course unlock action
|
|
1927
1984
|
* @example "Course unlocked successfully."
|
|
1928
1985
|
*/
|
|
1929
1986
|
comments: string;
|
|
1930
1987
|
}
|
|
1931
|
-
export interface
|
|
1988
|
+
export interface InputC9Nvfilwnd {
|
|
1932
1989
|
/**
|
|
1933
1990
|
* ITA number to update for the user
|
|
1934
1991
|
* @example "ITA123456"
|
|
1935
1992
|
*/
|
|
1936
1993
|
itaNumber: string;
|
|
1937
1994
|
}
|
|
1938
|
-
export interface
|
|
1995
|
+
export interface InputVynk4V82Hlf {
|
|
1939
1996
|
/** @example true */
|
|
1940
1997
|
agreedWithCertTerms: boolean;
|
|
1941
1998
|
/** @example 1717230000000 */
|
|
@@ -2009,7 +2066,7 @@ export interface InputMgiii85Qor {
|
|
|
2009
2066
|
/** Sponsor information for a student in the tenant */
|
|
2010
2067
|
sponsor?: Sponsor;
|
|
2011
2068
|
}
|
|
2012
|
-
export interface
|
|
2069
|
+
export interface InputSzdt1Ehw1F {
|
|
2013
2070
|
/**
|
|
2014
2071
|
* The grade to override the course result with
|
|
2015
2072
|
* @example "A"
|
|
@@ -2017,7 +2074,7 @@ export interface Input17Tw549Oah {
|
|
|
2017
2074
|
resultGrade: string;
|
|
2018
2075
|
}
|
|
2019
2076
|
/** Pending approval review parameters */
|
|
2020
|
-
export interface
|
|
2077
|
+
export interface InputRaggvf9Tdaf {
|
|
2021
2078
|
/**
|
|
2022
2079
|
* Notes provided by the reviewer for the pending approval
|
|
2023
2080
|
* @example "Please review the submitted documents."
|
|
@@ -2037,7 +2094,7 @@ export interface InputRxs18Ly1Jmf {
|
|
|
2037
2094
|
reviewedOn?: number;
|
|
2038
2095
|
}
|
|
2039
2096
|
/** Schema for overriding course result dates. */
|
|
2040
|
-
export interface
|
|
2097
|
+
export interface Input504Pqmq2W3 {
|
|
2041
2098
|
/**
|
|
2042
2099
|
* The date when the course result expires, in milliseconds since epoch.
|
|
2043
2100
|
* @example 1735689600000
|
|
@@ -2051,14 +2108,14 @@ export interface InputFgo7Tyrxudl {
|
|
|
2051
2108
|
}
|
|
2052
2109
|
/** Reset sponsorship request takes no body */
|
|
2053
2110
|
export type ResetSponsorshipBody = object;
|
|
2054
|
-
export interface
|
|
2111
|
+
export interface InputE48N2Qyfcu {
|
|
2055
2112
|
filter: {
|
|
2056
2113
|
from?: number;
|
|
2057
2114
|
sortOrder?: string;
|
|
2058
2115
|
sortField?: string;
|
|
2059
2116
|
};
|
|
2060
2117
|
}
|
|
2061
|
-
export interface
|
|
2118
|
+
export interface OutputE48N2Qyfcu {
|
|
2062
2119
|
users: {
|
|
2063
2120
|
firstName: string;
|
|
2064
2121
|
lastName: string;
|
|
@@ -2082,7 +2139,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
2082
2139
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
2083
2140
|
* @example "CHECKED"
|
|
2084
2141
|
*/
|
|
2085
|
-
export declare enum
|
|
2142
|
+
export declare enum InputO15AanoemrValueEnum {
|
|
2086
2143
|
CHECKED = "CHECKED",
|
|
2087
2144
|
UNCHECKED = "UNCHECKED",
|
|
2088
2145
|
NOVALUE = "NOVALUE"
|
|
@@ -2115,6 +2172,8 @@ export interface GetEventsParams {
|
|
|
2115
2172
|
}
|
|
2116
2173
|
export type GetEventsData = any;
|
|
2117
2174
|
export type GetEventsError = ErrorResponse;
|
|
2175
|
+
export type UpdateApproveData = any;
|
|
2176
|
+
export type UpdateApproveError = ErrorResponse;
|
|
2118
2177
|
export type DeleteOrgData = any;
|
|
2119
2178
|
export type DeleteOrgError = ErrorResponse;
|
|
2120
2179
|
export interface ListReportAffiliateParams {
|
|
@@ -2181,7 +2240,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2181
2240
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2182
2241
|
export type CreateReportUsersSimpleData = any;
|
|
2183
2242
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2184
|
-
export type CreateSearchUsersCountData =
|
|
2243
|
+
export type CreateSearchUsersCountData = Output5Bph624559;
|
|
2185
2244
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2186
2245
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2187
2246
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2205,7 +2264,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2205
2264
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2206
2265
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2207
2266
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2208
|
-
export type GetCertificationCourseFileSignData =
|
|
2267
|
+
export type GetCertificationCourseFileSignData = Output9Avku1Eafm;
|
|
2209
2268
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2210
2269
|
export interface CreateCertificationCourseFileSignParams {
|
|
2211
2270
|
/** @example "pdf" */
|
|
@@ -2219,11 +2278,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2219
2278
|
/** @example "fileID" */
|
|
2220
2279
|
fileId: string;
|
|
2221
2280
|
}
|
|
2222
|
-
export type CreateCertificationCourseFileSignData =
|
|
2281
|
+
export type CreateCertificationCourseFileSignData = OutputC61Yutxgkz;
|
|
2223
2282
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2224
2283
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2225
2284
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2226
|
-
export type CreateCertificationCourseDocumentData =
|
|
2285
|
+
export type CreateCertificationCourseDocumentData = Output907Bqms0Gd;
|
|
2227
2286
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2228
2287
|
export type DeleteSponsorshipPendingApprovalData = any;
|
|
2229
2288
|
export type DeleteSponsorshipPendingApprovalError = ErrorResponse;
|
|
@@ -2239,7 +2298,7 @@ export type UpdateUserData = any;
|
|
|
2239
2298
|
export type UpdateUserError = ErrorResponse;
|
|
2240
2299
|
export type DeleteCertificationCourseData = any;
|
|
2241
2300
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2242
|
-
export type GetCertificationApplicationItemFileData =
|
|
2301
|
+
export type GetCertificationApplicationItemFileData = Output0Mvvp8Ezlc;
|
|
2243
2302
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2244
2303
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2245
2304
|
/** @example "pdf" */
|
|
@@ -2253,9 +2312,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2253
2312
|
/** @example "fileVersion" */
|
|
2254
2313
|
fileVersion: string;
|
|
2255
2314
|
}
|
|
2256
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2315
|
+
export type CreateCertificationApplicationItemFileData = OutputW7312H25Cc;
|
|
2257
2316
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2258
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2317
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputR212F9Ykfn;
|
|
2259
2318
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2260
2319
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2261
2320
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2263,7 +2322,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2263
2322
|
export type GetCourseError = ErrorResponse;
|
|
2264
2323
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2265
2324
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2266
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2325
|
+
export type GetCertificationApplicationForeignFillData = OutputXbpkpl54M0I;
|
|
2267
2326
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2268
2327
|
export type GetCertificationPrintData = any;
|
|
2269
2328
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2297,7 +2356,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2297
2356
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2298
2357
|
export type CreateCertificationWaiveData = any;
|
|
2299
2358
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2300
|
-
export type CreateCertificationMoveData =
|
|
2359
|
+
export type CreateCertificationMoveData = OutputLakap8U75H;
|
|
2301
2360
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2302
2361
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2303
2362
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2329,7 +2388,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2329
2388
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2330
2389
|
export type CreateCertificationCourseRedeemData = any;
|
|
2331
2390
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2332
|
-
export type CreateCertificationMoveValidateData =
|
|
2391
|
+
export type CreateCertificationMoveValidateData = OutputHmffu9Hc2H;
|
|
2333
2392
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2334
2393
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2335
2394
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2347,7 +2406,7 @@ export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
|
2347
2406
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2348
2407
|
export type CreateSponsorshipResetData = any;
|
|
2349
2408
|
export type CreateSponsorshipResetError = ErrorResponse;
|
|
2350
|
-
export type CreateCertificationResult =
|
|
2409
|
+
export type CreateCertificationResult = OutputE48N2Qyfcu;
|
|
2351
2410
|
export type CreateCertificationFail = ErrorResponse;
|
|
2352
2411
|
export type CreateCertificationPublishInfoResult = any;
|
|
2353
2412
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2394,7 +2453,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2394
2453
|
}
|
|
2395
2454
|
/**
|
|
2396
2455
|
* @title BCCSA Program API
|
|
2397
|
-
* @version 3.0.
|
|
2456
|
+
* @version 3.0.39
|
|
2398
2457
|
* @baseUrl http://localhost:8080
|
|
2399
2458
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2400
2459
|
*/
|
|
@@ -2409,7 +2468,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2409
2468
|
* @request POST:/contactUs
|
|
2410
2469
|
* @secure
|
|
2411
2470
|
*/
|
|
2412
|
-
listContactUs: (data:
|
|
2471
|
+
listContactUs: (data: InputDvpeshuco, params?: RequestParams) => Promise<any>;
|
|
2413
2472
|
};
|
|
2414
2473
|
customer: {
|
|
2415
2474
|
/**
|
|
@@ -2443,6 +2502,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2443
2502
|
*/
|
|
2444
2503
|
getEvents: ({ startTime, endTime, ...query }: GetEventsParams, params?: RequestParams) => Promise<any>;
|
|
2445
2504
|
};
|
|
2505
|
+
sponsorship: {
|
|
2506
|
+
/**
|
|
2507
|
+
* @description Public endpoint that approves a pending sponsorship (attestation) request. The employer-provided details are recorded as approval notes, the request is marked approved by the system, and the student is notified by email.
|
|
2508
|
+
*
|
|
2509
|
+
* @tags Sponsorship
|
|
2510
|
+
* @name UpdateApprove
|
|
2511
|
+
* @summary Approve Sponsorship Request
|
|
2512
|
+
* @request PUT:/sponsorship/approve/{paID}
|
|
2513
|
+
* @secure
|
|
2514
|
+
*/
|
|
2515
|
+
updateApprove: (paId: string, data: InputVvmwfls90N, params?: RequestParams) => Promise<any>;
|
|
2516
|
+
};
|
|
2446
2517
|
tenant: {
|
|
2447
2518
|
/**
|
|
2448
2519
|
* @description Delete bridge
|
|
@@ -2513,7 +2584,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2513
2584
|
* @request POST:/tenant/report/applicationExport
|
|
2514
2585
|
* @secure
|
|
2515
2586
|
*/
|
|
2516
|
-
createReportApplicationExport: (data:
|
|
2587
|
+
createReportApplicationExport: (data: InputAo0Hmwpt3Z, params?: RequestParams) => Promise<any>;
|
|
2517
2588
|
/**
|
|
2518
2589
|
* @description Export a report of applications based on the provided filters.
|
|
2519
2590
|
*
|
|
@@ -2523,7 +2594,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2523
2594
|
* @request POST:/tenant/report/applicationStatus
|
|
2524
2595
|
* @secure
|
|
2525
2596
|
*/
|
|
2526
|
-
listReportApplicationStatus: (data:
|
|
2597
|
+
listReportApplicationStatus: (data: InputSf456Uwm0Y, params?: RequestParams) => Promise<any>;
|
|
2527
2598
|
/**
|
|
2528
2599
|
* @description Export a report of applications based on the provided filters.
|
|
2529
2600
|
*
|
|
@@ -2533,7 +2604,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2533
2604
|
* @request POST:/tenant/report/applicationsReport
|
|
2534
2605
|
* @secure
|
|
2535
2606
|
*/
|
|
2536
|
-
createReportApplicationsReport: (data:
|
|
2607
|
+
createReportApplicationsReport: (data: InputGk0V7Sd10D, params?: RequestParams) => Promise<any>;
|
|
2537
2608
|
/**
|
|
2538
2609
|
* @description This route allows you to post certificates email for the tenant.
|
|
2539
2610
|
*
|
|
@@ -2543,7 +2614,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2543
2614
|
* @request POST:/tenant/certificates/email
|
|
2544
2615
|
* @secure
|
|
2545
2616
|
*/
|
|
2546
|
-
createCertificatesEmail: (data:
|
|
2617
|
+
createCertificatesEmail: (data: InputRw5C352Zh1, params?: RequestParams) => Promise<any>;
|
|
2547
2618
|
/**
|
|
2548
2619
|
* @description Generate a preview of the completed certifications report.
|
|
2549
2620
|
*
|
|
@@ -2573,7 +2644,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2573
2644
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2574
2645
|
* @secure
|
|
2575
2646
|
*/
|
|
2576
|
-
createLicenseRedeem: (userId: string, data:
|
|
2647
|
+
createLicenseRedeem: (userId: string, data: InputWq7Kc998Gu, params?: RequestParams) => Promise<any>;
|
|
2577
2648
|
/**
|
|
2578
2649
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2579
2650
|
*
|
|
@@ -2583,7 +2654,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2583
2654
|
* @request POST:/tenant/report/orglicenses/
|
|
2584
2655
|
* @secure
|
|
2585
2656
|
*/
|
|
2586
|
-
listReportOrglicenses: (data:
|
|
2657
|
+
listReportOrglicenses: (data: InputAohpyyjnf, params?: RequestParams) => Promise<any>;
|
|
2587
2658
|
/**
|
|
2588
2659
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2589
2660
|
*
|
|
@@ -2593,7 +2664,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2593
2664
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2594
2665
|
* @secure
|
|
2595
2666
|
*/
|
|
2596
|
-
createReportOrglicensesPreview: (data:
|
|
2667
|
+
createReportOrglicensesPreview: (data: InputAge25V1T74, params?: RequestParams) => Promise<any>;
|
|
2597
2668
|
/**
|
|
2598
2669
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2599
2670
|
*
|
|
@@ -2633,7 +2704,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2633
2704
|
* @request POST:/tenant/report/users/advanced
|
|
2634
2705
|
* @secure
|
|
2635
2706
|
*/
|
|
2636
|
-
createReportUsersAdvanced: (data:
|
|
2707
|
+
createReportUsersAdvanced: (data: Input7U9Wc63O0Z, params?: RequestParams) => Promise<any>;
|
|
2637
2708
|
/**
|
|
2638
2709
|
* @description Searches for users in the tenant by their IDs.
|
|
2639
2710
|
*
|
|
@@ -2643,7 +2714,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2643
2714
|
* @request POST:/tenant/search/users/ids
|
|
2644
2715
|
* @secure
|
|
2645
2716
|
*/
|
|
2646
|
-
listSearchUsersIds: (data:
|
|
2717
|
+
listSearchUsersIds: (data: InputOer8Gvslkt, params?: RequestParams) => Promise<any>;
|
|
2647
2718
|
/**
|
|
2648
2719
|
* @description Searches for users in the tenant by term and filters.
|
|
2649
2720
|
*
|
|
@@ -2653,7 +2724,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2653
2724
|
* @request POST:/tenant/search/users/term
|
|
2654
2725
|
* @secure
|
|
2655
2726
|
*/
|
|
2656
|
-
createSearchUsersTerm: (data:
|
|
2727
|
+
createSearchUsersTerm: (data: InputRx2Of25Z1S, params?: RequestParams) => Promise<any>;
|
|
2657
2728
|
/**
|
|
2658
2729
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2659
2730
|
*
|
|
@@ -2663,7 +2734,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2663
2734
|
* @request POST:/tenant/report/users/simple
|
|
2664
2735
|
* @secure
|
|
2665
2736
|
*/
|
|
2666
|
-
createReportUsersSimple: (data:
|
|
2737
|
+
createReportUsersSimple: (data: InputBwf6Vwqau4H, params?: RequestParams) => Promise<any>;
|
|
2667
2738
|
/**
|
|
2668
2739
|
* @description Retrieve user by ID.
|
|
2669
2740
|
*
|
|
@@ -2673,7 +2744,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2673
2744
|
* @request POST:/tenant/search/users/count
|
|
2674
2745
|
* @secure
|
|
2675
2746
|
*/
|
|
2676
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2747
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<Output5Bph624559>;
|
|
2677
2748
|
};
|
|
2678
2749
|
user: {
|
|
2679
2750
|
/**
|
|
@@ -2705,7 +2776,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2705
2776
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2706
2777
|
* @secure
|
|
2707
2778
|
*/
|
|
2708
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2779
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: InputO6S14Hm8Ny, params?: RequestParams) => Promise<any>;
|
|
2709
2780
|
/**
|
|
2710
2781
|
* @description Delete a certification process application by type.
|
|
2711
2782
|
*
|
|
@@ -2795,7 +2866,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2795
2866
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2796
2867
|
* @secure
|
|
2797
2868
|
*/
|
|
2798
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2869
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<Output9Avku1Eafm>;
|
|
2799
2870
|
/**
|
|
2800
2871
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2801
2872
|
*
|
|
@@ -2805,7 +2876,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2805
2876
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2806
2877
|
* @secure
|
|
2807
2878
|
*/
|
|
2808
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2879
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputC61Yutxgkz>;
|
|
2809
2880
|
/**
|
|
2810
2881
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2811
2882
|
*
|
|
@@ -2825,7 +2896,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2825
2896
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2826
2897
|
* @secure
|
|
2827
2898
|
*/
|
|
2828
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2899
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: Input907Bqms0Gd, params?: RequestParams) => Promise<Output907Bqms0Gd>;
|
|
2829
2900
|
/**
|
|
2830
2901
|
* @description Deletes (cancels) a PENDING sponsorship/attestation pending-approval request for the given user. Admin only. Completed (approved/rejected) requests cannot be deleted. No notification is sent.
|
|
2831
2902
|
*
|
|
@@ -2875,7 +2946,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2875
2946
|
* @request POST:/user/{userID}
|
|
2876
2947
|
* @secure
|
|
2877
2948
|
*/
|
|
2878
|
-
createUser: (userId: string, data:
|
|
2949
|
+
createUser: (userId: string, data: Input5Ajhwikstb, params?: RequestParams) => Promise<any>;
|
|
2879
2950
|
/**
|
|
2880
2951
|
* @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.
|
|
2881
2952
|
*
|
|
@@ -2885,7 +2956,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2885
2956
|
* @request PUT:/user/{userID}
|
|
2886
2957
|
* @secure
|
|
2887
2958
|
*/
|
|
2888
|
-
updateUser: (userId: string, data:
|
|
2959
|
+
updateUser: (userId: string, data: InputVynk4V82Hlf, params?: RequestParams) => Promise<any>;
|
|
2889
2960
|
/**
|
|
2890
2961
|
* @description Delete course from user
|
|
2891
2962
|
*
|
|
@@ -2905,7 +2976,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2905
2976
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2906
2977
|
* @secure
|
|
2907
2978
|
*/
|
|
2908
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2979
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<Output0Mvvp8Ezlc>;
|
|
2909
2980
|
/**
|
|
2910
2981
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2911
2982
|
*
|
|
@@ -2915,7 +2986,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2915
2986
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2916
2987
|
* @secure
|
|
2917
2988
|
*/
|
|
2918
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2989
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputW7312H25Cc>;
|
|
2919
2990
|
/**
|
|
2920
2991
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2921
2992
|
*
|
|
@@ -2925,7 +2996,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2925
2996
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2926
2997
|
* @secure
|
|
2927
2998
|
*/
|
|
2928
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2999
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputR212F9Ykfn>;
|
|
2929
3000
|
/**
|
|
2930
3001
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2931
3002
|
*
|
|
@@ -2965,7 +3036,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2965
3036
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2966
3037
|
* @secure
|
|
2967
3038
|
*/
|
|
2968
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
3039
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputXbpkpl54M0I>;
|
|
2969
3040
|
/**
|
|
2970
3041
|
* @description This endpoint will print certificate
|
|
2971
3042
|
*
|
|
@@ -3025,7 +3096,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3025
3096
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
3026
3097
|
* @secure
|
|
3027
3098
|
*/
|
|
3028
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
3099
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputA30Shinbjtk, params?: RequestParams) => Promise<any>;
|
|
3029
3100
|
/**
|
|
3030
3101
|
* @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.
|
|
3031
3102
|
*
|
|
@@ -3055,7 +3126,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3055
3126
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
3056
3127
|
* @secure
|
|
3057
3128
|
*/
|
|
3058
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3129
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputHttuep0Xaa, params?: RequestParams) => Promise<any>;
|
|
3059
3130
|
/**
|
|
3060
3131
|
* @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.
|
|
3061
3132
|
*
|
|
@@ -3065,7 +3136,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3065
3136
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
3066
3137
|
* @secure
|
|
3067
3138
|
*/
|
|
3068
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3139
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputR89Sd266I6, params?: RequestParams) => Promise<any>;
|
|
3069
3140
|
/**
|
|
3070
3141
|
* @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.
|
|
3071
3142
|
*
|
|
@@ -3075,7 +3146,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3075
3146
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
3076
3147
|
* @secure
|
|
3077
3148
|
*/
|
|
3078
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
3149
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputS523Pjmwoa, params?: RequestParams) => Promise<any>;
|
|
3079
3150
|
/**
|
|
3080
3151
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
3081
3152
|
*
|
|
@@ -3085,7 +3156,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3085
3156
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
3086
3157
|
* @secure
|
|
3087
3158
|
*/
|
|
3088
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
3159
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: Input7Pkse4K1Q5, params?: RequestParams) => Promise<any>;
|
|
3089
3160
|
/**
|
|
3090
3161
|
* @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.
|
|
3091
3162
|
*
|
|
@@ -3125,7 +3196,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3125
3196
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
3126
3197
|
* @secure
|
|
3127
3198
|
*/
|
|
3128
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
3199
|
+
createCertificationWaive: (userId: string, certProcId: string, data: Input3Dqkxxnovwg, params?: RequestParams) => Promise<any>;
|
|
3129
3200
|
/**
|
|
3130
3201
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
3131
3202
|
*
|
|
@@ -3135,7 +3206,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3135
3206
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
3136
3207
|
* @secure
|
|
3137
3208
|
*/
|
|
3138
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3209
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputLakap8U75H>;
|
|
3139
3210
|
/**
|
|
3140
3211
|
* @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.
|
|
3141
3212
|
*
|
|
@@ -3175,7 +3246,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3175
3246
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
3176
3247
|
* @secure
|
|
3177
3248
|
*/
|
|
3178
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
3249
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputO15Aanoemr, params?: RequestParams) => Promise<any>;
|
|
3179
3250
|
/**
|
|
3180
3251
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
3181
3252
|
*
|
|
@@ -3235,7 +3306,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3235
3306
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3236
3307
|
* @secure
|
|
3237
3308
|
*/
|
|
3238
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
3309
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: InputQ6D0Sejtsf, params?: RequestParams) => Promise<any>;
|
|
3239
3310
|
/**
|
|
3240
3311
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3241
3312
|
*
|
|
@@ -3255,7 +3326,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3255
3326
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3256
3327
|
* @secure
|
|
3257
3328
|
*/
|
|
3258
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3329
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputMzh8Dry519, params?: RequestParams) => Promise<any>;
|
|
3259
3330
|
/**
|
|
3260
3331
|
* @description This route allows you to submit a pending approval.
|
|
3261
3332
|
*
|
|
@@ -3265,7 +3336,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3265
3336
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3266
3337
|
* @secure
|
|
3267
3338
|
*/
|
|
3268
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3339
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputIw7Hk3Mq5M, params?: RequestParams) => Promise<any>;
|
|
3269
3340
|
/**
|
|
3270
3341
|
* @description This route allows you to review a pending approval.
|
|
3271
3342
|
*
|
|
@@ -3275,7 +3346,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3275
3346
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3276
3347
|
* @secure
|
|
3277
3348
|
*/
|
|
3278
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3349
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputRaggvf9Tdaf, params?: RequestParams) => Promise<any>;
|
|
3279
3350
|
/**
|
|
3280
3351
|
* @description Redeems a license for a user by product ID.
|
|
3281
3352
|
*
|
|
@@ -3285,7 +3356,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3285
3356
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3286
3357
|
* @secure
|
|
3287
3358
|
*/
|
|
3288
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3359
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputLh0T8171Wqg, params?: RequestParams) => Promise<any>;
|
|
3289
3360
|
/**
|
|
3290
3361
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3291
3362
|
*
|
|
@@ -3295,7 +3366,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3295
3366
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3296
3367
|
* @secure
|
|
3297
3368
|
*/
|
|
3298
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3369
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputHmffu9Hc2H>;
|
|
3299
3370
|
/**
|
|
3300
3371
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3301
3372
|
*
|
|
@@ -3305,7 +3376,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3305
3376
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3306
3377
|
* @secure
|
|
3307
3378
|
*/
|
|
3308
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3379
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputLk5B7Priqt, params?: RequestParams) => Promise<any>;
|
|
3309
3380
|
/**
|
|
3310
3381
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3311
3382
|
*
|
|
@@ -3315,7 +3386,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3315
3386
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3316
3387
|
* @secure
|
|
3317
3388
|
*/
|
|
3318
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3389
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input90Jd0Xyanx, params?: RequestParams) => Promise<any>;
|
|
3319
3390
|
/**
|
|
3320
3391
|
* @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.
|
|
3321
3392
|
*
|
|
@@ -3325,7 +3396,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3325
3396
|
* @request POST:/user/{userID}/updateITA
|
|
3326
3397
|
* @secure
|
|
3327
3398
|
*/
|
|
3328
|
-
createUpdateIta: (userId: string, data:
|
|
3399
|
+
createUpdateIta: (userId: string, data: InputC9Nvfilwnd, params?: RequestParams) => Promise<any>;
|
|
3329
3400
|
/**
|
|
3330
3401
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3331
3402
|
*
|
|
@@ -3335,7 +3406,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3335
3406
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3336
3407
|
* @secure
|
|
3337
3408
|
*/
|
|
3338
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3409
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputSzdt1Ehw1F, params?: RequestParams) => Promise<any>;
|
|
3339
3410
|
/**
|
|
3340
3411
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3341
3412
|
*
|
|
@@ -3345,7 +3416,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3345
3416
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3346
3417
|
* @secure
|
|
3347
3418
|
*/
|
|
3348
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3419
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: Input504Pqmq2W3, params?: RequestParams) => Promise<any>;
|
|
3349
3420
|
/**
|
|
3350
3421
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3351
3422
|
*
|
|
@@ -3387,7 +3458,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3387
3458
|
* @request POST:/users/certification/{certSpecID}
|
|
3388
3459
|
* @secure
|
|
3389
3460
|
*/
|
|
3390
|
-
createCertification: (certSpecId: string, data:
|
|
3461
|
+
createCertification: (certSpecId: string, data: InputE48N2Qyfcu, params?: RequestParams) => Promise<OutputE48N2Qyfcu>;
|
|
3391
3462
|
/**
|
|
3392
3463
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3393
3464
|
*
|