@ikonintegration/bccsa-program-api 3.0.23 → 3.0.24
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 +114 -98
- package/dist/Api.d.ts +114 -102
- package/dist/Api.js +23 -8
- package/dist/Api.js.map +1 -1
- package/package.json +2 -2
- package/tsconfig.json +3 -2
package/dist/Api.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ export interface ErrorResponse {
|
|
|
5
5
|
/** Error code */
|
|
6
6
|
errCode: string;
|
|
7
7
|
}
|
|
8
|
-
export interface
|
|
8
|
+
export interface InputCad8Ejyr4Y {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -431,7 +431,7 @@ export type Name = string;
|
|
|
431
431
|
export type CertTitle = string;
|
|
432
432
|
/** User display name */
|
|
433
433
|
export type DisplayName = string;
|
|
434
|
-
export interface
|
|
434
|
+
export interface InputRygxm02Mdf {
|
|
435
435
|
/**
|
|
436
436
|
* ID of the certification to filter applications by
|
|
437
437
|
* @example "certification123"
|
|
@@ -488,7 +488,7 @@ export interface InputU4C3V4De8Hg {
|
|
|
488
488
|
*/
|
|
489
489
|
ignoreCompletedCertifications?: boolean | null;
|
|
490
490
|
}
|
|
491
|
-
export interface
|
|
491
|
+
export interface InputMfhgwhflhq {
|
|
492
492
|
/**
|
|
493
493
|
* ID of the certification to filter applications by
|
|
494
494
|
* @example "certification123"
|
|
@@ -545,7 +545,7 @@ export interface InputVsl3M1Bf02 {
|
|
|
545
545
|
*/
|
|
546
546
|
ignoreCompletedCertifications?: boolean | null;
|
|
547
547
|
}
|
|
548
|
-
export interface
|
|
548
|
+
export interface InputO1Utmw3Ddv {
|
|
549
549
|
/**
|
|
550
550
|
* ID of the certification to filter applications by
|
|
551
551
|
* @example "certification123"
|
|
@@ -602,7 +602,7 @@ export interface InputQtxygdy6Sp {
|
|
|
602
602
|
*/
|
|
603
603
|
ignoreCompletedCertifications?: boolean | null;
|
|
604
604
|
}
|
|
605
|
-
export interface
|
|
605
|
+
export interface InputOx8B0Fn9M2L {
|
|
606
606
|
/**
|
|
607
607
|
* The ID of the certificate specifications to be used for the email
|
|
608
608
|
* @example "certSpecsID123"
|
|
@@ -643,7 +643,7 @@ export interface InputW7Byz2Y6Du {
|
|
|
643
643
|
emailAddress: string;
|
|
644
644
|
}[];
|
|
645
645
|
}
|
|
646
|
-
export interface
|
|
646
|
+
export interface InputEqnnf7Kjev {
|
|
647
647
|
/**
|
|
648
648
|
* The ID of the product for which the license is being redeemed
|
|
649
649
|
* @example "productID123"
|
|
@@ -655,7 +655,7 @@ export interface Input72I12Ohjlb {
|
|
|
655
655
|
*/
|
|
656
656
|
sessionID?: string;
|
|
657
657
|
}
|
|
658
|
-
export interface
|
|
658
|
+
export interface InputVkbamnqi6Ih {
|
|
659
659
|
/**
|
|
660
660
|
* Search term to filter licenses
|
|
661
661
|
* @example "active"
|
|
@@ -672,7 +672,7 @@ export interface Input9X53Pc16Nx {
|
|
|
672
672
|
*/
|
|
673
673
|
sortField?: any;
|
|
674
674
|
}
|
|
675
|
-
export interface
|
|
675
|
+
export interface Input89V7C8Afh7 {
|
|
676
676
|
/**
|
|
677
677
|
* Search term to filter licenses
|
|
678
678
|
* @example "active"
|
|
@@ -728,7 +728,7 @@ export interface ReportXLSXSchema {
|
|
|
728
728
|
xlsxStream: File;
|
|
729
729
|
contentType: ReportXlsxSchemaContentTypeEnum;
|
|
730
730
|
}
|
|
731
|
-
export interface
|
|
731
|
+
export interface InputXt5Pmzvupx {
|
|
732
732
|
/**
|
|
733
733
|
* Start date for the report
|
|
734
734
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -750,11 +750,11 @@ export interface InputF7Vlnyefnb {
|
|
|
750
750
|
*/
|
|
751
751
|
dateType?: string;
|
|
752
752
|
}
|
|
753
|
-
export interface
|
|
753
|
+
export interface InputGvktmmbhkh {
|
|
754
754
|
/** List of user IDs to search for in the tenant. */
|
|
755
755
|
IDs: (string | null)[];
|
|
756
756
|
}
|
|
757
|
-
export interface
|
|
757
|
+
export interface InputY60712Ei2U {
|
|
758
758
|
/** The term to search for in the user profiles. */
|
|
759
759
|
searchTerm?: string | null;
|
|
760
760
|
/** Filter criteria for the user search. */
|
|
@@ -794,7 +794,7 @@ export interface Input6Eq5Uhd3Vt {
|
|
|
794
794
|
};
|
|
795
795
|
};
|
|
796
796
|
}
|
|
797
|
-
export interface
|
|
797
|
+
export interface InputUthvuhm96N {
|
|
798
798
|
/** The term to search for in the user profiles. */
|
|
799
799
|
searchTerm?: string | null;
|
|
800
800
|
/** Filter criteria for the user search. */
|
|
@@ -834,21 +834,21 @@ export interface InputMwks4Uarfm {
|
|
|
834
834
|
};
|
|
835
835
|
};
|
|
836
836
|
}
|
|
837
|
-
export interface
|
|
837
|
+
export interface OutputRjxgiilfs {
|
|
838
838
|
/** External system ID 2 */
|
|
839
839
|
userCount: ExternalID2;
|
|
840
840
|
transactionID?: string | null;
|
|
841
841
|
}
|
|
842
842
|
/** External system ID 2 */
|
|
843
843
|
export type ExternalID2 = number;
|
|
844
|
-
export interface
|
|
844
|
+
export interface Output5Htlnblgkj {
|
|
845
845
|
/**
|
|
846
846
|
* Signed URL for the course file
|
|
847
847
|
* @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"
|
|
848
848
|
*/
|
|
849
849
|
fileURL: string;
|
|
850
850
|
}
|
|
851
|
-
export interface
|
|
851
|
+
export interface OutputMjeq72N11H {
|
|
852
852
|
/**
|
|
853
853
|
* Amount to be refunded for the cancellation
|
|
854
854
|
* @example 0
|
|
@@ -1139,7 +1139,7 @@ export interface CourseResponseEntity {
|
|
|
1139
1139
|
}
|
|
1140
1140
|
/** Label of the course enrolled (course version) */
|
|
1141
1141
|
export type OnlineCourseLabel = string;
|
|
1142
|
-
export interface
|
|
1142
|
+
export interface OutputKj3Tjk191H {
|
|
1143
1143
|
/**
|
|
1144
1144
|
* Signed URL for the course file
|
|
1145
1145
|
* @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"
|
|
@@ -1157,7 +1157,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1157
1157
|
transactionID?: string | null;
|
|
1158
1158
|
}
|
|
1159
1159
|
/** Application Foreign Fill response type */
|
|
1160
|
-
export interface
|
|
1160
|
+
export interface OutputK4Rwz2Mqow {
|
|
1161
1161
|
items: {
|
|
1162
1162
|
userID: string;
|
|
1163
1163
|
createdOn?: number;
|
|
@@ -1340,7 +1340,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1340
1340
|
applicationItems?: Record<string, any>[];
|
|
1341
1341
|
transactionID?: string | null;
|
|
1342
1342
|
}
|
|
1343
|
-
export interface
|
|
1343
|
+
export interface InputI4T3Lq4Y4 {
|
|
1344
1344
|
issuedOn?: number;
|
|
1345
1345
|
expiresOn?: number;
|
|
1346
1346
|
fileItems?: {
|
|
@@ -1349,21 +1349,21 @@ export interface Input69Xz46Fwmt {
|
|
|
1349
1349
|
}[];
|
|
1350
1350
|
additionalNotes?: string | null;
|
|
1351
1351
|
}
|
|
1352
|
-
export interface
|
|
1352
|
+
export interface InputJze29Qql3J {
|
|
1353
1353
|
/**
|
|
1354
1354
|
* Indicates whether the application is locked
|
|
1355
1355
|
* @example true
|
|
1356
1356
|
*/
|
|
1357
1357
|
isApplicationLocked: boolean;
|
|
1358
1358
|
}
|
|
1359
|
-
export interface
|
|
1359
|
+
export interface Output2Fueyis9Mf {
|
|
1360
1360
|
/**
|
|
1361
1361
|
* Signed URL for the course file
|
|
1362
1362
|
* @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"
|
|
1363
1363
|
*/
|
|
1364
1364
|
fileURL: string;
|
|
1365
1365
|
}
|
|
1366
|
-
export interface
|
|
1366
|
+
export interface InputQbz0M4Dqc3 {
|
|
1367
1367
|
/**
|
|
1368
1368
|
* Indicates whether the waiver is approved
|
|
1369
1369
|
* @example true
|
|
@@ -1375,14 +1375,14 @@ export interface InputSucbklla9Yk {
|
|
|
1375
1375
|
*/
|
|
1376
1376
|
additionalNotes?: string | null;
|
|
1377
1377
|
}
|
|
1378
|
-
export interface
|
|
1378
|
+
export interface Input044Oyybc0M {
|
|
1379
1379
|
/**
|
|
1380
1380
|
* Optional notes regarding the waiver
|
|
1381
1381
|
* @example "Waiver granted due to special circumstances."
|
|
1382
1382
|
*/
|
|
1383
1383
|
additionalNotes?: string | null;
|
|
1384
1384
|
}
|
|
1385
|
-
export interface
|
|
1385
|
+
export interface InputJtey9Gkj4N {
|
|
1386
1386
|
students: {
|
|
1387
1387
|
/**
|
|
1388
1388
|
* User ID of the student to redeem the course for
|
|
@@ -1416,7 +1416,7 @@ export interface InputDhlgnq7Qbrg {
|
|
|
1416
1416
|
*/
|
|
1417
1417
|
autoEnrolSessionID?: string;
|
|
1418
1418
|
}
|
|
1419
|
-
export interface
|
|
1419
|
+
export interface InputKk888In56 {
|
|
1420
1420
|
invites: {
|
|
1421
1421
|
/**
|
|
1422
1422
|
* Email address of the user to invite
|
|
@@ -1445,7 +1445,7 @@ export interface Input9Fuob5H5Gu {
|
|
|
1445
1445
|
*/
|
|
1446
1446
|
isReservedSeat: boolean;
|
|
1447
1447
|
}
|
|
1448
|
-
export interface
|
|
1448
|
+
export interface InputF4Qkw71Af5 {
|
|
1449
1449
|
/**
|
|
1450
1450
|
* Indicates whether to waive the certification process
|
|
1451
1451
|
* @example true
|
|
@@ -1458,7 +1458,7 @@ export interface InputHncfz63Fiwk {
|
|
|
1458
1458
|
comments?: string | null;
|
|
1459
1459
|
}
|
|
1460
1460
|
/** Certification move response schema */
|
|
1461
|
-
export interface
|
|
1461
|
+
export interface Output16J18Ccnj2 {
|
|
1462
1462
|
errors?: {
|
|
1463
1463
|
status: string;
|
|
1464
1464
|
object?: Record<string, any>;
|
|
@@ -1466,19 +1466,19 @@ export interface OutputQssne1Jk1X {
|
|
|
1466
1466
|
}[];
|
|
1467
1467
|
}
|
|
1468
1468
|
/** Schema for writing a certification trigger check. */
|
|
1469
|
-
export interface
|
|
1469
|
+
export interface InputBs15Figong {
|
|
1470
1470
|
/**
|
|
1471
1471
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1472
1472
|
* @example "CHECKED"
|
|
1473
1473
|
*/
|
|
1474
|
-
value:
|
|
1474
|
+
value: InputBs15FigongValueEnum;
|
|
1475
1475
|
/**
|
|
1476
1476
|
* List of course IDs that are blocked by this trigger check.
|
|
1477
1477
|
* @example ["course1","course2"]
|
|
1478
1478
|
*/
|
|
1479
1479
|
blockedCourses?: string[];
|
|
1480
1480
|
}
|
|
1481
|
-
export interface
|
|
1481
|
+
export interface Input4X96Bzl8Ls {
|
|
1482
1482
|
/**
|
|
1483
1483
|
* Indicates whether the application item is approved
|
|
1484
1484
|
* @example true
|
|
@@ -1504,7 +1504,7 @@ export interface InputH4M4Vr7Xm2L {
|
|
|
1504
1504
|
export interface StudentHistoryRequestSchema {
|
|
1505
1505
|
requirements: string[];
|
|
1506
1506
|
}
|
|
1507
|
-
export interface
|
|
1507
|
+
export interface InputVp1Fgim6Yo {
|
|
1508
1508
|
/**
|
|
1509
1509
|
* Optional activation key for the application
|
|
1510
1510
|
* @example "AK-123456"
|
|
@@ -1512,7 +1512,7 @@ export interface InputOzrwgtx1Z2 {
|
|
|
1512
1512
|
activationKey?: string;
|
|
1513
1513
|
}
|
|
1514
1514
|
/** Schema for course submission item details post request. */
|
|
1515
|
-
export interface
|
|
1515
|
+
export interface InputJ33Sd4Ayqi {
|
|
1516
1516
|
/**
|
|
1517
1517
|
* The ID of the file being submitted.
|
|
1518
1518
|
* @example "fileID123"
|
|
@@ -1525,7 +1525,7 @@ export interface InputRa49Ugtgj {
|
|
|
1525
1525
|
fileName: string;
|
|
1526
1526
|
}
|
|
1527
1527
|
/** Schema for the response to course submission item details post request. */
|
|
1528
|
-
export interface
|
|
1528
|
+
export interface OutputJ33Sd4Ayqi {
|
|
1529
1529
|
submissionItems: {
|
|
1530
1530
|
/**
|
|
1531
1531
|
* The ID of the file being submitted.
|
|
@@ -1540,7 +1540,7 @@ export interface OutputRa49Ugtgj {
|
|
|
1540
1540
|
}[];
|
|
1541
1541
|
}
|
|
1542
1542
|
/** Pending approval submission parameters */
|
|
1543
|
-
export interface
|
|
1543
|
+
export interface InputC7Xaos72Zo {
|
|
1544
1544
|
/**
|
|
1545
1545
|
* Type of pending approval
|
|
1546
1546
|
* @example "certification"
|
|
@@ -1560,7 +1560,7 @@ export interface Input7Xiplwv8Cr {
|
|
|
1560
1560
|
fileName: string;
|
|
1561
1561
|
}[];
|
|
1562
1562
|
}
|
|
1563
|
-
export interface
|
|
1563
|
+
export interface InputS2K8Zhf0Z1 {
|
|
1564
1564
|
/**
|
|
1565
1565
|
* The ID of the course for which the license is being redeemed
|
|
1566
1566
|
* @example "courseID123"
|
|
@@ -1628,7 +1628,7 @@ export interface Input8Uqmgsj643 {
|
|
|
1628
1628
|
acknowledgement?: string | null;
|
|
1629
1629
|
}
|
|
1630
1630
|
/** Validate certification move response schema */
|
|
1631
|
-
export interface
|
|
1631
|
+
export interface OutputOqmbw6Fqjz {
|
|
1632
1632
|
courses: {
|
|
1633
1633
|
name: string;
|
|
1634
1634
|
status: string;
|
|
@@ -1639,21 +1639,21 @@ export interface OutputFvqn0Re8M9 {
|
|
|
1639
1639
|
validated: boolean;
|
|
1640
1640
|
mustCreateCP: boolean;
|
|
1641
1641
|
}
|
|
1642
|
-
export interface
|
|
1642
|
+
export interface InputWx6Vxgv83B {
|
|
1643
1643
|
/**
|
|
1644
1644
|
* Comments regarding the end of the cooldown period
|
|
1645
1645
|
* @example "Cooldown period ended successfully."
|
|
1646
1646
|
*/
|
|
1647
1647
|
comments: string;
|
|
1648
1648
|
}
|
|
1649
|
-
export interface
|
|
1649
|
+
export interface Output8X4Eotpmfa {
|
|
1650
1650
|
/**
|
|
1651
1651
|
* Signed URL for the course file
|
|
1652
1652
|
* @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"
|
|
1653
1653
|
*/
|
|
1654
1654
|
fileURL: string;
|
|
1655
1655
|
}
|
|
1656
|
-
export interface
|
|
1656
|
+
export interface InputBii9Su5Lr6 {
|
|
1657
1657
|
/** @example true */
|
|
1658
1658
|
agreedWithCertTerms: boolean;
|
|
1659
1659
|
/** @example 1717230000000 */
|
|
@@ -1725,21 +1725,21 @@ export interface InputOtoghzqho4 {
|
|
|
1725
1725
|
/** @example "EXT#999" */
|
|
1726
1726
|
externalID2?: string | null;
|
|
1727
1727
|
}
|
|
1728
|
-
export interface
|
|
1728
|
+
export interface Input6D6Jgcta59 {
|
|
1729
1729
|
/**
|
|
1730
1730
|
* Comments regarding the course unlock action
|
|
1731
1731
|
* @example "Course unlocked successfully."
|
|
1732
1732
|
*/
|
|
1733
1733
|
comments: string;
|
|
1734
1734
|
}
|
|
1735
|
-
export interface
|
|
1735
|
+
export interface InputJpfssm5Oik {
|
|
1736
1736
|
/**
|
|
1737
1737
|
* ITA number to update for the user
|
|
1738
1738
|
* @example "ITA123456"
|
|
1739
1739
|
*/
|
|
1740
1740
|
itaNumber: string;
|
|
1741
1741
|
}
|
|
1742
|
-
export interface
|
|
1742
|
+
export interface InputRdlskcnfpv {
|
|
1743
1743
|
/** @example true */
|
|
1744
1744
|
agreedWithCertTerms: boolean;
|
|
1745
1745
|
/** @example 1717230000000 */
|
|
@@ -1811,7 +1811,7 @@ export interface Input6I1B04X05S {
|
|
|
1811
1811
|
/** @example "EXT#999" */
|
|
1812
1812
|
externalID2?: string | null;
|
|
1813
1813
|
}
|
|
1814
|
-
export interface
|
|
1814
|
+
export interface Input4Dsobi1Hzx {
|
|
1815
1815
|
/**
|
|
1816
1816
|
* The grade to override the course result with
|
|
1817
1817
|
* @example "A"
|
|
@@ -1819,7 +1819,7 @@ export interface Input7Li5D5Dgch {
|
|
|
1819
1819
|
resultGrade: string;
|
|
1820
1820
|
}
|
|
1821
1821
|
/** Pending approval review parameters */
|
|
1822
|
-
export interface
|
|
1822
|
+
export interface InputAioiui29Q9 {
|
|
1823
1823
|
/**
|
|
1824
1824
|
* Notes provided by the reviewer for the pending approval
|
|
1825
1825
|
* @example "Please review the submitted documents."
|
|
@@ -1832,7 +1832,7 @@ export interface InputUn9Itok4S6 {
|
|
|
1832
1832
|
approved: boolean;
|
|
1833
1833
|
}
|
|
1834
1834
|
/** Schema for overriding course result dates. */
|
|
1835
|
-
export interface
|
|
1835
|
+
export interface Input0Yk8Sac5Su {
|
|
1836
1836
|
/**
|
|
1837
1837
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1838
1838
|
* @example 1735689600000
|
|
@@ -1844,14 +1844,14 @@ export interface Input552J2Xh4N9 {
|
|
|
1844
1844
|
*/
|
|
1845
1845
|
completionDate?: number;
|
|
1846
1846
|
}
|
|
1847
|
-
export interface
|
|
1847
|
+
export interface InputEvsnfd14P3 {
|
|
1848
1848
|
filter: {
|
|
1849
1849
|
from?: number;
|
|
1850
1850
|
sortOrder?: string;
|
|
1851
1851
|
sortField?: string;
|
|
1852
1852
|
};
|
|
1853
1853
|
}
|
|
1854
|
-
export interface
|
|
1854
|
+
export interface OutputEvsnfd14P3 {
|
|
1855
1855
|
users: {
|
|
1856
1856
|
firstName: string;
|
|
1857
1857
|
lastName: string;
|
|
@@ -1875,7 +1875,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
1875
1875
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1876
1876
|
* @example "CHECKED"
|
|
1877
1877
|
*/
|
|
1878
|
-
export declare enum
|
|
1878
|
+
export declare enum InputBs15FigongValueEnum {
|
|
1879
1879
|
CHECKED = "CHECKED",
|
|
1880
1880
|
UNCHECKED = "UNCHECKED",
|
|
1881
1881
|
NOVALUE = "NOVALUE"
|
|
@@ -1968,7 +1968,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
1968
1968
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
1969
1969
|
export type CreateReportUsersSimpleData = any;
|
|
1970
1970
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
1971
|
-
export type CreateSearchUsersCountData =
|
|
1971
|
+
export type CreateSearchUsersCountData = OutputRjxgiilfs;
|
|
1972
1972
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
1973
1973
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
1974
1974
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -1992,7 +1992,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
1992
1992
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
1993
1993
|
export type DeleteCertificationCourseFileSignData = any;
|
|
1994
1994
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
1995
|
-
export type GetCertificationCourseFileSignData =
|
|
1995
|
+
export type GetCertificationCourseFileSignData = OutputKj3Tjk191H;
|
|
1996
1996
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
1997
1997
|
export interface CreateCertificationCourseFileSignParams {
|
|
1998
1998
|
/** @example "pdf" */
|
|
@@ -2006,11 +2006,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2006
2006
|
/** @example "fileID" */
|
|
2007
2007
|
fileId: string;
|
|
2008
2008
|
}
|
|
2009
|
-
export type CreateCertificationCourseFileSignData =
|
|
2009
|
+
export type CreateCertificationCourseFileSignData = Output8X4Eotpmfa;
|
|
2010
2010
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2011
2011
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2012
2012
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2013
|
-
export type CreateCertificationCourseDocumentData =
|
|
2013
|
+
export type CreateCertificationCourseDocumentData = OutputJ33Sd4Ayqi;
|
|
2014
2014
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2015
2015
|
export type DeleteUserData = any;
|
|
2016
2016
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2022,7 +2022,7 @@ export type UpdateUserData = any;
|
|
|
2022
2022
|
export type UpdateUserError = ErrorResponse;
|
|
2023
2023
|
export type DeleteCertificationCourseData = any;
|
|
2024
2024
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2025
|
-
export type GetCertificationApplicationItemFileData =
|
|
2025
|
+
export type GetCertificationApplicationItemFileData = Output5Htlnblgkj;
|
|
2026
2026
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2027
2027
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2028
2028
|
/** @example "pdf" */
|
|
@@ -2036,9 +2036,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2036
2036
|
/** @example "fileVersion" */
|
|
2037
2037
|
fileVersion: string;
|
|
2038
2038
|
}
|
|
2039
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2039
|
+
export type CreateCertificationApplicationItemFileData = Output2Fueyis9Mf;
|
|
2040
2040
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2041
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2041
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputMjeq72N11H;
|
|
2042
2042
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2043
2043
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2044
2044
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2046,7 +2046,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2046
2046
|
export type GetCourseError = ErrorResponse;
|
|
2047
2047
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2048
2048
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2049
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2049
|
+
export type GetCertificationApplicationForeignFillData = OutputK4Rwz2Mqow;
|
|
2050
2050
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2051
2051
|
export type GetCertificationPrintData = any;
|
|
2052
2052
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2080,7 +2080,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2080
2080
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2081
2081
|
export type CreateCertificationWaiveData = any;
|
|
2082
2082
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2083
|
-
export type CreateCertificationMoveData =
|
|
2083
|
+
export type CreateCertificationMoveData = Output16J18Ccnj2;
|
|
2084
2084
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2085
2085
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2086
2086
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2094,6 +2094,8 @@ export type CreateRefreshOrgMembershipData = any;
|
|
|
2094
2094
|
export type CreateRefreshOrgMembershipError = ErrorResponse;
|
|
2095
2095
|
export type CreateCertificationCourseRetakeData = any;
|
|
2096
2096
|
export type CreateCertificationCourseRetakeError = ErrorResponse;
|
|
2097
|
+
export type CreateCertificationCourseRevokeAllData = any;
|
|
2098
|
+
export type CreateCertificationCourseRevokeAllError = ErrorResponse;
|
|
2097
2099
|
export type CreateCertificationCourseRevokeData = any;
|
|
2098
2100
|
export type CreateCertificationCourseRevokeError = ErrorResponse;
|
|
2099
2101
|
export type CreateCertificationApplicationItemRemoveData = any;
|
|
@@ -2110,7 +2112,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2110
2112
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2111
2113
|
export type CreateCertificationCourseRedeemData = any;
|
|
2112
2114
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2113
|
-
export type CreateCertificationMoveValidateData =
|
|
2115
|
+
export type CreateCertificationMoveValidateData = OutputOqmbw6Fqjz;
|
|
2114
2116
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2115
2117
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2116
2118
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2126,7 +2128,7 @@ export type CreateCertificationPublishInfoData = any;
|
|
|
2126
2128
|
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2127
2129
|
export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
2128
2130
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2129
|
-
export type CreateCertificationResult =
|
|
2131
|
+
export type CreateCertificationResult = OutputEvsnfd14P3;
|
|
2130
2132
|
export type CreateCertificationFail = ErrorResponse;
|
|
2131
2133
|
export type CreateCertificationPublishInfoResult = any;
|
|
2132
2134
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2173,7 +2175,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2173
2175
|
}
|
|
2174
2176
|
/**
|
|
2175
2177
|
* @title BCCSA Program API
|
|
2176
|
-
* @version 3.0.
|
|
2178
|
+
* @version 3.0.24
|
|
2177
2179
|
* @baseUrl http://localhost:8080
|
|
2178
2180
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2179
2181
|
*/
|
|
@@ -2188,7 +2190,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2188
2190
|
* @request POST:/contactUs
|
|
2189
2191
|
* @secure
|
|
2190
2192
|
*/
|
|
2191
|
-
listContactUs: (data:
|
|
2193
|
+
listContactUs: (data: InputCad8Ejyr4Y, params?: RequestParams) => Promise<any>;
|
|
2192
2194
|
};
|
|
2193
2195
|
customer: {
|
|
2194
2196
|
/**
|
|
@@ -2292,7 +2294,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2292
2294
|
* @request POST:/tenant/report/applicationExport
|
|
2293
2295
|
* @secure
|
|
2294
2296
|
*/
|
|
2295
|
-
createReportApplicationExport: (data:
|
|
2297
|
+
createReportApplicationExport: (data: InputRygxm02Mdf, params?: RequestParams) => Promise<any>;
|
|
2296
2298
|
/**
|
|
2297
2299
|
* @description Export a report of applications based on the provided filters.
|
|
2298
2300
|
*
|
|
@@ -2302,7 +2304,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2302
2304
|
* @request POST:/tenant/report/applicationStatus
|
|
2303
2305
|
* @secure
|
|
2304
2306
|
*/
|
|
2305
|
-
listReportApplicationStatus: (data:
|
|
2307
|
+
listReportApplicationStatus: (data: InputMfhgwhflhq, params?: RequestParams) => Promise<any>;
|
|
2306
2308
|
/**
|
|
2307
2309
|
* @description Export a report of applications based on the provided filters.
|
|
2308
2310
|
*
|
|
@@ -2312,7 +2314,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2312
2314
|
* @request POST:/tenant/report/applicationsReport
|
|
2313
2315
|
* @secure
|
|
2314
2316
|
*/
|
|
2315
|
-
createReportApplicationsReport: (data:
|
|
2317
|
+
createReportApplicationsReport: (data: InputO1Utmw3Ddv, params?: RequestParams) => Promise<any>;
|
|
2316
2318
|
/**
|
|
2317
2319
|
* @description This route allows you to post certificates email for the tenant.
|
|
2318
2320
|
*
|
|
@@ -2322,7 +2324,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2322
2324
|
* @request POST:/tenant/certificates/email
|
|
2323
2325
|
* @secure
|
|
2324
2326
|
*/
|
|
2325
|
-
createCertificatesEmail: (data:
|
|
2327
|
+
createCertificatesEmail: (data: InputOx8B0Fn9M2L, params?: RequestParams) => Promise<any>;
|
|
2326
2328
|
/**
|
|
2327
2329
|
* @description Generate a preview of the completed certifications report.
|
|
2328
2330
|
*
|
|
@@ -2352,7 +2354,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2352
2354
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2353
2355
|
* @secure
|
|
2354
2356
|
*/
|
|
2355
|
-
createLicenseRedeem: (userId: string, data:
|
|
2357
|
+
createLicenseRedeem: (userId: string, data: InputEqnnf7Kjev, params?: RequestParams) => Promise<any>;
|
|
2356
2358
|
/**
|
|
2357
2359
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2358
2360
|
*
|
|
@@ -2362,7 +2364,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2362
2364
|
* @request POST:/tenant/report/orglicenses/
|
|
2363
2365
|
* @secure
|
|
2364
2366
|
*/
|
|
2365
|
-
listReportOrglicenses: (data:
|
|
2367
|
+
listReportOrglicenses: (data: InputVkbamnqi6Ih, params?: RequestParams) => Promise<any>;
|
|
2366
2368
|
/**
|
|
2367
2369
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2368
2370
|
*
|
|
@@ -2372,7 +2374,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2372
2374
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2373
2375
|
* @secure
|
|
2374
2376
|
*/
|
|
2375
|
-
createReportOrglicensesPreview: (data:
|
|
2377
|
+
createReportOrglicensesPreview: (data: Input89V7C8Afh7, params?: RequestParams) => Promise<any>;
|
|
2376
2378
|
/**
|
|
2377
2379
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2378
2380
|
*
|
|
@@ -2402,7 +2404,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2402
2404
|
* @request POST:/tenant/report/users/advanced
|
|
2403
2405
|
* @secure
|
|
2404
2406
|
*/
|
|
2405
|
-
createReportUsersAdvanced: (data:
|
|
2407
|
+
createReportUsersAdvanced: (data: InputXt5Pmzvupx, params?: RequestParams) => Promise<any>;
|
|
2406
2408
|
/**
|
|
2407
2409
|
* @description Searches for users in the tenant by their IDs.
|
|
2408
2410
|
*
|
|
@@ -2412,7 +2414,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2412
2414
|
* @request POST:/tenant/search/users/ids
|
|
2413
2415
|
* @secure
|
|
2414
2416
|
*/
|
|
2415
|
-
listSearchUsersIds: (data:
|
|
2417
|
+
listSearchUsersIds: (data: InputGvktmmbhkh, params?: RequestParams) => Promise<any>;
|
|
2416
2418
|
/**
|
|
2417
2419
|
* @description Searches for users in the tenant by term and filters.
|
|
2418
2420
|
*
|
|
@@ -2422,7 +2424,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2422
2424
|
* @request POST:/tenant/search/users/term
|
|
2423
2425
|
* @secure
|
|
2424
2426
|
*/
|
|
2425
|
-
createSearchUsersTerm: (data:
|
|
2427
|
+
createSearchUsersTerm: (data: InputY60712Ei2U, params?: RequestParams) => Promise<any>;
|
|
2426
2428
|
/**
|
|
2427
2429
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2428
2430
|
*
|
|
@@ -2432,7 +2434,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2432
2434
|
* @request POST:/tenant/report/users/simple
|
|
2433
2435
|
* @secure
|
|
2434
2436
|
*/
|
|
2435
|
-
createReportUsersSimple: (data:
|
|
2437
|
+
createReportUsersSimple: (data: InputUthvuhm96N, params?: RequestParams) => Promise<any>;
|
|
2436
2438
|
/**
|
|
2437
2439
|
* @description Retrieve user by ID.
|
|
2438
2440
|
*
|
|
@@ -2442,7 +2444,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2442
2444
|
* @request POST:/tenant/search/users/count
|
|
2443
2445
|
* @secure
|
|
2444
2446
|
*/
|
|
2445
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2447
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputRjxgiilfs>;
|
|
2446
2448
|
};
|
|
2447
2449
|
user: {
|
|
2448
2450
|
/**
|
|
@@ -2474,7 +2476,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2474
2476
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2475
2477
|
* @secure
|
|
2476
2478
|
*/
|
|
2477
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2479
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: InputI4T3Lq4Y4, params?: RequestParams) => Promise<any>;
|
|
2478
2480
|
/**
|
|
2479
2481
|
* @description Delete a certification process application by type.
|
|
2480
2482
|
*
|
|
@@ -2564,7 +2566,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2564
2566
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2565
2567
|
* @secure
|
|
2566
2568
|
*/
|
|
2567
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2569
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputKj3Tjk191H>;
|
|
2568
2570
|
/**
|
|
2569
2571
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2570
2572
|
*
|
|
@@ -2574,7 +2576,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2574
2576
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2575
2577
|
* @secure
|
|
2576
2578
|
*/
|
|
2577
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2579
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<Output8X4Eotpmfa>;
|
|
2578
2580
|
/**
|
|
2579
2581
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2580
2582
|
*
|
|
@@ -2594,7 +2596,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2594
2596
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2595
2597
|
* @secure
|
|
2596
2598
|
*/
|
|
2597
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2599
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputJ33Sd4Ayqi, params?: RequestParams) => Promise<OutputJ33Sd4Ayqi>;
|
|
2598
2600
|
/**
|
|
2599
2601
|
* @description Delete user by ID.
|
|
2600
2602
|
*
|
|
@@ -2624,7 +2626,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2624
2626
|
* @request POST:/user/{userID}
|
|
2625
2627
|
* @secure
|
|
2626
2628
|
*/
|
|
2627
|
-
createUser: (userId: string, data:
|
|
2629
|
+
createUser: (userId: string, data: InputBii9Su5Lr6, params?: RequestParams) => Promise<any>;
|
|
2628
2630
|
/**
|
|
2629
2631
|
* @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.
|
|
2630
2632
|
*
|
|
@@ -2634,7 +2636,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2634
2636
|
* @request PUT:/user/{userID}
|
|
2635
2637
|
* @secure
|
|
2636
2638
|
*/
|
|
2637
|
-
updateUser: (userId: string, data:
|
|
2639
|
+
updateUser: (userId: string, data: InputRdlskcnfpv, params?: RequestParams) => Promise<any>;
|
|
2638
2640
|
/**
|
|
2639
2641
|
* @description Delete course from user
|
|
2640
2642
|
*
|
|
@@ -2654,7 +2656,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2654
2656
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2655
2657
|
* @secure
|
|
2656
2658
|
*/
|
|
2657
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2659
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<Output5Htlnblgkj>;
|
|
2658
2660
|
/**
|
|
2659
2661
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2660
2662
|
*
|
|
@@ -2664,7 +2666,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2664
2666
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2665
2667
|
* @secure
|
|
2666
2668
|
*/
|
|
2667
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2669
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<Output2Fueyis9Mf>;
|
|
2668
2670
|
/**
|
|
2669
2671
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2670
2672
|
*
|
|
@@ -2674,7 +2676,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2674
2676
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2675
2677
|
* @secure
|
|
2676
2678
|
*/
|
|
2677
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2679
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputMjeq72N11H>;
|
|
2678
2680
|
/**
|
|
2679
2681
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2680
2682
|
*
|
|
@@ -2714,7 +2716,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2714
2716
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2715
2717
|
* @secure
|
|
2716
2718
|
*/
|
|
2717
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2719
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputK4Rwz2Mqow>;
|
|
2718
2720
|
/**
|
|
2719
2721
|
* @description This endpoint will print certificate
|
|
2720
2722
|
*
|
|
@@ -2774,7 +2776,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2774
2776
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2775
2777
|
* @secure
|
|
2776
2778
|
*/
|
|
2777
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2779
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputJze29Qql3J, params?: RequestParams) => Promise<any>;
|
|
2778
2780
|
/**
|
|
2779
2781
|
* @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.
|
|
2780
2782
|
*
|
|
@@ -2804,7 +2806,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2804
2806
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2805
2807
|
* @secure
|
|
2806
2808
|
*/
|
|
2807
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2809
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputQbz0M4Dqc3, params?: RequestParams) => Promise<any>;
|
|
2808
2810
|
/**
|
|
2809
2811
|
* @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.
|
|
2810
2812
|
*
|
|
@@ -2814,7 +2816,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2814
2816
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2815
2817
|
* @secure
|
|
2816
2818
|
*/
|
|
2817
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2819
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: Input044Oyybc0M, params?: RequestParams) => Promise<any>;
|
|
2818
2820
|
/**
|
|
2819
2821
|
* @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.
|
|
2820
2822
|
*
|
|
@@ -2824,7 +2826,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2824
2826
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2825
2827
|
* @secure
|
|
2826
2828
|
*/
|
|
2827
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2829
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputJtey9Gkj4N, params?: RequestParams) => Promise<any>;
|
|
2828
2830
|
/**
|
|
2829
2831
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2830
2832
|
*
|
|
@@ -2834,7 +2836,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2834
2836
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2835
2837
|
* @secure
|
|
2836
2838
|
*/
|
|
2837
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2839
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputKk888In56, params?: RequestParams) => Promise<any>;
|
|
2838
2840
|
/**
|
|
2839
2841
|
* @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.
|
|
2840
2842
|
*
|
|
@@ -2874,7 +2876,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2874
2876
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2875
2877
|
* @secure
|
|
2876
2878
|
*/
|
|
2877
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2879
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputF4Qkw71Af5, params?: RequestParams) => Promise<any>;
|
|
2878
2880
|
/**
|
|
2879
2881
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
2880
2882
|
*
|
|
@@ -2884,7 +2886,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2884
2886
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2885
2887
|
* @secure
|
|
2886
2888
|
*/
|
|
2887
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2889
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<Output16J18Ccnj2>;
|
|
2888
2890
|
/**
|
|
2889
2891
|
* @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.
|
|
2890
2892
|
*
|
|
@@ -2924,7 +2926,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2924
2926
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2925
2927
|
* @secure
|
|
2926
2928
|
*/
|
|
2927
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
2929
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputBs15Figong, params?: RequestParams) => Promise<any>;
|
|
2928
2930
|
/**
|
|
2929
2931
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
2930
2932
|
*
|
|
@@ -2945,6 +2947,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2945
2947
|
* @secure
|
|
2946
2948
|
*/
|
|
2947
2949
|
createCertificationCourseRetake: (userId: string, certProcId: string, courseId: string, params?: RequestParams) => Promise<any>;
|
|
2950
|
+
/**
|
|
2951
|
+
* @description Batch-revokes all eligible courses on a certification process
|
|
2952
|
+
*
|
|
2953
|
+
* @tags Course
|
|
2954
|
+
* @name CreateCertificationCourseRevokeAll
|
|
2955
|
+
* @summary Revoke all eligible courses
|
|
2956
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/revokeAll
|
|
2957
|
+
* @secure
|
|
2958
|
+
*/
|
|
2959
|
+
createCertificationCourseRevokeAll: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
|
|
2948
2960
|
/**
|
|
2949
2961
|
* @description This route allows you to revoke a course for a certification process for a user in a specific course.
|
|
2950
2962
|
*
|
|
@@ -2974,7 +2986,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2974
2986
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
2975
2987
|
* @secure
|
|
2976
2988
|
*/
|
|
2977
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
2989
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: Input4X96Bzl8Ls, params?: RequestParams) => Promise<any>;
|
|
2978
2990
|
/**
|
|
2979
2991
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
2980
2992
|
*
|
|
@@ -2994,7 +3006,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2994
3006
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
2995
3007
|
* @secure
|
|
2996
3008
|
*/
|
|
2997
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3009
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputVp1Fgim6Yo, params?: RequestParams) => Promise<any>;
|
|
2998
3010
|
/**
|
|
2999
3011
|
* @description This route allows you to submit a pending approval.
|
|
3000
3012
|
*
|
|
@@ -3004,7 +3016,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3004
3016
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3005
3017
|
* @secure
|
|
3006
3018
|
*/
|
|
3007
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3019
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputC7Xaos72Zo, params?: RequestParams) => Promise<any>;
|
|
3008
3020
|
/**
|
|
3009
3021
|
* @description This route allows you to review a pending approval.
|
|
3010
3022
|
*
|
|
@@ -3014,7 +3026,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3014
3026
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3015
3027
|
* @secure
|
|
3016
3028
|
*/
|
|
3017
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3029
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputAioiui29Q9, params?: RequestParams) => Promise<any>;
|
|
3018
3030
|
/**
|
|
3019
3031
|
* @description Redeems a license for a user by product ID.
|
|
3020
3032
|
*
|
|
@@ -3024,7 +3036,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3024
3036
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3025
3037
|
* @secure
|
|
3026
3038
|
*/
|
|
3027
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3039
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputS2K8Zhf0Z1, params?: RequestParams) => Promise<any>;
|
|
3028
3040
|
/**
|
|
3029
3041
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3030
3042
|
*
|
|
@@ -3034,7 +3046,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3034
3046
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3035
3047
|
* @secure
|
|
3036
3048
|
*/
|
|
3037
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3049
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputOqmbw6Fqjz>;
|
|
3038
3050
|
/**
|
|
3039
3051
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3040
3052
|
*
|
|
@@ -3044,7 +3056,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3044
3056
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3045
3057
|
* @secure
|
|
3046
3058
|
*/
|
|
3047
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3059
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputWx6Vxgv83B, params?: RequestParams) => Promise<any>;
|
|
3048
3060
|
/**
|
|
3049
3061
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3050
3062
|
*
|
|
@@ -3054,7 +3066,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3054
3066
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3055
3067
|
* @secure
|
|
3056
3068
|
*/
|
|
3057
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3069
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input6D6Jgcta59, params?: RequestParams) => Promise<any>;
|
|
3058
3070
|
/**
|
|
3059
3071
|
* @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.
|
|
3060
3072
|
*
|
|
@@ -3064,7 +3076,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3064
3076
|
* @request POST:/user/{userID}/updateITA
|
|
3065
3077
|
* @secure
|
|
3066
3078
|
*/
|
|
3067
|
-
createUpdateIta: (userId: string, data:
|
|
3079
|
+
createUpdateIta: (userId: string, data: InputJpfssm5Oik, params?: RequestParams) => Promise<any>;
|
|
3068
3080
|
/**
|
|
3069
3081
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3070
3082
|
*
|
|
@@ -3074,7 +3086,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3074
3086
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3075
3087
|
* @secure
|
|
3076
3088
|
*/
|
|
3077
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3089
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: Input4Dsobi1Hzx, params?: RequestParams) => Promise<any>;
|
|
3078
3090
|
/**
|
|
3079
3091
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3080
3092
|
*
|
|
@@ -3084,7 +3096,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3084
3096
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3085
3097
|
* @secure
|
|
3086
3098
|
*/
|
|
3087
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3099
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: Input0Yk8Sac5Su, params?: RequestParams) => Promise<any>;
|
|
3088
3100
|
/**
|
|
3089
3101
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3090
3102
|
*
|
|
@@ -3116,7 +3128,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3116
3128
|
* @request POST:/users/certification/{certSpecID}
|
|
3117
3129
|
* @secure
|
|
3118
3130
|
*/
|
|
3119
|
-
createCertification: (certSpecId: string, data:
|
|
3131
|
+
createCertification: (certSpecId: string, data: InputEvsnfd14P3, params?: RequestParams) => Promise<OutputEvsnfd14P3>;
|
|
3120
3132
|
/**
|
|
3121
3133
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3122
3134
|
*
|