@ikonintegration/bccsa-program-api 3.0.38 → 3.0.40
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 +471 -93
- package/dist/Api.d.ts +367 -102
- package/dist/Api.js +160 -8
- package/dist/Api.js.map +1 -1
- package/package.json +2 -2
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 InputPayanh5Rg7 {
|
|
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 InputLuf22Qfjwd {
|
|
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 Input7Vmuwipays {
|
|
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 Input2Aq4Pyagkd {
|
|
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 Input8Klnphf8Bc {
|
|
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 Input3Nox52Otw6 {
|
|
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 Input6Hyaakdeqh {
|
|
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 Input97Kt0K1U4M {
|
|
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 Input0Spjg5T0Z6L {
|
|
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 InputP41Mwrllc3J {
|
|
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 InputXoh70L5Ehi {
|
|
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 Input0Vk0Eax6Wa {
|
|
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 InputC8Zwd7Q8U9 {
|
|
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 Output8Atvagu67T {
|
|
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 OutputYasax7Adi6 {
|
|
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 OutputEro394Udh7 {
|
|
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 OutputWxu6Mostsg {
|
|
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 OutputG6Fp4O6Jqs {
|
|
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 Input6Xov0Uhvug {
|
|
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 InputS2I3Ncfw06I {
|
|
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 OutputDvz4Kpu7Qqf {
|
|
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 InputAkthwncsqzg {
|
|
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 InputYuieq8467B {
|
|
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 Input5Sm698V54Kl {
|
|
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 Input00Cup216Sw {
|
|
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 InputRiihigs1Zdi {
|
|
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 OutputRt315Aaaee {
|
|
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 Input9S37F7Gzue {
|
|
1653
1710
|
/**
|
|
1654
1711
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1655
1712
|
* @example "CHECKED"
|
|
1656
1713
|
*/
|
|
1657
|
-
value:
|
|
1714
|
+
value: Input9S37F7GzueValueEnum;
|
|
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 InputCc03755Grj {
|
|
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 InputQr67F4X9Qz {
|
|
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 Input1Gepy2Er06 {
|
|
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 Output1Gepy2Er06 {
|
|
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 Input2Ypeat3Q15H {
|
|
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 Input250S74Bjft {
|
|
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 OutputApyuuj0P1 {
|
|
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 InputL2Zy7U6Osi {
|
|
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 OutputXz9Iif7Elb {
|
|
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 InputHkz0Gc0Zaj {
|
|
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 Input09Umpjsbpm {
|
|
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 Input8Inz421X6C {
|
|
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 Input5Num6Uwu17K {
|
|
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 InputV0Qo4M776D {
|
|
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 InputGzpcnkmsxo {
|
|
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 InputC1Toblrnow {
|
|
2041
2098
|
/**
|
|
2042
2099
|
* The date when the course result expires, in milliseconds since epoch.
|
|
2043
2100
|
* @example 1735689600000
|
|
@@ -2051,14 +2108,100 @@ export interface InputFgo7Tyrxudl {
|
|
|
2051
2108
|
}
|
|
2052
2109
|
/** Reset sponsorship request takes no body */
|
|
2053
2110
|
export type ResetSponsorshipBody = object;
|
|
2054
|
-
|
|
2111
|
+
/** List of work hours records for a user */
|
|
2112
|
+
export type WorkHoursListResponse = WorkHoursResponseEntity[];
|
|
2113
|
+
/** Single work hours object */
|
|
2114
|
+
export interface WorkHoursResponseEntity {
|
|
2115
|
+
/** User who created the record */
|
|
2116
|
+
createdBy?: CreatedBy;
|
|
2117
|
+
/** Timestamp when the record was created */
|
|
2118
|
+
createdOn?: CreatedOn;
|
|
2119
|
+
/** User who last updated the record */
|
|
2120
|
+
updatedBy?: UpdatedBy;
|
|
2121
|
+
/** Timestamp of last update */
|
|
2122
|
+
updatedOn?: UpdatedOn;
|
|
2123
|
+
/** Entity identifier for work hours */
|
|
2124
|
+
dbEntity?: DbEntity;
|
|
2125
|
+
/** Unique identifier of the work hours record */
|
|
2126
|
+
id: Id;
|
|
2127
|
+
/** Tenant ID associated with the work hours record */
|
|
2128
|
+
tenantID: TenantID;
|
|
2129
|
+
/** User ID related with this work hours record */
|
|
2130
|
+
userID: UserID;
|
|
2131
|
+
/** Number of hours entered for a specific period */
|
|
2132
|
+
hours?: Hours;
|
|
2133
|
+
/** Initial date of the work period (timestamp) */
|
|
2134
|
+
initDate: InitDate;
|
|
2135
|
+
/** End date of the work period (timestamp) */
|
|
2136
|
+
endDate?: EndDate;
|
|
2137
|
+
/** Concrete pump categories the user selected to enter hours */
|
|
2138
|
+
categories?: Categories;
|
|
2139
|
+
/** Array of documents that prove the hours worked */
|
|
2140
|
+
attachments?: Attachments;
|
|
2141
|
+
}
|
|
2142
|
+
/** Number of hours entered for a specific period */
|
|
2143
|
+
export type Hours = number;
|
|
2144
|
+
/** Initial date of the work period (timestamp) */
|
|
2145
|
+
export type InitDate = number;
|
|
2146
|
+
/** End date of the work period (timestamp) */
|
|
2147
|
+
export type EndDate = number;
|
|
2148
|
+
/** Concrete pump categories the user selected to enter hours */
|
|
2149
|
+
export type Categories = string[];
|
|
2150
|
+
/** Array of documents that prove the hours worked */
|
|
2151
|
+
export type Attachments = {
|
|
2152
|
+
/** Identifier of the attachment file */
|
|
2153
|
+
fileID: string;
|
|
2154
|
+
/** Name of the attachment file */
|
|
2155
|
+
fileName: string;
|
|
2156
|
+
}[];
|
|
2157
|
+
/** Payload to create or update a work hours record */
|
|
2158
|
+
export interface WorkHoursWrite {
|
|
2159
|
+
/** @example 40 */
|
|
2160
|
+
hours?: number;
|
|
2161
|
+
/** @example 1717230000000 */
|
|
2162
|
+
initDate: number;
|
|
2163
|
+
/** @example 1717830000000 */
|
|
2164
|
+
endDate?: number;
|
|
2165
|
+
/** @example ["boom","line"] */
|
|
2166
|
+
categories?: string[];
|
|
2167
|
+
/** @example [{"fileID":"fileID","fileName":"proof.pdf"}] */
|
|
2168
|
+
attachments?: {
|
|
2169
|
+
/**
|
|
2170
|
+
* @minLength 1
|
|
2171
|
+
* @example "fileID"
|
|
2172
|
+
*/
|
|
2173
|
+
fileID: string;
|
|
2174
|
+
/**
|
|
2175
|
+
* @minLength 1
|
|
2176
|
+
* @example "proof.pdf"
|
|
2177
|
+
*/
|
|
2178
|
+
fileName: string;
|
|
2179
|
+
}[];
|
|
2180
|
+
}
|
|
2181
|
+
/** Work hours file response */
|
|
2182
|
+
export interface OutputEhwsfr213Q {
|
|
2183
|
+
/**
|
|
2184
|
+
* Signed URL for the work hours file
|
|
2185
|
+
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
|
|
2186
|
+
*/
|
|
2187
|
+
fileURL: string;
|
|
2188
|
+
}
|
|
2189
|
+
/** Work hours file response */
|
|
2190
|
+
export interface OutputK0Lpmp4384 {
|
|
2191
|
+
/**
|
|
2192
|
+
* Signed URL for the work hours file
|
|
2193
|
+
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
|
|
2194
|
+
*/
|
|
2195
|
+
fileURL: string;
|
|
2196
|
+
}
|
|
2197
|
+
export interface Input3T6Epmw0B5 {
|
|
2055
2198
|
filter: {
|
|
2056
2199
|
from?: number;
|
|
2057
2200
|
sortOrder?: string;
|
|
2058
2201
|
sortField?: string;
|
|
2059
2202
|
};
|
|
2060
2203
|
}
|
|
2061
|
-
export interface
|
|
2204
|
+
export interface Output3T6Epmw0B5 {
|
|
2062
2205
|
users: {
|
|
2063
2206
|
firstName: string;
|
|
2064
2207
|
lastName: string;
|
|
@@ -2082,7 +2225,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
2082
2225
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
2083
2226
|
* @example "CHECKED"
|
|
2084
2227
|
*/
|
|
2085
|
-
export declare enum
|
|
2228
|
+
export declare enum Input9S37F7GzueValueEnum {
|
|
2086
2229
|
CHECKED = "CHECKED",
|
|
2087
2230
|
UNCHECKED = "UNCHECKED",
|
|
2088
2231
|
NOVALUE = "NOVALUE"
|
|
@@ -2115,6 +2258,8 @@ export interface GetEventsParams {
|
|
|
2115
2258
|
}
|
|
2116
2259
|
export type GetEventsData = any;
|
|
2117
2260
|
export type GetEventsError = ErrorResponse;
|
|
2261
|
+
export type UpdateApproveData = any;
|
|
2262
|
+
export type UpdateApproveError = ErrorResponse;
|
|
2118
2263
|
export type DeleteOrgData = any;
|
|
2119
2264
|
export type DeleteOrgError = ErrorResponse;
|
|
2120
2265
|
export interface ListReportAffiliateParams {
|
|
@@ -2181,7 +2326,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2181
2326
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2182
2327
|
export type CreateReportUsersSimpleData = any;
|
|
2183
2328
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2184
|
-
export type CreateSearchUsersCountData =
|
|
2329
|
+
export type CreateSearchUsersCountData = Output8Atvagu67T;
|
|
2185
2330
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2186
2331
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2187
2332
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2205,7 +2350,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2205
2350
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2206
2351
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2207
2352
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2208
|
-
export type GetCertificationCourseFileSignData =
|
|
2353
|
+
export type GetCertificationCourseFileSignData = OutputWxu6Mostsg;
|
|
2209
2354
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2210
2355
|
export interface CreateCertificationCourseFileSignParams {
|
|
2211
2356
|
/** @example "pdf" */
|
|
@@ -2219,11 +2364,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2219
2364
|
/** @example "fileID" */
|
|
2220
2365
|
fileId: string;
|
|
2221
2366
|
}
|
|
2222
|
-
export type CreateCertificationCourseFileSignData =
|
|
2367
|
+
export type CreateCertificationCourseFileSignData = OutputXz9Iif7Elb;
|
|
2223
2368
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2224
2369
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2225
2370
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2226
|
-
export type CreateCertificationCourseDocumentData =
|
|
2371
|
+
export type CreateCertificationCourseDocumentData = Output1Gepy2Er06;
|
|
2227
2372
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2228
2373
|
export type DeleteSponsorshipPendingApprovalData = any;
|
|
2229
2374
|
export type DeleteSponsorshipPendingApprovalError = ErrorResponse;
|
|
@@ -2239,7 +2384,7 @@ export type UpdateUserData = any;
|
|
|
2239
2384
|
export type UpdateUserError = ErrorResponse;
|
|
2240
2385
|
export type DeleteCertificationCourseData = any;
|
|
2241
2386
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2242
|
-
export type GetCertificationApplicationItemFileData =
|
|
2387
|
+
export type GetCertificationApplicationItemFileData = OutputYasax7Adi6;
|
|
2243
2388
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2244
2389
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2245
2390
|
/** @example "pdf" */
|
|
@@ -2253,9 +2398,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2253
2398
|
/** @example "fileVersion" */
|
|
2254
2399
|
fileVersion: string;
|
|
2255
2400
|
}
|
|
2256
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2401
|
+
export type CreateCertificationApplicationItemFileData = OutputDvz4Kpu7Qqf;
|
|
2257
2402
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2258
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2403
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputEro394Udh7;
|
|
2259
2404
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2260
2405
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2261
2406
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2263,7 +2408,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2263
2408
|
export type GetCourseError = ErrorResponse;
|
|
2264
2409
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2265
2410
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2266
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2411
|
+
export type GetCertificationApplicationForeignFillData = OutputG6Fp4O6Jqs;
|
|
2267
2412
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2268
2413
|
export type GetCertificationPrintData = any;
|
|
2269
2414
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2297,7 +2442,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2297
2442
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2298
2443
|
export type CreateCertificationWaiveData = any;
|
|
2299
2444
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2300
|
-
export type CreateCertificationMoveData =
|
|
2445
|
+
export type CreateCertificationMoveData = OutputRt315Aaaee;
|
|
2301
2446
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2302
2447
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2303
2448
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2329,7 +2474,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2329
2474
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2330
2475
|
export type CreateCertificationCourseRedeemData = any;
|
|
2331
2476
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2332
|
-
export type CreateCertificationMoveValidateData =
|
|
2477
|
+
export type CreateCertificationMoveValidateData = OutputApyuuj0P1;
|
|
2333
2478
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2334
2479
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2335
2480
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2347,7 +2492,33 @@ export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
|
2347
2492
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2348
2493
|
export type CreateSponsorshipResetData = any;
|
|
2349
2494
|
export type CreateSponsorshipResetError = ErrorResponse;
|
|
2350
|
-
export type
|
|
2495
|
+
export type GetWorkHoursData = WorkHoursListResponse;
|
|
2496
|
+
export type GetWorkHoursError = ErrorResponse;
|
|
2497
|
+
export type GetWorkHours2Data = WorkHoursResponseEntity;
|
|
2498
|
+
export type GetWorkHours2Error = ErrorResponse;
|
|
2499
|
+
export type ListWorkHoursData = WorkHoursResponseEntity;
|
|
2500
|
+
export type ListWorkHoursError = ErrorResponse;
|
|
2501
|
+
export type UpdateWorkHoursData = WorkHoursResponseEntity;
|
|
2502
|
+
export type UpdateWorkHoursError = ErrorResponse;
|
|
2503
|
+
export type DeleteWorkHoursData = any;
|
|
2504
|
+
export type DeleteWorkHoursError = ErrorResponse;
|
|
2505
|
+
export interface CreateWorkHoursFileSignParams {
|
|
2506
|
+
/** @example "pdf" */
|
|
2507
|
+
fileType: string;
|
|
2508
|
+
/** @example "userID" */
|
|
2509
|
+
userId: string;
|
|
2510
|
+
/** @example "workHoursID" */
|
|
2511
|
+
workHoursId: string;
|
|
2512
|
+
/** @example "fileID" */
|
|
2513
|
+
fileId: string;
|
|
2514
|
+
}
|
|
2515
|
+
export type CreateWorkHoursFileSignData = OutputEhwsfr213Q;
|
|
2516
|
+
export type CreateWorkHoursFileSignError = ErrorResponse;
|
|
2517
|
+
export type DeleteWorkHoursFileSignData = any;
|
|
2518
|
+
export type DeleteWorkHoursFileSignError = ErrorResponse;
|
|
2519
|
+
export type GetWorkHoursFileSignData = OutputK0Lpmp4384;
|
|
2520
|
+
export type GetWorkHoursFileSignError = ErrorResponse;
|
|
2521
|
+
export type CreateCertificationResult = Output3T6Epmw0B5;
|
|
2351
2522
|
export type CreateCertificationFail = ErrorResponse;
|
|
2352
2523
|
export type CreateCertificationPublishInfoResult = any;
|
|
2353
2524
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2394,7 +2565,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2394
2565
|
}
|
|
2395
2566
|
/**
|
|
2396
2567
|
* @title BCCSA Program API
|
|
2397
|
-
* @version 3.0.
|
|
2568
|
+
* @version 3.0.40
|
|
2398
2569
|
* @baseUrl http://localhost:8080
|
|
2399
2570
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2400
2571
|
*/
|
|
@@ -2409,7 +2580,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2409
2580
|
* @request POST:/contactUs
|
|
2410
2581
|
* @secure
|
|
2411
2582
|
*/
|
|
2412
|
-
listContactUs: (data:
|
|
2583
|
+
listContactUs: (data: InputPayanh5Rg7, params?: RequestParams) => Promise<any>;
|
|
2413
2584
|
};
|
|
2414
2585
|
customer: {
|
|
2415
2586
|
/**
|
|
@@ -2443,6 +2614,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2443
2614
|
*/
|
|
2444
2615
|
getEvents: ({ startTime, endTime, ...query }: GetEventsParams, params?: RequestParams) => Promise<any>;
|
|
2445
2616
|
};
|
|
2617
|
+
sponsorship: {
|
|
2618
|
+
/**
|
|
2619
|
+
* @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.
|
|
2620
|
+
*
|
|
2621
|
+
* @tags Sponsorship
|
|
2622
|
+
* @name UpdateApprove
|
|
2623
|
+
* @summary Approve Sponsorship Request
|
|
2624
|
+
* @request PUT:/sponsorship/approve/{paID}
|
|
2625
|
+
* @secure
|
|
2626
|
+
*/
|
|
2627
|
+
updateApprove: (paId: string, data: InputLuf22Qfjwd, params?: RequestParams) => Promise<any>;
|
|
2628
|
+
};
|
|
2446
2629
|
tenant: {
|
|
2447
2630
|
/**
|
|
2448
2631
|
* @description Delete bridge
|
|
@@ -2513,7 +2696,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2513
2696
|
* @request POST:/tenant/report/applicationExport
|
|
2514
2697
|
* @secure
|
|
2515
2698
|
*/
|
|
2516
|
-
createReportApplicationExport: (data:
|
|
2699
|
+
createReportApplicationExport: (data: Input7Vmuwipays, params?: RequestParams) => Promise<any>;
|
|
2517
2700
|
/**
|
|
2518
2701
|
* @description Export a report of applications based on the provided filters.
|
|
2519
2702
|
*
|
|
@@ -2523,7 +2706,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2523
2706
|
* @request POST:/tenant/report/applicationStatus
|
|
2524
2707
|
* @secure
|
|
2525
2708
|
*/
|
|
2526
|
-
listReportApplicationStatus: (data:
|
|
2709
|
+
listReportApplicationStatus: (data: Input2Aq4Pyagkd, params?: RequestParams) => Promise<any>;
|
|
2527
2710
|
/**
|
|
2528
2711
|
* @description Export a report of applications based on the provided filters.
|
|
2529
2712
|
*
|
|
@@ -2533,7 +2716,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2533
2716
|
* @request POST:/tenant/report/applicationsReport
|
|
2534
2717
|
* @secure
|
|
2535
2718
|
*/
|
|
2536
|
-
createReportApplicationsReport: (data:
|
|
2719
|
+
createReportApplicationsReport: (data: Input8Klnphf8Bc, params?: RequestParams) => Promise<any>;
|
|
2537
2720
|
/**
|
|
2538
2721
|
* @description This route allows you to post certificates email for the tenant.
|
|
2539
2722
|
*
|
|
@@ -2543,7 +2726,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2543
2726
|
* @request POST:/tenant/certificates/email
|
|
2544
2727
|
* @secure
|
|
2545
2728
|
*/
|
|
2546
|
-
createCertificatesEmail: (data:
|
|
2729
|
+
createCertificatesEmail: (data: Input3Nox52Otw6, params?: RequestParams) => Promise<any>;
|
|
2547
2730
|
/**
|
|
2548
2731
|
* @description Generate a preview of the completed certifications report.
|
|
2549
2732
|
*
|
|
@@ -2573,7 +2756,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2573
2756
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2574
2757
|
* @secure
|
|
2575
2758
|
*/
|
|
2576
|
-
createLicenseRedeem: (userId: string, data:
|
|
2759
|
+
createLicenseRedeem: (userId: string, data: Input6Hyaakdeqh, params?: RequestParams) => Promise<any>;
|
|
2577
2760
|
/**
|
|
2578
2761
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2579
2762
|
*
|
|
@@ -2583,7 +2766,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2583
2766
|
* @request POST:/tenant/report/orglicenses/
|
|
2584
2767
|
* @secure
|
|
2585
2768
|
*/
|
|
2586
|
-
listReportOrglicenses: (data:
|
|
2769
|
+
listReportOrglicenses: (data: Input97Kt0K1U4M, params?: RequestParams) => Promise<any>;
|
|
2587
2770
|
/**
|
|
2588
2771
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2589
2772
|
*
|
|
@@ -2593,7 +2776,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2593
2776
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2594
2777
|
* @secure
|
|
2595
2778
|
*/
|
|
2596
|
-
createReportOrglicensesPreview: (data:
|
|
2779
|
+
createReportOrglicensesPreview: (data: Input0Spjg5T0Z6L, params?: RequestParams) => Promise<any>;
|
|
2597
2780
|
/**
|
|
2598
2781
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2599
2782
|
*
|
|
@@ -2633,7 +2816,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2633
2816
|
* @request POST:/tenant/report/users/advanced
|
|
2634
2817
|
* @secure
|
|
2635
2818
|
*/
|
|
2636
|
-
createReportUsersAdvanced: (data:
|
|
2819
|
+
createReportUsersAdvanced: (data: InputP41Mwrllc3J, params?: RequestParams) => Promise<any>;
|
|
2637
2820
|
/**
|
|
2638
2821
|
* @description Searches for users in the tenant by their IDs.
|
|
2639
2822
|
*
|
|
@@ -2643,7 +2826,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2643
2826
|
* @request POST:/tenant/search/users/ids
|
|
2644
2827
|
* @secure
|
|
2645
2828
|
*/
|
|
2646
|
-
listSearchUsersIds: (data:
|
|
2829
|
+
listSearchUsersIds: (data: InputXoh70L5Ehi, params?: RequestParams) => Promise<any>;
|
|
2647
2830
|
/**
|
|
2648
2831
|
* @description Searches for users in the tenant by term and filters.
|
|
2649
2832
|
*
|
|
@@ -2653,7 +2836,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2653
2836
|
* @request POST:/tenant/search/users/term
|
|
2654
2837
|
* @secure
|
|
2655
2838
|
*/
|
|
2656
|
-
createSearchUsersTerm: (data:
|
|
2839
|
+
createSearchUsersTerm: (data: Input0Vk0Eax6Wa, params?: RequestParams) => Promise<any>;
|
|
2657
2840
|
/**
|
|
2658
2841
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2659
2842
|
*
|
|
@@ -2663,7 +2846,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2663
2846
|
* @request POST:/tenant/report/users/simple
|
|
2664
2847
|
* @secure
|
|
2665
2848
|
*/
|
|
2666
|
-
createReportUsersSimple: (data:
|
|
2849
|
+
createReportUsersSimple: (data: InputC8Zwd7Q8U9, params?: RequestParams) => Promise<any>;
|
|
2667
2850
|
/**
|
|
2668
2851
|
* @description Retrieve user by ID.
|
|
2669
2852
|
*
|
|
@@ -2673,7 +2856,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2673
2856
|
* @request POST:/tenant/search/users/count
|
|
2674
2857
|
* @secure
|
|
2675
2858
|
*/
|
|
2676
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2859
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<Output8Atvagu67T>;
|
|
2677
2860
|
};
|
|
2678
2861
|
user: {
|
|
2679
2862
|
/**
|
|
@@ -2705,7 +2888,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2705
2888
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2706
2889
|
* @secure
|
|
2707
2890
|
*/
|
|
2708
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2891
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: Input6Xov0Uhvug, params?: RequestParams) => Promise<any>;
|
|
2709
2892
|
/**
|
|
2710
2893
|
* @description Delete a certification process application by type.
|
|
2711
2894
|
*
|
|
@@ -2795,7 +2978,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2795
2978
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2796
2979
|
* @secure
|
|
2797
2980
|
*/
|
|
2798
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2981
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputWxu6Mostsg>;
|
|
2799
2982
|
/**
|
|
2800
2983
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2801
2984
|
*
|
|
@@ -2805,7 +2988,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2805
2988
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2806
2989
|
* @secure
|
|
2807
2990
|
*/
|
|
2808
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2991
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputXz9Iif7Elb>;
|
|
2809
2992
|
/**
|
|
2810
2993
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2811
2994
|
*
|
|
@@ -2825,7 +3008,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2825
3008
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2826
3009
|
* @secure
|
|
2827
3010
|
*/
|
|
2828
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
3011
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: Input1Gepy2Er06, params?: RequestParams) => Promise<Output1Gepy2Er06>;
|
|
2829
3012
|
/**
|
|
2830
3013
|
* @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
3014
|
*
|
|
@@ -2875,7 +3058,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2875
3058
|
* @request POST:/user/{userID}
|
|
2876
3059
|
* @secure
|
|
2877
3060
|
*/
|
|
2878
|
-
createUser: (userId: string, data:
|
|
3061
|
+
createUser: (userId: string, data: InputHkz0Gc0Zaj, params?: RequestParams) => Promise<any>;
|
|
2879
3062
|
/**
|
|
2880
3063
|
* @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
3064
|
*
|
|
@@ -2885,7 +3068,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2885
3068
|
* @request PUT:/user/{userID}
|
|
2886
3069
|
* @secure
|
|
2887
3070
|
*/
|
|
2888
|
-
updateUser: (userId: string, data:
|
|
3071
|
+
updateUser: (userId: string, data: Input5Num6Uwu17K, params?: RequestParams) => Promise<any>;
|
|
2889
3072
|
/**
|
|
2890
3073
|
* @description Delete course from user
|
|
2891
3074
|
*
|
|
@@ -2905,7 +3088,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2905
3088
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2906
3089
|
* @secure
|
|
2907
3090
|
*/
|
|
2908
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
3091
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputYasax7Adi6>;
|
|
2909
3092
|
/**
|
|
2910
3093
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2911
3094
|
*
|
|
@@ -2915,7 +3098,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2915
3098
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2916
3099
|
* @secure
|
|
2917
3100
|
*/
|
|
2918
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
3101
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputDvz4Kpu7Qqf>;
|
|
2919
3102
|
/**
|
|
2920
3103
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2921
3104
|
*
|
|
@@ -2925,7 +3108,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2925
3108
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2926
3109
|
* @secure
|
|
2927
3110
|
*/
|
|
2928
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
3111
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputEro394Udh7>;
|
|
2929
3112
|
/**
|
|
2930
3113
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2931
3114
|
*
|
|
@@ -2965,7 +3148,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2965
3148
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2966
3149
|
* @secure
|
|
2967
3150
|
*/
|
|
2968
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
3151
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputG6Fp4O6Jqs>;
|
|
2969
3152
|
/**
|
|
2970
3153
|
* @description This endpoint will print certificate
|
|
2971
3154
|
*
|
|
@@ -3025,7 +3208,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3025
3208
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
3026
3209
|
* @secure
|
|
3027
3210
|
*/
|
|
3028
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
3211
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputS2I3Ncfw06I, params?: RequestParams) => Promise<any>;
|
|
3029
3212
|
/**
|
|
3030
3213
|
* @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
3214
|
*
|
|
@@ -3055,7 +3238,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3055
3238
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
3056
3239
|
* @secure
|
|
3057
3240
|
*/
|
|
3058
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3241
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputAkthwncsqzg, params?: RequestParams) => Promise<any>;
|
|
3059
3242
|
/**
|
|
3060
3243
|
* @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
3244
|
*
|
|
@@ -3065,7 +3248,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3065
3248
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
3066
3249
|
* @secure
|
|
3067
3250
|
*/
|
|
3068
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3251
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputYuieq8467B, params?: RequestParams) => Promise<any>;
|
|
3069
3252
|
/**
|
|
3070
3253
|
* @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
3254
|
*
|
|
@@ -3075,7 +3258,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3075
3258
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
3076
3259
|
* @secure
|
|
3077
3260
|
*/
|
|
3078
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
3261
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: Input5Sm698V54Kl, params?: RequestParams) => Promise<any>;
|
|
3079
3262
|
/**
|
|
3080
3263
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
3081
3264
|
*
|
|
@@ -3085,7 +3268,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3085
3268
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
3086
3269
|
* @secure
|
|
3087
3270
|
*/
|
|
3088
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
3271
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: Input00Cup216Sw, params?: RequestParams) => Promise<any>;
|
|
3089
3272
|
/**
|
|
3090
3273
|
* @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
3274
|
*
|
|
@@ -3125,7 +3308,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3125
3308
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
3126
3309
|
* @secure
|
|
3127
3310
|
*/
|
|
3128
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
3311
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputRiihigs1Zdi, params?: RequestParams) => Promise<any>;
|
|
3129
3312
|
/**
|
|
3130
3313
|
* @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
3314
|
*
|
|
@@ -3135,7 +3318,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3135
3318
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
3136
3319
|
* @secure
|
|
3137
3320
|
*/
|
|
3138
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3321
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputRt315Aaaee>;
|
|
3139
3322
|
/**
|
|
3140
3323
|
* @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
3324
|
*
|
|
@@ -3175,7 +3358,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3175
3358
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
3176
3359
|
* @secure
|
|
3177
3360
|
*/
|
|
3178
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
3361
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: Input9S37F7Gzue, params?: RequestParams) => Promise<any>;
|
|
3179
3362
|
/**
|
|
3180
3363
|
* @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
3364
|
*
|
|
@@ -3235,7 +3418,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3235
3418
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3236
3419
|
* @secure
|
|
3237
3420
|
*/
|
|
3238
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
3421
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: InputCc03755Grj, params?: RequestParams) => Promise<any>;
|
|
3239
3422
|
/**
|
|
3240
3423
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3241
3424
|
*
|
|
@@ -3255,7 +3438,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3255
3438
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3256
3439
|
* @secure
|
|
3257
3440
|
*/
|
|
3258
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3441
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputQr67F4X9Qz, params?: RequestParams) => Promise<any>;
|
|
3259
3442
|
/**
|
|
3260
3443
|
* @description This route allows you to submit a pending approval.
|
|
3261
3444
|
*
|
|
@@ -3265,7 +3448,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3265
3448
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3266
3449
|
* @secure
|
|
3267
3450
|
*/
|
|
3268
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3451
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: Input2Ypeat3Q15H, params?: RequestParams) => Promise<any>;
|
|
3269
3452
|
/**
|
|
3270
3453
|
* @description This route allows you to review a pending approval.
|
|
3271
3454
|
*
|
|
@@ -3275,7 +3458,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3275
3458
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3276
3459
|
* @secure
|
|
3277
3460
|
*/
|
|
3278
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3461
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputGzpcnkmsxo, params?: RequestParams) => Promise<any>;
|
|
3279
3462
|
/**
|
|
3280
3463
|
* @description Redeems a license for a user by product ID.
|
|
3281
3464
|
*
|
|
@@ -3285,7 +3468,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3285
3468
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3286
3469
|
* @secure
|
|
3287
3470
|
*/
|
|
3288
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3471
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: Input250S74Bjft, params?: RequestParams) => Promise<any>;
|
|
3289
3472
|
/**
|
|
3290
3473
|
* @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
3474
|
*
|
|
@@ -3295,7 +3478,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3295
3478
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3296
3479
|
* @secure
|
|
3297
3480
|
*/
|
|
3298
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3481
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputApyuuj0P1>;
|
|
3299
3482
|
/**
|
|
3300
3483
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3301
3484
|
*
|
|
@@ -3305,7 +3488,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3305
3488
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3306
3489
|
* @secure
|
|
3307
3490
|
*/
|
|
3308
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3491
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputL2Zy7U6Osi, params?: RequestParams) => Promise<any>;
|
|
3309
3492
|
/**
|
|
3310
3493
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3311
3494
|
*
|
|
@@ -3315,7 +3498,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3315
3498
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3316
3499
|
* @secure
|
|
3317
3500
|
*/
|
|
3318
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3501
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input09Umpjsbpm, params?: RequestParams) => Promise<any>;
|
|
3319
3502
|
/**
|
|
3320
3503
|
* @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
3504
|
*
|
|
@@ -3325,7 +3508,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3325
3508
|
* @request POST:/user/{userID}/updateITA
|
|
3326
3509
|
* @secure
|
|
3327
3510
|
*/
|
|
3328
|
-
createUpdateIta: (userId: string, data:
|
|
3511
|
+
createUpdateIta: (userId: string, data: Input8Inz421X6C, params?: RequestParams) => Promise<any>;
|
|
3329
3512
|
/**
|
|
3330
3513
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3331
3514
|
*
|
|
@@ -3335,7 +3518,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3335
3518
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3336
3519
|
* @secure
|
|
3337
3520
|
*/
|
|
3338
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3521
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputV0Qo4M776D, params?: RequestParams) => Promise<any>;
|
|
3339
3522
|
/**
|
|
3340
3523
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3341
3524
|
*
|
|
@@ -3345,7 +3528,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3345
3528
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3346
3529
|
* @secure
|
|
3347
3530
|
*/
|
|
3348
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3531
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputC1Toblrnow, params?: RequestParams) => Promise<any>;
|
|
3349
3532
|
/**
|
|
3350
3533
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3351
3534
|
*
|
|
@@ -3376,6 +3559,88 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3376
3559
|
* @secure
|
|
3377
3560
|
*/
|
|
3378
3561
|
createSponsorshipReset: (userId: string, data: ResetSponsorshipBody, params?: RequestParams) => Promise<any>;
|
|
3562
|
+
/**
|
|
3563
|
+
* @description Retrieve all work hours records (proof of experience) for a user.
|
|
3564
|
+
*
|
|
3565
|
+
* @tags WorkHours
|
|
3566
|
+
* @name GetWorkHours
|
|
3567
|
+
* @summary List User Work Hours
|
|
3568
|
+
* @request GET:/user/{userID}/workHours
|
|
3569
|
+
* @secure
|
|
3570
|
+
*/
|
|
3571
|
+
getWorkHours: (userId: string, params?: RequestParams) => Promise<WorkHoursListResponse>;
|
|
3572
|
+
/**
|
|
3573
|
+
* @description Retrieve a single work hours record (proof of experience) for a user by its ID.
|
|
3574
|
+
*
|
|
3575
|
+
* @tags WorkHours
|
|
3576
|
+
* @name GetWorkHours2
|
|
3577
|
+
* @summary Get User Work Hours
|
|
3578
|
+
* @request GET:/user/{userID}/workHours/{workHoursID}
|
|
3579
|
+
* @originalName getWorkHours
|
|
3580
|
+
* @duplicate
|
|
3581
|
+
* @secure
|
|
3582
|
+
*/
|
|
3583
|
+
getWorkHours2: (userId: string, workHoursId: string, params?: RequestParams) => Promise<WorkHoursResponseEntity>;
|
|
3584
|
+
/**
|
|
3585
|
+
* @description Create a new work hours record (proof of experience) for a user. Use "new" as the workHoursID path parameter to create a new entry.
|
|
3586
|
+
*
|
|
3587
|
+
* @tags WorkHours
|
|
3588
|
+
* @name ListWorkHours
|
|
3589
|
+
* @summary Create User Work Hours
|
|
3590
|
+
* @request POST:/user/{userID}/workHours/{workHoursID}
|
|
3591
|
+
* @secure
|
|
3592
|
+
*/
|
|
3593
|
+
listWorkHours: (userId: string, workHoursId: string, data: WorkHoursWrite, params?: RequestParams) => Promise<WorkHoursResponseEntity>;
|
|
3594
|
+
/**
|
|
3595
|
+
* @description Update an existing work hours record (proof of experience) for a user.
|
|
3596
|
+
*
|
|
3597
|
+
* @tags WorkHours
|
|
3598
|
+
* @name UpdateWorkHours
|
|
3599
|
+
* @summary Update User Work Hours
|
|
3600
|
+
* @request PUT:/user/{userID}/workHours/{workHoursID}
|
|
3601
|
+
* @secure
|
|
3602
|
+
*/
|
|
3603
|
+
updateWorkHours: (userId: string, workHoursId: string, data: WorkHoursWrite, params?: RequestParams) => Promise<WorkHoursResponseEntity>;
|
|
3604
|
+
/**
|
|
3605
|
+
* @description Delete a work hours record (proof of experience) for a user by its ID.
|
|
3606
|
+
*
|
|
3607
|
+
* @tags WorkHours
|
|
3608
|
+
* @name DeleteWorkHours
|
|
3609
|
+
* @summary Delete User Work Hours
|
|
3610
|
+
* @request DELETE:/user/{userID}/workHours/{workHoursID}
|
|
3611
|
+
* @secure
|
|
3612
|
+
*/
|
|
3613
|
+
deleteWorkHours: (userId: string, workHoursId: string, params?: RequestParams) => Promise<any>;
|
|
3614
|
+
/**
|
|
3615
|
+
* @description This route allows you to create a signed URL to upload a work hours file for a user.
|
|
3616
|
+
*
|
|
3617
|
+
* @tags WorkHours
|
|
3618
|
+
* @name CreateWorkHoursFileSign
|
|
3619
|
+
* @summary Work hours file
|
|
3620
|
+
* @request POST:/user/{userID}/workHours/{workHoursID}/fileSign/{fileID}
|
|
3621
|
+
* @secure
|
|
3622
|
+
*/
|
|
3623
|
+
createWorkHoursFileSign: ({ userId, workHoursId, fileId, ...query }: CreateWorkHoursFileSignParams, params?: RequestParams) => Promise<OutputEhwsfr213Q>;
|
|
3624
|
+
/**
|
|
3625
|
+
* @description Delete a work hours file for a user.
|
|
3626
|
+
*
|
|
3627
|
+
* @tags WorkHours
|
|
3628
|
+
* @name DeleteWorkHoursFileSign
|
|
3629
|
+
* @summary Delete Work Hours File
|
|
3630
|
+
* @request DELETE:/user/{userID}/workHours/{workHoursID}/fileSign/{fileID}
|
|
3631
|
+
* @secure
|
|
3632
|
+
*/
|
|
3633
|
+
deleteWorkHoursFileSign: (userId: string, workHoursId: string, fileId: string, params?: RequestParams) => Promise<any>;
|
|
3634
|
+
/**
|
|
3635
|
+
* @description Retrieve a signed URL to download a work hours file for a user.
|
|
3636
|
+
*
|
|
3637
|
+
* @tags WorkHours
|
|
3638
|
+
* @name GetWorkHoursFileSign
|
|
3639
|
+
* @summary Get Work Hours File
|
|
3640
|
+
* @request GET:/user/{userID}/workHours/{workHoursID}/fileSign/{fileID}
|
|
3641
|
+
* @secure
|
|
3642
|
+
*/
|
|
3643
|
+
getWorkHoursFileSign: (userId: string, workHoursId: string, fileId: string, params?: RequestParams) => Promise<OutputK0Lpmp4384>;
|
|
3379
3644
|
};
|
|
3380
3645
|
users: {
|
|
3381
3646
|
/**
|
|
@@ -3387,7 +3652,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3387
3652
|
* @request POST:/users/certification/{certSpecID}
|
|
3388
3653
|
* @secure
|
|
3389
3654
|
*/
|
|
3390
|
-
createCertification: (certSpecId: string, data:
|
|
3655
|
+
createCertification: (certSpecId: string, data: Input3T6Epmw0B5, params?: RequestParams) => Promise<Output3T6Epmw0B5>;
|
|
3391
3656
|
/**
|
|
3392
3657
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3393
3658
|
*
|