@ikonintegration/bccsa-program-api 3.0.2 → 3.0.3
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 +102 -97
- package/dist/Api.d.ts +108 -103
- package/dist/Api.js +12 -12
- package/dist/Api.js.map +1 -1
- package/package.json +1 -1
package/dist/Api.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ export interface ErrorResponse {
|
|
|
5
5
|
/** Error code */
|
|
6
6
|
errCode: string;
|
|
7
7
|
}
|
|
8
|
-
export interface
|
|
8
|
+
export interface InputTvxwuv0Lzz {
|
|
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 InputZ6Pi8Vxh7M {
|
|
453
453
|
/**
|
|
454
454
|
* ID of the certification to filter applications by
|
|
455
455
|
* @example "certification123"
|
|
@@ -506,14 +506,14 @@ export interface InputDumukbklse {
|
|
|
506
506
|
*/
|
|
507
507
|
ignoreCompletedCertifications?: boolean | null;
|
|
508
508
|
}
|
|
509
|
-
export interface
|
|
509
|
+
export interface InputGye2V8Ohmd {
|
|
510
510
|
/**
|
|
511
511
|
* ID of the certification to filter applications by
|
|
512
512
|
* @example "certification123"
|
|
513
513
|
*/
|
|
514
514
|
certificationID: string;
|
|
515
515
|
}
|
|
516
|
-
export interface
|
|
516
|
+
export interface InputOv5Fi8V7Spg {
|
|
517
517
|
/**
|
|
518
518
|
* ID of the certification to filter applications by
|
|
519
519
|
* @example "certification123"
|
|
@@ -570,7 +570,7 @@ export interface InputUq7B65Nv6O {
|
|
|
570
570
|
*/
|
|
571
571
|
ignoreCompletedCertifications?: boolean | null;
|
|
572
572
|
}
|
|
573
|
-
export interface
|
|
573
|
+
export interface InputBkk90S004W {
|
|
574
574
|
/**
|
|
575
575
|
* The ID of the certificate specifications to be used for the email
|
|
576
576
|
* @example "certSpecsID123"
|
|
@@ -611,7 +611,7 @@ export interface InputCv7Dbpazyrk {
|
|
|
611
611
|
emailAddress: string;
|
|
612
612
|
}[];
|
|
613
613
|
}
|
|
614
|
-
export interface
|
|
614
|
+
export interface InputX2C1K65Gifl {
|
|
615
615
|
/**
|
|
616
616
|
* The ID of the product for which the license is being redeemed
|
|
617
617
|
* @example "productID123"
|
|
@@ -623,7 +623,7 @@ export interface InputJk3Bw1Tint {
|
|
|
623
623
|
*/
|
|
624
624
|
sessionID?: string;
|
|
625
625
|
}
|
|
626
|
-
export interface
|
|
626
|
+
export interface Input2Wsk314Pl5 {
|
|
627
627
|
/**
|
|
628
628
|
* Search term to filter licenses
|
|
629
629
|
* @example "active"
|
|
@@ -640,7 +640,7 @@ export interface InputWzettp4290I {
|
|
|
640
640
|
*/
|
|
641
641
|
sortField?: any;
|
|
642
642
|
}
|
|
643
|
-
export interface
|
|
643
|
+
export interface InputTxggs7Woq6 {
|
|
644
644
|
/**
|
|
645
645
|
* Search term to filter licenses
|
|
646
646
|
* @example "active"
|
|
@@ -679,7 +679,7 @@ export interface ReportXLSXSchema {
|
|
|
679
679
|
xlsxStream: any;
|
|
680
680
|
contentType: ReportXlsxSchemaContentTypeEnum;
|
|
681
681
|
}
|
|
682
|
-
export interface
|
|
682
|
+
export interface InputYq50Sx0V4B {
|
|
683
683
|
/**
|
|
684
684
|
* Start date for the report
|
|
685
685
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -701,11 +701,11 @@ export interface Input892Rn0Dcsi {
|
|
|
701
701
|
*/
|
|
702
702
|
dateType?: string;
|
|
703
703
|
}
|
|
704
|
-
export interface
|
|
704
|
+
export interface InputTbhih4Yvyml {
|
|
705
705
|
/** List of user IDs to search for in the tenant. */
|
|
706
706
|
IDs: (string | null)[];
|
|
707
707
|
}
|
|
708
|
-
export interface
|
|
708
|
+
export interface InputO4A7I6Erux {
|
|
709
709
|
/** The term to search for in the user profiles. */
|
|
710
710
|
searchTerm?: string | null;
|
|
711
711
|
/** Filter criteria for the user search. */
|
|
@@ -745,7 +745,7 @@ export interface InputV6E8Mdcsrog {
|
|
|
745
745
|
};
|
|
746
746
|
};
|
|
747
747
|
}
|
|
748
|
-
export interface
|
|
748
|
+
export interface InputAvxn578Ayl {
|
|
749
749
|
/** The term to search for in the user profiles. */
|
|
750
750
|
searchTerm?: string | null;
|
|
751
751
|
/** Filter criteria for the user search. */
|
|
@@ -787,19 +787,19 @@ export interface InputRh1Mxhpymzi {
|
|
|
787
787
|
}
|
|
788
788
|
/** External system ID 2 */
|
|
789
789
|
export type ExternalID2 = number;
|
|
790
|
-
export interface
|
|
790
|
+
export interface OutputC6Zbeptre9 {
|
|
791
791
|
/** External system ID 2 */
|
|
792
792
|
userCount: ExternalID2;
|
|
793
793
|
transactionID?: string | null;
|
|
794
794
|
}
|
|
795
|
-
export interface
|
|
795
|
+
export interface OutputLdhu1O1Ukh {
|
|
796
796
|
/**
|
|
797
797
|
* Signed URL for the course file
|
|
798
798
|
* @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"
|
|
799
799
|
*/
|
|
800
800
|
fileURL: string;
|
|
801
801
|
}
|
|
802
|
-
export interface
|
|
802
|
+
export interface OutputNjpt2Hwj7U {
|
|
803
803
|
/**
|
|
804
804
|
* Amount to be refunded for the cancellation
|
|
805
805
|
* @example 0
|
|
@@ -1085,7 +1085,7 @@ export interface CourseResponseEntity {
|
|
|
1085
1085
|
/** Justifications for overridden course restrictions */
|
|
1086
1086
|
overwrittenJustification?: OverwrittenJustification;
|
|
1087
1087
|
}
|
|
1088
|
-
export interface
|
|
1088
|
+
export interface OutputVis5Wecmb6 {
|
|
1089
1089
|
/**
|
|
1090
1090
|
* Signed URL for the course file
|
|
1091
1091
|
* @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"
|
|
@@ -1103,7 +1103,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1103
1103
|
transactionID?: string | null;
|
|
1104
1104
|
}
|
|
1105
1105
|
/** Application Foreign Fill response type */
|
|
1106
|
-
export interface
|
|
1106
|
+
export interface OutputBl0Nmvx0Fl {
|
|
1107
1107
|
items: {
|
|
1108
1108
|
userID: string;
|
|
1109
1109
|
createdOn?: number;
|
|
@@ -1322,7 +1322,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1322
1322
|
applicationItems?: Record<string, any>[];
|
|
1323
1323
|
transactionID?: string | null;
|
|
1324
1324
|
}
|
|
1325
|
-
export interface
|
|
1325
|
+
export interface Input8Tmaavfxxb {
|
|
1326
1326
|
issuedOn?: number;
|
|
1327
1327
|
expiresOn?: number;
|
|
1328
1328
|
fileItems?: {
|
|
@@ -1331,14 +1331,14 @@ export interface InputNcjglx3Tjm {
|
|
|
1331
1331
|
}[];
|
|
1332
1332
|
additionalNotes?: string | null;
|
|
1333
1333
|
}
|
|
1334
|
-
export interface
|
|
1334
|
+
export interface OutputPcdo7909Xu {
|
|
1335
1335
|
/**
|
|
1336
1336
|
* Signed URL for the course file
|
|
1337
1337
|
* @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"
|
|
1338
1338
|
*/
|
|
1339
1339
|
fileURL: string;
|
|
1340
1340
|
}
|
|
1341
|
-
export interface
|
|
1341
|
+
export interface Input3M1P1Qx4Be {
|
|
1342
1342
|
/**
|
|
1343
1343
|
* Indicates whether the waiver is approved
|
|
1344
1344
|
* @example true
|
|
@@ -1350,14 +1350,14 @@ export interface InputUa9Yvagjrf {
|
|
|
1350
1350
|
*/
|
|
1351
1351
|
additionalNotes?: string | null;
|
|
1352
1352
|
}
|
|
1353
|
-
export interface
|
|
1353
|
+
export interface InputYbre7T2Cxe {
|
|
1354
1354
|
/**
|
|
1355
1355
|
* Optional notes regarding the waiver
|
|
1356
1356
|
* @example "Waiver granted due to special circumstances."
|
|
1357
1357
|
*/
|
|
1358
1358
|
additionalNotes?: string | null;
|
|
1359
1359
|
}
|
|
1360
|
-
export interface
|
|
1360
|
+
export interface InputA0Hnvf0Nx2 {
|
|
1361
1361
|
students: {
|
|
1362
1362
|
/**
|
|
1363
1363
|
* User ID of the student to redeem the course for
|
|
@@ -1391,7 +1391,7 @@ export interface InputNrbtc45Gm6 {
|
|
|
1391
1391
|
*/
|
|
1392
1392
|
autoEnrolSessionID?: string;
|
|
1393
1393
|
}
|
|
1394
|
-
export interface
|
|
1394
|
+
export interface InputMigwi1Qi7G {
|
|
1395
1395
|
invites: {
|
|
1396
1396
|
/**
|
|
1397
1397
|
* Email address of the user to invite
|
|
@@ -1420,7 +1420,7 @@ export interface InputClawl8Syhe {
|
|
|
1420
1420
|
*/
|
|
1421
1421
|
isReservedSeat: boolean;
|
|
1422
1422
|
}
|
|
1423
|
-
export interface
|
|
1423
|
+
export interface InputRgdzgwaso4 {
|
|
1424
1424
|
/**
|
|
1425
1425
|
* Indicates whether to waive the certification process
|
|
1426
1426
|
* @example true
|
|
@@ -1433,7 +1433,7 @@ export interface Input11Ltvrwz24 {
|
|
|
1433
1433
|
comments?: string | null;
|
|
1434
1434
|
}
|
|
1435
1435
|
/** Certification move response schema */
|
|
1436
|
-
export interface
|
|
1436
|
+
export interface Output4I79T77Ric {
|
|
1437
1437
|
errors?: {
|
|
1438
1438
|
status: string;
|
|
1439
1439
|
object?: Record<string, any>;
|
|
@@ -1441,19 +1441,19 @@ export interface OutputSkawtoyaw {
|
|
|
1441
1441
|
}[];
|
|
1442
1442
|
}
|
|
1443
1443
|
/** Schema for writing a certification trigger check. */
|
|
1444
|
-
export interface
|
|
1444
|
+
export interface InputF0Scbkkx2H {
|
|
1445
1445
|
/**
|
|
1446
1446
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1447
1447
|
* @example "CHECKED"
|
|
1448
1448
|
*/
|
|
1449
|
-
value:
|
|
1449
|
+
value: InputF0Scbkkx2HValueEnum;
|
|
1450
1450
|
/**
|
|
1451
1451
|
* List of course IDs that are blocked by this trigger check.
|
|
1452
1452
|
* @example ["course1","course2"]
|
|
1453
1453
|
*/
|
|
1454
1454
|
blockedCourses?: string[];
|
|
1455
1455
|
}
|
|
1456
|
-
export interface
|
|
1456
|
+
export interface Input4Hktu5Vloe {
|
|
1457
1457
|
/**
|
|
1458
1458
|
* Indicates whether the application item is approved
|
|
1459
1459
|
* @example true
|
|
@@ -1479,7 +1479,7 @@ export interface Input8Z0Atlua8P {
|
|
|
1479
1479
|
export interface StudentHistoryRequestSchema {
|
|
1480
1480
|
requirements: string[];
|
|
1481
1481
|
}
|
|
1482
|
-
export interface
|
|
1482
|
+
export interface InputL8Sf59Uzhm {
|
|
1483
1483
|
/**
|
|
1484
1484
|
* Optional activation key for the application
|
|
1485
1485
|
* @example "AK-123456"
|
|
@@ -1487,7 +1487,7 @@ export interface InputAaqdabpog5 {
|
|
|
1487
1487
|
activationKey?: string;
|
|
1488
1488
|
}
|
|
1489
1489
|
/** Schema for course submission item details post request. */
|
|
1490
|
-
export interface
|
|
1490
|
+
export interface Input6Yt73Y2Qm0J {
|
|
1491
1491
|
/**
|
|
1492
1492
|
* The ID of the file being submitted.
|
|
1493
1493
|
* @example "fileID123"
|
|
@@ -1500,7 +1500,7 @@ export interface InputNwou315U97 {
|
|
|
1500
1500
|
fileName: string;
|
|
1501
1501
|
}
|
|
1502
1502
|
/** Schema for the response to course submission item details post request. */
|
|
1503
|
-
export interface
|
|
1503
|
+
export interface Output6Yt73Y2Qm0J {
|
|
1504
1504
|
submissionItems: {
|
|
1505
1505
|
/**
|
|
1506
1506
|
* The ID of the file being submitted.
|
|
@@ -1515,7 +1515,7 @@ export interface OutputNwou315U97 {
|
|
|
1515
1515
|
}[];
|
|
1516
1516
|
}
|
|
1517
1517
|
/** Pending approval submission parameters */
|
|
1518
|
-
export interface
|
|
1518
|
+
export interface InputQuioenmjqm {
|
|
1519
1519
|
/**
|
|
1520
1520
|
* Type of pending approval
|
|
1521
1521
|
* @example "certification"
|
|
@@ -1535,7 +1535,7 @@ export interface InputBa5J0Xro42 {
|
|
|
1535
1535
|
fileName: string;
|
|
1536
1536
|
}[];
|
|
1537
1537
|
}
|
|
1538
|
-
export interface
|
|
1538
|
+
export interface InputX20Gr5Dswoh {
|
|
1539
1539
|
/**
|
|
1540
1540
|
* The ID of the course for which the license is being redeemed
|
|
1541
1541
|
* @example "courseID123"
|
|
@@ -1596,9 +1596,14 @@ export interface InputSm8Kytz15Q {
|
|
|
1596
1596
|
* @example "autoEnrolSessionID678"
|
|
1597
1597
|
*/
|
|
1598
1598
|
autoEnrolSessionID?: string | null;
|
|
1599
|
+
/**
|
|
1600
|
+
* The response to the acknowledgement of terms or conditions
|
|
1601
|
+
* @example "Accepted"
|
|
1602
|
+
*/
|
|
1603
|
+
acknowledgement?: string | null;
|
|
1599
1604
|
}
|
|
1600
1605
|
/** Validate certification move response schema */
|
|
1601
|
-
export interface
|
|
1606
|
+
export interface OutputU05X7H42A4 {
|
|
1602
1607
|
courses: {
|
|
1603
1608
|
name: string;
|
|
1604
1609
|
status: string;
|
|
@@ -1609,21 +1614,21 @@ export interface OutputUhpj06T58M {
|
|
|
1609
1614
|
validated: boolean;
|
|
1610
1615
|
mustCreateCP: boolean;
|
|
1611
1616
|
}
|
|
1612
|
-
export interface
|
|
1617
|
+
export interface Input84Yzg8N851 {
|
|
1613
1618
|
/**
|
|
1614
1619
|
* Comments regarding the end of the cooldown period
|
|
1615
1620
|
* @example "Cooldown period ended successfully."
|
|
1616
1621
|
*/
|
|
1617
1622
|
comments: string;
|
|
1618
1623
|
}
|
|
1619
|
-
export interface
|
|
1624
|
+
export interface Output15Dbnf1Bbf {
|
|
1620
1625
|
/**
|
|
1621
1626
|
* Signed URL for the course file
|
|
1622
1627
|
* @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"
|
|
1623
1628
|
*/
|
|
1624
1629
|
fileURL: string;
|
|
1625
1630
|
}
|
|
1626
|
-
export interface
|
|
1631
|
+
export interface InputMvudju017X {
|
|
1627
1632
|
/** @example true */
|
|
1628
1633
|
agreedWithCertTerms: boolean;
|
|
1629
1634
|
/** @example 1717230000000 */
|
|
@@ -1695,21 +1700,21 @@ export interface InputSlux1Wdv32 {
|
|
|
1695
1700
|
/** @example "EXT#999" */
|
|
1696
1701
|
externalID2?: string | null;
|
|
1697
1702
|
}
|
|
1698
|
-
export interface
|
|
1703
|
+
export interface InputDnhk6I4Mqw {
|
|
1699
1704
|
/**
|
|
1700
1705
|
* Comments regarding the course unlock action
|
|
1701
1706
|
* @example "Course unlocked successfully."
|
|
1702
1707
|
*/
|
|
1703
1708
|
comments: string;
|
|
1704
1709
|
}
|
|
1705
|
-
export interface
|
|
1710
|
+
export interface InputR5Dyvltvs4 {
|
|
1706
1711
|
/**
|
|
1707
1712
|
* ITA number to update for the user
|
|
1708
1713
|
* @example "ITA123456"
|
|
1709
1714
|
*/
|
|
1710
1715
|
itaNumber: string;
|
|
1711
1716
|
}
|
|
1712
|
-
export interface
|
|
1717
|
+
export interface InputQoo29Cdxrrf {
|
|
1713
1718
|
/** @example true */
|
|
1714
1719
|
agreedWithCertTerms: boolean;
|
|
1715
1720
|
/** @example 1717230000000 */
|
|
@@ -1781,7 +1786,7 @@ export interface InputE8Hrkb3574 {
|
|
|
1781
1786
|
/** @example "EXT#999" */
|
|
1782
1787
|
externalID2?: string | null;
|
|
1783
1788
|
}
|
|
1784
|
-
export interface
|
|
1789
|
+
export interface InputWozo5Nmr6A {
|
|
1785
1790
|
/**
|
|
1786
1791
|
* The grade to override the course result with
|
|
1787
1792
|
* @example "A"
|
|
@@ -1789,7 +1794,7 @@ export interface Input07W55Khdfh {
|
|
|
1789
1794
|
resultGrade: string;
|
|
1790
1795
|
}
|
|
1791
1796
|
/** Pending approval review parameters */
|
|
1792
|
-
export interface
|
|
1797
|
+
export interface InputG1Rfyng6Qw {
|
|
1793
1798
|
/**
|
|
1794
1799
|
* Notes provided by the reviewer for the pending approval
|
|
1795
1800
|
* @example "Please review the submitted documents."
|
|
@@ -1802,7 +1807,7 @@ export interface InputIsb9Rfgqkbh {
|
|
|
1802
1807
|
approved: boolean;
|
|
1803
1808
|
}
|
|
1804
1809
|
/** Schema for overriding course result dates. */
|
|
1805
|
-
export interface
|
|
1810
|
+
export interface InputW9Rwp645Nq {
|
|
1806
1811
|
/**
|
|
1807
1812
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1808
1813
|
* @example 1735689600000
|
|
@@ -1814,14 +1819,14 @@ export interface Input1Vc8C8B4Ug {
|
|
|
1814
1819
|
*/
|
|
1815
1820
|
completionDate?: number;
|
|
1816
1821
|
}
|
|
1817
|
-
export interface
|
|
1822
|
+
export interface InputSbgwv0Lrpq {
|
|
1818
1823
|
filter: {
|
|
1819
1824
|
from?: number;
|
|
1820
1825
|
sortOrder?: string;
|
|
1821
1826
|
sortField?: string;
|
|
1822
1827
|
};
|
|
1823
1828
|
}
|
|
1824
|
-
export interface
|
|
1829
|
+
export interface OutputSbgwv0Lrpq {
|
|
1825
1830
|
users: {
|
|
1826
1831
|
firstName: string;
|
|
1827
1832
|
lastName: string;
|
|
@@ -1841,7 +1846,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
1841
1846
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1842
1847
|
* @example "CHECKED"
|
|
1843
1848
|
*/
|
|
1844
|
-
export declare enum
|
|
1849
|
+
export declare enum InputF0Scbkkx2HValueEnum {
|
|
1845
1850
|
CHECKED = "CHECKED",
|
|
1846
1851
|
UNCHECKED = "UNCHECKED",
|
|
1847
1852
|
NOVALUE = "NOVALUE"
|
|
@@ -1932,7 +1937,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
1932
1937
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
1933
1938
|
export type CreateReportUsersSimpleData = any;
|
|
1934
1939
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
1935
|
-
export type CreateSearchUsersCountData =
|
|
1940
|
+
export type CreateSearchUsersCountData = OutputC6Zbeptre9;
|
|
1936
1941
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
1937
1942
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
1938
1943
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -1950,7 +1955,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
1950
1955
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
1951
1956
|
export type DeleteCertificationCourseFileSignData = any;
|
|
1952
1957
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
1953
|
-
export type GetCertificationCourseFileSignData =
|
|
1958
|
+
export type GetCertificationCourseFileSignData = OutputVis5Wecmb6;
|
|
1954
1959
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
1955
1960
|
export interface CreateCertificationCourseFileSignParams {
|
|
1956
1961
|
/** @example "pdf" */
|
|
@@ -1964,12 +1969,12 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
1964
1969
|
/** @example "fileID" */
|
|
1965
1970
|
fileId: string;
|
|
1966
1971
|
}
|
|
1967
|
-
export type CreateCertificationCourseFileSignData =
|
|
1972
|
+
export type CreateCertificationCourseFileSignData = Output15Dbnf1Bbf;
|
|
1968
1973
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
1969
1974
|
export type DeleteCertificationCourseDocumentData = any;
|
|
1970
1975
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
1971
|
-
export type
|
|
1972
|
-
export type
|
|
1976
|
+
export type CreateCertificationCourseDocumentData = Output6Yt73Y2Qm0J;
|
|
1977
|
+
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
1973
1978
|
export type DeleteUserData = any;
|
|
1974
1979
|
export type DeleteUserError = ErrorResponse;
|
|
1975
1980
|
export type GetUserResult = UserResponseEntity;
|
|
@@ -1980,7 +1985,7 @@ export type UpdateUserData = any;
|
|
|
1980
1985
|
export type UpdateUserError = ErrorResponse;
|
|
1981
1986
|
export type DeleteCertificationCourseData = any;
|
|
1982
1987
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
1983
|
-
export type GetCertificationApplicationItemFileData =
|
|
1988
|
+
export type GetCertificationApplicationItemFileData = OutputLdhu1O1Ukh;
|
|
1984
1989
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
1985
1990
|
export interface CreateCertificationApplicationItemFileParams {
|
|
1986
1991
|
/** @example "pdf" */
|
|
@@ -1994,9 +1999,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
1994
1999
|
/** @example "fileVersion" */
|
|
1995
2000
|
fileVersion: string;
|
|
1996
2001
|
}
|
|
1997
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2002
|
+
export type CreateCertificationApplicationItemFileData = OutputPcdo7909Xu;
|
|
1998
2003
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
1999
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2004
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputNjpt2Hwj7U;
|
|
2000
2005
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2001
2006
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2002
2007
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2004,7 +2009,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2004
2009
|
export type GetCourseError = ErrorResponse;
|
|
2005
2010
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2006
2011
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2007
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2012
|
+
export type GetCertificationApplicationForeignFillData = OutputBl0Nmvx0Fl;
|
|
2008
2013
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2009
2014
|
export type GetCertificationPrintData = any;
|
|
2010
2015
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2038,7 +2043,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2038
2043
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2039
2044
|
export type CreateCertificationWaiveData = any;
|
|
2040
2045
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2041
|
-
export type CreateCertificationMoveData =
|
|
2046
|
+
export type CreateCertificationMoveData = Output4I79T77Ric;
|
|
2042
2047
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2043
2048
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2044
2049
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2066,7 +2071,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2066
2071
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2067
2072
|
export type CreateCertificationCourseRedeemData = any;
|
|
2068
2073
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2069
|
-
export type CreateCertificationMoveValidateData =
|
|
2074
|
+
export type CreateCertificationMoveValidateData = OutputU05X7H42A4;
|
|
2070
2075
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2071
2076
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2072
2077
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2078,7 +2083,7 @@ export type UpdateCertificationCourseOverrideResultData = any;
|
|
|
2078
2083
|
export type UpdateCertificationCourseOverrideResultError = ErrorResponse;
|
|
2079
2084
|
export type UpdateCertificationSetDatesData = any;
|
|
2080
2085
|
export type UpdateCertificationSetDatesError = ErrorResponse;
|
|
2081
|
-
export type CreateCertificationResult =
|
|
2086
|
+
export type CreateCertificationResult = OutputSbgwv0Lrpq;
|
|
2082
2087
|
export type CreateCertificationFail = ErrorResponse;
|
|
2083
2088
|
import type { AxiosInstance, AxiosRequestConfig, ResponseType } from 'axios';
|
|
2084
2089
|
export type QueryParamsType = Record<string | number, any>;
|
|
@@ -2123,7 +2128,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2123
2128
|
}
|
|
2124
2129
|
/**
|
|
2125
2130
|
* @title BCCSA Program API
|
|
2126
|
-
* @version 3.0.
|
|
2131
|
+
* @version 3.0.3
|
|
2127
2132
|
* @baseUrl http://localhost:8080
|
|
2128
2133
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2129
2134
|
*/
|
|
@@ -2138,7 +2143,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2138
2143
|
* @request POST:/contactUs
|
|
2139
2144
|
* @secure
|
|
2140
2145
|
*/
|
|
2141
|
-
listContactUs: (data:
|
|
2146
|
+
listContactUs: (data: InputTvxwuv0Lzz, params?: RequestParams) => Promise<any>;
|
|
2142
2147
|
};
|
|
2143
2148
|
customer: {
|
|
2144
2149
|
/**
|
|
@@ -2242,7 +2247,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2242
2247
|
* @request POST:/tenant/report/applicationExport
|
|
2243
2248
|
* @secure
|
|
2244
2249
|
*/
|
|
2245
|
-
createReportApplicationExport: (data:
|
|
2250
|
+
createReportApplicationExport: (data: InputZ6Pi8Vxh7M, params?: RequestParams) => Promise<any>;
|
|
2246
2251
|
/**
|
|
2247
2252
|
* @description Export a report of applications based on the provided filters.
|
|
2248
2253
|
*
|
|
@@ -2252,7 +2257,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2252
2257
|
* @request POST:/tenant/report/applicationStatus
|
|
2253
2258
|
* @secure
|
|
2254
2259
|
*/
|
|
2255
|
-
listReportApplicationStatus: (data:
|
|
2260
|
+
listReportApplicationStatus: (data: InputGye2V8Ohmd, params?: RequestParams) => Promise<any>;
|
|
2256
2261
|
/**
|
|
2257
2262
|
* @description Export a report of applications based on the provided filters.
|
|
2258
2263
|
*
|
|
@@ -2262,7 +2267,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2262
2267
|
* @request POST:/tenant/report/applicationsReport
|
|
2263
2268
|
* @secure
|
|
2264
2269
|
*/
|
|
2265
|
-
createReportApplicationsReport: (data:
|
|
2270
|
+
createReportApplicationsReport: (data: InputOv5Fi8V7Spg, params?: RequestParams) => Promise<any>;
|
|
2266
2271
|
/**
|
|
2267
2272
|
* @description This route allows you to post certificates email for the tenant.
|
|
2268
2273
|
*
|
|
@@ -2272,7 +2277,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2272
2277
|
* @request POST:/tenant/certificates/email
|
|
2273
2278
|
* @secure
|
|
2274
2279
|
*/
|
|
2275
|
-
createCertificatesEmail: (data:
|
|
2280
|
+
createCertificatesEmail: (data: InputBkk90S004W, params?: RequestParams) => Promise<any>;
|
|
2276
2281
|
/**
|
|
2277
2282
|
* @description Generate a preview of the completed certifications report.
|
|
2278
2283
|
*
|
|
@@ -2302,7 +2307,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2302
2307
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2303
2308
|
* @secure
|
|
2304
2309
|
*/
|
|
2305
|
-
createLicenseRedeem: (userId: string, data:
|
|
2310
|
+
createLicenseRedeem: (userId: string, data: InputX2C1K65Gifl, params?: RequestParams) => Promise<any>;
|
|
2306
2311
|
/**
|
|
2307
2312
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2308
2313
|
*
|
|
@@ -2312,7 +2317,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2312
2317
|
* @request POST:/tenant/report/orglicenses/
|
|
2313
2318
|
* @secure
|
|
2314
2319
|
*/
|
|
2315
|
-
listReportOrglicenses: (data:
|
|
2320
|
+
listReportOrglicenses: (data: Input2Wsk314Pl5, params?: RequestParams) => Promise<any>;
|
|
2316
2321
|
/**
|
|
2317
2322
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2318
2323
|
*
|
|
@@ -2322,7 +2327,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2322
2327
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2323
2328
|
* @secure
|
|
2324
2329
|
*/
|
|
2325
|
-
createReportOrglicensesPreview: (data:
|
|
2330
|
+
createReportOrglicensesPreview: (data: InputTxggs7Woq6, params?: RequestParams) => Promise<any>;
|
|
2326
2331
|
/**
|
|
2327
2332
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2328
2333
|
*
|
|
@@ -2342,7 +2347,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2342
2347
|
* @request POST:/tenant/report/users/advanced
|
|
2343
2348
|
* @secure
|
|
2344
2349
|
*/
|
|
2345
|
-
createReportUsersAdvanced: (data:
|
|
2350
|
+
createReportUsersAdvanced: (data: InputYq50Sx0V4B, params?: RequestParams) => Promise<any>;
|
|
2346
2351
|
/**
|
|
2347
2352
|
* @description Searches for users in the tenant by their IDs.
|
|
2348
2353
|
*
|
|
@@ -2352,7 +2357,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2352
2357
|
* @request POST:/tenant/search/users/ids
|
|
2353
2358
|
* @secure
|
|
2354
2359
|
*/
|
|
2355
|
-
listSearchUsersIds: (data:
|
|
2360
|
+
listSearchUsersIds: (data: InputTbhih4Yvyml, params?: RequestParams) => Promise<any>;
|
|
2356
2361
|
/**
|
|
2357
2362
|
* @description Searches for users in the tenant by term and filters.
|
|
2358
2363
|
*
|
|
@@ -2362,7 +2367,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2362
2367
|
* @request POST:/tenant/search/users/term
|
|
2363
2368
|
* @secure
|
|
2364
2369
|
*/
|
|
2365
|
-
createSearchUsersTerm: (data:
|
|
2370
|
+
createSearchUsersTerm: (data: InputO4A7I6Erux, params?: RequestParams) => Promise<any>;
|
|
2366
2371
|
/**
|
|
2367
2372
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2368
2373
|
*
|
|
@@ -2372,7 +2377,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2372
2377
|
* @request POST:/tenant/report/users/simple
|
|
2373
2378
|
* @secure
|
|
2374
2379
|
*/
|
|
2375
|
-
createReportUsersSimple: (data:
|
|
2380
|
+
createReportUsersSimple: (data: InputAvxn578Ayl, params?: RequestParams) => Promise<any>;
|
|
2376
2381
|
/**
|
|
2377
2382
|
* @description Retrieve user by ID.
|
|
2378
2383
|
*
|
|
@@ -2382,7 +2387,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2382
2387
|
* @request POST:/tenant/search/users/count
|
|
2383
2388
|
* @secure
|
|
2384
2389
|
*/
|
|
2385
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2390
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputC6Zbeptre9>;
|
|
2386
2391
|
};
|
|
2387
2392
|
user: {
|
|
2388
2393
|
/**
|
|
@@ -2414,7 +2419,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2414
2419
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2415
2420
|
* @secure
|
|
2416
2421
|
*/
|
|
2417
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2422
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: Input8Tmaavfxxb, params?: RequestParams) => Promise<any>;
|
|
2418
2423
|
/**
|
|
2419
2424
|
* @description Delete a certification process application by type.
|
|
2420
2425
|
*
|
|
@@ -2474,7 +2479,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2474
2479
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2475
2480
|
* @secure
|
|
2476
2481
|
*/
|
|
2477
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2482
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputVis5Wecmb6>;
|
|
2478
2483
|
/**
|
|
2479
2484
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2480
2485
|
*
|
|
@@ -2484,7 +2489,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2484
2489
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2485
2490
|
* @secure
|
|
2486
2491
|
*/
|
|
2487
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2492
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<Output15Dbnf1Bbf>;
|
|
2488
2493
|
/**
|
|
2489
2494
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2490
2495
|
*
|
|
@@ -2499,12 +2504,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2499
2504
|
* @description This route allows you to set or override a course submission item (file) for a user in a specific course.
|
|
2500
2505
|
*
|
|
2501
2506
|
* @tags Course
|
|
2502
|
-
* @name
|
|
2507
|
+
* @name CreateCertificationCourseDocument
|
|
2503
2508
|
* @summary Set Course Submission Item
|
|
2504
|
-
* @request
|
|
2509
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2505
2510
|
* @secure
|
|
2506
2511
|
*/
|
|
2507
|
-
|
|
2512
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: Input6Yt73Y2Qm0J, params?: RequestParams) => Promise<Output6Yt73Y2Qm0J>;
|
|
2508
2513
|
/**
|
|
2509
2514
|
* @description Delete user by ID.
|
|
2510
2515
|
*
|
|
@@ -2534,7 +2539,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2534
2539
|
* @request POST:/user/{userID}
|
|
2535
2540
|
* @secure
|
|
2536
2541
|
*/
|
|
2537
|
-
createUser: (userId: string, data:
|
|
2542
|
+
createUser: (userId: string, data: InputMvudju017X, params?: RequestParams) => Promise<any>;
|
|
2538
2543
|
/**
|
|
2539
2544
|
* @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.
|
|
2540
2545
|
*
|
|
@@ -2544,7 +2549,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2544
2549
|
* @request PUT:/user/{userID}
|
|
2545
2550
|
* @secure
|
|
2546
2551
|
*/
|
|
2547
|
-
updateUser: (userId: string, data:
|
|
2552
|
+
updateUser: (userId: string, data: InputQoo29Cdxrrf, params?: RequestParams) => Promise<any>;
|
|
2548
2553
|
/**
|
|
2549
2554
|
* @description Delete course from user
|
|
2550
2555
|
*
|
|
@@ -2564,7 +2569,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2564
2569
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2565
2570
|
* @secure
|
|
2566
2571
|
*/
|
|
2567
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2572
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputLdhu1O1Ukh>;
|
|
2568
2573
|
/**
|
|
2569
2574
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2570
2575
|
*
|
|
@@ -2574,7 +2579,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2574
2579
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2575
2580
|
* @secure
|
|
2576
2581
|
*/
|
|
2577
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2582
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputPcdo7909Xu>;
|
|
2578
2583
|
/**
|
|
2579
2584
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2580
2585
|
*
|
|
@@ -2584,7 +2589,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2584
2589
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2585
2590
|
* @secure
|
|
2586
2591
|
*/
|
|
2587
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2592
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputNjpt2Hwj7U>;
|
|
2588
2593
|
/**
|
|
2589
2594
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2590
2595
|
*
|
|
@@ -2624,7 +2629,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2624
2629
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2625
2630
|
* @secure
|
|
2626
2631
|
*/
|
|
2627
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2632
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputBl0Nmvx0Fl>;
|
|
2628
2633
|
/**
|
|
2629
2634
|
* @description This endpoint will print certificate
|
|
2630
2635
|
*
|
|
@@ -2714,7 +2719,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2714
2719
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2715
2720
|
* @secure
|
|
2716
2721
|
*/
|
|
2717
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2722
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: Input3M1P1Qx4Be, params?: RequestParams) => Promise<any>;
|
|
2718
2723
|
/**
|
|
2719
2724
|
* @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.
|
|
2720
2725
|
*
|
|
@@ -2724,7 +2729,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2724
2729
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2725
2730
|
* @secure
|
|
2726
2731
|
*/
|
|
2727
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2732
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputYbre7T2Cxe, params?: RequestParams) => Promise<any>;
|
|
2728
2733
|
/**
|
|
2729
2734
|
* @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.
|
|
2730
2735
|
*
|
|
@@ -2734,7 +2739,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2734
2739
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2735
2740
|
* @secure
|
|
2736
2741
|
*/
|
|
2737
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2742
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputA0Hnvf0Nx2, params?: RequestParams) => Promise<any>;
|
|
2738
2743
|
/**
|
|
2739
2744
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2740
2745
|
*
|
|
@@ -2744,7 +2749,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2744
2749
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2745
2750
|
* @secure
|
|
2746
2751
|
*/
|
|
2747
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2752
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputMigwi1Qi7G, params?: RequestParams) => Promise<any>;
|
|
2748
2753
|
/**
|
|
2749
2754
|
* @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.
|
|
2750
2755
|
*
|
|
@@ -2784,7 +2789,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2784
2789
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2785
2790
|
* @secure
|
|
2786
2791
|
*/
|
|
2787
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2792
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputRgdzgwaso4, params?: RequestParams) => Promise<any>;
|
|
2788
2793
|
/**
|
|
2789
2794
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
2790
2795
|
*
|
|
@@ -2794,7 +2799,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2794
2799
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2795
2800
|
* @secure
|
|
2796
2801
|
*/
|
|
2797
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2802
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<Output4I79T77Ric>;
|
|
2798
2803
|
/**
|
|
2799
2804
|
* @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.
|
|
2800
2805
|
*
|
|
@@ -2824,7 +2829,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2824
2829
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2825
2830
|
* @secure
|
|
2826
2831
|
*/
|
|
2827
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
2832
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputF0Scbkkx2H, params?: RequestParams) => Promise<any>;
|
|
2828
2833
|
/**
|
|
2829
2834
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
2830
2835
|
*
|
|
@@ -2874,7 +2879,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2874
2879
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
2875
2880
|
* @secure
|
|
2876
2881
|
*/
|
|
2877
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
2882
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: Input4Hktu5Vloe, params?: RequestParams) => Promise<any>;
|
|
2878
2883
|
/**
|
|
2879
2884
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
2880
2885
|
*
|
|
@@ -2894,7 +2899,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2894
2899
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
2895
2900
|
* @secure
|
|
2896
2901
|
*/
|
|
2897
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
2902
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputL8Sf59Uzhm, params?: RequestParams) => Promise<any>;
|
|
2898
2903
|
/**
|
|
2899
2904
|
* @description This route allows you to submit a pending approval.
|
|
2900
2905
|
*
|
|
@@ -2904,7 +2909,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2904
2909
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
2905
2910
|
* @secure
|
|
2906
2911
|
*/
|
|
2907
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
2912
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputQuioenmjqm, params?: RequestParams) => Promise<any>;
|
|
2908
2913
|
/**
|
|
2909
2914
|
* @description This route allows you to review a pending approval.
|
|
2910
2915
|
*
|
|
@@ -2914,7 +2919,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2914
2919
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
2915
2920
|
* @secure
|
|
2916
2921
|
*/
|
|
2917
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
2922
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputG1Rfyng6Qw, params?: RequestParams) => Promise<any>;
|
|
2918
2923
|
/**
|
|
2919
2924
|
* @description Redeems a license for a user by product ID.
|
|
2920
2925
|
*
|
|
@@ -2924,7 +2929,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2924
2929
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
2925
2930
|
* @secure
|
|
2926
2931
|
*/
|
|
2927
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
2932
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputX20Gr5Dswoh, params?: RequestParams) => Promise<any>;
|
|
2928
2933
|
/**
|
|
2929
2934
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
2930
2935
|
*
|
|
@@ -2934,7 +2939,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2934
2939
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
2935
2940
|
* @secure
|
|
2936
2941
|
*/
|
|
2937
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2942
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputU05X7H42A4>;
|
|
2938
2943
|
/**
|
|
2939
2944
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
2940
2945
|
*
|
|
@@ -2944,7 +2949,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2944
2949
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
2945
2950
|
* @secure
|
|
2946
2951
|
*/
|
|
2947
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
2952
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: Input84Yzg8N851, params?: RequestParams) => Promise<any>;
|
|
2948
2953
|
/**
|
|
2949
2954
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
2950
2955
|
*
|
|
@@ -2954,7 +2959,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2954
2959
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
2955
2960
|
* @secure
|
|
2956
2961
|
*/
|
|
2957
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
2962
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputDnhk6I4Mqw, params?: RequestParams) => Promise<any>;
|
|
2958
2963
|
/**
|
|
2959
2964
|
* @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.
|
|
2960
2965
|
*
|
|
@@ -2964,7 +2969,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2964
2969
|
* @request POST:/user/{userID}/updateITA
|
|
2965
2970
|
* @secure
|
|
2966
2971
|
*/
|
|
2967
|
-
createUpdateIta: (userId: string, data:
|
|
2972
|
+
createUpdateIta: (userId: string, data: InputR5Dyvltvs4, params?: RequestParams) => Promise<any>;
|
|
2968
2973
|
/**
|
|
2969
2974
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
2970
2975
|
*
|
|
@@ -2974,7 +2979,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2974
2979
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
2975
2980
|
* @secure
|
|
2976
2981
|
*/
|
|
2977
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
2982
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputWozo5Nmr6A, params?: RequestParams) => Promise<any>;
|
|
2978
2983
|
/**
|
|
2979
2984
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
2980
2985
|
*
|
|
@@ -2984,7 +2989,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2984
2989
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
2985
2990
|
* @secure
|
|
2986
2991
|
*/
|
|
2987
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
2992
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputW9Rwp645Nq, params?: RequestParams) => Promise<any>;
|
|
2988
2993
|
};
|
|
2989
2994
|
users: {
|
|
2990
2995
|
/**
|
|
@@ -2996,6 +3001,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2996
3001
|
* @request POST:/users/certification/{certSpecID}
|
|
2997
3002
|
* @secure
|
|
2998
3003
|
*/
|
|
2999
|
-
createCertification: (certSpecId: string, data:
|
|
3004
|
+
createCertification: (certSpecId: string, data: InputSbgwv0Lrpq, params?: RequestParams) => Promise<OutputSbgwv0Lrpq>;
|
|
3000
3005
|
};
|
|
3001
3006
|
}
|