@ikonintegration/bccsa-program-api 3.0.16 → 3.0.18
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 +136 -93
- package/dist/Api.d.ts +128 -102
- package/dist/Api.js +21 -8
- package/dist/Api.js.map +1 -1
- package/package.json +3 -3
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 InputKu5Sk9Sh92 {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -449,7 +449,7 @@ export interface PendingApprovalResponseSchema {
|
|
|
449
449
|
}[];
|
|
450
450
|
}[] | null;
|
|
451
451
|
}
|
|
452
|
-
export interface
|
|
452
|
+
export interface InputXw929Aen7Bf {
|
|
453
453
|
/**
|
|
454
454
|
* ID of the certification to filter applications by
|
|
455
455
|
* @example "certification123"
|
|
@@ -506,7 +506,7 @@ export interface InputD3Dhjn9Ys4 {
|
|
|
506
506
|
*/
|
|
507
507
|
ignoreCompletedCertifications?: boolean | null;
|
|
508
508
|
}
|
|
509
|
-
export interface
|
|
509
|
+
export interface Input35J2796Gs6 {
|
|
510
510
|
/**
|
|
511
511
|
* ID of the certification to filter applications by
|
|
512
512
|
* @example "certification123"
|
|
@@ -563,7 +563,7 @@ export interface InputTyyuqx8L2O {
|
|
|
563
563
|
*/
|
|
564
564
|
ignoreCompletedCertifications?: boolean | null;
|
|
565
565
|
}
|
|
566
|
-
export interface
|
|
566
|
+
export interface InputHcxw0Ld5Mm {
|
|
567
567
|
/**
|
|
568
568
|
* ID of the certification to filter applications by
|
|
569
569
|
* @example "certification123"
|
|
@@ -620,7 +620,7 @@ export interface InputJycvujxvg4H {
|
|
|
620
620
|
*/
|
|
621
621
|
ignoreCompletedCertifications?: boolean | null;
|
|
622
622
|
}
|
|
623
|
-
export interface
|
|
623
|
+
export interface InputVs15Rvq2Se {
|
|
624
624
|
/**
|
|
625
625
|
* The ID of the certificate specifications to be used for the email
|
|
626
626
|
* @example "certSpecsID123"
|
|
@@ -661,7 +661,7 @@ export interface InputOd8Hvevtkh {
|
|
|
661
661
|
emailAddress: string;
|
|
662
662
|
}[];
|
|
663
663
|
}
|
|
664
|
-
export interface
|
|
664
|
+
export interface InputPaypy2R12D {
|
|
665
665
|
/**
|
|
666
666
|
* The ID of the product for which the license is being redeemed
|
|
667
667
|
* @example "productID123"
|
|
@@ -673,7 +673,7 @@ export interface Input8Oiix3Elgyj {
|
|
|
673
673
|
*/
|
|
674
674
|
sessionID?: string;
|
|
675
675
|
}
|
|
676
|
-
export interface
|
|
676
|
+
export interface InputW329Pjqc6W {
|
|
677
677
|
/**
|
|
678
678
|
* Search term to filter licenses
|
|
679
679
|
* @example "active"
|
|
@@ -690,7 +690,7 @@ export interface InputFpgop3Isd5 {
|
|
|
690
690
|
*/
|
|
691
691
|
sortField?: any;
|
|
692
692
|
}
|
|
693
|
-
export interface
|
|
693
|
+
export interface InputUg8Sq1Oe2O {
|
|
694
694
|
/**
|
|
695
695
|
* Search term to filter licenses
|
|
696
696
|
* @example "active"
|
|
@@ -745,7 +745,7 @@ export interface ReportXLSXSchema {
|
|
|
745
745
|
xlsxStream: any;
|
|
746
746
|
contentType: ReportXlsxSchemaContentTypeEnum;
|
|
747
747
|
}
|
|
748
|
-
export interface
|
|
748
|
+
export interface Input0Qfozgx5Uhi {
|
|
749
749
|
/**
|
|
750
750
|
* Start date for the report
|
|
751
751
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -767,11 +767,11 @@ export interface InputOazpxrxma7 {
|
|
|
767
767
|
*/
|
|
768
768
|
dateType?: string;
|
|
769
769
|
}
|
|
770
|
-
export interface
|
|
770
|
+
export interface InputSawqiqgzdg {
|
|
771
771
|
/** List of user IDs to search for in the tenant. */
|
|
772
772
|
IDs: (string | null)[];
|
|
773
773
|
}
|
|
774
|
-
export interface
|
|
774
|
+
export interface InputUqxa8O8P4P {
|
|
775
775
|
/** The term to search for in the user profiles. */
|
|
776
776
|
searchTerm?: string | null;
|
|
777
777
|
/** Filter criteria for the user search. */
|
|
@@ -811,7 +811,7 @@ export interface InputRyccpgocqi {
|
|
|
811
811
|
};
|
|
812
812
|
};
|
|
813
813
|
}
|
|
814
|
-
export interface
|
|
814
|
+
export interface InputVwnllzjkhxh {
|
|
815
815
|
/** The term to search for in the user profiles. */
|
|
816
816
|
searchTerm?: string | null;
|
|
817
817
|
/** Filter criteria for the user search. */
|
|
@@ -853,19 +853,19 @@ export interface InputVvhra13Jmh {
|
|
|
853
853
|
}
|
|
854
854
|
/** External system ID 2 */
|
|
855
855
|
export type ExternalID2 = number;
|
|
856
|
-
export interface
|
|
856
|
+
export interface Output787Hynhzcy {
|
|
857
857
|
/** External system ID 2 */
|
|
858
858
|
userCount: ExternalID2;
|
|
859
859
|
transactionID?: string | null;
|
|
860
860
|
}
|
|
861
|
-
export interface
|
|
861
|
+
export interface OutputEnuvbrox8U {
|
|
862
862
|
/**
|
|
863
863
|
* Signed URL for the course file
|
|
864
864
|
* @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"
|
|
865
865
|
*/
|
|
866
866
|
fileURL: string;
|
|
867
867
|
}
|
|
868
|
-
export interface
|
|
868
|
+
export interface OutputKifnk4D7E5 {
|
|
869
869
|
/**
|
|
870
870
|
* Amount to be refunded for the cancellation
|
|
871
871
|
* @example 0
|
|
@@ -1156,7 +1156,7 @@ export interface CourseResponseEntity {
|
|
|
1156
1156
|
/** Justifications for overridden course restrictions */
|
|
1157
1157
|
overwrittenJustification?: OverwrittenJustification;
|
|
1158
1158
|
}
|
|
1159
|
-
export interface
|
|
1159
|
+
export interface OutputXrwws4Z3Ct {
|
|
1160
1160
|
/**
|
|
1161
1161
|
* Signed URL for the course file
|
|
1162
1162
|
* @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"
|
|
@@ -1174,7 +1174,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1174
1174
|
transactionID?: string | null;
|
|
1175
1175
|
}
|
|
1176
1176
|
/** Application Foreign Fill response type */
|
|
1177
|
-
export interface
|
|
1177
|
+
export interface OutputQjzec4Duuc {
|
|
1178
1178
|
items: {
|
|
1179
1179
|
userID: string;
|
|
1180
1180
|
createdOn?: number;
|
|
@@ -1317,6 +1317,20 @@ export type ExternalID = string;
|
|
|
1317
1317
|
export type IsEnabled = boolean;
|
|
1318
1318
|
/** Whether the user has opted out of having their certification information published to 3rd party integrations */
|
|
1319
1319
|
export type CertifiedUserOptOut = boolean;
|
|
1320
|
+
export interface PartitionEntry {
|
|
1321
|
+
partID: string;
|
|
1322
|
+
userID: string;
|
|
1323
|
+
updateByApp?: string;
|
|
1324
|
+
updateOn?: number;
|
|
1325
|
+
value?: any;
|
|
1326
|
+
}
|
|
1327
|
+
/** User data from IDM including user profile and partition data */
|
|
1328
|
+
export interface UserDataResponse {
|
|
1329
|
+
/** IDM user object */
|
|
1330
|
+
user: Record<string, any>;
|
|
1331
|
+
/** User partition data from IDM */
|
|
1332
|
+
partitions: PartitionEntry[];
|
|
1333
|
+
}
|
|
1320
1334
|
/** Response schema for certification process data */
|
|
1321
1335
|
export interface CertificationProcessResponseEntity {
|
|
1322
1336
|
/** @example "abc123" */
|
|
@@ -1397,7 +1411,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1397
1411
|
applicationItems?: Record<string, any>[];
|
|
1398
1412
|
transactionID?: string | null;
|
|
1399
1413
|
}
|
|
1400
|
-
export interface
|
|
1414
|
+
export interface InputHrih8Ewod9 {
|
|
1401
1415
|
issuedOn?: number;
|
|
1402
1416
|
expiresOn?: number;
|
|
1403
1417
|
fileItems?: {
|
|
@@ -1406,21 +1420,21 @@ export interface InputJ86Ad2Cw25 {
|
|
|
1406
1420
|
}[];
|
|
1407
1421
|
additionalNotes?: string | null;
|
|
1408
1422
|
}
|
|
1409
|
-
export interface
|
|
1423
|
+
export interface InputExlx6Kmiyk {
|
|
1410
1424
|
/**
|
|
1411
1425
|
* Indicates whether the application is locked
|
|
1412
1426
|
* @example true
|
|
1413
1427
|
*/
|
|
1414
1428
|
isApplicationLocked: boolean;
|
|
1415
1429
|
}
|
|
1416
|
-
export interface
|
|
1430
|
+
export interface OutputL9Lsxt67K6 {
|
|
1417
1431
|
/**
|
|
1418
1432
|
* Signed URL for the course file
|
|
1419
1433
|
* @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"
|
|
1420
1434
|
*/
|
|
1421
1435
|
fileURL: string;
|
|
1422
1436
|
}
|
|
1423
|
-
export interface
|
|
1437
|
+
export interface Input7719Nph8Zd {
|
|
1424
1438
|
/**
|
|
1425
1439
|
* Indicates whether the waiver is approved
|
|
1426
1440
|
* @example true
|
|
@@ -1432,14 +1446,14 @@ export interface InputPn24Tkrz5N {
|
|
|
1432
1446
|
*/
|
|
1433
1447
|
additionalNotes?: string | null;
|
|
1434
1448
|
}
|
|
1435
|
-
export interface
|
|
1449
|
+
export interface InputZbhamsxp1Z {
|
|
1436
1450
|
/**
|
|
1437
1451
|
* Optional notes regarding the waiver
|
|
1438
1452
|
* @example "Waiver granted due to special circumstances."
|
|
1439
1453
|
*/
|
|
1440
1454
|
additionalNotes?: string | null;
|
|
1441
1455
|
}
|
|
1442
|
-
export interface
|
|
1456
|
+
export interface InputGpijef66O4 {
|
|
1443
1457
|
students: {
|
|
1444
1458
|
/**
|
|
1445
1459
|
* User ID of the student to redeem the course for
|
|
@@ -1473,7 +1487,7 @@ export interface Input766Ii876Sj {
|
|
|
1473
1487
|
*/
|
|
1474
1488
|
autoEnrolSessionID?: string;
|
|
1475
1489
|
}
|
|
1476
|
-
export interface
|
|
1490
|
+
export interface InputCzgh25Ljqci {
|
|
1477
1491
|
invites: {
|
|
1478
1492
|
/**
|
|
1479
1493
|
* Email address of the user to invite
|
|
@@ -1502,7 +1516,7 @@ export interface InputG1V252Slib {
|
|
|
1502
1516
|
*/
|
|
1503
1517
|
isReservedSeat: boolean;
|
|
1504
1518
|
}
|
|
1505
|
-
export interface
|
|
1519
|
+
export interface InputK2Rc3Wlkrek {
|
|
1506
1520
|
/**
|
|
1507
1521
|
* Indicates whether to waive the certification process
|
|
1508
1522
|
* @example true
|
|
@@ -1515,7 +1529,7 @@ export interface InputQfsksefyis {
|
|
|
1515
1529
|
comments?: string | null;
|
|
1516
1530
|
}
|
|
1517
1531
|
/** Certification move response schema */
|
|
1518
|
-
export interface
|
|
1532
|
+
export interface Output9Os0Vno7C8 {
|
|
1519
1533
|
errors?: {
|
|
1520
1534
|
status: string;
|
|
1521
1535
|
object?: Record<string, any>;
|
|
@@ -1523,19 +1537,19 @@ export interface OutputYon3Esf9Sd {
|
|
|
1523
1537
|
}[];
|
|
1524
1538
|
}
|
|
1525
1539
|
/** Schema for writing a certification trigger check. */
|
|
1526
|
-
export interface
|
|
1540
|
+
export interface InputPqhsrmybpxg {
|
|
1527
1541
|
/**
|
|
1528
1542
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1529
1543
|
* @example "CHECKED"
|
|
1530
1544
|
*/
|
|
1531
|
-
value:
|
|
1545
|
+
value: InputPqhsrmybpxgValueEnum;
|
|
1532
1546
|
/**
|
|
1533
1547
|
* List of course IDs that are blocked by this trigger check.
|
|
1534
1548
|
* @example ["course1","course2"]
|
|
1535
1549
|
*/
|
|
1536
1550
|
blockedCourses?: string[];
|
|
1537
1551
|
}
|
|
1538
|
-
export interface
|
|
1552
|
+
export interface InputW2Hgjd81B5K {
|
|
1539
1553
|
/**
|
|
1540
1554
|
* Indicates whether the application item is approved
|
|
1541
1555
|
* @example true
|
|
@@ -1561,7 +1575,7 @@ export interface Input2D3A4F27Ipf {
|
|
|
1561
1575
|
export interface StudentHistoryRequestSchema {
|
|
1562
1576
|
requirements: string[];
|
|
1563
1577
|
}
|
|
1564
|
-
export interface
|
|
1578
|
+
export interface InputI0A5825Too {
|
|
1565
1579
|
/**
|
|
1566
1580
|
* Optional activation key for the application
|
|
1567
1581
|
* @example "AK-123456"
|
|
@@ -1569,7 +1583,7 @@ export interface InputRw404Uorif {
|
|
|
1569
1583
|
activationKey?: string;
|
|
1570
1584
|
}
|
|
1571
1585
|
/** Schema for course submission item details post request. */
|
|
1572
|
-
export interface
|
|
1586
|
+
export interface InputX971Gy4Xlt {
|
|
1573
1587
|
/**
|
|
1574
1588
|
* The ID of the file being submitted.
|
|
1575
1589
|
* @example "fileID123"
|
|
@@ -1582,7 +1596,7 @@ export interface InputAt2Qquee7L {
|
|
|
1582
1596
|
fileName: string;
|
|
1583
1597
|
}
|
|
1584
1598
|
/** Schema for the response to course submission item details post request. */
|
|
1585
|
-
export interface
|
|
1599
|
+
export interface OutputX971Gy4Xlt {
|
|
1586
1600
|
submissionItems: {
|
|
1587
1601
|
/**
|
|
1588
1602
|
* The ID of the file being submitted.
|
|
@@ -1597,7 +1611,7 @@ export interface OutputAt2Qquee7L {
|
|
|
1597
1611
|
}[];
|
|
1598
1612
|
}
|
|
1599
1613
|
/** Pending approval submission parameters */
|
|
1600
|
-
export interface
|
|
1614
|
+
export interface InputEz5Vik82Vo {
|
|
1601
1615
|
/**
|
|
1602
1616
|
* Type of pending approval
|
|
1603
1617
|
* @example "certification"
|
|
@@ -1617,7 +1631,7 @@ export interface InputWoyg2Gtn48L {
|
|
|
1617
1631
|
fileName: string;
|
|
1618
1632
|
}[];
|
|
1619
1633
|
}
|
|
1620
|
-
export interface
|
|
1634
|
+
export interface InputUg0Ok0E71Uf {
|
|
1621
1635
|
/**
|
|
1622
1636
|
* The ID of the course for which the license is being redeemed
|
|
1623
1637
|
* @example "courseID123"
|
|
@@ -1685,7 +1699,7 @@ export interface InputHd03Cx4Ul6 {
|
|
|
1685
1699
|
acknowledgement?: string | null;
|
|
1686
1700
|
}
|
|
1687
1701
|
/** Validate certification move response schema */
|
|
1688
|
-
export interface
|
|
1702
|
+
export interface OutputK1Vmu5U26Ui {
|
|
1689
1703
|
courses: {
|
|
1690
1704
|
name: string;
|
|
1691
1705
|
status: string;
|
|
@@ -1696,21 +1710,21 @@ export interface Output901E0Rl7D1K {
|
|
|
1696
1710
|
validated: boolean;
|
|
1697
1711
|
mustCreateCP: boolean;
|
|
1698
1712
|
}
|
|
1699
|
-
export interface
|
|
1713
|
+
export interface InputSsnp8Ehya8 {
|
|
1700
1714
|
/**
|
|
1701
1715
|
* Comments regarding the end of the cooldown period
|
|
1702
1716
|
* @example "Cooldown period ended successfully."
|
|
1703
1717
|
*/
|
|
1704
1718
|
comments: string;
|
|
1705
1719
|
}
|
|
1706
|
-
export interface
|
|
1720
|
+
export interface Output3Gc0M2Rgl {
|
|
1707
1721
|
/**
|
|
1708
1722
|
* Signed URL for the course file
|
|
1709
1723
|
* @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"
|
|
1710
1724
|
*/
|
|
1711
1725
|
fileURL: string;
|
|
1712
1726
|
}
|
|
1713
|
-
export interface
|
|
1727
|
+
export interface InputQk1Xrtgy5P {
|
|
1714
1728
|
/** @example true */
|
|
1715
1729
|
agreedWithCertTerms: boolean;
|
|
1716
1730
|
/** @example 1717230000000 */
|
|
@@ -1782,21 +1796,21 @@ export interface InputT28Ksq4Qbh {
|
|
|
1782
1796
|
/** @example "EXT#999" */
|
|
1783
1797
|
externalID2?: string | null;
|
|
1784
1798
|
}
|
|
1785
|
-
export interface
|
|
1799
|
+
export interface InputFqxl9Eme1A {
|
|
1786
1800
|
/**
|
|
1787
1801
|
* Comments regarding the course unlock action
|
|
1788
1802
|
* @example "Course unlocked successfully."
|
|
1789
1803
|
*/
|
|
1790
1804
|
comments: string;
|
|
1791
1805
|
}
|
|
1792
|
-
export interface
|
|
1806
|
+
export interface InputSjvahfw1Eg {
|
|
1793
1807
|
/**
|
|
1794
1808
|
* ITA number to update for the user
|
|
1795
1809
|
* @example "ITA123456"
|
|
1796
1810
|
*/
|
|
1797
1811
|
itaNumber: string;
|
|
1798
1812
|
}
|
|
1799
|
-
export interface
|
|
1813
|
+
export interface Input71S3H4Tio3 {
|
|
1800
1814
|
/** @example true */
|
|
1801
1815
|
agreedWithCertTerms: boolean;
|
|
1802
1816
|
/** @example 1717230000000 */
|
|
@@ -1868,7 +1882,7 @@ export interface InputR78Km2A863 {
|
|
|
1868
1882
|
/** @example "EXT#999" */
|
|
1869
1883
|
externalID2?: string | null;
|
|
1870
1884
|
}
|
|
1871
|
-
export interface
|
|
1885
|
+
export interface InputV8Dirfzvi3J {
|
|
1872
1886
|
/**
|
|
1873
1887
|
* The grade to override the course result with
|
|
1874
1888
|
* @example "A"
|
|
@@ -1876,7 +1890,7 @@ export interface InputCo4Zlxh4K7 {
|
|
|
1876
1890
|
resultGrade: string;
|
|
1877
1891
|
}
|
|
1878
1892
|
/** Pending approval review parameters */
|
|
1879
|
-
export interface
|
|
1893
|
+
export interface InputR8Bym586I1 {
|
|
1880
1894
|
/**
|
|
1881
1895
|
* Notes provided by the reviewer for the pending approval
|
|
1882
1896
|
* @example "Please review the submitted documents."
|
|
@@ -1889,7 +1903,7 @@ export interface InputDfj95F0L6A {
|
|
|
1889
1903
|
approved: boolean;
|
|
1890
1904
|
}
|
|
1891
1905
|
/** Schema for overriding course result dates. */
|
|
1892
|
-
export interface
|
|
1906
|
+
export interface InputFgprgfexgw {
|
|
1893
1907
|
/**
|
|
1894
1908
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1895
1909
|
* @example 1735689600000
|
|
@@ -1901,14 +1915,14 @@ export interface InputDfrz7Yoxs1 {
|
|
|
1901
1915
|
*/
|
|
1902
1916
|
completionDate?: number;
|
|
1903
1917
|
}
|
|
1904
|
-
export interface
|
|
1918
|
+
export interface InputTpceh1Xad1 {
|
|
1905
1919
|
filter: {
|
|
1906
1920
|
from?: number;
|
|
1907
1921
|
sortOrder?: string;
|
|
1908
1922
|
sortField?: string;
|
|
1909
1923
|
};
|
|
1910
1924
|
}
|
|
1911
|
-
export interface
|
|
1925
|
+
export interface OutputTpceh1Xad1 {
|
|
1912
1926
|
users: {
|
|
1913
1927
|
firstName: string;
|
|
1914
1928
|
lastName: string;
|
|
@@ -1928,7 +1942,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
1928
1942
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1929
1943
|
* @example "CHECKED"
|
|
1930
1944
|
*/
|
|
1931
|
-
export declare enum
|
|
1945
|
+
export declare enum InputPqhsrmybpxgValueEnum {
|
|
1932
1946
|
CHECKED = "CHECKED",
|
|
1933
1947
|
UNCHECKED = "UNCHECKED",
|
|
1934
1948
|
NOVALUE = "NOVALUE"
|
|
@@ -2021,7 +2035,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2021
2035
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2022
2036
|
export type CreateReportUsersSimpleData = any;
|
|
2023
2037
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2024
|
-
export type CreateSearchUsersCountData =
|
|
2038
|
+
export type CreateSearchUsersCountData = Output787Hynhzcy;
|
|
2025
2039
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2026
2040
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2027
2041
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2045,7 +2059,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2045
2059
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2046
2060
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2047
2061
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2048
|
-
export type GetCertificationCourseFileSignData =
|
|
2062
|
+
export type GetCertificationCourseFileSignData = OutputXrwws4Z3Ct;
|
|
2049
2063
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2050
2064
|
export interface CreateCertificationCourseFileSignParams {
|
|
2051
2065
|
/** @example "pdf" */
|
|
@@ -2059,11 +2073,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2059
2073
|
/** @example "fileID" */
|
|
2060
2074
|
fileId: string;
|
|
2061
2075
|
}
|
|
2062
|
-
export type CreateCertificationCourseFileSignData =
|
|
2076
|
+
export type CreateCertificationCourseFileSignData = Output3Gc0M2Rgl;
|
|
2063
2077
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2064
2078
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2065
2079
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2066
|
-
export type CreateCertificationCourseDocumentData =
|
|
2080
|
+
export type CreateCertificationCourseDocumentData = OutputX971Gy4Xlt;
|
|
2067
2081
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2068
2082
|
export type DeleteUserData = any;
|
|
2069
2083
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2075,7 +2089,7 @@ export type UpdateUserData = any;
|
|
|
2075
2089
|
export type UpdateUserError = ErrorResponse;
|
|
2076
2090
|
export type DeleteCertificationCourseData = any;
|
|
2077
2091
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2078
|
-
export type GetCertificationApplicationItemFileData =
|
|
2092
|
+
export type GetCertificationApplicationItemFileData = OutputEnuvbrox8U;
|
|
2079
2093
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2080
2094
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2081
2095
|
/** @example "pdf" */
|
|
@@ -2089,9 +2103,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2089
2103
|
/** @example "fileVersion" */
|
|
2090
2104
|
fileVersion: string;
|
|
2091
2105
|
}
|
|
2092
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2106
|
+
export type CreateCertificationApplicationItemFileData = OutputL9Lsxt67K6;
|
|
2093
2107
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2094
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2108
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputKifnk4D7E5;
|
|
2095
2109
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2096
2110
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2097
2111
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2099,7 +2113,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2099
2113
|
export type GetCourseError = ErrorResponse;
|
|
2100
2114
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2101
2115
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2102
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2116
|
+
export type GetCertificationApplicationForeignFillData = OutputQjzec4Duuc;
|
|
2103
2117
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2104
2118
|
export type GetCertificationPrintData = any;
|
|
2105
2119
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2109,6 +2123,8 @@ export type GetRequirementData = StudentHistoryResponseSchema;
|
|
|
2109
2123
|
export type GetRequirementError = ErrorResponse;
|
|
2110
2124
|
export type GetCertificationsUpcomingCoursesData = UserUpcomingCoursesResponseSchema;
|
|
2111
2125
|
export type GetCertificationsUpcomingCoursesError = ErrorResponse;
|
|
2126
|
+
export type GetUserDataData = UserDataResponse;
|
|
2127
|
+
export type GetUserDataError = ErrorResponse;
|
|
2112
2128
|
export type CreateCertificationApplicationLockData = any;
|
|
2113
2129
|
export type CreateCertificationApplicationLockError = ErrorResponse;
|
|
2114
2130
|
export type CreateSessionAddData = any;
|
|
@@ -2131,7 +2147,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2131
2147
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2132
2148
|
export type CreateCertificationWaiveData = any;
|
|
2133
2149
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2134
|
-
export type CreateCertificationMoveData =
|
|
2150
|
+
export type CreateCertificationMoveData = Output9Os0Vno7C8;
|
|
2135
2151
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2136
2152
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2137
2153
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2159,7 +2175,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2159
2175
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2160
2176
|
export type CreateCertificationCourseRedeemData = any;
|
|
2161
2177
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2162
|
-
export type CreateCertificationMoveValidateData =
|
|
2178
|
+
export type CreateCertificationMoveValidateData = OutputK1Vmu5U26Ui;
|
|
2163
2179
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2164
2180
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2165
2181
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2173,7 +2189,7 @@ export type UpdateCertificationSetDatesData = any;
|
|
|
2173
2189
|
export type UpdateCertificationSetDatesError = ErrorResponse;
|
|
2174
2190
|
export type CreateCertificationPublishInfoData = any;
|
|
2175
2191
|
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2176
|
-
export type CreateCertificationResult =
|
|
2192
|
+
export type CreateCertificationResult = OutputTpceh1Xad1;
|
|
2177
2193
|
export type CreateCertificationFail = ErrorResponse;
|
|
2178
2194
|
export type CreateCertificationPublishInfoResult = any;
|
|
2179
2195
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2220,7 +2236,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2220
2236
|
}
|
|
2221
2237
|
/**
|
|
2222
2238
|
* @title BCCSA Program API
|
|
2223
|
-
* @version 3.0.
|
|
2239
|
+
* @version 3.0.18
|
|
2224
2240
|
* @baseUrl http://localhost:8080
|
|
2225
2241
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2226
2242
|
*/
|
|
@@ -2235,7 +2251,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2235
2251
|
* @request POST:/contactUs
|
|
2236
2252
|
* @secure
|
|
2237
2253
|
*/
|
|
2238
|
-
listContactUs: (data:
|
|
2254
|
+
listContactUs: (data: InputKu5Sk9Sh92, params?: RequestParams) => Promise<any>;
|
|
2239
2255
|
};
|
|
2240
2256
|
customer: {
|
|
2241
2257
|
/**
|
|
@@ -2339,7 +2355,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2339
2355
|
* @request POST:/tenant/report/applicationExport
|
|
2340
2356
|
* @secure
|
|
2341
2357
|
*/
|
|
2342
|
-
createReportApplicationExport: (data:
|
|
2358
|
+
createReportApplicationExport: (data: InputXw929Aen7Bf, params?: RequestParams) => Promise<any>;
|
|
2343
2359
|
/**
|
|
2344
2360
|
* @description Export a report of applications based on the provided filters.
|
|
2345
2361
|
*
|
|
@@ -2349,7 +2365,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2349
2365
|
* @request POST:/tenant/report/applicationStatus
|
|
2350
2366
|
* @secure
|
|
2351
2367
|
*/
|
|
2352
|
-
listReportApplicationStatus: (data:
|
|
2368
|
+
listReportApplicationStatus: (data: Input35J2796Gs6, params?: RequestParams) => Promise<any>;
|
|
2353
2369
|
/**
|
|
2354
2370
|
* @description Export a report of applications based on the provided filters.
|
|
2355
2371
|
*
|
|
@@ -2359,7 +2375,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2359
2375
|
* @request POST:/tenant/report/applicationsReport
|
|
2360
2376
|
* @secure
|
|
2361
2377
|
*/
|
|
2362
|
-
createReportApplicationsReport: (data:
|
|
2378
|
+
createReportApplicationsReport: (data: InputHcxw0Ld5Mm, params?: RequestParams) => Promise<any>;
|
|
2363
2379
|
/**
|
|
2364
2380
|
* @description This route allows you to post certificates email for the tenant.
|
|
2365
2381
|
*
|
|
@@ -2369,7 +2385,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2369
2385
|
* @request POST:/tenant/certificates/email
|
|
2370
2386
|
* @secure
|
|
2371
2387
|
*/
|
|
2372
|
-
createCertificatesEmail: (data:
|
|
2388
|
+
createCertificatesEmail: (data: InputVs15Rvq2Se, params?: RequestParams) => Promise<any>;
|
|
2373
2389
|
/**
|
|
2374
2390
|
* @description Generate a preview of the completed certifications report.
|
|
2375
2391
|
*
|
|
@@ -2399,7 +2415,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2399
2415
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2400
2416
|
* @secure
|
|
2401
2417
|
*/
|
|
2402
|
-
createLicenseRedeem: (userId: string, data:
|
|
2418
|
+
createLicenseRedeem: (userId: string, data: InputPaypy2R12D, params?: RequestParams) => Promise<any>;
|
|
2403
2419
|
/**
|
|
2404
2420
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2405
2421
|
*
|
|
@@ -2409,7 +2425,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2409
2425
|
* @request POST:/tenant/report/orglicenses/
|
|
2410
2426
|
* @secure
|
|
2411
2427
|
*/
|
|
2412
|
-
listReportOrglicenses: (data:
|
|
2428
|
+
listReportOrglicenses: (data: InputW329Pjqc6W, params?: RequestParams) => Promise<any>;
|
|
2413
2429
|
/**
|
|
2414
2430
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2415
2431
|
*
|
|
@@ -2419,7 +2435,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2419
2435
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2420
2436
|
* @secure
|
|
2421
2437
|
*/
|
|
2422
|
-
createReportOrglicensesPreview: (data:
|
|
2438
|
+
createReportOrglicensesPreview: (data: InputUg8Sq1Oe2O, params?: RequestParams) => Promise<any>;
|
|
2423
2439
|
/**
|
|
2424
2440
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2425
2441
|
*
|
|
@@ -2449,7 +2465,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2449
2465
|
* @request POST:/tenant/report/users/advanced
|
|
2450
2466
|
* @secure
|
|
2451
2467
|
*/
|
|
2452
|
-
createReportUsersAdvanced: (data:
|
|
2468
|
+
createReportUsersAdvanced: (data: Input0Qfozgx5Uhi, params?: RequestParams) => Promise<any>;
|
|
2453
2469
|
/**
|
|
2454
2470
|
* @description Searches for users in the tenant by their IDs.
|
|
2455
2471
|
*
|
|
@@ -2459,7 +2475,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2459
2475
|
* @request POST:/tenant/search/users/ids
|
|
2460
2476
|
* @secure
|
|
2461
2477
|
*/
|
|
2462
|
-
listSearchUsersIds: (data:
|
|
2478
|
+
listSearchUsersIds: (data: InputSawqiqgzdg, params?: RequestParams) => Promise<any>;
|
|
2463
2479
|
/**
|
|
2464
2480
|
* @description Searches for users in the tenant by term and filters.
|
|
2465
2481
|
*
|
|
@@ -2469,7 +2485,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2469
2485
|
* @request POST:/tenant/search/users/term
|
|
2470
2486
|
* @secure
|
|
2471
2487
|
*/
|
|
2472
|
-
createSearchUsersTerm: (data:
|
|
2488
|
+
createSearchUsersTerm: (data: InputUqxa8O8P4P, params?: RequestParams) => Promise<any>;
|
|
2473
2489
|
/**
|
|
2474
2490
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2475
2491
|
*
|
|
@@ -2479,7 +2495,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2479
2495
|
* @request POST:/tenant/report/users/simple
|
|
2480
2496
|
* @secure
|
|
2481
2497
|
*/
|
|
2482
|
-
createReportUsersSimple: (data:
|
|
2498
|
+
createReportUsersSimple: (data: InputVwnllzjkhxh, params?: RequestParams) => Promise<any>;
|
|
2483
2499
|
/**
|
|
2484
2500
|
* @description Retrieve user by ID.
|
|
2485
2501
|
*
|
|
@@ -2489,7 +2505,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2489
2505
|
* @request POST:/tenant/search/users/count
|
|
2490
2506
|
* @secure
|
|
2491
2507
|
*/
|
|
2492
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2508
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<Output787Hynhzcy>;
|
|
2493
2509
|
};
|
|
2494
2510
|
user: {
|
|
2495
2511
|
/**
|
|
@@ -2521,7 +2537,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2521
2537
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2522
2538
|
* @secure
|
|
2523
2539
|
*/
|
|
2524
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2540
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: InputHrih8Ewod9, params?: RequestParams) => Promise<any>;
|
|
2525
2541
|
/**
|
|
2526
2542
|
* @description Delete a certification process application by type.
|
|
2527
2543
|
*
|
|
@@ -2611,7 +2627,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2611
2627
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2612
2628
|
* @secure
|
|
2613
2629
|
*/
|
|
2614
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2630
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputXrwws4Z3Ct>;
|
|
2615
2631
|
/**
|
|
2616
2632
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2617
2633
|
*
|
|
@@ -2621,7 +2637,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2621
2637
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2622
2638
|
* @secure
|
|
2623
2639
|
*/
|
|
2624
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2640
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<Output3Gc0M2Rgl>;
|
|
2625
2641
|
/**
|
|
2626
2642
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2627
2643
|
*
|
|
@@ -2641,7 +2657,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2641
2657
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2642
2658
|
* @secure
|
|
2643
2659
|
*/
|
|
2644
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2660
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputX971Gy4Xlt, params?: RequestParams) => Promise<OutputX971Gy4Xlt>;
|
|
2645
2661
|
/**
|
|
2646
2662
|
* @description Delete user by ID.
|
|
2647
2663
|
*
|
|
@@ -2671,7 +2687,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2671
2687
|
* @request POST:/user/{userID}
|
|
2672
2688
|
* @secure
|
|
2673
2689
|
*/
|
|
2674
|
-
createUser: (userId: string, data:
|
|
2690
|
+
createUser: (userId: string, data: InputQk1Xrtgy5P, params?: RequestParams) => Promise<any>;
|
|
2675
2691
|
/**
|
|
2676
2692
|
* @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.
|
|
2677
2693
|
*
|
|
@@ -2681,7 +2697,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2681
2697
|
* @request PUT:/user/{userID}
|
|
2682
2698
|
* @secure
|
|
2683
2699
|
*/
|
|
2684
|
-
updateUser: (userId: string, data:
|
|
2700
|
+
updateUser: (userId: string, data: Input71S3H4Tio3, params?: RequestParams) => Promise<any>;
|
|
2685
2701
|
/**
|
|
2686
2702
|
* @description Delete course from user
|
|
2687
2703
|
*
|
|
@@ -2701,7 +2717,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2701
2717
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2702
2718
|
* @secure
|
|
2703
2719
|
*/
|
|
2704
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2720
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputEnuvbrox8U>;
|
|
2705
2721
|
/**
|
|
2706
2722
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2707
2723
|
*
|
|
@@ -2711,7 +2727,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2711
2727
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2712
2728
|
* @secure
|
|
2713
2729
|
*/
|
|
2714
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2730
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputL9Lsxt67K6>;
|
|
2715
2731
|
/**
|
|
2716
2732
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2717
2733
|
*
|
|
@@ -2721,7 +2737,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2721
2737
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2722
2738
|
* @secure
|
|
2723
2739
|
*/
|
|
2724
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2740
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputKifnk4D7E5>;
|
|
2725
2741
|
/**
|
|
2726
2742
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2727
2743
|
*
|
|
@@ -2761,7 +2777,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2761
2777
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2762
2778
|
* @secure
|
|
2763
2779
|
*/
|
|
2764
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2780
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputQjzec4Duuc>;
|
|
2765
2781
|
/**
|
|
2766
2782
|
* @description This endpoint will print certificate
|
|
2767
2783
|
*
|
|
@@ -2802,6 +2818,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2802
2818
|
* @secure
|
|
2803
2819
|
*/
|
|
2804
2820
|
getCertificationsUpcomingCourses: (userId: string, params?: RequestParams) => Promise<UserUpcomingCoursesResponseSchema>;
|
|
2821
|
+
/**
|
|
2822
|
+
* @description Retrieve user data from IDM including user profile and partition data. Uses API credentials for full read access.
|
|
2823
|
+
*
|
|
2824
|
+
* @tags User
|
|
2825
|
+
* @name GetUserData
|
|
2826
|
+
* @summary Get User Data
|
|
2827
|
+
* @request GET:/user/{userID}/userData
|
|
2828
|
+
* @secure
|
|
2829
|
+
*/
|
|
2830
|
+
getUserData: (userId: string, params?: RequestParams) => Promise<UserDataResponse>;
|
|
2805
2831
|
/**
|
|
2806
2832
|
* @description This route indicates users should not be able to advance or make changes to applications in this certification.
|
|
2807
2833
|
*
|
|
@@ -2811,7 +2837,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2811
2837
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2812
2838
|
* @secure
|
|
2813
2839
|
*/
|
|
2814
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2840
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputExlx6Kmiyk, params?: RequestParams) => Promise<any>;
|
|
2815
2841
|
/**
|
|
2816
2842
|
* @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.
|
|
2817
2843
|
*
|
|
@@ -2841,7 +2867,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2841
2867
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2842
2868
|
* @secure
|
|
2843
2869
|
*/
|
|
2844
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2870
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: Input7719Nph8Zd, params?: RequestParams) => Promise<any>;
|
|
2845
2871
|
/**
|
|
2846
2872
|
* @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.
|
|
2847
2873
|
*
|
|
@@ -2851,7 +2877,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2851
2877
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2852
2878
|
* @secure
|
|
2853
2879
|
*/
|
|
2854
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2880
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputZbhamsxp1Z, params?: RequestParams) => Promise<any>;
|
|
2855
2881
|
/**
|
|
2856
2882
|
* @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.
|
|
2857
2883
|
*
|
|
@@ -2861,7 +2887,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2861
2887
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2862
2888
|
* @secure
|
|
2863
2889
|
*/
|
|
2864
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2890
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputGpijef66O4, params?: RequestParams) => Promise<any>;
|
|
2865
2891
|
/**
|
|
2866
2892
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2867
2893
|
*
|
|
@@ -2871,7 +2897,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2871
2897
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2872
2898
|
* @secure
|
|
2873
2899
|
*/
|
|
2874
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2900
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputCzgh25Ljqci, params?: RequestParams) => Promise<any>;
|
|
2875
2901
|
/**
|
|
2876
2902
|
* @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.
|
|
2877
2903
|
*
|
|
@@ -2911,7 +2937,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2911
2937
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2912
2938
|
* @secure
|
|
2913
2939
|
*/
|
|
2914
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2940
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputK2Rc3Wlkrek, params?: RequestParams) => Promise<any>;
|
|
2915
2941
|
/**
|
|
2916
2942
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
2917
2943
|
*
|
|
@@ -2921,7 +2947,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2921
2947
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2922
2948
|
* @secure
|
|
2923
2949
|
*/
|
|
2924
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2950
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<Output9Os0Vno7C8>;
|
|
2925
2951
|
/**
|
|
2926
2952
|
* @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.
|
|
2927
2953
|
*
|
|
@@ -2951,7 +2977,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2951
2977
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2952
2978
|
* @secure
|
|
2953
2979
|
*/
|
|
2954
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
2980
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputPqhsrmybpxg, params?: RequestParams) => Promise<any>;
|
|
2955
2981
|
/**
|
|
2956
2982
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
2957
2983
|
*
|
|
@@ -3001,7 +3027,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3001
3027
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3002
3028
|
* @secure
|
|
3003
3029
|
*/
|
|
3004
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
3030
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: InputW2Hgjd81B5K, params?: RequestParams) => Promise<any>;
|
|
3005
3031
|
/**
|
|
3006
3032
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3007
3033
|
*
|
|
@@ -3021,7 +3047,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3021
3047
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3022
3048
|
* @secure
|
|
3023
3049
|
*/
|
|
3024
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3050
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputI0A5825Too, params?: RequestParams) => Promise<any>;
|
|
3025
3051
|
/**
|
|
3026
3052
|
* @description This route allows you to submit a pending approval.
|
|
3027
3053
|
*
|
|
@@ -3031,7 +3057,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3031
3057
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3032
3058
|
* @secure
|
|
3033
3059
|
*/
|
|
3034
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3060
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputEz5Vik82Vo, params?: RequestParams) => Promise<any>;
|
|
3035
3061
|
/**
|
|
3036
3062
|
* @description This route allows you to review a pending approval.
|
|
3037
3063
|
*
|
|
@@ -3041,7 +3067,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3041
3067
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3042
3068
|
* @secure
|
|
3043
3069
|
*/
|
|
3044
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3070
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputR8Bym586I1, params?: RequestParams) => Promise<any>;
|
|
3045
3071
|
/**
|
|
3046
3072
|
* @description Redeems a license for a user by product ID.
|
|
3047
3073
|
*
|
|
@@ -3051,7 +3077,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3051
3077
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3052
3078
|
* @secure
|
|
3053
3079
|
*/
|
|
3054
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3080
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputUg0Ok0E71Uf, params?: RequestParams) => Promise<any>;
|
|
3055
3081
|
/**
|
|
3056
3082
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3057
3083
|
*
|
|
@@ -3061,7 +3087,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3061
3087
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3062
3088
|
* @secure
|
|
3063
3089
|
*/
|
|
3064
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3090
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputK1Vmu5U26Ui>;
|
|
3065
3091
|
/**
|
|
3066
3092
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3067
3093
|
*
|
|
@@ -3071,7 +3097,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3071
3097
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3072
3098
|
* @secure
|
|
3073
3099
|
*/
|
|
3074
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3100
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputSsnp8Ehya8, params?: RequestParams) => Promise<any>;
|
|
3075
3101
|
/**
|
|
3076
3102
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3077
3103
|
*
|
|
@@ -3081,7 +3107,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3081
3107
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3082
3108
|
* @secure
|
|
3083
3109
|
*/
|
|
3084
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3110
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputFqxl9Eme1A, params?: RequestParams) => Promise<any>;
|
|
3085
3111
|
/**
|
|
3086
3112
|
* @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.
|
|
3087
3113
|
*
|
|
@@ -3091,7 +3117,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3091
3117
|
* @request POST:/user/{userID}/updateITA
|
|
3092
3118
|
* @secure
|
|
3093
3119
|
*/
|
|
3094
|
-
createUpdateIta: (userId: string, data:
|
|
3120
|
+
createUpdateIta: (userId: string, data: InputSjvahfw1Eg, params?: RequestParams) => Promise<any>;
|
|
3095
3121
|
/**
|
|
3096
3122
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3097
3123
|
*
|
|
@@ -3101,7 +3127,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3101
3127
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3102
3128
|
* @secure
|
|
3103
3129
|
*/
|
|
3104
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3130
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputV8Dirfzvi3J, params?: RequestParams) => Promise<any>;
|
|
3105
3131
|
/**
|
|
3106
3132
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3107
3133
|
*
|
|
@@ -3111,7 +3137,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3111
3137
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3112
3138
|
* @secure
|
|
3113
3139
|
*/
|
|
3114
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3140
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputFgprgfexgw, params?: RequestParams) => Promise<any>;
|
|
3115
3141
|
/**
|
|
3116
3142
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3117
3143
|
*
|
|
@@ -3133,7 +3159,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3133
3159
|
* @request POST:/users/certification/{certSpecID}
|
|
3134
3160
|
* @secure
|
|
3135
3161
|
*/
|
|
3136
|
-
createCertification: (certSpecId: string, data:
|
|
3162
|
+
createCertification: (certSpecId: string, data: InputTpceh1Xad1, params?: RequestParams) => Promise<OutputTpceh1Xad1>;
|
|
3137
3163
|
/**
|
|
3138
3164
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3139
3165
|
*
|