@ikonintegration/bccsa-program-api 3.0.15 → 3.0.17
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 +188 -124
- package/dist/Api.d.ts +160 -122
- package/dist/Api.js +54 -28
- package/dist/Api.js.map +1 -1
- package/package.json +2 -2
package/dist/Api.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ export interface ErrorResponse {
|
|
|
5
5
|
/** Error code */
|
|
6
6
|
errCode: string;
|
|
7
7
|
}
|
|
8
|
-
export interface
|
|
8
|
+
export interface InputEn99Qyf92S {
|
|
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 Input38Hcfrecd8 {
|
|
453
453
|
/**
|
|
454
454
|
* ID of the certification to filter applications by
|
|
455
455
|
* @example "certification123"
|
|
@@ -506,7 +506,7 @@ export interface InputLum0Yat3Ai {
|
|
|
506
506
|
*/
|
|
507
507
|
ignoreCompletedCertifications?: boolean | null;
|
|
508
508
|
}
|
|
509
|
-
export interface
|
|
509
|
+
export interface InputKme51Dz7A6 {
|
|
510
510
|
/**
|
|
511
511
|
* ID of the certification to filter applications by
|
|
512
512
|
* @example "certification123"
|
|
@@ -563,7 +563,7 @@ export interface InputTvnyljcrg4J {
|
|
|
563
563
|
*/
|
|
564
564
|
ignoreCompletedCertifications?: boolean | null;
|
|
565
565
|
}
|
|
566
|
-
export interface
|
|
566
|
+
export interface InputZimh3Glsfmj {
|
|
567
567
|
/**
|
|
568
568
|
* ID of the certification to filter applications by
|
|
569
569
|
* @example "certification123"
|
|
@@ -620,7 +620,7 @@ export interface InputBlhr31K5Kvk {
|
|
|
620
620
|
*/
|
|
621
621
|
ignoreCompletedCertifications?: boolean | null;
|
|
622
622
|
}
|
|
623
|
-
export interface
|
|
623
|
+
export interface InputTsj7Au05Gw {
|
|
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 InputVassce6Gz {
|
|
|
661
661
|
emailAddress: string;
|
|
662
662
|
}[];
|
|
663
663
|
}
|
|
664
|
-
export interface
|
|
664
|
+
export interface InputUf1J0E7Mb6 {
|
|
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 InputF92Orvmlfvk {
|
|
|
673
673
|
*/
|
|
674
674
|
sessionID?: string;
|
|
675
675
|
}
|
|
676
|
-
export interface
|
|
676
|
+
export interface InputH7P19Hfii4I {
|
|
677
677
|
/**
|
|
678
678
|
* Search term to filter licenses
|
|
679
679
|
* @example "active"
|
|
@@ -690,7 +690,7 @@ export interface InputNt9Aebjq5V {
|
|
|
690
690
|
*/
|
|
691
691
|
sortField?: any;
|
|
692
692
|
}
|
|
693
|
-
export interface
|
|
693
|
+
export interface InputHah5Gla80Q {
|
|
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 InputUplth6C9Ad {
|
|
749
749
|
/**
|
|
750
750
|
* Start date for the report
|
|
751
751
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -767,11 +767,11 @@ export interface InputHbv2Lakmwk {
|
|
|
767
767
|
*/
|
|
768
768
|
dateType?: string;
|
|
769
769
|
}
|
|
770
|
-
export interface
|
|
770
|
+
export interface Input7Jsubguwhpl {
|
|
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 InputJp1H3Pxa2V {
|
|
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 InputR8M6Krnm2O {
|
|
|
811
811
|
};
|
|
812
812
|
};
|
|
813
813
|
}
|
|
814
|
-
export interface
|
|
814
|
+
export interface Input061Ikqn2Yo {
|
|
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 InputCz3Bq19S0Ah {
|
|
|
853
853
|
}
|
|
854
854
|
/** External system ID 2 */
|
|
855
855
|
export type ExternalID2 = number;
|
|
856
|
-
export interface
|
|
856
|
+
export interface OutputH0Jr66Rgmi {
|
|
857
857
|
/** External system ID 2 */
|
|
858
858
|
userCount: ExternalID2;
|
|
859
859
|
transactionID?: string | null;
|
|
860
860
|
}
|
|
861
|
-
export interface
|
|
861
|
+
export interface Output9162449N3V {
|
|
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 Output99Bafbnty2 {
|
|
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 OutputW20V1Q9Cfzh {
|
|
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 OutputBmyceqkfzo {
|
|
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 InputA3Yzaj9Yge {
|
|
1401
1415
|
issuedOn?: number;
|
|
1402
1416
|
expiresOn?: number;
|
|
1403
1417
|
fileItems?: {
|
|
@@ -1406,21 +1420,21 @@ export interface Input0Ct4Plaos1 {
|
|
|
1406
1420
|
}[];
|
|
1407
1421
|
additionalNotes?: string | null;
|
|
1408
1422
|
}
|
|
1409
|
-
export interface
|
|
1423
|
+
export interface InputYkrswdxt80H {
|
|
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 OutputH9Obb07K5S {
|
|
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 InputOu74Xwaupt {
|
|
1424
1438
|
/**
|
|
1425
1439
|
* Indicates whether the waiver is approved
|
|
1426
1440
|
* @example true
|
|
@@ -1432,14 +1446,14 @@ export interface Input8Xspx1Ojjji {
|
|
|
1432
1446
|
*/
|
|
1433
1447
|
additionalNotes?: string | null;
|
|
1434
1448
|
}
|
|
1435
|
-
export interface
|
|
1449
|
+
export interface InputEoy83X4Gst {
|
|
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 InputSzy4Sbd1Vek {
|
|
1443
1457
|
students: {
|
|
1444
1458
|
/**
|
|
1445
1459
|
* User ID of the student to redeem the course for
|
|
@@ -1473,7 +1487,7 @@ export interface InputIuhjhdecd4 {
|
|
|
1473
1487
|
*/
|
|
1474
1488
|
autoEnrolSessionID?: string;
|
|
1475
1489
|
}
|
|
1476
|
-
export interface
|
|
1490
|
+
export interface Input0Xoiyidh46 {
|
|
1477
1491
|
invites: {
|
|
1478
1492
|
/**
|
|
1479
1493
|
* Email address of the user to invite
|
|
@@ -1502,7 +1516,7 @@ export interface InputTj13Ygxoni {
|
|
|
1502
1516
|
*/
|
|
1503
1517
|
isReservedSeat: boolean;
|
|
1504
1518
|
}
|
|
1505
|
-
export interface
|
|
1519
|
+
export interface Input9Gk1Eer7Ldh {
|
|
1506
1520
|
/**
|
|
1507
1521
|
* Indicates whether to waive the certification process
|
|
1508
1522
|
* @example true
|
|
@@ -1515,7 +1529,7 @@ export interface Input8Vbpsda0N9 {
|
|
|
1515
1529
|
comments?: string | null;
|
|
1516
1530
|
}
|
|
1517
1531
|
/** Certification move response schema */
|
|
1518
|
-
export interface
|
|
1532
|
+
export interface Output8K3Kc2235 {
|
|
1519
1533
|
errors?: {
|
|
1520
1534
|
status: string;
|
|
1521
1535
|
object?: Record<string, any>;
|
|
@@ -1523,19 +1537,19 @@ export interface OutputI2Fhhyfixuf {
|
|
|
1523
1537
|
}[];
|
|
1524
1538
|
}
|
|
1525
1539
|
/** Schema for writing a certification trigger check. */
|
|
1526
|
-
export interface
|
|
1540
|
+
export interface InputB03Ca4Xqtw {
|
|
1527
1541
|
/**
|
|
1528
1542
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1529
1543
|
* @example "CHECKED"
|
|
1530
1544
|
*/
|
|
1531
|
-
value:
|
|
1545
|
+
value: InputB03Ca4XqtwValueEnum;
|
|
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 InputNqcjc8Hvq6 {
|
|
1539
1553
|
/**
|
|
1540
1554
|
* Indicates whether the application item is approved
|
|
1541
1555
|
* @example true
|
|
@@ -1561,7 +1575,7 @@ export interface InputCt7Hzamjb0F {
|
|
|
1561
1575
|
export interface StudentHistoryRequestSchema {
|
|
1562
1576
|
requirements: string[];
|
|
1563
1577
|
}
|
|
1564
|
-
export interface
|
|
1578
|
+
export interface InputEdu05Vaqm1 {
|
|
1565
1579
|
/**
|
|
1566
1580
|
* Optional activation key for the application
|
|
1567
1581
|
* @example "AK-123456"
|
|
@@ -1569,7 +1583,7 @@ export interface InputB85Ac5Ruzk {
|
|
|
1569
1583
|
activationKey?: string;
|
|
1570
1584
|
}
|
|
1571
1585
|
/** Schema for course submission item details post request. */
|
|
1572
|
-
export interface
|
|
1586
|
+
export interface Input2Kraeg1Oyh {
|
|
1573
1587
|
/**
|
|
1574
1588
|
* The ID of the file being submitted.
|
|
1575
1589
|
* @example "fileID123"
|
|
@@ -1582,7 +1596,7 @@ export interface Input1Smrp0K7Eb {
|
|
|
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 Output2Kraeg1Oyh {
|
|
1586
1600
|
submissionItems: {
|
|
1587
1601
|
/**
|
|
1588
1602
|
* The ID of the file being submitted.
|
|
@@ -1597,7 +1611,7 @@ export interface Output1Smrp0K7Eb {
|
|
|
1597
1611
|
}[];
|
|
1598
1612
|
}
|
|
1599
1613
|
/** Pending approval submission parameters */
|
|
1600
|
-
export interface
|
|
1614
|
+
export interface Input6Wmqoozm3 {
|
|
1601
1615
|
/**
|
|
1602
1616
|
* Type of pending approval
|
|
1603
1617
|
* @example "certification"
|
|
@@ -1617,7 +1631,7 @@ export interface Input9Mj6Qqre5S {
|
|
|
1617
1631
|
fileName: string;
|
|
1618
1632
|
}[];
|
|
1619
1633
|
}
|
|
1620
|
-
export interface
|
|
1634
|
+
export interface Input7Bzeouyok2 {
|
|
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 InputUnzi8Qisxeh {
|
|
|
1685
1699
|
acknowledgement?: string | null;
|
|
1686
1700
|
}
|
|
1687
1701
|
/** Validate certification move response schema */
|
|
1688
|
-
export interface
|
|
1702
|
+
export interface OutputUwt1Sn61Y6 {
|
|
1689
1703
|
courses: {
|
|
1690
1704
|
name: string;
|
|
1691
1705
|
status: string;
|
|
@@ -1696,21 +1710,21 @@ export interface OutputY45Vbqfo81 {
|
|
|
1696
1710
|
validated: boolean;
|
|
1697
1711
|
mustCreateCP: boolean;
|
|
1698
1712
|
}
|
|
1699
|
-
export interface
|
|
1713
|
+
export interface InputIvdyk9Pfse {
|
|
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 OutputMwn8En7U7W {
|
|
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 InputGmvq9Lbnmi {
|
|
1714
1728
|
/** @example true */
|
|
1715
1729
|
agreedWithCertTerms: boolean;
|
|
1716
1730
|
/** @example 1717230000000 */
|
|
@@ -1782,21 +1796,21 @@ export interface Input905Tgwkv6Fg {
|
|
|
1782
1796
|
/** @example "EXT#999" */
|
|
1783
1797
|
externalID2?: string | null;
|
|
1784
1798
|
}
|
|
1785
|
-
export interface
|
|
1799
|
+
export interface Input1Ev9Bv5Hdvl {
|
|
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 InputTlq6Xv9Taz {
|
|
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 Input7Ny7Clq7Hog {
|
|
1800
1814
|
/** @example true */
|
|
1801
1815
|
agreedWithCertTerms: boolean;
|
|
1802
1816
|
/** @example 1717230000000 */
|
|
@@ -1868,7 +1882,7 @@ export interface InputV6Wd08Y0N1H {
|
|
|
1868
1882
|
/** @example "EXT#999" */
|
|
1869
1883
|
externalID2?: string | null;
|
|
1870
1884
|
}
|
|
1871
|
-
export interface
|
|
1885
|
+
export interface InputThseotb1Em {
|
|
1872
1886
|
/**
|
|
1873
1887
|
* The grade to override the course result with
|
|
1874
1888
|
* @example "A"
|
|
@@ -1876,7 +1890,7 @@ export interface InputXkxx7Hw196 {
|
|
|
1876
1890
|
resultGrade: string;
|
|
1877
1891
|
}
|
|
1878
1892
|
/** Pending approval review parameters */
|
|
1879
|
-
export interface
|
|
1893
|
+
export interface InputLir3Krf8Mnf {
|
|
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 InputNnnwmf5V47 {
|
|
|
1889
1903
|
approved: boolean;
|
|
1890
1904
|
}
|
|
1891
1905
|
/** Schema for overriding course result dates. */
|
|
1892
|
-
export interface
|
|
1906
|
+
export interface InputNhgat59Crhi {
|
|
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 InputBury8Umbwt {
|
|
|
1901
1915
|
*/
|
|
1902
1916
|
completionDate?: number;
|
|
1903
1917
|
}
|
|
1904
|
-
export interface
|
|
1918
|
+
export interface InputMiwmdmv0H5 {
|
|
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 OutputMiwmdmv0H5 {
|
|
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 InputB03Ca4XqtwValueEnum {
|
|
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 = OutputH0Jr66Rgmi;
|
|
2025
2039
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2026
2040
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2027
2041
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2031,6 +2045,12 @@ export type CreateCertificationApplicationItemData = any;
|
|
|
2031
2045
|
export type CreateCertificationApplicationItemError = ErrorResponse;
|
|
2032
2046
|
export type DeleteCertificationApplicationBlacklistData = any;
|
|
2033
2047
|
export type DeleteCertificationApplicationBlacklistError = ErrorResponse;
|
|
2048
|
+
export type DeleteCertificationData = any;
|
|
2049
|
+
export type DeleteCertificationError = ErrorResponse;
|
|
2050
|
+
export type GetCertificationData = CertificationProcessResponseEntity;
|
|
2051
|
+
export type GetCertificationError = ErrorResponse;
|
|
2052
|
+
export type CreateCertificationData = any;
|
|
2053
|
+
export type CreateCertificationError = ErrorResponse;
|
|
2034
2054
|
export type DeleteCertificationApplicationData = any;
|
|
2035
2055
|
export type DeleteCertificationApplicationError = ErrorResponse;
|
|
2036
2056
|
export type GetCertificationApplicationData = CertificationApplicationResponseEntity;
|
|
@@ -2039,7 +2059,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2039
2059
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2040
2060
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2041
2061
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2042
|
-
export type GetCertificationCourseFileSignData =
|
|
2062
|
+
export type GetCertificationCourseFileSignData = OutputW20V1Q9Cfzh;
|
|
2043
2063
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2044
2064
|
export interface CreateCertificationCourseFileSignParams {
|
|
2045
2065
|
/** @example "pdf" */
|
|
@@ -2053,11 +2073,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2053
2073
|
/** @example "fileID" */
|
|
2054
2074
|
fileId: string;
|
|
2055
2075
|
}
|
|
2056
|
-
export type CreateCertificationCourseFileSignData =
|
|
2076
|
+
export type CreateCertificationCourseFileSignData = OutputMwn8En7U7W;
|
|
2057
2077
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2058
2078
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2059
2079
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2060
|
-
export type CreateCertificationCourseDocumentData =
|
|
2080
|
+
export type CreateCertificationCourseDocumentData = Output2Kraeg1Oyh;
|
|
2061
2081
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2062
2082
|
export type DeleteUserData = any;
|
|
2063
2083
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2069,7 +2089,7 @@ export type UpdateUserData = any;
|
|
|
2069
2089
|
export type UpdateUserError = ErrorResponse;
|
|
2070
2090
|
export type DeleteCertificationCourseData = any;
|
|
2071
2091
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2072
|
-
export type GetCertificationApplicationItemFileData =
|
|
2092
|
+
export type GetCertificationApplicationItemFileData = Output9162449N3V;
|
|
2073
2093
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2074
2094
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2075
2095
|
/** @example "pdf" */
|
|
@@ -2083,9 +2103,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2083
2103
|
/** @example "fileVersion" */
|
|
2084
2104
|
fileVersion: string;
|
|
2085
2105
|
}
|
|
2086
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2106
|
+
export type CreateCertificationApplicationItemFileData = OutputH9Obb07K5S;
|
|
2087
2107
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2088
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2108
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = Output99Bafbnty2;
|
|
2089
2109
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2090
2110
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2091
2111
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2093,7 +2113,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2093
2113
|
export type GetCourseError = ErrorResponse;
|
|
2094
2114
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2095
2115
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2096
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2116
|
+
export type GetCertificationApplicationForeignFillData = OutputBmyceqkfzo;
|
|
2097
2117
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2098
2118
|
export type GetCertificationPrintData = any;
|
|
2099
2119
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2103,10 +2123,8 @@ export type GetRequirementData = StudentHistoryResponseSchema;
|
|
|
2103
2123
|
export type GetRequirementError = ErrorResponse;
|
|
2104
2124
|
export type GetCertificationsUpcomingCoursesData = UserUpcomingCoursesResponseSchema;
|
|
2105
2125
|
export type GetCertificationsUpcomingCoursesError = ErrorResponse;
|
|
2106
|
-
export type
|
|
2107
|
-
export type
|
|
2108
|
-
export type CreateCertificationData = any;
|
|
2109
|
-
export type CreateCertificationError = ErrorResponse;
|
|
2126
|
+
export type GetUserDataData = UserDataResponse;
|
|
2127
|
+
export type GetUserDataError = ErrorResponse;
|
|
2110
2128
|
export type CreateCertificationApplicationLockData = any;
|
|
2111
2129
|
export type CreateCertificationApplicationLockError = ErrorResponse;
|
|
2112
2130
|
export type CreateSessionAddData = any;
|
|
@@ -2129,7 +2147,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2129
2147
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2130
2148
|
export type CreateCertificationWaiveData = any;
|
|
2131
2149
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2132
|
-
export type CreateCertificationMoveData =
|
|
2150
|
+
export type CreateCertificationMoveData = Output8K3Kc2235;
|
|
2133
2151
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2134
2152
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2135
2153
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2157,7 +2175,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2157
2175
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2158
2176
|
export type CreateCertificationCourseRedeemData = any;
|
|
2159
2177
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2160
|
-
export type CreateCertificationMoveValidateData =
|
|
2178
|
+
export type CreateCertificationMoveValidateData = OutputUwt1Sn61Y6;
|
|
2161
2179
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2162
2180
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2163
2181
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2171,7 +2189,7 @@ export type UpdateCertificationSetDatesData = any;
|
|
|
2171
2189
|
export type UpdateCertificationSetDatesError = ErrorResponse;
|
|
2172
2190
|
export type CreateCertificationPublishInfoData = any;
|
|
2173
2191
|
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2174
|
-
export type CreateCertificationResult =
|
|
2192
|
+
export type CreateCertificationResult = OutputMiwmdmv0H5;
|
|
2175
2193
|
export type CreateCertificationFail = ErrorResponse;
|
|
2176
2194
|
export type CreateCertificationPublishInfoResult = any;
|
|
2177
2195
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2218,7 +2236,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2218
2236
|
}
|
|
2219
2237
|
/**
|
|
2220
2238
|
* @title BCCSA Program API
|
|
2221
|
-
* @version 3.0.
|
|
2239
|
+
* @version 3.0.17
|
|
2222
2240
|
* @baseUrl http://localhost:8080
|
|
2223
2241
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2224
2242
|
*/
|
|
@@ -2233,7 +2251,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2233
2251
|
* @request POST:/contactUs
|
|
2234
2252
|
* @secure
|
|
2235
2253
|
*/
|
|
2236
|
-
listContactUs: (data:
|
|
2254
|
+
listContactUs: (data: InputEn99Qyf92S, params?: RequestParams) => Promise<any>;
|
|
2237
2255
|
};
|
|
2238
2256
|
customer: {
|
|
2239
2257
|
/**
|
|
@@ -2337,7 +2355,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2337
2355
|
* @request POST:/tenant/report/applicationExport
|
|
2338
2356
|
* @secure
|
|
2339
2357
|
*/
|
|
2340
|
-
createReportApplicationExport: (data:
|
|
2358
|
+
createReportApplicationExport: (data: Input38Hcfrecd8, params?: RequestParams) => Promise<any>;
|
|
2341
2359
|
/**
|
|
2342
2360
|
* @description Export a report of applications based on the provided filters.
|
|
2343
2361
|
*
|
|
@@ -2347,7 +2365,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2347
2365
|
* @request POST:/tenant/report/applicationStatus
|
|
2348
2366
|
* @secure
|
|
2349
2367
|
*/
|
|
2350
|
-
listReportApplicationStatus: (data:
|
|
2368
|
+
listReportApplicationStatus: (data: InputKme51Dz7A6, params?: RequestParams) => Promise<any>;
|
|
2351
2369
|
/**
|
|
2352
2370
|
* @description Export a report of applications based on the provided filters.
|
|
2353
2371
|
*
|
|
@@ -2357,7 +2375,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2357
2375
|
* @request POST:/tenant/report/applicationsReport
|
|
2358
2376
|
* @secure
|
|
2359
2377
|
*/
|
|
2360
|
-
createReportApplicationsReport: (data:
|
|
2378
|
+
createReportApplicationsReport: (data: InputZimh3Glsfmj, params?: RequestParams) => Promise<any>;
|
|
2361
2379
|
/**
|
|
2362
2380
|
* @description This route allows you to post certificates email for the tenant.
|
|
2363
2381
|
*
|
|
@@ -2367,7 +2385,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2367
2385
|
* @request POST:/tenant/certificates/email
|
|
2368
2386
|
* @secure
|
|
2369
2387
|
*/
|
|
2370
|
-
createCertificatesEmail: (data:
|
|
2388
|
+
createCertificatesEmail: (data: InputTsj7Au05Gw, params?: RequestParams) => Promise<any>;
|
|
2371
2389
|
/**
|
|
2372
2390
|
* @description Generate a preview of the completed certifications report.
|
|
2373
2391
|
*
|
|
@@ -2397,7 +2415,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2397
2415
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2398
2416
|
* @secure
|
|
2399
2417
|
*/
|
|
2400
|
-
createLicenseRedeem: (userId: string, data:
|
|
2418
|
+
createLicenseRedeem: (userId: string, data: InputUf1J0E7Mb6, params?: RequestParams) => Promise<any>;
|
|
2401
2419
|
/**
|
|
2402
2420
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2403
2421
|
*
|
|
@@ -2407,7 +2425,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2407
2425
|
* @request POST:/tenant/report/orglicenses/
|
|
2408
2426
|
* @secure
|
|
2409
2427
|
*/
|
|
2410
|
-
listReportOrglicenses: (data:
|
|
2428
|
+
listReportOrglicenses: (data: InputH7P19Hfii4I, params?: RequestParams) => Promise<any>;
|
|
2411
2429
|
/**
|
|
2412
2430
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2413
2431
|
*
|
|
@@ -2417,7 +2435,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2417
2435
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2418
2436
|
* @secure
|
|
2419
2437
|
*/
|
|
2420
|
-
createReportOrglicensesPreview: (data:
|
|
2438
|
+
createReportOrglicensesPreview: (data: InputHah5Gla80Q, params?: RequestParams) => Promise<any>;
|
|
2421
2439
|
/**
|
|
2422
2440
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2423
2441
|
*
|
|
@@ -2447,7 +2465,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2447
2465
|
* @request POST:/tenant/report/users/advanced
|
|
2448
2466
|
* @secure
|
|
2449
2467
|
*/
|
|
2450
|
-
createReportUsersAdvanced: (data:
|
|
2468
|
+
createReportUsersAdvanced: (data: InputUplth6C9Ad, params?: RequestParams) => Promise<any>;
|
|
2451
2469
|
/**
|
|
2452
2470
|
* @description Searches for users in the tenant by their IDs.
|
|
2453
2471
|
*
|
|
@@ -2457,7 +2475,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2457
2475
|
* @request POST:/tenant/search/users/ids
|
|
2458
2476
|
* @secure
|
|
2459
2477
|
*/
|
|
2460
|
-
listSearchUsersIds: (data:
|
|
2478
|
+
listSearchUsersIds: (data: Input7Jsubguwhpl, params?: RequestParams) => Promise<any>;
|
|
2461
2479
|
/**
|
|
2462
2480
|
* @description Searches for users in the tenant by term and filters.
|
|
2463
2481
|
*
|
|
@@ -2467,7 +2485,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2467
2485
|
* @request POST:/tenant/search/users/term
|
|
2468
2486
|
* @secure
|
|
2469
2487
|
*/
|
|
2470
|
-
createSearchUsersTerm: (data:
|
|
2488
|
+
createSearchUsersTerm: (data: InputJp1H3Pxa2V, params?: RequestParams) => Promise<any>;
|
|
2471
2489
|
/**
|
|
2472
2490
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2473
2491
|
*
|
|
@@ -2477,7 +2495,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2477
2495
|
* @request POST:/tenant/report/users/simple
|
|
2478
2496
|
* @secure
|
|
2479
2497
|
*/
|
|
2480
|
-
createReportUsersSimple: (data:
|
|
2498
|
+
createReportUsersSimple: (data: Input061Ikqn2Yo, params?: RequestParams) => Promise<any>;
|
|
2481
2499
|
/**
|
|
2482
2500
|
* @description Retrieve user by ID.
|
|
2483
2501
|
*
|
|
@@ -2487,7 +2505,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2487
2505
|
* @request POST:/tenant/search/users/count
|
|
2488
2506
|
* @secure
|
|
2489
2507
|
*/
|
|
2490
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2508
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputH0Jr66Rgmi>;
|
|
2491
2509
|
};
|
|
2492
2510
|
user: {
|
|
2493
2511
|
/**
|
|
@@ -2519,7 +2537,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2519
2537
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2520
2538
|
* @secure
|
|
2521
2539
|
*/
|
|
2522
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2540
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: InputA3Yzaj9Yge, params?: RequestParams) => Promise<any>;
|
|
2523
2541
|
/**
|
|
2524
2542
|
* @description Delete a certification process application by type.
|
|
2525
2543
|
*
|
|
@@ -2530,6 +2548,36 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2530
2548
|
* @secure
|
|
2531
2549
|
*/
|
|
2532
2550
|
deleteCertificationApplicationBlacklist: (userId: string, certProcId: string, applicationType: string, sourceId: string, params?: RequestParams) => Promise<any>;
|
|
2551
|
+
/**
|
|
2552
|
+
* @description Delete certification process by user and certproc IDs.
|
|
2553
|
+
*
|
|
2554
|
+
* @tags Certification
|
|
2555
|
+
* @name DeleteCertification
|
|
2556
|
+
* @summary Delete Certification Process
|
|
2557
|
+
* @request DELETE:/user/{userID}/certification/{certProcID}
|
|
2558
|
+
* @secure
|
|
2559
|
+
*/
|
|
2560
|
+
deleteCertification: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
|
|
2561
|
+
/**
|
|
2562
|
+
* @description Retrieve course for a user by their user ID.
|
|
2563
|
+
*
|
|
2564
|
+
* @tags Certification
|
|
2565
|
+
* @name GetCertification
|
|
2566
|
+
* @summary Get Certification Process for User
|
|
2567
|
+
* @request GET:/user/{userID}/certification/{certProcID}
|
|
2568
|
+
* @secure
|
|
2569
|
+
*/
|
|
2570
|
+
getCertification: (userId: string, certProcId: string, params?: RequestParams) => Promise<CertificationProcessResponseEntity>;
|
|
2571
|
+
/**
|
|
2572
|
+
* @description This route allows you to start a certification process for a user.
|
|
2573
|
+
*
|
|
2574
|
+
* @tags Certification
|
|
2575
|
+
* @name CreateCertification
|
|
2576
|
+
* @summary Start Certification Process
|
|
2577
|
+
* @request POST:/user/{userID}/certification/{certProcID}
|
|
2578
|
+
* @secure
|
|
2579
|
+
*/
|
|
2580
|
+
createCertification: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
|
|
2533
2581
|
/**
|
|
2534
2582
|
* @description Delete a certification process application by type.
|
|
2535
2583
|
*
|
|
@@ -2579,7 +2627,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2579
2627
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2580
2628
|
* @secure
|
|
2581
2629
|
*/
|
|
2582
|
-
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<OutputW20V1Q9Cfzh>;
|
|
2583
2631
|
/**
|
|
2584
2632
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2585
2633
|
*
|
|
@@ -2589,7 +2637,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2589
2637
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2590
2638
|
* @secure
|
|
2591
2639
|
*/
|
|
2592
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2640
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputMwn8En7U7W>;
|
|
2593
2641
|
/**
|
|
2594
2642
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2595
2643
|
*
|
|
@@ -2609,7 +2657,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2609
2657
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2610
2658
|
* @secure
|
|
2611
2659
|
*/
|
|
2612
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2660
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: Input2Kraeg1Oyh, params?: RequestParams) => Promise<Output2Kraeg1Oyh>;
|
|
2613
2661
|
/**
|
|
2614
2662
|
* @description Delete user by ID.
|
|
2615
2663
|
*
|
|
@@ -2639,7 +2687,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2639
2687
|
* @request POST:/user/{userID}
|
|
2640
2688
|
* @secure
|
|
2641
2689
|
*/
|
|
2642
|
-
createUser: (userId: string, data:
|
|
2690
|
+
createUser: (userId: string, data: InputGmvq9Lbnmi, params?: RequestParams) => Promise<any>;
|
|
2643
2691
|
/**
|
|
2644
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.
|
|
2645
2693
|
*
|
|
@@ -2649,7 +2697,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2649
2697
|
* @request PUT:/user/{userID}
|
|
2650
2698
|
* @secure
|
|
2651
2699
|
*/
|
|
2652
|
-
updateUser: (userId: string, data:
|
|
2700
|
+
updateUser: (userId: string, data: Input7Ny7Clq7Hog, params?: RequestParams) => Promise<any>;
|
|
2653
2701
|
/**
|
|
2654
2702
|
* @description Delete course from user
|
|
2655
2703
|
*
|
|
@@ -2669,7 +2717,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2669
2717
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2670
2718
|
* @secure
|
|
2671
2719
|
*/
|
|
2672
|
-
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<Output9162449N3V>;
|
|
2673
2721
|
/**
|
|
2674
2722
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2675
2723
|
*
|
|
@@ -2679,7 +2727,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2679
2727
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2680
2728
|
* @secure
|
|
2681
2729
|
*/
|
|
2682
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2730
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputH9Obb07K5S>;
|
|
2683
2731
|
/**
|
|
2684
2732
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2685
2733
|
*
|
|
@@ -2689,7 +2737,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2689
2737
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2690
2738
|
* @secure
|
|
2691
2739
|
*/
|
|
2692
|
-
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<Output99Bafbnty2>;
|
|
2693
2741
|
/**
|
|
2694
2742
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2695
2743
|
*
|
|
@@ -2729,7 +2777,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2729
2777
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2730
2778
|
* @secure
|
|
2731
2779
|
*/
|
|
2732
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2780
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputBmyceqkfzo>;
|
|
2733
2781
|
/**
|
|
2734
2782
|
* @description This endpoint will print certificate
|
|
2735
2783
|
*
|
|
@@ -2771,25 +2819,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2771
2819
|
*/
|
|
2772
2820
|
getCertificationsUpcomingCourses: (userId: string, params?: RequestParams) => Promise<UserUpcomingCoursesResponseSchema>;
|
|
2773
2821
|
/**
|
|
2774
|
-
* @description Retrieve
|
|
2775
|
-
*
|
|
2776
|
-
* @tags Certification
|
|
2777
|
-
* @name GetCertification
|
|
2778
|
-
* @summary Get Certification Process for User
|
|
2779
|
-
* @request GET:/user/{userID}/certification/{certProcID}
|
|
2780
|
-
* @secure
|
|
2781
|
-
*/
|
|
2782
|
-
getCertification: (userId: string, certProcId: string, params?: RequestParams) => Promise<CertificationProcessResponseEntity>;
|
|
2783
|
-
/**
|
|
2784
|
-
* @description This route allows you to start a certification process for a user.
|
|
2822
|
+
* @description Retrieve user data from IDM including user profile and partition data. Uses API credentials for full read access.
|
|
2785
2823
|
*
|
|
2786
|
-
* @tags
|
|
2787
|
-
* @name
|
|
2788
|
-
* @summary
|
|
2789
|
-
* @request
|
|
2824
|
+
* @tags User
|
|
2825
|
+
* @name GetUserData
|
|
2826
|
+
* @summary Get User Data
|
|
2827
|
+
* @request GET:/user/{userID}/userData
|
|
2790
2828
|
* @secure
|
|
2791
2829
|
*/
|
|
2792
|
-
|
|
2830
|
+
getUserData: (userId: string, params?: RequestParams) => Promise<UserDataResponse>;
|
|
2793
2831
|
/**
|
|
2794
2832
|
* @description This route indicates users should not be able to advance or make changes to applications in this certification.
|
|
2795
2833
|
*
|
|
@@ -2799,7 +2837,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2799
2837
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2800
2838
|
* @secure
|
|
2801
2839
|
*/
|
|
2802
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2840
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputYkrswdxt80H, params?: RequestParams) => Promise<any>;
|
|
2803
2841
|
/**
|
|
2804
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.
|
|
2805
2843
|
*
|
|
@@ -2829,7 +2867,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2829
2867
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2830
2868
|
* @secure
|
|
2831
2869
|
*/
|
|
2832
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2870
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputOu74Xwaupt, params?: RequestParams) => Promise<any>;
|
|
2833
2871
|
/**
|
|
2834
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.
|
|
2835
2873
|
*
|
|
@@ -2839,7 +2877,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2839
2877
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2840
2878
|
* @secure
|
|
2841
2879
|
*/
|
|
2842
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2880
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputEoy83X4Gst, params?: RequestParams) => Promise<any>;
|
|
2843
2881
|
/**
|
|
2844
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.
|
|
2845
2883
|
*
|
|
@@ -2849,7 +2887,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2849
2887
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2850
2888
|
* @secure
|
|
2851
2889
|
*/
|
|
2852
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2890
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputSzy4Sbd1Vek, params?: RequestParams) => Promise<any>;
|
|
2853
2891
|
/**
|
|
2854
2892
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2855
2893
|
*
|
|
@@ -2859,7 +2897,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2859
2897
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2860
2898
|
* @secure
|
|
2861
2899
|
*/
|
|
2862
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2900
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: Input0Xoiyidh46, params?: RequestParams) => Promise<any>;
|
|
2863
2901
|
/**
|
|
2864
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.
|
|
2865
2903
|
*
|
|
@@ -2899,7 +2937,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2899
2937
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2900
2938
|
* @secure
|
|
2901
2939
|
*/
|
|
2902
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2940
|
+
createCertificationWaive: (userId: string, certProcId: string, data: Input9Gk1Eer7Ldh, params?: RequestParams) => Promise<any>;
|
|
2903
2941
|
/**
|
|
2904
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.
|
|
2905
2943
|
*
|
|
@@ -2909,7 +2947,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2909
2947
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2910
2948
|
* @secure
|
|
2911
2949
|
*/
|
|
2912
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2950
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<Output8K3Kc2235>;
|
|
2913
2951
|
/**
|
|
2914
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.
|
|
2915
2953
|
*
|
|
@@ -2939,7 +2977,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2939
2977
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2940
2978
|
* @secure
|
|
2941
2979
|
*/
|
|
2942
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
2980
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputB03Ca4Xqtw, params?: RequestParams) => Promise<any>;
|
|
2943
2981
|
/**
|
|
2944
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.
|
|
2945
2983
|
*
|
|
@@ -2989,7 +3027,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2989
3027
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
2990
3028
|
* @secure
|
|
2991
3029
|
*/
|
|
2992
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
3030
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: InputNqcjc8Hvq6, params?: RequestParams) => Promise<any>;
|
|
2993
3031
|
/**
|
|
2994
3032
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
2995
3033
|
*
|
|
@@ -3009,7 +3047,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3009
3047
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3010
3048
|
* @secure
|
|
3011
3049
|
*/
|
|
3012
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3050
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputEdu05Vaqm1, params?: RequestParams) => Promise<any>;
|
|
3013
3051
|
/**
|
|
3014
3052
|
* @description This route allows you to submit a pending approval.
|
|
3015
3053
|
*
|
|
@@ -3019,7 +3057,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3019
3057
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3020
3058
|
* @secure
|
|
3021
3059
|
*/
|
|
3022
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3060
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: Input6Wmqoozm3, params?: RequestParams) => Promise<any>;
|
|
3023
3061
|
/**
|
|
3024
3062
|
* @description This route allows you to review a pending approval.
|
|
3025
3063
|
*
|
|
@@ -3029,7 +3067,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3029
3067
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3030
3068
|
* @secure
|
|
3031
3069
|
*/
|
|
3032
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3070
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputLir3Krf8Mnf, params?: RequestParams) => Promise<any>;
|
|
3033
3071
|
/**
|
|
3034
3072
|
* @description Redeems a license for a user by product ID.
|
|
3035
3073
|
*
|
|
@@ -3039,7 +3077,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3039
3077
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3040
3078
|
* @secure
|
|
3041
3079
|
*/
|
|
3042
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3080
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: Input7Bzeouyok2, params?: RequestParams) => Promise<any>;
|
|
3043
3081
|
/**
|
|
3044
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.
|
|
3045
3083
|
*
|
|
@@ -3049,7 +3087,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3049
3087
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3050
3088
|
* @secure
|
|
3051
3089
|
*/
|
|
3052
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3090
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputUwt1Sn61Y6>;
|
|
3053
3091
|
/**
|
|
3054
3092
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3055
3093
|
*
|
|
@@ -3059,7 +3097,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3059
3097
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3060
3098
|
* @secure
|
|
3061
3099
|
*/
|
|
3062
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3100
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputIvdyk9Pfse, params?: RequestParams) => Promise<any>;
|
|
3063
3101
|
/**
|
|
3064
3102
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3065
3103
|
*
|
|
@@ -3069,7 +3107,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3069
3107
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3070
3108
|
* @secure
|
|
3071
3109
|
*/
|
|
3072
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3110
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input1Ev9Bv5Hdvl, params?: RequestParams) => Promise<any>;
|
|
3073
3111
|
/**
|
|
3074
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.
|
|
3075
3113
|
*
|
|
@@ -3079,7 +3117,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3079
3117
|
* @request POST:/user/{userID}/updateITA
|
|
3080
3118
|
* @secure
|
|
3081
3119
|
*/
|
|
3082
|
-
createUpdateIta: (userId: string, data:
|
|
3120
|
+
createUpdateIta: (userId: string, data: InputTlq6Xv9Taz, params?: RequestParams) => Promise<any>;
|
|
3083
3121
|
/**
|
|
3084
3122
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3085
3123
|
*
|
|
@@ -3089,7 +3127,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3089
3127
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3090
3128
|
* @secure
|
|
3091
3129
|
*/
|
|
3092
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3130
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputThseotb1Em, params?: RequestParams) => Promise<any>;
|
|
3093
3131
|
/**
|
|
3094
3132
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3095
3133
|
*
|
|
@@ -3099,7 +3137,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3099
3137
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3100
3138
|
* @secure
|
|
3101
3139
|
*/
|
|
3102
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3140
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputNhgat59Crhi, params?: RequestParams) => Promise<any>;
|
|
3103
3141
|
/**
|
|
3104
3142
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3105
3143
|
*
|
|
@@ -3121,7 +3159,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3121
3159
|
* @request POST:/users/certification/{certSpecID}
|
|
3122
3160
|
* @secure
|
|
3123
3161
|
*/
|
|
3124
|
-
createCertification: (certSpecId: string, data:
|
|
3162
|
+
createCertification: (certSpecId: string, data: InputMiwmdmv0H5, params?: RequestParams) => Promise<OutputMiwmdmv0H5>;
|
|
3125
3163
|
/**
|
|
3126
3164
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3127
3165
|
*
|