@ikonintegration/bccsa-program-api 3.0.10 → 3.0.12
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 +96 -98
- package/dist/Api.d.ts +104 -102
- package/dist/Api.js +8 -8
- package/dist/Api.js.map +1 -1
- package/package.json +1 -1
package/dist/Api.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ export interface ErrorResponse {
|
|
|
5
5
|
/** Error code */
|
|
6
6
|
errCode: string;
|
|
7
7
|
}
|
|
8
|
-
export interface
|
|
8
|
+
export interface InputPe53Brwfjj {
|
|
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 InputTl5Xrjjwwg {
|
|
453
453
|
/**
|
|
454
454
|
* ID of the certification to filter applications by
|
|
455
455
|
* @example "certification123"
|
|
@@ -506,7 +506,7 @@ export interface InputYu80Od690X {
|
|
|
506
506
|
*/
|
|
507
507
|
ignoreCompletedCertifications?: boolean | null;
|
|
508
508
|
}
|
|
509
|
-
export interface
|
|
509
|
+
export interface Input7Wkfcnrebb {
|
|
510
510
|
/**
|
|
511
511
|
* ID of the certification to filter applications by
|
|
512
512
|
* @example "certification123"
|
|
@@ -563,7 +563,7 @@ export interface InputYgpe7B8Ron {
|
|
|
563
563
|
*/
|
|
564
564
|
ignoreCompletedCertifications?: boolean | null;
|
|
565
565
|
}
|
|
566
|
-
export interface
|
|
566
|
+
export interface InputTyiwrdmgw6 {
|
|
567
567
|
/**
|
|
568
568
|
* ID of the certification to filter applications by
|
|
569
569
|
* @example "certification123"
|
|
@@ -620,7 +620,7 @@ export interface InputT26Yt60F95 {
|
|
|
620
620
|
*/
|
|
621
621
|
ignoreCompletedCertifications?: boolean | null;
|
|
622
622
|
}
|
|
623
|
-
export interface
|
|
623
|
+
export interface InputG65298619Kg {
|
|
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 InputEr5N2L91Fj {
|
|
|
661
661
|
emailAddress: string;
|
|
662
662
|
}[];
|
|
663
663
|
}
|
|
664
|
-
export interface
|
|
664
|
+
export interface Input2E7Irudg4C {
|
|
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 InputKamfat7578H {
|
|
|
673
673
|
*/
|
|
674
674
|
sessionID?: string;
|
|
675
675
|
}
|
|
676
|
-
export interface
|
|
676
|
+
export interface InputRek8Ekfq6G {
|
|
677
677
|
/**
|
|
678
678
|
* Search term to filter licenses
|
|
679
679
|
* @example "active"
|
|
@@ -690,7 +690,7 @@ export interface InputMm8O6Y3Lfzi {
|
|
|
690
690
|
*/
|
|
691
691
|
sortField?: any;
|
|
692
692
|
}
|
|
693
|
-
export interface
|
|
693
|
+
export interface InputOaqycechqc {
|
|
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 InputOix1Fbwy5J {
|
|
749
749
|
/**
|
|
750
750
|
* Start date for the report
|
|
751
751
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -767,11 +767,11 @@ export interface Input9Yu1X2Ojm9J {
|
|
|
767
767
|
*/
|
|
768
768
|
dateType?: string;
|
|
769
769
|
}
|
|
770
|
-
export interface
|
|
770
|
+
export interface InputYlcu719In5 {
|
|
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 InputTtclghucpzg {
|
|
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 Input7Yeqbhu8Y0F {
|
|
|
811
811
|
};
|
|
812
812
|
};
|
|
813
813
|
}
|
|
814
|
-
export interface
|
|
814
|
+
export interface InputSozb4Fr6Pwk {
|
|
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 Input9Rp6Ctkysij {
|
|
|
853
853
|
}
|
|
854
854
|
/** External system ID 2 */
|
|
855
855
|
export type ExternalID2 = number;
|
|
856
|
-
export interface
|
|
856
|
+
export interface OutputK11M37Kse5 {
|
|
857
857
|
/** External system ID 2 */
|
|
858
858
|
userCount: ExternalID2;
|
|
859
859
|
transactionID?: string | null;
|
|
860
860
|
}
|
|
861
|
-
export interface
|
|
861
|
+
export interface OutputN2Mqdkbx9P {
|
|
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 OutputBmpg97Oc6O {
|
|
869
869
|
/**
|
|
870
870
|
* Amount to be refunded for the cancellation
|
|
871
871
|
* @example 0
|
|
@@ -1152,7 +1152,7 @@ export interface CourseResponseEntity {
|
|
|
1152
1152
|
/** Justifications for overridden course restrictions */
|
|
1153
1153
|
overwrittenJustification?: OverwrittenJustification;
|
|
1154
1154
|
}
|
|
1155
|
-
export interface
|
|
1155
|
+
export interface OutputWbgzigq2Z4G {
|
|
1156
1156
|
/**
|
|
1157
1157
|
* Signed URL for the course file
|
|
1158
1158
|
* @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"
|
|
@@ -1170,7 +1170,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1170
1170
|
transactionID?: string | null;
|
|
1171
1171
|
}
|
|
1172
1172
|
/** Application Foreign Fill response type */
|
|
1173
|
-
export interface
|
|
1173
|
+
export interface Output57Vk1Sr3Kyj {
|
|
1174
1174
|
items: {
|
|
1175
1175
|
userID: string;
|
|
1176
1176
|
createdOn?: number;
|
|
@@ -1311,6 +1311,8 @@ export type IsSponsored = boolean;
|
|
|
1311
1311
|
export type ExternalID = string;
|
|
1312
1312
|
/** Whether the user is enabled */
|
|
1313
1313
|
export type IsEnabled = boolean;
|
|
1314
|
+
/** Whether the user has opted out of having their certification information published to 3rd party integrations */
|
|
1315
|
+
export type CertifiedUserOptOut = boolean;
|
|
1314
1316
|
/** Response schema for certification process data */
|
|
1315
1317
|
export interface CertificationProcessResponseEntity {
|
|
1316
1318
|
/** @example "abc123" */
|
|
@@ -1391,7 +1393,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1391
1393
|
applicationItems?: Record<string, any>[];
|
|
1392
1394
|
transactionID?: string | null;
|
|
1393
1395
|
}
|
|
1394
|
-
export interface
|
|
1396
|
+
export interface InputBejlnd4Qri {
|
|
1395
1397
|
issuedOn?: number;
|
|
1396
1398
|
expiresOn?: number;
|
|
1397
1399
|
fileItems?: {
|
|
@@ -1400,21 +1402,21 @@ export interface InputDymh5Dtqbzi {
|
|
|
1400
1402
|
}[];
|
|
1401
1403
|
additionalNotes?: string | null;
|
|
1402
1404
|
}
|
|
1403
|
-
export interface
|
|
1405
|
+
export interface InputFeog5Wf2Wc {
|
|
1404
1406
|
/**
|
|
1405
1407
|
* Indicates whether the application is locked
|
|
1406
1408
|
* @example true
|
|
1407
1409
|
*/
|
|
1408
1410
|
isApplicationLocked: boolean;
|
|
1409
1411
|
}
|
|
1410
|
-
export interface
|
|
1412
|
+
export interface OutputXxvwx06Ayr {
|
|
1411
1413
|
/**
|
|
1412
1414
|
* Signed URL for the course file
|
|
1413
1415
|
* @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"
|
|
1414
1416
|
*/
|
|
1415
1417
|
fileURL: string;
|
|
1416
1418
|
}
|
|
1417
|
-
export interface
|
|
1419
|
+
export interface InputOrjwer2Lg8 {
|
|
1418
1420
|
/**
|
|
1419
1421
|
* Indicates whether the waiver is approved
|
|
1420
1422
|
* @example true
|
|
@@ -1426,14 +1428,14 @@ export interface InputErp6R9Lb76H {
|
|
|
1426
1428
|
*/
|
|
1427
1429
|
additionalNotes?: string | null;
|
|
1428
1430
|
}
|
|
1429
|
-
export interface
|
|
1431
|
+
export interface InputFzsqwdj8R5 {
|
|
1430
1432
|
/**
|
|
1431
1433
|
* Optional notes regarding the waiver
|
|
1432
1434
|
* @example "Waiver granted due to special circumstances."
|
|
1433
1435
|
*/
|
|
1434
1436
|
additionalNotes?: string | null;
|
|
1435
1437
|
}
|
|
1436
|
-
export interface
|
|
1438
|
+
export interface Input5Btgd4Ab7W {
|
|
1437
1439
|
students: {
|
|
1438
1440
|
/**
|
|
1439
1441
|
* User ID of the student to redeem the course for
|
|
@@ -1467,7 +1469,7 @@ export interface Input6Ungdr7M1G {
|
|
|
1467
1469
|
*/
|
|
1468
1470
|
autoEnrolSessionID?: string;
|
|
1469
1471
|
}
|
|
1470
|
-
export interface
|
|
1472
|
+
export interface InputLpq2890S17K {
|
|
1471
1473
|
invites: {
|
|
1472
1474
|
/**
|
|
1473
1475
|
* Email address of the user to invite
|
|
@@ -1496,7 +1498,7 @@ export interface InputWoyxyec215 {
|
|
|
1496
1498
|
*/
|
|
1497
1499
|
isReservedSeat: boolean;
|
|
1498
1500
|
}
|
|
1499
|
-
export interface
|
|
1501
|
+
export interface InputJ9Dcdc6Jvp {
|
|
1500
1502
|
/**
|
|
1501
1503
|
* Indicates whether to waive the certification process
|
|
1502
1504
|
* @example true
|
|
@@ -1509,7 +1511,7 @@ export interface Input24Hnrp97Etj {
|
|
|
1509
1511
|
comments?: string | null;
|
|
1510
1512
|
}
|
|
1511
1513
|
/** Certification move response schema */
|
|
1512
|
-
export interface
|
|
1514
|
+
export interface OutputNxirkiytfi {
|
|
1513
1515
|
errors?: {
|
|
1514
1516
|
status: string;
|
|
1515
1517
|
object?: Record<string, any>;
|
|
@@ -1517,19 +1519,19 @@ export interface Output8Vfmpvd1Fpk {
|
|
|
1517
1519
|
}[];
|
|
1518
1520
|
}
|
|
1519
1521
|
/** Schema for writing a certification trigger check. */
|
|
1520
|
-
export interface
|
|
1522
|
+
export interface InputCry1Yr2K4J {
|
|
1521
1523
|
/**
|
|
1522
1524
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1523
1525
|
* @example "CHECKED"
|
|
1524
1526
|
*/
|
|
1525
|
-
value:
|
|
1527
|
+
value: InputCry1Yr2K4JValueEnum;
|
|
1526
1528
|
/**
|
|
1527
1529
|
* List of course IDs that are blocked by this trigger check.
|
|
1528
1530
|
* @example ["course1","course2"]
|
|
1529
1531
|
*/
|
|
1530
1532
|
blockedCourses?: string[];
|
|
1531
1533
|
}
|
|
1532
|
-
export interface
|
|
1534
|
+
export interface InputZ1Lsr49K6C {
|
|
1533
1535
|
/**
|
|
1534
1536
|
* Indicates whether the application item is approved
|
|
1535
1537
|
* @example true
|
|
@@ -1555,7 +1557,7 @@ export interface InputIis91Oru0W {
|
|
|
1555
1557
|
export interface StudentHistoryRequestSchema {
|
|
1556
1558
|
requirements: string[];
|
|
1557
1559
|
}
|
|
1558
|
-
export interface
|
|
1560
|
+
export interface InputUate2Qkkga {
|
|
1559
1561
|
/**
|
|
1560
1562
|
* Optional activation key for the application
|
|
1561
1563
|
* @example "AK-123456"
|
|
@@ -1563,7 +1565,7 @@ export interface InputHv4X9A8Ecqi {
|
|
|
1563
1565
|
activationKey?: string;
|
|
1564
1566
|
}
|
|
1565
1567
|
/** Schema for course submission item details post request. */
|
|
1566
|
-
export interface
|
|
1568
|
+
export interface InputMypoea77Dig {
|
|
1567
1569
|
/**
|
|
1568
1570
|
* The ID of the file being submitted.
|
|
1569
1571
|
* @example "fileID123"
|
|
@@ -1576,7 +1578,7 @@ export interface InputVgu2P0752G {
|
|
|
1576
1578
|
fileName: string;
|
|
1577
1579
|
}
|
|
1578
1580
|
/** Schema for the response to course submission item details post request. */
|
|
1579
|
-
export interface
|
|
1581
|
+
export interface OutputMypoea77Dig {
|
|
1580
1582
|
submissionItems: {
|
|
1581
1583
|
/**
|
|
1582
1584
|
* The ID of the file being submitted.
|
|
@@ -1591,7 +1593,7 @@ export interface OutputVgu2P0752G {
|
|
|
1591
1593
|
}[];
|
|
1592
1594
|
}
|
|
1593
1595
|
/** Pending approval submission parameters */
|
|
1594
|
-
export interface
|
|
1596
|
+
export interface InputN6Mrda0K2I {
|
|
1595
1597
|
/**
|
|
1596
1598
|
* Type of pending approval
|
|
1597
1599
|
* @example "certification"
|
|
@@ -1611,7 +1613,7 @@ export interface InputMis0Xsifif {
|
|
|
1611
1613
|
fileName: string;
|
|
1612
1614
|
}[];
|
|
1613
1615
|
}
|
|
1614
|
-
export interface
|
|
1616
|
+
export interface InputOpeoejj9Rp {
|
|
1615
1617
|
/**
|
|
1616
1618
|
* The ID of the course for which the license is being redeemed
|
|
1617
1619
|
* @example "courseID123"
|
|
@@ -1679,7 +1681,7 @@ export interface InputF9Cmteudse {
|
|
|
1679
1681
|
acknowledgement?: string | null;
|
|
1680
1682
|
}
|
|
1681
1683
|
/** Validate certification move response schema */
|
|
1682
|
-
export interface
|
|
1684
|
+
export interface OutputU7D0Strhe {
|
|
1683
1685
|
courses: {
|
|
1684
1686
|
name: string;
|
|
1685
1687
|
status: string;
|
|
@@ -1690,21 +1692,21 @@ export interface OutputC81Tjz8Ikr {
|
|
|
1690
1692
|
validated: boolean;
|
|
1691
1693
|
mustCreateCP: boolean;
|
|
1692
1694
|
}
|
|
1693
|
-
export interface
|
|
1695
|
+
export interface InputDhf1Dn5Axj {
|
|
1694
1696
|
/**
|
|
1695
1697
|
* Comments regarding the end of the cooldown period
|
|
1696
1698
|
* @example "Cooldown period ended successfully."
|
|
1697
1699
|
*/
|
|
1698
1700
|
comments: string;
|
|
1699
1701
|
}
|
|
1700
|
-
export interface
|
|
1702
|
+
export interface Output6Icup3Essgh {
|
|
1701
1703
|
/**
|
|
1702
1704
|
* Signed URL for the course file
|
|
1703
1705
|
* @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"
|
|
1704
1706
|
*/
|
|
1705
1707
|
fileURL: string;
|
|
1706
1708
|
}
|
|
1707
|
-
export interface
|
|
1709
|
+
export interface Input1Anuav4Wq {
|
|
1708
1710
|
/** @example true */
|
|
1709
1711
|
agreedWithCertTerms: boolean;
|
|
1710
1712
|
/** @example 1717230000000 */
|
|
@@ -1776,21 +1778,21 @@ export interface InputEw00Q9Xaswf {
|
|
|
1776
1778
|
/** @example "EXT#999" */
|
|
1777
1779
|
externalID2?: string | null;
|
|
1778
1780
|
}
|
|
1779
|
-
export interface
|
|
1781
|
+
export interface Input0K8Sf4Aceh {
|
|
1780
1782
|
/**
|
|
1781
1783
|
* Comments regarding the course unlock action
|
|
1782
1784
|
* @example "Course unlocked successfully."
|
|
1783
1785
|
*/
|
|
1784
1786
|
comments: string;
|
|
1785
1787
|
}
|
|
1786
|
-
export interface
|
|
1788
|
+
export interface InputJed24Agekg {
|
|
1787
1789
|
/**
|
|
1788
1790
|
* ITA number to update for the user
|
|
1789
1791
|
* @example "ITA123456"
|
|
1790
1792
|
*/
|
|
1791
1793
|
itaNumber: string;
|
|
1792
1794
|
}
|
|
1793
|
-
export interface
|
|
1795
|
+
export interface InputBmj0Xzqnsb {
|
|
1794
1796
|
/** @example true */
|
|
1795
1797
|
agreedWithCertTerms: boolean;
|
|
1796
1798
|
/** @example 1717230000000 */
|
|
@@ -1862,7 +1864,7 @@ export interface InputUnw384K18D {
|
|
|
1862
1864
|
/** @example "EXT#999" */
|
|
1863
1865
|
externalID2?: string | null;
|
|
1864
1866
|
}
|
|
1865
|
-
export interface
|
|
1867
|
+
export interface InputZ1Izmy5Hlbg {
|
|
1866
1868
|
/**
|
|
1867
1869
|
* The grade to override the course result with
|
|
1868
1870
|
* @example "A"
|
|
@@ -1870,7 +1872,7 @@ export interface Input5Bax3Oggrc {
|
|
|
1870
1872
|
resultGrade: string;
|
|
1871
1873
|
}
|
|
1872
1874
|
/** Pending approval review parameters */
|
|
1873
|
-
export interface
|
|
1875
|
+
export interface InputL3M904Duc3 {
|
|
1874
1876
|
/**
|
|
1875
1877
|
* Notes provided by the reviewer for the pending approval
|
|
1876
1878
|
* @example "Please review the submitted documents."
|
|
@@ -1883,7 +1885,7 @@ export interface Input9N2Ph4Wwh6 {
|
|
|
1883
1885
|
approved: boolean;
|
|
1884
1886
|
}
|
|
1885
1887
|
/** Schema for overriding course result dates. */
|
|
1886
|
-
export interface
|
|
1888
|
+
export interface Input2Yxx0Kgi6F {
|
|
1887
1889
|
/**
|
|
1888
1890
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1889
1891
|
* @example 1735689600000
|
|
@@ -1895,14 +1897,14 @@ export interface Input8Nuiwqqism {
|
|
|
1895
1897
|
*/
|
|
1896
1898
|
completionDate?: number;
|
|
1897
1899
|
}
|
|
1898
|
-
export interface
|
|
1900
|
+
export interface InputKor28Jj449 {
|
|
1899
1901
|
filter: {
|
|
1900
1902
|
from?: number;
|
|
1901
1903
|
sortOrder?: string;
|
|
1902
1904
|
sortField?: string;
|
|
1903
1905
|
};
|
|
1904
1906
|
}
|
|
1905
|
-
export interface
|
|
1907
|
+
export interface OutputKor28Jj449 {
|
|
1906
1908
|
users: {
|
|
1907
1909
|
firstName: string;
|
|
1908
1910
|
lastName: string;
|
|
@@ -1922,7 +1924,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
1922
1924
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1923
1925
|
* @example "CHECKED"
|
|
1924
1926
|
*/
|
|
1925
|
-
export declare enum
|
|
1927
|
+
export declare enum InputCry1Yr2K4JValueEnum {
|
|
1926
1928
|
CHECKED = "CHECKED",
|
|
1927
1929
|
UNCHECKED = "UNCHECKED",
|
|
1928
1930
|
NOVALUE = "NOVALUE"
|
|
@@ -2015,7 +2017,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2015
2017
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2016
2018
|
export type CreateReportUsersSimpleData = any;
|
|
2017
2019
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2018
|
-
export type CreateSearchUsersCountData =
|
|
2020
|
+
export type CreateSearchUsersCountData = OutputK11M37Kse5;
|
|
2019
2021
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2020
2022
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2021
2023
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2033,7 +2035,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2033
2035
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2034
2036
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2035
2037
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2036
|
-
export type GetCertificationCourseFileSignData =
|
|
2038
|
+
export type GetCertificationCourseFileSignData = OutputWbgzigq2Z4G;
|
|
2037
2039
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2038
2040
|
export interface CreateCertificationCourseFileSignParams {
|
|
2039
2041
|
/** @example "pdf" */
|
|
@@ -2047,11 +2049,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2047
2049
|
/** @example "fileID" */
|
|
2048
2050
|
fileId: string;
|
|
2049
2051
|
}
|
|
2050
|
-
export type CreateCertificationCourseFileSignData =
|
|
2052
|
+
export type CreateCertificationCourseFileSignData = Output6Icup3Essgh;
|
|
2051
2053
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2052
2054
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2053
2055
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2054
|
-
export type CreateCertificationCourseDocumentData =
|
|
2056
|
+
export type CreateCertificationCourseDocumentData = OutputMypoea77Dig;
|
|
2055
2057
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2056
2058
|
export type DeleteUserData = any;
|
|
2057
2059
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2063,7 +2065,7 @@ export type UpdateUserData = any;
|
|
|
2063
2065
|
export type UpdateUserError = ErrorResponse;
|
|
2064
2066
|
export type DeleteCertificationCourseData = any;
|
|
2065
2067
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2066
|
-
export type GetCertificationApplicationItemFileData =
|
|
2068
|
+
export type GetCertificationApplicationItemFileData = OutputN2Mqdkbx9P;
|
|
2067
2069
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2068
2070
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2069
2071
|
/** @example "pdf" */
|
|
@@ -2077,9 +2079,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2077
2079
|
/** @example "fileVersion" */
|
|
2078
2080
|
fileVersion: string;
|
|
2079
2081
|
}
|
|
2080
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2082
|
+
export type CreateCertificationApplicationItemFileData = OutputXxvwx06Ayr;
|
|
2081
2083
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2082
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2084
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputBmpg97Oc6O;
|
|
2083
2085
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2084
2086
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2085
2087
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2087,7 +2089,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2087
2089
|
export type GetCourseError = ErrorResponse;
|
|
2088
2090
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2089
2091
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2090
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2092
|
+
export type GetCertificationApplicationForeignFillData = Output57Vk1Sr3Kyj;
|
|
2091
2093
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2092
2094
|
export type GetCertificationPrintData = any;
|
|
2093
2095
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2123,7 +2125,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2123
2125
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2124
2126
|
export type CreateCertificationWaiveData = any;
|
|
2125
2127
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2126
|
-
export type CreateCertificationMoveData =
|
|
2128
|
+
export type CreateCertificationMoveData = OutputNxirkiytfi;
|
|
2127
2129
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2128
2130
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2129
2131
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2151,7 +2153,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2151
2153
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2152
2154
|
export type CreateCertificationCourseRedeemData = any;
|
|
2153
2155
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2154
|
-
export type CreateCertificationMoveValidateData =
|
|
2156
|
+
export type CreateCertificationMoveValidateData = OutputU7D0Strhe;
|
|
2155
2157
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2156
2158
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2157
2159
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2163,7 +2165,7 @@ export type UpdateCertificationCourseOverrideResultData = any;
|
|
|
2163
2165
|
export type UpdateCertificationCourseOverrideResultError = ErrorResponse;
|
|
2164
2166
|
export type UpdateCertificationSetDatesData = any;
|
|
2165
2167
|
export type UpdateCertificationSetDatesError = ErrorResponse;
|
|
2166
|
-
export type CreateCertificationResult =
|
|
2168
|
+
export type CreateCertificationResult = OutputKor28Jj449;
|
|
2167
2169
|
export type CreateCertificationFail = ErrorResponse;
|
|
2168
2170
|
import type { AxiosInstance, AxiosRequestConfig, ResponseType } from 'axios';
|
|
2169
2171
|
export type QueryParamsType = Record<string | number, any>;
|
|
@@ -2208,7 +2210,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2208
2210
|
}
|
|
2209
2211
|
/**
|
|
2210
2212
|
* @title BCCSA Program API
|
|
2211
|
-
* @version 3.0.
|
|
2213
|
+
* @version 3.0.12
|
|
2212
2214
|
* @baseUrl http://localhost:8080
|
|
2213
2215
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2214
2216
|
*/
|
|
@@ -2223,7 +2225,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2223
2225
|
* @request POST:/contactUs
|
|
2224
2226
|
* @secure
|
|
2225
2227
|
*/
|
|
2226
|
-
listContactUs: (data:
|
|
2228
|
+
listContactUs: (data: InputPe53Brwfjj, params?: RequestParams) => Promise<any>;
|
|
2227
2229
|
};
|
|
2228
2230
|
customer: {
|
|
2229
2231
|
/**
|
|
@@ -2327,7 +2329,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2327
2329
|
* @request POST:/tenant/report/applicationExport
|
|
2328
2330
|
* @secure
|
|
2329
2331
|
*/
|
|
2330
|
-
createReportApplicationExport: (data:
|
|
2332
|
+
createReportApplicationExport: (data: InputTl5Xrjjwwg, params?: RequestParams) => Promise<any>;
|
|
2331
2333
|
/**
|
|
2332
2334
|
* @description Export a report of applications based on the provided filters.
|
|
2333
2335
|
*
|
|
@@ -2337,7 +2339,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2337
2339
|
* @request POST:/tenant/report/applicationStatus
|
|
2338
2340
|
* @secure
|
|
2339
2341
|
*/
|
|
2340
|
-
listReportApplicationStatus: (data:
|
|
2342
|
+
listReportApplicationStatus: (data: Input7Wkfcnrebb, params?: RequestParams) => Promise<any>;
|
|
2341
2343
|
/**
|
|
2342
2344
|
* @description Export a report of applications based on the provided filters.
|
|
2343
2345
|
*
|
|
@@ -2347,7 +2349,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2347
2349
|
* @request POST:/tenant/report/applicationsReport
|
|
2348
2350
|
* @secure
|
|
2349
2351
|
*/
|
|
2350
|
-
createReportApplicationsReport: (data:
|
|
2352
|
+
createReportApplicationsReport: (data: InputTyiwrdmgw6, params?: RequestParams) => Promise<any>;
|
|
2351
2353
|
/**
|
|
2352
2354
|
* @description This route allows you to post certificates email for the tenant.
|
|
2353
2355
|
*
|
|
@@ -2357,7 +2359,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2357
2359
|
* @request POST:/tenant/certificates/email
|
|
2358
2360
|
* @secure
|
|
2359
2361
|
*/
|
|
2360
|
-
createCertificatesEmail: (data:
|
|
2362
|
+
createCertificatesEmail: (data: InputG65298619Kg, params?: RequestParams) => Promise<any>;
|
|
2361
2363
|
/**
|
|
2362
2364
|
* @description Generate a preview of the completed certifications report.
|
|
2363
2365
|
*
|
|
@@ -2387,7 +2389,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2387
2389
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2388
2390
|
* @secure
|
|
2389
2391
|
*/
|
|
2390
|
-
createLicenseRedeem: (userId: string, data:
|
|
2392
|
+
createLicenseRedeem: (userId: string, data: Input2E7Irudg4C, params?: RequestParams) => Promise<any>;
|
|
2391
2393
|
/**
|
|
2392
2394
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2393
2395
|
*
|
|
@@ -2397,7 +2399,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2397
2399
|
* @request POST:/tenant/report/orglicenses/
|
|
2398
2400
|
* @secure
|
|
2399
2401
|
*/
|
|
2400
|
-
listReportOrglicenses: (data:
|
|
2402
|
+
listReportOrglicenses: (data: InputRek8Ekfq6G, params?: RequestParams) => Promise<any>;
|
|
2401
2403
|
/**
|
|
2402
2404
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2403
2405
|
*
|
|
@@ -2407,7 +2409,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2407
2409
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2408
2410
|
* @secure
|
|
2409
2411
|
*/
|
|
2410
|
-
createReportOrglicensesPreview: (data:
|
|
2412
|
+
createReportOrglicensesPreview: (data: InputOaqycechqc, params?: RequestParams) => Promise<any>;
|
|
2411
2413
|
/**
|
|
2412
2414
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2413
2415
|
*
|
|
@@ -2437,7 +2439,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2437
2439
|
* @request POST:/tenant/report/users/advanced
|
|
2438
2440
|
* @secure
|
|
2439
2441
|
*/
|
|
2440
|
-
createReportUsersAdvanced: (data:
|
|
2442
|
+
createReportUsersAdvanced: (data: InputOix1Fbwy5J, params?: RequestParams) => Promise<any>;
|
|
2441
2443
|
/**
|
|
2442
2444
|
* @description Searches for users in the tenant by their IDs.
|
|
2443
2445
|
*
|
|
@@ -2447,7 +2449,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2447
2449
|
* @request POST:/tenant/search/users/ids
|
|
2448
2450
|
* @secure
|
|
2449
2451
|
*/
|
|
2450
|
-
listSearchUsersIds: (data:
|
|
2452
|
+
listSearchUsersIds: (data: InputYlcu719In5, params?: RequestParams) => Promise<any>;
|
|
2451
2453
|
/**
|
|
2452
2454
|
* @description Searches for users in the tenant by term and filters.
|
|
2453
2455
|
*
|
|
@@ -2457,7 +2459,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2457
2459
|
* @request POST:/tenant/search/users/term
|
|
2458
2460
|
* @secure
|
|
2459
2461
|
*/
|
|
2460
|
-
createSearchUsersTerm: (data:
|
|
2462
|
+
createSearchUsersTerm: (data: InputTtclghucpzg, params?: RequestParams) => Promise<any>;
|
|
2461
2463
|
/**
|
|
2462
2464
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2463
2465
|
*
|
|
@@ -2467,7 +2469,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2467
2469
|
* @request POST:/tenant/report/users/simple
|
|
2468
2470
|
* @secure
|
|
2469
2471
|
*/
|
|
2470
|
-
createReportUsersSimple: (data:
|
|
2472
|
+
createReportUsersSimple: (data: InputSozb4Fr6Pwk, params?: RequestParams) => Promise<any>;
|
|
2471
2473
|
/**
|
|
2472
2474
|
* @description Retrieve user by ID.
|
|
2473
2475
|
*
|
|
@@ -2477,7 +2479,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2477
2479
|
* @request POST:/tenant/search/users/count
|
|
2478
2480
|
* @secure
|
|
2479
2481
|
*/
|
|
2480
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2482
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputK11M37Kse5>;
|
|
2481
2483
|
};
|
|
2482
2484
|
user: {
|
|
2483
2485
|
/**
|
|
@@ -2509,7 +2511,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2509
2511
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2510
2512
|
* @secure
|
|
2511
2513
|
*/
|
|
2512
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2514
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: InputBejlnd4Qri, params?: RequestParams) => Promise<any>;
|
|
2513
2515
|
/**
|
|
2514
2516
|
* @description Delete a certification process application by type.
|
|
2515
2517
|
*
|
|
@@ -2569,7 +2571,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2569
2571
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2570
2572
|
* @secure
|
|
2571
2573
|
*/
|
|
2572
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2574
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputWbgzigq2Z4G>;
|
|
2573
2575
|
/**
|
|
2574
2576
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2575
2577
|
*
|
|
@@ -2579,7 +2581,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2579
2581
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2580
2582
|
* @secure
|
|
2581
2583
|
*/
|
|
2582
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2584
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<Output6Icup3Essgh>;
|
|
2583
2585
|
/**
|
|
2584
2586
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2585
2587
|
*
|
|
@@ -2599,7 +2601,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2599
2601
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2600
2602
|
* @secure
|
|
2601
2603
|
*/
|
|
2602
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2604
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputMypoea77Dig, params?: RequestParams) => Promise<OutputMypoea77Dig>;
|
|
2603
2605
|
/**
|
|
2604
2606
|
* @description Delete user by ID.
|
|
2605
2607
|
*
|
|
@@ -2629,7 +2631,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2629
2631
|
* @request POST:/user/{userID}
|
|
2630
2632
|
* @secure
|
|
2631
2633
|
*/
|
|
2632
|
-
createUser: (userId: string, data:
|
|
2634
|
+
createUser: (userId: string, data: Input1Anuav4Wq, params?: RequestParams) => Promise<any>;
|
|
2633
2635
|
/**
|
|
2634
2636
|
* @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.
|
|
2635
2637
|
*
|
|
@@ -2639,7 +2641,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2639
2641
|
* @request PUT:/user/{userID}
|
|
2640
2642
|
* @secure
|
|
2641
2643
|
*/
|
|
2642
|
-
updateUser: (userId: string, data:
|
|
2644
|
+
updateUser: (userId: string, data: InputBmj0Xzqnsb, params?: RequestParams) => Promise<any>;
|
|
2643
2645
|
/**
|
|
2644
2646
|
* @description Delete course from user
|
|
2645
2647
|
*
|
|
@@ -2659,7 +2661,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2659
2661
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2660
2662
|
* @secure
|
|
2661
2663
|
*/
|
|
2662
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2664
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputN2Mqdkbx9P>;
|
|
2663
2665
|
/**
|
|
2664
2666
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2665
2667
|
*
|
|
@@ -2669,7 +2671,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2669
2671
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2670
2672
|
* @secure
|
|
2671
2673
|
*/
|
|
2672
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2674
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputXxvwx06Ayr>;
|
|
2673
2675
|
/**
|
|
2674
2676
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2675
2677
|
*
|
|
@@ -2679,7 +2681,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2679
2681
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2680
2682
|
* @secure
|
|
2681
2683
|
*/
|
|
2682
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2684
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputBmpg97Oc6O>;
|
|
2683
2685
|
/**
|
|
2684
2686
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2685
2687
|
*
|
|
@@ -2719,7 +2721,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2719
2721
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2720
2722
|
* @secure
|
|
2721
2723
|
*/
|
|
2722
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2724
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<Output57Vk1Sr3Kyj>;
|
|
2723
2725
|
/**
|
|
2724
2726
|
* @description This endpoint will print certificate
|
|
2725
2727
|
*
|
|
@@ -2789,7 +2791,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2789
2791
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2790
2792
|
* @secure
|
|
2791
2793
|
*/
|
|
2792
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2794
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputFeog5Wf2Wc, params?: RequestParams) => Promise<any>;
|
|
2793
2795
|
/**
|
|
2794
2796
|
* @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.
|
|
2795
2797
|
*
|
|
@@ -2819,7 +2821,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2819
2821
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2820
2822
|
* @secure
|
|
2821
2823
|
*/
|
|
2822
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2824
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputOrjwer2Lg8, params?: RequestParams) => Promise<any>;
|
|
2823
2825
|
/**
|
|
2824
2826
|
* @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.
|
|
2825
2827
|
*
|
|
@@ -2829,7 +2831,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2829
2831
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2830
2832
|
* @secure
|
|
2831
2833
|
*/
|
|
2832
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2834
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputFzsqwdj8R5, params?: RequestParams) => Promise<any>;
|
|
2833
2835
|
/**
|
|
2834
2836
|
* @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.
|
|
2835
2837
|
*
|
|
@@ -2839,7 +2841,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2839
2841
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2840
2842
|
* @secure
|
|
2841
2843
|
*/
|
|
2842
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2844
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: Input5Btgd4Ab7W, params?: RequestParams) => Promise<any>;
|
|
2843
2845
|
/**
|
|
2844
2846
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2845
2847
|
*
|
|
@@ -2849,7 +2851,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2849
2851
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2850
2852
|
* @secure
|
|
2851
2853
|
*/
|
|
2852
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2854
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputLpq2890S17K, params?: RequestParams) => Promise<any>;
|
|
2853
2855
|
/**
|
|
2854
2856
|
* @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.
|
|
2855
2857
|
*
|
|
@@ -2889,7 +2891,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2889
2891
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2890
2892
|
* @secure
|
|
2891
2893
|
*/
|
|
2892
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2894
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputJ9Dcdc6Jvp, params?: RequestParams) => Promise<any>;
|
|
2893
2895
|
/**
|
|
2894
2896
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
2895
2897
|
*
|
|
@@ -2899,7 +2901,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2899
2901
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2900
2902
|
* @secure
|
|
2901
2903
|
*/
|
|
2902
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2904
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputNxirkiytfi>;
|
|
2903
2905
|
/**
|
|
2904
2906
|
* @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.
|
|
2905
2907
|
*
|
|
@@ -2929,7 +2931,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2929
2931
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2930
2932
|
* @secure
|
|
2931
2933
|
*/
|
|
2932
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
2934
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputCry1Yr2K4J, params?: RequestParams) => Promise<any>;
|
|
2933
2935
|
/**
|
|
2934
2936
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
2935
2937
|
*
|
|
@@ -2979,7 +2981,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2979
2981
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
2980
2982
|
* @secure
|
|
2981
2983
|
*/
|
|
2982
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
2984
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: InputZ1Lsr49K6C, params?: RequestParams) => Promise<any>;
|
|
2983
2985
|
/**
|
|
2984
2986
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
2985
2987
|
*
|
|
@@ -2999,7 +3001,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2999
3001
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3000
3002
|
* @secure
|
|
3001
3003
|
*/
|
|
3002
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3004
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputUate2Qkkga, params?: RequestParams) => Promise<any>;
|
|
3003
3005
|
/**
|
|
3004
3006
|
* @description This route allows you to submit a pending approval.
|
|
3005
3007
|
*
|
|
@@ -3009,7 +3011,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3009
3011
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3010
3012
|
* @secure
|
|
3011
3013
|
*/
|
|
3012
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3014
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputN6Mrda0K2I, params?: RequestParams) => Promise<any>;
|
|
3013
3015
|
/**
|
|
3014
3016
|
* @description This route allows you to review a pending approval.
|
|
3015
3017
|
*
|
|
@@ -3019,7 +3021,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3019
3021
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3020
3022
|
* @secure
|
|
3021
3023
|
*/
|
|
3022
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3024
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputL3M904Duc3, params?: RequestParams) => Promise<any>;
|
|
3023
3025
|
/**
|
|
3024
3026
|
* @description Redeems a license for a user by product ID.
|
|
3025
3027
|
*
|
|
@@ -3029,7 +3031,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3029
3031
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3030
3032
|
* @secure
|
|
3031
3033
|
*/
|
|
3032
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3034
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputOpeoejj9Rp, params?: RequestParams) => Promise<any>;
|
|
3033
3035
|
/**
|
|
3034
3036
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3035
3037
|
*
|
|
@@ -3039,7 +3041,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3039
3041
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3040
3042
|
* @secure
|
|
3041
3043
|
*/
|
|
3042
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3044
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputU7D0Strhe>;
|
|
3043
3045
|
/**
|
|
3044
3046
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3045
3047
|
*
|
|
@@ -3049,7 +3051,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3049
3051
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3050
3052
|
* @secure
|
|
3051
3053
|
*/
|
|
3052
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3054
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputDhf1Dn5Axj, params?: RequestParams) => Promise<any>;
|
|
3053
3055
|
/**
|
|
3054
3056
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3055
3057
|
*
|
|
@@ -3059,7 +3061,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3059
3061
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3060
3062
|
* @secure
|
|
3061
3063
|
*/
|
|
3062
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3064
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input0K8Sf4Aceh, params?: RequestParams) => Promise<any>;
|
|
3063
3065
|
/**
|
|
3064
3066
|
* @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.
|
|
3065
3067
|
*
|
|
@@ -3069,7 +3071,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3069
3071
|
* @request POST:/user/{userID}/updateITA
|
|
3070
3072
|
* @secure
|
|
3071
3073
|
*/
|
|
3072
|
-
createUpdateIta: (userId: string, data:
|
|
3074
|
+
createUpdateIta: (userId: string, data: InputJed24Agekg, params?: RequestParams) => Promise<any>;
|
|
3073
3075
|
/**
|
|
3074
3076
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3075
3077
|
*
|
|
@@ -3079,7 +3081,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3079
3081
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3080
3082
|
* @secure
|
|
3081
3083
|
*/
|
|
3082
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3084
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputZ1Izmy5Hlbg, params?: RequestParams) => Promise<any>;
|
|
3083
3085
|
/**
|
|
3084
3086
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3085
3087
|
*
|
|
@@ -3089,7 +3091,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3089
3091
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3090
3092
|
* @secure
|
|
3091
3093
|
*/
|
|
3092
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3094
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: Input2Yxx0Kgi6F, params?: RequestParams) => Promise<any>;
|
|
3093
3095
|
};
|
|
3094
3096
|
users: {
|
|
3095
3097
|
/**
|
|
@@ -3101,6 +3103,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3101
3103
|
* @request POST:/users/certification/{certSpecID}
|
|
3102
3104
|
* @secure
|
|
3103
3105
|
*/
|
|
3104
|
-
createCertification: (certSpecId: string, data:
|
|
3106
|
+
createCertification: (certSpecId: string, data: InputKor28Jj449, params?: RequestParams) => Promise<OutputKor28Jj449>;
|
|
3105
3107
|
};
|
|
3106
3108
|
}
|