@ikonintegration/bccsa-program-api 3.0.22 → 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 +142 -93
- package/dist/Api.d.ts +126 -102
- package/dist/Api.js +38 -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 InputXbxna7Vwxqf {
|
|
|
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 InputSvegezyxe7K {
|
|
|
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 InputNiz3R426O9 {
|
|
|
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 InputZgur4Qd9K2 {
|
|
|
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 InputV7Itlz0Fet {
|
|
|
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 InputLoahmjjq17 {
|
|
|
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 Input3Ndh3Ay011 {
|
|
|
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 InputGy0Wsngoyd {
|
|
|
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 InputLgyo2Cwx2P {
|
|
|
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 InputAnf84C7Mm1 {
|
|
|
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 Input31496Ii02B {
|
|
|
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 InputHs98Atyc9F {
|
|
|
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 InputC2C6Ye4O73F {
|
|
|
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 Input3V2Qv5M3Td {
|
|
|
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 OutputGxbxzc82Lc {
|
|
|
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 InputFn59Rhsl73 {
|
|
|
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 InputC27Jkf6Oev {
|
|
|
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 InputChnzxwim4 {
|
|
|
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 OutputChnzxwim4 {
|
|
|
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 InputQrdb4Hyap7 {
|
|
|
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 InputVkgzthahbw {
|
|
|
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 OutputZynw683Mlij {
|
|
|
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 InputA59Zw5Efhm {
|
|
|
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 InputHisqek20O6J {
|
|
|
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 InputXdobl2Kymz {
|
|
|
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 InputS2Gzi3P07Kk {
|
|
|
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 InputNfn330Yien {
|
|
|
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,10 +2080,12 @@ 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;
|
|
2087
|
+
export type CreateCertificationCourseSessionMoveStudentData = any;
|
|
2088
|
+
export type CreateCertificationCourseSessionMoveStudentError = ErrorResponse;
|
|
2087
2089
|
export type CreateCertificationTriggerCheckData = any;
|
|
2088
2090
|
export type CreateCertificationTriggerCheckError = ErrorResponse;
|
|
2089
2091
|
export type CreateCertificationTriggerSetData = any;
|
|
@@ -2092,6 +2094,8 @@ export type CreateRefreshOrgMembershipData = any;
|
|
|
2092
2094
|
export type CreateRefreshOrgMembershipError = ErrorResponse;
|
|
2093
2095
|
export type CreateCertificationCourseRetakeData = any;
|
|
2094
2096
|
export type CreateCertificationCourseRetakeError = ErrorResponse;
|
|
2097
|
+
export type CreateCertificationCourseRevokeAllData = any;
|
|
2098
|
+
export type CreateCertificationCourseRevokeAllError = ErrorResponse;
|
|
2095
2099
|
export type CreateCertificationCourseRevokeData = any;
|
|
2096
2100
|
export type CreateCertificationCourseRevokeError = ErrorResponse;
|
|
2097
2101
|
export type CreateCertificationApplicationItemRemoveData = any;
|
|
@@ -2108,7 +2112,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2108
2112
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2109
2113
|
export type CreateCertificationCourseRedeemData = any;
|
|
2110
2114
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2111
|
-
export type CreateCertificationMoveValidateData =
|
|
2115
|
+
export type CreateCertificationMoveValidateData = OutputOqmbw6Fqjz;
|
|
2112
2116
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2113
2117
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2114
2118
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2124,7 +2128,7 @@ export type CreateCertificationPublishInfoData = any;
|
|
|
2124
2128
|
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2125
2129
|
export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
2126
2130
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2127
|
-
export type CreateCertificationResult =
|
|
2131
|
+
export type CreateCertificationResult = OutputEvsnfd14P3;
|
|
2128
2132
|
export type CreateCertificationFail = ErrorResponse;
|
|
2129
2133
|
export type CreateCertificationPublishInfoResult = any;
|
|
2130
2134
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2171,7 +2175,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2171
2175
|
}
|
|
2172
2176
|
/**
|
|
2173
2177
|
* @title BCCSA Program API
|
|
2174
|
-
* @version 3.0.
|
|
2178
|
+
* @version 3.0.24
|
|
2175
2179
|
* @baseUrl http://localhost:8080
|
|
2176
2180
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2177
2181
|
*/
|
|
@@ -2186,7 +2190,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2186
2190
|
* @request POST:/contactUs
|
|
2187
2191
|
* @secure
|
|
2188
2192
|
*/
|
|
2189
|
-
listContactUs: (data:
|
|
2193
|
+
listContactUs: (data: InputCad8Ejyr4Y, params?: RequestParams) => Promise<any>;
|
|
2190
2194
|
};
|
|
2191
2195
|
customer: {
|
|
2192
2196
|
/**
|
|
@@ -2290,7 +2294,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2290
2294
|
* @request POST:/tenant/report/applicationExport
|
|
2291
2295
|
* @secure
|
|
2292
2296
|
*/
|
|
2293
|
-
createReportApplicationExport: (data:
|
|
2297
|
+
createReportApplicationExport: (data: InputRygxm02Mdf, params?: RequestParams) => Promise<any>;
|
|
2294
2298
|
/**
|
|
2295
2299
|
* @description Export a report of applications based on the provided filters.
|
|
2296
2300
|
*
|
|
@@ -2300,7 +2304,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2300
2304
|
* @request POST:/tenant/report/applicationStatus
|
|
2301
2305
|
* @secure
|
|
2302
2306
|
*/
|
|
2303
|
-
listReportApplicationStatus: (data:
|
|
2307
|
+
listReportApplicationStatus: (data: InputMfhgwhflhq, params?: RequestParams) => Promise<any>;
|
|
2304
2308
|
/**
|
|
2305
2309
|
* @description Export a report of applications based on the provided filters.
|
|
2306
2310
|
*
|
|
@@ -2310,7 +2314,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2310
2314
|
* @request POST:/tenant/report/applicationsReport
|
|
2311
2315
|
* @secure
|
|
2312
2316
|
*/
|
|
2313
|
-
createReportApplicationsReport: (data:
|
|
2317
|
+
createReportApplicationsReport: (data: InputO1Utmw3Ddv, params?: RequestParams) => Promise<any>;
|
|
2314
2318
|
/**
|
|
2315
2319
|
* @description This route allows you to post certificates email for the tenant.
|
|
2316
2320
|
*
|
|
@@ -2320,7 +2324,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2320
2324
|
* @request POST:/tenant/certificates/email
|
|
2321
2325
|
* @secure
|
|
2322
2326
|
*/
|
|
2323
|
-
createCertificatesEmail: (data:
|
|
2327
|
+
createCertificatesEmail: (data: InputOx8B0Fn9M2L, params?: RequestParams) => Promise<any>;
|
|
2324
2328
|
/**
|
|
2325
2329
|
* @description Generate a preview of the completed certifications report.
|
|
2326
2330
|
*
|
|
@@ -2350,7 +2354,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2350
2354
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2351
2355
|
* @secure
|
|
2352
2356
|
*/
|
|
2353
|
-
createLicenseRedeem: (userId: string, data:
|
|
2357
|
+
createLicenseRedeem: (userId: string, data: InputEqnnf7Kjev, params?: RequestParams) => Promise<any>;
|
|
2354
2358
|
/**
|
|
2355
2359
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2356
2360
|
*
|
|
@@ -2360,7 +2364,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2360
2364
|
* @request POST:/tenant/report/orglicenses/
|
|
2361
2365
|
* @secure
|
|
2362
2366
|
*/
|
|
2363
|
-
listReportOrglicenses: (data:
|
|
2367
|
+
listReportOrglicenses: (data: InputVkbamnqi6Ih, params?: RequestParams) => Promise<any>;
|
|
2364
2368
|
/**
|
|
2365
2369
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2366
2370
|
*
|
|
@@ -2370,7 +2374,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2370
2374
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2371
2375
|
* @secure
|
|
2372
2376
|
*/
|
|
2373
|
-
createReportOrglicensesPreview: (data:
|
|
2377
|
+
createReportOrglicensesPreview: (data: Input89V7C8Afh7, params?: RequestParams) => Promise<any>;
|
|
2374
2378
|
/**
|
|
2375
2379
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2376
2380
|
*
|
|
@@ -2400,7 +2404,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2400
2404
|
* @request POST:/tenant/report/users/advanced
|
|
2401
2405
|
* @secure
|
|
2402
2406
|
*/
|
|
2403
|
-
createReportUsersAdvanced: (data:
|
|
2407
|
+
createReportUsersAdvanced: (data: InputXt5Pmzvupx, params?: RequestParams) => Promise<any>;
|
|
2404
2408
|
/**
|
|
2405
2409
|
* @description Searches for users in the tenant by their IDs.
|
|
2406
2410
|
*
|
|
@@ -2410,7 +2414,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2410
2414
|
* @request POST:/tenant/search/users/ids
|
|
2411
2415
|
* @secure
|
|
2412
2416
|
*/
|
|
2413
|
-
listSearchUsersIds: (data:
|
|
2417
|
+
listSearchUsersIds: (data: InputGvktmmbhkh, params?: RequestParams) => Promise<any>;
|
|
2414
2418
|
/**
|
|
2415
2419
|
* @description Searches for users in the tenant by term and filters.
|
|
2416
2420
|
*
|
|
@@ -2420,7 +2424,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2420
2424
|
* @request POST:/tenant/search/users/term
|
|
2421
2425
|
* @secure
|
|
2422
2426
|
*/
|
|
2423
|
-
createSearchUsersTerm: (data:
|
|
2427
|
+
createSearchUsersTerm: (data: InputY60712Ei2U, params?: RequestParams) => Promise<any>;
|
|
2424
2428
|
/**
|
|
2425
2429
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2426
2430
|
*
|
|
@@ -2430,7 +2434,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2430
2434
|
* @request POST:/tenant/report/users/simple
|
|
2431
2435
|
* @secure
|
|
2432
2436
|
*/
|
|
2433
|
-
createReportUsersSimple: (data:
|
|
2437
|
+
createReportUsersSimple: (data: InputUthvuhm96N, params?: RequestParams) => Promise<any>;
|
|
2434
2438
|
/**
|
|
2435
2439
|
* @description Retrieve user by ID.
|
|
2436
2440
|
*
|
|
@@ -2440,7 +2444,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2440
2444
|
* @request POST:/tenant/search/users/count
|
|
2441
2445
|
* @secure
|
|
2442
2446
|
*/
|
|
2443
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2447
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputRjxgiilfs>;
|
|
2444
2448
|
};
|
|
2445
2449
|
user: {
|
|
2446
2450
|
/**
|
|
@@ -2472,7 +2476,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2472
2476
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2473
2477
|
* @secure
|
|
2474
2478
|
*/
|
|
2475
|
-
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>;
|
|
2476
2480
|
/**
|
|
2477
2481
|
* @description Delete a certification process application by type.
|
|
2478
2482
|
*
|
|
@@ -2562,7 +2566,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2562
2566
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2563
2567
|
* @secure
|
|
2564
2568
|
*/
|
|
2565
|
-
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>;
|
|
2566
2570
|
/**
|
|
2567
2571
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2568
2572
|
*
|
|
@@ -2572,7 +2576,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2572
2576
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2573
2577
|
* @secure
|
|
2574
2578
|
*/
|
|
2575
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2579
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<Output8X4Eotpmfa>;
|
|
2576
2580
|
/**
|
|
2577
2581
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2578
2582
|
*
|
|
@@ -2592,7 +2596,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2592
2596
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2593
2597
|
* @secure
|
|
2594
2598
|
*/
|
|
2595
|
-
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>;
|
|
2596
2600
|
/**
|
|
2597
2601
|
* @description Delete user by ID.
|
|
2598
2602
|
*
|
|
@@ -2622,7 +2626,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2622
2626
|
* @request POST:/user/{userID}
|
|
2623
2627
|
* @secure
|
|
2624
2628
|
*/
|
|
2625
|
-
createUser: (userId: string, data:
|
|
2629
|
+
createUser: (userId: string, data: InputBii9Su5Lr6, params?: RequestParams) => Promise<any>;
|
|
2626
2630
|
/**
|
|
2627
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.
|
|
2628
2632
|
*
|
|
@@ -2632,7 +2636,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2632
2636
|
* @request PUT:/user/{userID}
|
|
2633
2637
|
* @secure
|
|
2634
2638
|
*/
|
|
2635
|
-
updateUser: (userId: string, data:
|
|
2639
|
+
updateUser: (userId: string, data: InputRdlskcnfpv, params?: RequestParams) => Promise<any>;
|
|
2636
2640
|
/**
|
|
2637
2641
|
* @description Delete course from user
|
|
2638
2642
|
*
|
|
@@ -2652,7 +2656,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2652
2656
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2653
2657
|
* @secure
|
|
2654
2658
|
*/
|
|
2655
|
-
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>;
|
|
2656
2660
|
/**
|
|
2657
2661
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2658
2662
|
*
|
|
@@ -2662,7 +2666,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2662
2666
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2663
2667
|
* @secure
|
|
2664
2668
|
*/
|
|
2665
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2669
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<Output2Fueyis9Mf>;
|
|
2666
2670
|
/**
|
|
2667
2671
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2668
2672
|
*
|
|
@@ -2672,7 +2676,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2672
2676
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2673
2677
|
* @secure
|
|
2674
2678
|
*/
|
|
2675
|
-
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>;
|
|
2676
2680
|
/**
|
|
2677
2681
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2678
2682
|
*
|
|
@@ -2712,7 +2716,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2712
2716
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2713
2717
|
* @secure
|
|
2714
2718
|
*/
|
|
2715
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2719
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputK4Rwz2Mqow>;
|
|
2716
2720
|
/**
|
|
2717
2721
|
* @description This endpoint will print certificate
|
|
2718
2722
|
*
|
|
@@ -2772,7 +2776,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2772
2776
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2773
2777
|
* @secure
|
|
2774
2778
|
*/
|
|
2775
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2779
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputJze29Qql3J, params?: RequestParams) => Promise<any>;
|
|
2776
2780
|
/**
|
|
2777
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.
|
|
2778
2782
|
*
|
|
@@ -2802,7 +2806,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2802
2806
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2803
2807
|
* @secure
|
|
2804
2808
|
*/
|
|
2805
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2809
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputQbz0M4Dqc3, params?: RequestParams) => Promise<any>;
|
|
2806
2810
|
/**
|
|
2807
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.
|
|
2808
2812
|
*
|
|
@@ -2812,7 +2816,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2812
2816
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2813
2817
|
* @secure
|
|
2814
2818
|
*/
|
|
2815
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2819
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: Input044Oyybc0M, params?: RequestParams) => Promise<any>;
|
|
2816
2820
|
/**
|
|
2817
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.
|
|
2818
2822
|
*
|
|
@@ -2822,7 +2826,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2822
2826
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2823
2827
|
* @secure
|
|
2824
2828
|
*/
|
|
2825
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2829
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputJtey9Gkj4N, params?: RequestParams) => Promise<any>;
|
|
2826
2830
|
/**
|
|
2827
2831
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2828
2832
|
*
|
|
@@ -2832,7 +2836,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2832
2836
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2833
2837
|
* @secure
|
|
2834
2838
|
*/
|
|
2835
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2839
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputKk888In56, params?: RequestParams) => Promise<any>;
|
|
2836
2840
|
/**
|
|
2837
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.
|
|
2838
2842
|
*
|
|
@@ -2872,7 +2876,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2872
2876
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2873
2877
|
* @secure
|
|
2874
2878
|
*/
|
|
2875
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2879
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputF4Qkw71Af5, params?: RequestParams) => Promise<any>;
|
|
2876
2880
|
/**
|
|
2877
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.
|
|
2878
2882
|
*
|
|
@@ -2882,7 +2886,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2882
2886
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2883
2887
|
* @secure
|
|
2884
2888
|
*/
|
|
2885
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2889
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<Output16J18Ccnj2>;
|
|
2886
2890
|
/**
|
|
2887
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.
|
|
2888
2892
|
*
|
|
@@ -2893,6 +2897,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2893
2897
|
* @secure
|
|
2894
2898
|
*/
|
|
2895
2899
|
createCertificationCourseSessionReplace: (userId: string, certProcId: string, courseId: string, sessionId: string, secUserId: string, params?: RequestParams) => Promise<any>;
|
|
2900
|
+
/**
|
|
2901
|
+
* @description This endpoint allows you to move a student from one course session to another within the same certification process. It requires the user ID, certification process ID, course ID, current session ID, and new session ID as path parameters.
|
|
2902
|
+
*
|
|
2903
|
+
* @tags Certification
|
|
2904
|
+
* @name CreateCertificationCourseSessionMoveStudent
|
|
2905
|
+
* @summary Reschedule Session Enrolment
|
|
2906
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/moveStudent/{newSessionID}
|
|
2907
|
+
* @secure
|
|
2908
|
+
*/
|
|
2909
|
+
createCertificationCourseSessionMoveStudent: (userId: string, certProcId: string, courseId: string, sessionId: string, newSessionId: string, params?: RequestParams) => Promise<any>;
|
|
2896
2910
|
/**
|
|
2897
2911
|
* @description This route allows you to set a trigger check for a certification process, such as blocking courses.
|
|
2898
2912
|
*
|
|
@@ -2912,7 +2926,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2912
2926
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2913
2927
|
* @secure
|
|
2914
2928
|
*/
|
|
2915
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
2929
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputBs15Figong, params?: RequestParams) => Promise<any>;
|
|
2916
2930
|
/**
|
|
2917
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.
|
|
2918
2932
|
*
|
|
@@ -2933,6 +2947,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2933
2947
|
* @secure
|
|
2934
2948
|
*/
|
|
2935
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>;
|
|
2936
2960
|
/**
|
|
2937
2961
|
* @description This route allows you to revoke a course for a certification process for a user in a specific course.
|
|
2938
2962
|
*
|
|
@@ -2962,7 +2986,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2962
2986
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
2963
2987
|
* @secure
|
|
2964
2988
|
*/
|
|
2965
|
-
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>;
|
|
2966
2990
|
/**
|
|
2967
2991
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
2968
2992
|
*
|
|
@@ -2982,7 +3006,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2982
3006
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
2983
3007
|
* @secure
|
|
2984
3008
|
*/
|
|
2985
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3009
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputVp1Fgim6Yo, params?: RequestParams) => Promise<any>;
|
|
2986
3010
|
/**
|
|
2987
3011
|
* @description This route allows you to submit a pending approval.
|
|
2988
3012
|
*
|
|
@@ -2992,7 +3016,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2992
3016
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
2993
3017
|
* @secure
|
|
2994
3018
|
*/
|
|
2995
|
-
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>;
|
|
2996
3020
|
/**
|
|
2997
3021
|
* @description This route allows you to review a pending approval.
|
|
2998
3022
|
*
|
|
@@ -3002,7 +3026,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3002
3026
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3003
3027
|
* @secure
|
|
3004
3028
|
*/
|
|
3005
|
-
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>;
|
|
3006
3030
|
/**
|
|
3007
3031
|
* @description Redeems a license for a user by product ID.
|
|
3008
3032
|
*
|
|
@@ -3012,7 +3036,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3012
3036
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3013
3037
|
* @secure
|
|
3014
3038
|
*/
|
|
3015
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3039
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputS2K8Zhf0Z1, params?: RequestParams) => Promise<any>;
|
|
3016
3040
|
/**
|
|
3017
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.
|
|
3018
3042
|
*
|
|
@@ -3022,7 +3046,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3022
3046
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3023
3047
|
* @secure
|
|
3024
3048
|
*/
|
|
3025
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3049
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputOqmbw6Fqjz>;
|
|
3026
3050
|
/**
|
|
3027
3051
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3028
3052
|
*
|
|
@@ -3032,7 +3056,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3032
3056
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3033
3057
|
* @secure
|
|
3034
3058
|
*/
|
|
3035
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3059
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputWx6Vxgv83B, params?: RequestParams) => Promise<any>;
|
|
3036
3060
|
/**
|
|
3037
3061
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3038
3062
|
*
|
|
@@ -3042,7 +3066,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3042
3066
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3043
3067
|
* @secure
|
|
3044
3068
|
*/
|
|
3045
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3069
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input6D6Jgcta59, params?: RequestParams) => Promise<any>;
|
|
3046
3070
|
/**
|
|
3047
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.
|
|
3048
3072
|
*
|
|
@@ -3052,7 +3076,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3052
3076
|
* @request POST:/user/{userID}/updateITA
|
|
3053
3077
|
* @secure
|
|
3054
3078
|
*/
|
|
3055
|
-
createUpdateIta: (userId: string, data:
|
|
3079
|
+
createUpdateIta: (userId: string, data: InputJpfssm5Oik, params?: RequestParams) => Promise<any>;
|
|
3056
3080
|
/**
|
|
3057
3081
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3058
3082
|
*
|
|
@@ -3062,7 +3086,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3062
3086
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3063
3087
|
* @secure
|
|
3064
3088
|
*/
|
|
3065
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3089
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: Input4Dsobi1Hzx, params?: RequestParams) => Promise<any>;
|
|
3066
3090
|
/**
|
|
3067
3091
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3068
3092
|
*
|
|
@@ -3072,7 +3096,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3072
3096
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3073
3097
|
* @secure
|
|
3074
3098
|
*/
|
|
3075
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3099
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: Input0Yk8Sac5Su, params?: RequestParams) => Promise<any>;
|
|
3076
3100
|
/**
|
|
3077
3101
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3078
3102
|
*
|
|
@@ -3104,7 +3128,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3104
3128
|
* @request POST:/users/certification/{certSpecID}
|
|
3105
3129
|
* @secure
|
|
3106
3130
|
*/
|
|
3107
|
-
createCertification: (certSpecId: string, data:
|
|
3131
|
+
createCertification: (certSpecId: string, data: InputEvsnfd14P3, params?: RequestParams) => Promise<OutputEvsnfd14P3>;
|
|
3108
3132
|
/**
|
|
3109
3133
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3110
3134
|
*
|