@ikonintegration/bccsa-program-api 3.0.37 → 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 +240 -93
- package/dist/Api.d.ts +227 -102
- package/dist/Api.js +43 -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 InputN2Pbfp1G69 {
|
|
|
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 InputJ598Pbmrge {
|
|
|
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 InputZpvr6A88Xc {
|
|
|
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 InputC1Ye5Hwls5J {
|
|
|
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 InputSaxqz8G15X {
|
|
|
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 InputQdeponwb9F {
|
|
|
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 InputJh6321Ew32 {
|
|
|
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 InputCfab2Oqckr {
|
|
|
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 InputFyv0Tovwba {
|
|
|
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 OutputYz6Rjygfu2 {
|
|
|
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;
|
|
@@ -1379,6 +1436,41 @@ export type SourceType = string;
|
|
|
1379
1436
|
export type ExpiresOn = number;
|
|
1380
1437
|
/** Date when the result was achieved (e.g., passed) */
|
|
1381
1438
|
export type ResultDate = number;
|
|
1439
|
+
/** The retrieved sponsorship pending-approval record */
|
|
1440
|
+
export interface GetPendingApprovalResponse {
|
|
1441
|
+
/** @example "PA-abc123" */
|
|
1442
|
+
id: string;
|
|
1443
|
+
/** @example "SPONSOR_ATTESTATION" */
|
|
1444
|
+
type: string;
|
|
1445
|
+
/** @example "userID" */
|
|
1446
|
+
userID: string;
|
|
1447
|
+
/** @example "SRBC-01" */
|
|
1448
|
+
tenantID: string;
|
|
1449
|
+
certProcID?: string;
|
|
1450
|
+
courseID?: string;
|
|
1451
|
+
/** @example "PENDING" */
|
|
1452
|
+
approvalState?: string;
|
|
1453
|
+
approvalNotes?: string;
|
|
1454
|
+
reviewedBy?: string;
|
|
1455
|
+
reviewedOn?: number;
|
|
1456
|
+
createdBy?: string;
|
|
1457
|
+
createdOn?: number;
|
|
1458
|
+
updatedBy?: string;
|
|
1459
|
+
updatedOn?: number;
|
|
1460
|
+
sponsor?: {
|
|
1461
|
+
name?: string;
|
|
1462
|
+
phone?: string;
|
|
1463
|
+
email?: string;
|
|
1464
|
+
title?: string;
|
|
1465
|
+
};
|
|
1466
|
+
user?: {
|
|
1467
|
+
id?: string;
|
|
1468
|
+
name?: string;
|
|
1469
|
+
email?: string;
|
|
1470
|
+
};
|
|
1471
|
+
remindersStartedOn?: number;
|
|
1472
|
+
[key: string]: any;
|
|
1473
|
+
}
|
|
1382
1474
|
/** Response with list of user certification processes and it's upcoming courses and sessions */
|
|
1383
1475
|
export interface UserUpcomingCoursesResponseSchema {
|
|
1384
1476
|
procs?: {
|
|
@@ -1488,7 +1580,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1488
1580
|
applicationItems?: Record<string, any>[];
|
|
1489
1581
|
transactionID?: string | null;
|
|
1490
1582
|
}
|
|
1491
|
-
export interface
|
|
1583
|
+
export interface InputO6S14Hm8Ny {
|
|
1492
1584
|
issuedOn?: number;
|
|
1493
1585
|
expiresOn?: number;
|
|
1494
1586
|
fileItems?: {
|
|
@@ -1497,21 +1589,21 @@ export interface InputLok8Yjdg8Lf {
|
|
|
1497
1589
|
}[];
|
|
1498
1590
|
additionalNotes?: string | null;
|
|
1499
1591
|
}
|
|
1500
|
-
export interface
|
|
1592
|
+
export interface InputA30Shinbjtk {
|
|
1501
1593
|
/**
|
|
1502
1594
|
* Indicates whether the application is locked
|
|
1503
1595
|
* @example true
|
|
1504
1596
|
*/
|
|
1505
1597
|
isApplicationLocked: boolean;
|
|
1506
1598
|
}
|
|
1507
|
-
export interface
|
|
1599
|
+
export interface OutputW7312H25Cc {
|
|
1508
1600
|
/**
|
|
1509
1601
|
* Signed URL for the course file
|
|
1510
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"
|
|
1511
1603
|
*/
|
|
1512
1604
|
fileURL: string;
|
|
1513
1605
|
}
|
|
1514
|
-
export interface
|
|
1606
|
+
export interface InputHttuep0Xaa {
|
|
1515
1607
|
/**
|
|
1516
1608
|
* Indicates whether the waiver is approved
|
|
1517
1609
|
* @example true
|
|
@@ -1523,14 +1615,14 @@ export interface InputV9Pu8Hsooe {
|
|
|
1523
1615
|
*/
|
|
1524
1616
|
additionalNotes?: string | null;
|
|
1525
1617
|
}
|
|
1526
|
-
export interface
|
|
1618
|
+
export interface InputR89Sd266I6 {
|
|
1527
1619
|
/**
|
|
1528
1620
|
* Optional notes regarding the waiver
|
|
1529
1621
|
* @example "Waiver granted due to special circumstances."
|
|
1530
1622
|
*/
|
|
1531
1623
|
additionalNotes?: string | null;
|
|
1532
1624
|
}
|
|
1533
|
-
export interface
|
|
1625
|
+
export interface InputS523Pjmwoa {
|
|
1534
1626
|
students: {
|
|
1535
1627
|
/**
|
|
1536
1628
|
* User ID of the student to redeem the course for
|
|
@@ -1564,7 +1656,7 @@ export interface InputZv1Ikpfitw {
|
|
|
1564
1656
|
*/
|
|
1565
1657
|
autoEnrolSessionID?: string;
|
|
1566
1658
|
}
|
|
1567
|
-
export interface
|
|
1659
|
+
export interface Input7Pkse4K1Q5 {
|
|
1568
1660
|
invites: {
|
|
1569
1661
|
/**
|
|
1570
1662
|
* Email address of the user to invite
|
|
@@ -1593,7 +1685,7 @@ export interface InputNf5K52Xa14 {
|
|
|
1593
1685
|
*/
|
|
1594
1686
|
isReservedSeat: boolean;
|
|
1595
1687
|
}
|
|
1596
|
-
export interface
|
|
1688
|
+
export interface Input3Dqkxxnovwg {
|
|
1597
1689
|
/**
|
|
1598
1690
|
* Indicates whether to waive the certification process
|
|
1599
1691
|
* @example true
|
|
@@ -1606,7 +1698,7 @@ export interface Input1B88Huavnlf {
|
|
|
1606
1698
|
comments?: string | null;
|
|
1607
1699
|
}
|
|
1608
1700
|
/** Certification move response schema */
|
|
1609
|
-
export interface
|
|
1701
|
+
export interface OutputLakap8U75H {
|
|
1610
1702
|
errors?: {
|
|
1611
1703
|
status: string;
|
|
1612
1704
|
object?: Record<string, any>;
|
|
@@ -1614,19 +1706,19 @@ export interface OutputK40A9P4Wntj {
|
|
|
1614
1706
|
}[];
|
|
1615
1707
|
}
|
|
1616
1708
|
/** Schema for writing a certification trigger check. */
|
|
1617
|
-
export interface
|
|
1709
|
+
export interface InputO15Aanoemr {
|
|
1618
1710
|
/**
|
|
1619
1711
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1620
1712
|
* @example "CHECKED"
|
|
1621
1713
|
*/
|
|
1622
|
-
value:
|
|
1714
|
+
value: InputO15AanoemrValueEnum;
|
|
1623
1715
|
/**
|
|
1624
1716
|
* List of course IDs that are blocked by this trigger check.
|
|
1625
1717
|
* @example ["course1","course2"]
|
|
1626
1718
|
*/
|
|
1627
1719
|
blockedCourses?: string[];
|
|
1628
1720
|
}
|
|
1629
|
-
export interface
|
|
1721
|
+
export interface InputQ6D0Sejtsf {
|
|
1630
1722
|
/**
|
|
1631
1723
|
* Indicates whether the application item is approved
|
|
1632
1724
|
* @example true
|
|
@@ -1652,7 +1744,7 @@ export interface InputTyyk1Gva3F {
|
|
|
1652
1744
|
export interface StudentHistoryRequestSchema {
|
|
1653
1745
|
requirements: string[];
|
|
1654
1746
|
}
|
|
1655
|
-
export interface
|
|
1747
|
+
export interface InputMzh8Dry519 {
|
|
1656
1748
|
/**
|
|
1657
1749
|
* Optional activation key for the application
|
|
1658
1750
|
* @example "AK-123456"
|
|
@@ -1660,7 +1752,7 @@ export interface Input1Ud4Zfxio7 {
|
|
|
1660
1752
|
activationKey?: string;
|
|
1661
1753
|
}
|
|
1662
1754
|
/** Schema for course submission item details post request. */
|
|
1663
|
-
export interface
|
|
1755
|
+
export interface Input907Bqms0Gd {
|
|
1664
1756
|
/**
|
|
1665
1757
|
* The ID of the file being submitted.
|
|
1666
1758
|
* @example "fileID123"
|
|
@@ -1673,7 +1765,7 @@ export interface Input9Ar42O9Flp {
|
|
|
1673
1765
|
fileName: string;
|
|
1674
1766
|
}
|
|
1675
1767
|
/** Schema for the response to course submission item details post request. */
|
|
1676
|
-
export interface
|
|
1768
|
+
export interface Output907Bqms0Gd {
|
|
1677
1769
|
submissionItems: {
|
|
1678
1770
|
/**
|
|
1679
1771
|
* The ID of the file being submitted.
|
|
@@ -1688,7 +1780,7 @@ export interface Output9Ar42O9Flp {
|
|
|
1688
1780
|
}[];
|
|
1689
1781
|
}
|
|
1690
1782
|
/** Pending approval submission parameters */
|
|
1691
|
-
export interface
|
|
1783
|
+
export interface InputIw7Hk3Mq5M {
|
|
1692
1784
|
/**
|
|
1693
1785
|
* Type of pending approval
|
|
1694
1786
|
* @example "certification"
|
|
@@ -1708,7 +1800,7 @@ export interface Input83Eunpl3Y9 {
|
|
|
1708
1800
|
fileName: string;
|
|
1709
1801
|
}[];
|
|
1710
1802
|
}
|
|
1711
|
-
export interface
|
|
1803
|
+
export interface InputLh0T8171Wqg {
|
|
1712
1804
|
/**
|
|
1713
1805
|
* The ID of the course for which the license is being redeemed
|
|
1714
1806
|
* @example "courseID123"
|
|
@@ -1776,7 +1868,7 @@ export interface InputBvmzq8Voop {
|
|
|
1776
1868
|
acknowledgement?: string | null;
|
|
1777
1869
|
}
|
|
1778
1870
|
/** Validate certification move response schema */
|
|
1779
|
-
export interface
|
|
1871
|
+
export interface OutputHmffu9Hc2H {
|
|
1780
1872
|
courses: {
|
|
1781
1873
|
name: string;
|
|
1782
1874
|
status: string;
|
|
@@ -1787,21 +1879,21 @@ export interface OutputGbnglvar32H {
|
|
|
1787
1879
|
validated: boolean;
|
|
1788
1880
|
mustCreateCP: boolean;
|
|
1789
1881
|
}
|
|
1790
|
-
export interface
|
|
1882
|
+
export interface InputLk5B7Priqt {
|
|
1791
1883
|
/**
|
|
1792
1884
|
* Comments regarding the end of the cooldown period
|
|
1793
1885
|
* @example "Cooldown period ended successfully."
|
|
1794
1886
|
*/
|
|
1795
1887
|
comments: string;
|
|
1796
1888
|
}
|
|
1797
|
-
export interface
|
|
1889
|
+
export interface OutputC61Yutxgkz {
|
|
1798
1890
|
/**
|
|
1799
1891
|
* Signed URL for the course file
|
|
1800
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"
|
|
1801
1893
|
*/
|
|
1802
1894
|
fileURL: string;
|
|
1803
1895
|
}
|
|
1804
|
-
export interface
|
|
1896
|
+
export interface Input5Ajhwikstb {
|
|
1805
1897
|
/** @example true */
|
|
1806
1898
|
agreedWithCertTerms: boolean;
|
|
1807
1899
|
/** @example 1717230000000 */
|
|
@@ -1886,21 +1978,21 @@ export interface Sponsor {
|
|
|
1886
1978
|
/** Title of the sponsor of the student in the tenant */
|
|
1887
1979
|
title?: Title;
|
|
1888
1980
|
}
|
|
1889
|
-
export interface
|
|
1981
|
+
export interface Input90Jd0Xyanx {
|
|
1890
1982
|
/**
|
|
1891
1983
|
* Comments regarding the course unlock action
|
|
1892
1984
|
* @example "Course unlocked successfully."
|
|
1893
1985
|
*/
|
|
1894
1986
|
comments: string;
|
|
1895
1987
|
}
|
|
1896
|
-
export interface
|
|
1988
|
+
export interface InputC9Nvfilwnd {
|
|
1897
1989
|
/**
|
|
1898
1990
|
* ITA number to update for the user
|
|
1899
1991
|
* @example "ITA123456"
|
|
1900
1992
|
*/
|
|
1901
1993
|
itaNumber: string;
|
|
1902
1994
|
}
|
|
1903
|
-
export interface
|
|
1995
|
+
export interface InputVynk4V82Hlf {
|
|
1904
1996
|
/** @example true */
|
|
1905
1997
|
agreedWithCertTerms: boolean;
|
|
1906
1998
|
/** @example 1717230000000 */
|
|
@@ -1974,7 +2066,7 @@ export interface InputXumdodu3Vg {
|
|
|
1974
2066
|
/** Sponsor information for a student in the tenant */
|
|
1975
2067
|
sponsor?: Sponsor;
|
|
1976
2068
|
}
|
|
1977
|
-
export interface
|
|
2069
|
+
export interface InputSzdt1Ehw1F {
|
|
1978
2070
|
/**
|
|
1979
2071
|
* The grade to override the course result with
|
|
1980
2072
|
* @example "A"
|
|
@@ -1982,7 +2074,7 @@ export interface InputPpbi3Eojs7 {
|
|
|
1982
2074
|
resultGrade: string;
|
|
1983
2075
|
}
|
|
1984
2076
|
/** Pending approval review parameters */
|
|
1985
|
-
export interface
|
|
2077
|
+
export interface InputRaggvf9Tdaf {
|
|
1986
2078
|
/**
|
|
1987
2079
|
* Notes provided by the reviewer for the pending approval
|
|
1988
2080
|
* @example "Please review the submitted documents."
|
|
@@ -1993,9 +2085,16 @@ export interface Input9Vbbkncaff {
|
|
|
1993
2085
|
* @example true
|
|
1994
2086
|
*/
|
|
1995
2087
|
approved: boolean;
|
|
2088
|
+
/**
|
|
2089
|
+
* Timestamp (epoch milliseconds) of when the review was performed. Defaults to now when omitted.
|
|
2090
|
+
* @min 0
|
|
2091
|
+
* @exclusiveMin true
|
|
2092
|
+
* @example 1700000000000
|
|
2093
|
+
*/
|
|
2094
|
+
reviewedOn?: number;
|
|
1996
2095
|
}
|
|
1997
2096
|
/** Schema for overriding course result dates. */
|
|
1998
|
-
export interface
|
|
2097
|
+
export interface Input504Pqmq2W3 {
|
|
1999
2098
|
/**
|
|
2000
2099
|
* The date when the course result expires, in milliseconds since epoch.
|
|
2001
2100
|
* @example 1735689600000
|
|
@@ -2009,14 +2108,14 @@ export interface Input1Gg425Q9K7 {
|
|
|
2009
2108
|
}
|
|
2010
2109
|
/** Reset sponsorship request takes no body */
|
|
2011
2110
|
export type ResetSponsorshipBody = object;
|
|
2012
|
-
export interface
|
|
2111
|
+
export interface InputE48N2Qyfcu {
|
|
2013
2112
|
filter: {
|
|
2014
2113
|
from?: number;
|
|
2015
2114
|
sortOrder?: string;
|
|
2016
2115
|
sortField?: string;
|
|
2017
2116
|
};
|
|
2018
2117
|
}
|
|
2019
|
-
export interface
|
|
2118
|
+
export interface OutputE48N2Qyfcu {
|
|
2020
2119
|
users: {
|
|
2021
2120
|
firstName: string;
|
|
2022
2121
|
lastName: string;
|
|
@@ -2040,7 +2139,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
2040
2139
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
2041
2140
|
* @example "CHECKED"
|
|
2042
2141
|
*/
|
|
2043
|
-
export declare enum
|
|
2142
|
+
export declare enum InputO15AanoemrValueEnum {
|
|
2044
2143
|
CHECKED = "CHECKED",
|
|
2045
2144
|
UNCHECKED = "UNCHECKED",
|
|
2046
2145
|
NOVALUE = "NOVALUE"
|
|
@@ -2073,6 +2172,8 @@ export interface GetEventsParams {
|
|
|
2073
2172
|
}
|
|
2074
2173
|
export type GetEventsData = any;
|
|
2075
2174
|
export type GetEventsError = ErrorResponse;
|
|
2175
|
+
export type UpdateApproveData = any;
|
|
2176
|
+
export type UpdateApproveError = ErrorResponse;
|
|
2076
2177
|
export type DeleteOrgData = any;
|
|
2077
2178
|
export type DeleteOrgError = ErrorResponse;
|
|
2078
2179
|
export interface ListReportAffiliateParams {
|
|
@@ -2139,7 +2240,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2139
2240
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2140
2241
|
export type CreateReportUsersSimpleData = any;
|
|
2141
2242
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2142
|
-
export type CreateSearchUsersCountData =
|
|
2243
|
+
export type CreateSearchUsersCountData = Output5Bph624559;
|
|
2143
2244
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2144
2245
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2145
2246
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2163,7 +2264,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2163
2264
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2164
2265
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2165
2266
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2166
|
-
export type GetCertificationCourseFileSignData =
|
|
2267
|
+
export type GetCertificationCourseFileSignData = Output9Avku1Eafm;
|
|
2167
2268
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2168
2269
|
export interface CreateCertificationCourseFileSignParams {
|
|
2169
2270
|
/** @example "pdf" */
|
|
@@ -2177,14 +2278,16 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2177
2278
|
/** @example "fileID" */
|
|
2178
2279
|
fileId: string;
|
|
2179
2280
|
}
|
|
2180
|
-
export type CreateCertificationCourseFileSignData =
|
|
2281
|
+
export type CreateCertificationCourseFileSignData = OutputC61Yutxgkz;
|
|
2181
2282
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2182
2283
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2183
2284
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2184
|
-
export type CreateCertificationCourseDocumentData =
|
|
2285
|
+
export type CreateCertificationCourseDocumentData = Output907Bqms0Gd;
|
|
2185
2286
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2186
2287
|
export type DeleteSponsorshipPendingApprovalData = any;
|
|
2187
2288
|
export type DeleteSponsorshipPendingApprovalError = ErrorResponse;
|
|
2289
|
+
export type GetSponsorshipPendingApprovalData = GetPendingApprovalResponse;
|
|
2290
|
+
export type GetSponsorshipPendingApprovalError = ErrorResponse;
|
|
2188
2291
|
export type DeleteUserData = any;
|
|
2189
2292
|
export type DeleteUserError = ErrorResponse;
|
|
2190
2293
|
export type GetUserResult = UserResponseEntity;
|
|
@@ -2195,7 +2298,7 @@ export type UpdateUserData = any;
|
|
|
2195
2298
|
export type UpdateUserError = ErrorResponse;
|
|
2196
2299
|
export type DeleteCertificationCourseData = any;
|
|
2197
2300
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2198
|
-
export type GetCertificationApplicationItemFileData =
|
|
2301
|
+
export type GetCertificationApplicationItemFileData = Output0Mvvp8Ezlc;
|
|
2199
2302
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2200
2303
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2201
2304
|
/** @example "pdf" */
|
|
@@ -2209,9 +2312,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2209
2312
|
/** @example "fileVersion" */
|
|
2210
2313
|
fileVersion: string;
|
|
2211
2314
|
}
|
|
2212
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2315
|
+
export type CreateCertificationApplicationItemFileData = OutputW7312H25Cc;
|
|
2213
2316
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2214
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2317
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputR212F9Ykfn;
|
|
2215
2318
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2216
2319
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2217
2320
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2219,7 +2322,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2219
2322
|
export type GetCourseError = ErrorResponse;
|
|
2220
2323
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2221
2324
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2222
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2325
|
+
export type GetCertificationApplicationForeignFillData = OutputXbpkpl54M0I;
|
|
2223
2326
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2224
2327
|
export type GetCertificationPrintData = any;
|
|
2225
2328
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2253,7 +2356,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2253
2356
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2254
2357
|
export type CreateCertificationWaiveData = any;
|
|
2255
2358
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2256
|
-
export type CreateCertificationMoveData =
|
|
2359
|
+
export type CreateCertificationMoveData = OutputLakap8U75H;
|
|
2257
2360
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2258
2361
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2259
2362
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2285,7 +2388,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2285
2388
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2286
2389
|
export type CreateCertificationCourseRedeemData = any;
|
|
2287
2390
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2288
|
-
export type CreateCertificationMoveValidateData =
|
|
2391
|
+
export type CreateCertificationMoveValidateData = OutputHmffu9Hc2H;
|
|
2289
2392
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2290
2393
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2291
2394
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2303,7 +2406,7 @@ export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
|
2303
2406
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2304
2407
|
export type CreateSponsorshipResetData = any;
|
|
2305
2408
|
export type CreateSponsorshipResetError = ErrorResponse;
|
|
2306
|
-
export type CreateCertificationResult =
|
|
2409
|
+
export type CreateCertificationResult = OutputE48N2Qyfcu;
|
|
2307
2410
|
export type CreateCertificationFail = ErrorResponse;
|
|
2308
2411
|
export type CreateCertificationPublishInfoResult = any;
|
|
2309
2412
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2350,7 +2453,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2350
2453
|
}
|
|
2351
2454
|
/**
|
|
2352
2455
|
* @title BCCSA Program API
|
|
2353
|
-
* @version 3.0.
|
|
2456
|
+
* @version 3.0.39
|
|
2354
2457
|
* @baseUrl http://localhost:8080
|
|
2355
2458
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2356
2459
|
*/
|
|
@@ -2365,7 +2468,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2365
2468
|
* @request POST:/contactUs
|
|
2366
2469
|
* @secure
|
|
2367
2470
|
*/
|
|
2368
|
-
listContactUs: (data:
|
|
2471
|
+
listContactUs: (data: InputDvpeshuco, params?: RequestParams) => Promise<any>;
|
|
2369
2472
|
};
|
|
2370
2473
|
customer: {
|
|
2371
2474
|
/**
|
|
@@ -2399,6 +2502,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2399
2502
|
*/
|
|
2400
2503
|
getEvents: ({ startTime, endTime, ...query }: GetEventsParams, params?: RequestParams) => Promise<any>;
|
|
2401
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
|
+
};
|
|
2402
2517
|
tenant: {
|
|
2403
2518
|
/**
|
|
2404
2519
|
* @description Delete bridge
|
|
@@ -2469,7 +2584,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2469
2584
|
* @request POST:/tenant/report/applicationExport
|
|
2470
2585
|
* @secure
|
|
2471
2586
|
*/
|
|
2472
|
-
createReportApplicationExport: (data:
|
|
2587
|
+
createReportApplicationExport: (data: InputAo0Hmwpt3Z, params?: RequestParams) => Promise<any>;
|
|
2473
2588
|
/**
|
|
2474
2589
|
* @description Export a report of applications based on the provided filters.
|
|
2475
2590
|
*
|
|
@@ -2479,7 +2594,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2479
2594
|
* @request POST:/tenant/report/applicationStatus
|
|
2480
2595
|
* @secure
|
|
2481
2596
|
*/
|
|
2482
|
-
listReportApplicationStatus: (data:
|
|
2597
|
+
listReportApplicationStatus: (data: InputSf456Uwm0Y, params?: RequestParams) => Promise<any>;
|
|
2483
2598
|
/**
|
|
2484
2599
|
* @description Export a report of applications based on the provided filters.
|
|
2485
2600
|
*
|
|
@@ -2489,7 +2604,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2489
2604
|
* @request POST:/tenant/report/applicationsReport
|
|
2490
2605
|
* @secure
|
|
2491
2606
|
*/
|
|
2492
|
-
createReportApplicationsReport: (data:
|
|
2607
|
+
createReportApplicationsReport: (data: InputGk0V7Sd10D, params?: RequestParams) => Promise<any>;
|
|
2493
2608
|
/**
|
|
2494
2609
|
* @description This route allows you to post certificates email for the tenant.
|
|
2495
2610
|
*
|
|
@@ -2499,7 +2614,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2499
2614
|
* @request POST:/tenant/certificates/email
|
|
2500
2615
|
* @secure
|
|
2501
2616
|
*/
|
|
2502
|
-
createCertificatesEmail: (data:
|
|
2617
|
+
createCertificatesEmail: (data: InputRw5C352Zh1, params?: RequestParams) => Promise<any>;
|
|
2503
2618
|
/**
|
|
2504
2619
|
* @description Generate a preview of the completed certifications report.
|
|
2505
2620
|
*
|
|
@@ -2529,7 +2644,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2529
2644
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2530
2645
|
* @secure
|
|
2531
2646
|
*/
|
|
2532
|
-
createLicenseRedeem: (userId: string, data:
|
|
2647
|
+
createLicenseRedeem: (userId: string, data: InputWq7Kc998Gu, params?: RequestParams) => Promise<any>;
|
|
2533
2648
|
/**
|
|
2534
2649
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2535
2650
|
*
|
|
@@ -2539,7 +2654,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2539
2654
|
* @request POST:/tenant/report/orglicenses/
|
|
2540
2655
|
* @secure
|
|
2541
2656
|
*/
|
|
2542
|
-
listReportOrglicenses: (data:
|
|
2657
|
+
listReportOrglicenses: (data: InputAohpyyjnf, params?: RequestParams) => Promise<any>;
|
|
2543
2658
|
/**
|
|
2544
2659
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2545
2660
|
*
|
|
@@ -2549,7 +2664,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2549
2664
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2550
2665
|
* @secure
|
|
2551
2666
|
*/
|
|
2552
|
-
createReportOrglicensesPreview: (data:
|
|
2667
|
+
createReportOrglicensesPreview: (data: InputAge25V1T74, params?: RequestParams) => Promise<any>;
|
|
2553
2668
|
/**
|
|
2554
2669
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2555
2670
|
*
|
|
@@ -2589,7 +2704,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2589
2704
|
* @request POST:/tenant/report/users/advanced
|
|
2590
2705
|
* @secure
|
|
2591
2706
|
*/
|
|
2592
|
-
createReportUsersAdvanced: (data:
|
|
2707
|
+
createReportUsersAdvanced: (data: Input7U9Wc63O0Z, params?: RequestParams) => Promise<any>;
|
|
2593
2708
|
/**
|
|
2594
2709
|
* @description Searches for users in the tenant by their IDs.
|
|
2595
2710
|
*
|
|
@@ -2599,7 +2714,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2599
2714
|
* @request POST:/tenant/search/users/ids
|
|
2600
2715
|
* @secure
|
|
2601
2716
|
*/
|
|
2602
|
-
listSearchUsersIds: (data:
|
|
2717
|
+
listSearchUsersIds: (data: InputOer8Gvslkt, params?: RequestParams) => Promise<any>;
|
|
2603
2718
|
/**
|
|
2604
2719
|
* @description Searches for users in the tenant by term and filters.
|
|
2605
2720
|
*
|
|
@@ -2609,7 +2724,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2609
2724
|
* @request POST:/tenant/search/users/term
|
|
2610
2725
|
* @secure
|
|
2611
2726
|
*/
|
|
2612
|
-
createSearchUsersTerm: (data:
|
|
2727
|
+
createSearchUsersTerm: (data: InputRx2Of25Z1S, params?: RequestParams) => Promise<any>;
|
|
2613
2728
|
/**
|
|
2614
2729
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2615
2730
|
*
|
|
@@ -2619,7 +2734,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2619
2734
|
* @request POST:/tenant/report/users/simple
|
|
2620
2735
|
* @secure
|
|
2621
2736
|
*/
|
|
2622
|
-
createReportUsersSimple: (data:
|
|
2737
|
+
createReportUsersSimple: (data: InputBwf6Vwqau4H, params?: RequestParams) => Promise<any>;
|
|
2623
2738
|
/**
|
|
2624
2739
|
* @description Retrieve user by ID.
|
|
2625
2740
|
*
|
|
@@ -2629,7 +2744,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2629
2744
|
* @request POST:/tenant/search/users/count
|
|
2630
2745
|
* @secure
|
|
2631
2746
|
*/
|
|
2632
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2747
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<Output5Bph624559>;
|
|
2633
2748
|
};
|
|
2634
2749
|
user: {
|
|
2635
2750
|
/**
|
|
@@ -2661,7 +2776,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2661
2776
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2662
2777
|
* @secure
|
|
2663
2778
|
*/
|
|
2664
|
-
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>;
|
|
2665
2780
|
/**
|
|
2666
2781
|
* @description Delete a certification process application by type.
|
|
2667
2782
|
*
|
|
@@ -2751,7 +2866,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2751
2866
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2752
2867
|
* @secure
|
|
2753
2868
|
*/
|
|
2754
|
-
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>;
|
|
2755
2870
|
/**
|
|
2756
2871
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2757
2872
|
*
|
|
@@ -2761,7 +2876,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2761
2876
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2762
2877
|
* @secure
|
|
2763
2878
|
*/
|
|
2764
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2879
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputC61Yutxgkz>;
|
|
2765
2880
|
/**
|
|
2766
2881
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2767
2882
|
*
|
|
@@ -2781,7 +2896,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2781
2896
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2782
2897
|
* @secure
|
|
2783
2898
|
*/
|
|
2784
|
-
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>;
|
|
2785
2900
|
/**
|
|
2786
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.
|
|
2787
2902
|
*
|
|
@@ -2792,6 +2907,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2792
2907
|
* @secure
|
|
2793
2908
|
*/
|
|
2794
2909
|
deleteSponsorshipPendingApproval: (userId: string, paId: string, data: DeletePendingApprovalBody, params?: RequestParams) => Promise<any>;
|
|
2910
|
+
/**
|
|
2911
|
+
* @description Retrieves a sponsorship/attestation pending-approval record by its id for the given user. Admin only.
|
|
2912
|
+
*
|
|
2913
|
+
* @tags Sponsorship
|
|
2914
|
+
* @name GetSponsorshipPendingApproval
|
|
2915
|
+
* @summary Get a pending sponsorship request
|
|
2916
|
+
* @request GET:/user/{userID}/sponsorship/pendingApproval/{paID}
|
|
2917
|
+
* @secure
|
|
2918
|
+
*/
|
|
2919
|
+
getSponsorshipPendingApproval: (userId: string, paId: string, params?: RequestParams) => Promise<GetPendingApprovalResponse>;
|
|
2795
2920
|
/**
|
|
2796
2921
|
* @description Delete user by ID.
|
|
2797
2922
|
*
|
|
@@ -2821,7 +2946,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2821
2946
|
* @request POST:/user/{userID}
|
|
2822
2947
|
* @secure
|
|
2823
2948
|
*/
|
|
2824
|
-
createUser: (userId: string, data:
|
|
2949
|
+
createUser: (userId: string, data: Input5Ajhwikstb, params?: RequestParams) => Promise<any>;
|
|
2825
2950
|
/**
|
|
2826
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.
|
|
2827
2952
|
*
|
|
@@ -2831,7 +2956,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2831
2956
|
* @request PUT:/user/{userID}
|
|
2832
2957
|
* @secure
|
|
2833
2958
|
*/
|
|
2834
|
-
updateUser: (userId: string, data:
|
|
2959
|
+
updateUser: (userId: string, data: InputVynk4V82Hlf, params?: RequestParams) => Promise<any>;
|
|
2835
2960
|
/**
|
|
2836
2961
|
* @description Delete course from user
|
|
2837
2962
|
*
|
|
@@ -2851,7 +2976,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2851
2976
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2852
2977
|
* @secure
|
|
2853
2978
|
*/
|
|
2854
|
-
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>;
|
|
2855
2980
|
/**
|
|
2856
2981
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2857
2982
|
*
|
|
@@ -2861,7 +2986,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2861
2986
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2862
2987
|
* @secure
|
|
2863
2988
|
*/
|
|
2864
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2989
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputW7312H25Cc>;
|
|
2865
2990
|
/**
|
|
2866
2991
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2867
2992
|
*
|
|
@@ -2871,7 +2996,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2871
2996
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2872
2997
|
* @secure
|
|
2873
2998
|
*/
|
|
2874
|
-
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>;
|
|
2875
3000
|
/**
|
|
2876
3001
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2877
3002
|
*
|
|
@@ -2911,7 +3036,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2911
3036
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2912
3037
|
* @secure
|
|
2913
3038
|
*/
|
|
2914
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
3039
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputXbpkpl54M0I>;
|
|
2915
3040
|
/**
|
|
2916
3041
|
* @description This endpoint will print certificate
|
|
2917
3042
|
*
|
|
@@ -2971,7 +3096,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2971
3096
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2972
3097
|
* @secure
|
|
2973
3098
|
*/
|
|
2974
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
3099
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputA30Shinbjtk, params?: RequestParams) => Promise<any>;
|
|
2975
3100
|
/**
|
|
2976
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.
|
|
2977
3102
|
*
|
|
@@ -3001,7 +3126,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3001
3126
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
3002
3127
|
* @secure
|
|
3003
3128
|
*/
|
|
3004
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3129
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputHttuep0Xaa, params?: RequestParams) => Promise<any>;
|
|
3005
3130
|
/**
|
|
3006
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.
|
|
3007
3132
|
*
|
|
@@ -3011,7 +3136,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3011
3136
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
3012
3137
|
* @secure
|
|
3013
3138
|
*/
|
|
3014
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
3139
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputR89Sd266I6, params?: RequestParams) => Promise<any>;
|
|
3015
3140
|
/**
|
|
3016
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.
|
|
3017
3142
|
*
|
|
@@ -3021,7 +3146,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3021
3146
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
3022
3147
|
* @secure
|
|
3023
3148
|
*/
|
|
3024
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
3149
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputS523Pjmwoa, params?: RequestParams) => Promise<any>;
|
|
3025
3150
|
/**
|
|
3026
3151
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
3027
3152
|
*
|
|
@@ -3031,7 +3156,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3031
3156
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
3032
3157
|
* @secure
|
|
3033
3158
|
*/
|
|
3034
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
3159
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: Input7Pkse4K1Q5, params?: RequestParams) => Promise<any>;
|
|
3035
3160
|
/**
|
|
3036
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.
|
|
3037
3162
|
*
|
|
@@ -3071,7 +3196,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3071
3196
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
3072
3197
|
* @secure
|
|
3073
3198
|
*/
|
|
3074
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
3199
|
+
createCertificationWaive: (userId: string, certProcId: string, data: Input3Dqkxxnovwg, params?: RequestParams) => Promise<any>;
|
|
3075
3200
|
/**
|
|
3076
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.
|
|
3077
3202
|
*
|
|
@@ -3081,7 +3206,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3081
3206
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
3082
3207
|
* @secure
|
|
3083
3208
|
*/
|
|
3084
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3209
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputLakap8U75H>;
|
|
3085
3210
|
/**
|
|
3086
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.
|
|
3087
3212
|
*
|
|
@@ -3121,7 +3246,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3121
3246
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
3122
3247
|
* @secure
|
|
3123
3248
|
*/
|
|
3124
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
3249
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputO15Aanoemr, params?: RequestParams) => Promise<any>;
|
|
3125
3250
|
/**
|
|
3126
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.
|
|
3127
3252
|
*
|
|
@@ -3181,7 +3306,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3181
3306
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3182
3307
|
* @secure
|
|
3183
3308
|
*/
|
|
3184
|
-
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>;
|
|
3185
3310
|
/**
|
|
3186
3311
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3187
3312
|
*
|
|
@@ -3201,7 +3326,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3201
3326
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3202
3327
|
* @secure
|
|
3203
3328
|
*/
|
|
3204
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3329
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputMzh8Dry519, params?: RequestParams) => Promise<any>;
|
|
3205
3330
|
/**
|
|
3206
3331
|
* @description This route allows you to submit a pending approval.
|
|
3207
3332
|
*
|
|
@@ -3211,7 +3336,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3211
3336
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3212
3337
|
* @secure
|
|
3213
3338
|
*/
|
|
3214
|
-
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>;
|
|
3215
3340
|
/**
|
|
3216
3341
|
* @description This route allows you to review a pending approval.
|
|
3217
3342
|
*
|
|
@@ -3221,7 +3346,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3221
3346
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3222
3347
|
* @secure
|
|
3223
3348
|
*/
|
|
3224
|
-
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>;
|
|
3225
3350
|
/**
|
|
3226
3351
|
* @description Redeems a license for a user by product ID.
|
|
3227
3352
|
*
|
|
@@ -3231,7 +3356,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3231
3356
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3232
3357
|
* @secure
|
|
3233
3358
|
*/
|
|
3234
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3359
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputLh0T8171Wqg, params?: RequestParams) => Promise<any>;
|
|
3235
3360
|
/**
|
|
3236
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.
|
|
3237
3362
|
*
|
|
@@ -3241,7 +3366,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3241
3366
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3242
3367
|
* @secure
|
|
3243
3368
|
*/
|
|
3244
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3369
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputHmffu9Hc2H>;
|
|
3245
3370
|
/**
|
|
3246
3371
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3247
3372
|
*
|
|
@@ -3251,7 +3376,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3251
3376
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3252
3377
|
* @secure
|
|
3253
3378
|
*/
|
|
3254
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3379
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputLk5B7Priqt, params?: RequestParams) => Promise<any>;
|
|
3255
3380
|
/**
|
|
3256
3381
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3257
3382
|
*
|
|
@@ -3261,7 +3386,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3261
3386
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3262
3387
|
* @secure
|
|
3263
3388
|
*/
|
|
3264
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3389
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input90Jd0Xyanx, params?: RequestParams) => Promise<any>;
|
|
3265
3390
|
/**
|
|
3266
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.
|
|
3267
3392
|
*
|
|
@@ -3271,7 +3396,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3271
3396
|
* @request POST:/user/{userID}/updateITA
|
|
3272
3397
|
* @secure
|
|
3273
3398
|
*/
|
|
3274
|
-
createUpdateIta: (userId: string, data:
|
|
3399
|
+
createUpdateIta: (userId: string, data: InputC9Nvfilwnd, params?: RequestParams) => Promise<any>;
|
|
3275
3400
|
/**
|
|
3276
3401
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3277
3402
|
*
|
|
@@ -3281,7 +3406,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3281
3406
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3282
3407
|
* @secure
|
|
3283
3408
|
*/
|
|
3284
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3409
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputSzdt1Ehw1F, params?: RequestParams) => Promise<any>;
|
|
3285
3410
|
/**
|
|
3286
3411
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3287
3412
|
*
|
|
@@ -3291,7 +3416,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3291
3416
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3292
3417
|
* @secure
|
|
3293
3418
|
*/
|
|
3294
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3419
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: Input504Pqmq2W3, params?: RequestParams) => Promise<any>;
|
|
3295
3420
|
/**
|
|
3296
3421
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3297
3422
|
*
|
|
@@ -3333,7 +3458,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3333
3458
|
* @request POST:/users/certification/{certSpecID}
|
|
3334
3459
|
* @secure
|
|
3335
3460
|
*/
|
|
3336
|
-
createCertification: (certSpecId: string, data:
|
|
3461
|
+
createCertification: (certSpecId: string, data: InputE48N2Qyfcu, params?: RequestParams) => Promise<OutputE48N2Qyfcu>;
|
|
3337
3462
|
/**
|
|
3338
3463
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3339
3464
|
*
|