@ikonintegration/bccsa-program-api 3.0.14 → 3.0.16
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 +159 -143
- package/dist/Api.d.ts +140 -128
- package/dist/Api.js +47 -34
- package/dist/Api.js.map +1 -1
- package/package.json +2 -2
package/dist/Api.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ export interface ErrorResponse {
|
|
|
5
5
|
/** Error code */
|
|
6
6
|
errCode: string;
|
|
7
7
|
}
|
|
8
|
-
export interface
|
|
8
|
+
export interface InputUd1Py882Ha {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -449,7 +449,7 @@ export interface PendingApprovalResponseSchema {
|
|
|
449
449
|
}[];
|
|
450
450
|
}[] | null;
|
|
451
451
|
}
|
|
452
|
-
export interface
|
|
452
|
+
export interface InputD3Dhjn9Ys4 {
|
|
453
453
|
/**
|
|
454
454
|
* ID of the certification to filter applications by
|
|
455
455
|
* @example "certification123"
|
|
@@ -506,7 +506,7 @@ export interface InputC66Qlphg8W {
|
|
|
506
506
|
*/
|
|
507
507
|
ignoreCompletedCertifications?: boolean | null;
|
|
508
508
|
}
|
|
509
|
-
export interface
|
|
509
|
+
export interface InputTyyuqx8L2O {
|
|
510
510
|
/**
|
|
511
511
|
* ID of the certification to filter applications by
|
|
512
512
|
* @example "certification123"
|
|
@@ -563,7 +563,7 @@ export interface InputLtawqytdn2K {
|
|
|
563
563
|
*/
|
|
564
564
|
ignoreCompletedCertifications?: boolean | null;
|
|
565
565
|
}
|
|
566
|
-
export interface
|
|
566
|
+
export interface InputJycvujxvg4H {
|
|
567
567
|
/**
|
|
568
568
|
* ID of the certification to filter applications by
|
|
569
569
|
* @example "certification123"
|
|
@@ -620,7 +620,7 @@ export interface InputEzw3I74O88 {
|
|
|
620
620
|
*/
|
|
621
621
|
ignoreCompletedCertifications?: boolean | null;
|
|
622
622
|
}
|
|
623
|
-
export interface
|
|
623
|
+
export interface InputOd8Hvevtkh {
|
|
624
624
|
/**
|
|
625
625
|
* The ID of the certificate specifications to be used for the email
|
|
626
626
|
* @example "certSpecsID123"
|
|
@@ -661,7 +661,7 @@ export interface InputReechizngg {
|
|
|
661
661
|
emailAddress: string;
|
|
662
662
|
}[];
|
|
663
663
|
}
|
|
664
|
-
export interface
|
|
664
|
+
export interface Input8Oiix3Elgyj {
|
|
665
665
|
/**
|
|
666
666
|
* The ID of the product for which the license is being redeemed
|
|
667
667
|
* @example "productID123"
|
|
@@ -673,7 +673,7 @@ export interface InputXvb1Cckkphj {
|
|
|
673
673
|
*/
|
|
674
674
|
sessionID?: string;
|
|
675
675
|
}
|
|
676
|
-
export interface
|
|
676
|
+
export interface InputFpgop3Isd5 {
|
|
677
677
|
/**
|
|
678
678
|
* Search term to filter licenses
|
|
679
679
|
* @example "active"
|
|
@@ -690,7 +690,7 @@ export interface Input9Zuhh59Om6 {
|
|
|
690
690
|
*/
|
|
691
691
|
sortField?: any;
|
|
692
692
|
}
|
|
693
|
-
export interface
|
|
693
|
+
export interface InputIdt7Y9Ryz7L {
|
|
694
694
|
/**
|
|
695
695
|
* Search term to filter licenses
|
|
696
696
|
* @example "active"
|
|
@@ -745,7 +745,7 @@ export interface ReportXLSXSchema {
|
|
|
745
745
|
xlsxStream: any;
|
|
746
746
|
contentType: ReportXlsxSchemaContentTypeEnum;
|
|
747
747
|
}
|
|
748
|
-
export interface
|
|
748
|
+
export interface InputOazpxrxma7 {
|
|
749
749
|
/**
|
|
750
750
|
* Start date for the report
|
|
751
751
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -767,11 +767,11 @@ export interface InputRme2Lfmssbf {
|
|
|
767
767
|
*/
|
|
768
768
|
dateType?: string;
|
|
769
769
|
}
|
|
770
|
-
export interface
|
|
770
|
+
export interface InputVwx4A531Dx {
|
|
771
771
|
/** List of user IDs to search for in the tenant. */
|
|
772
772
|
IDs: (string | null)[];
|
|
773
773
|
}
|
|
774
|
-
export interface
|
|
774
|
+
export interface InputRyccpgocqi {
|
|
775
775
|
/** The term to search for in the user profiles. */
|
|
776
776
|
searchTerm?: string | null;
|
|
777
777
|
/** Filter criteria for the user search. */
|
|
@@ -811,7 +811,7 @@ export interface Input3Cb5S44063 {
|
|
|
811
811
|
};
|
|
812
812
|
};
|
|
813
813
|
}
|
|
814
|
-
export interface
|
|
814
|
+
export interface InputVvhra13Jmh {
|
|
815
815
|
/** The term to search for in the user profiles. */
|
|
816
816
|
searchTerm?: string | null;
|
|
817
817
|
/** Filter criteria for the user search. */
|
|
@@ -853,19 +853,19 @@ export interface InputPo9H04Ocjy {
|
|
|
853
853
|
}
|
|
854
854
|
/** External system ID 2 */
|
|
855
855
|
export type ExternalID2 = number;
|
|
856
|
-
export interface
|
|
856
|
+
export interface Output3Ic5X329Tg {
|
|
857
857
|
/** External system ID 2 */
|
|
858
858
|
userCount: ExternalID2;
|
|
859
859
|
transactionID?: string | null;
|
|
860
860
|
}
|
|
861
|
-
export interface
|
|
861
|
+
export interface OutputBwweo9Hk3I {
|
|
862
862
|
/**
|
|
863
863
|
* Signed URL for the course file
|
|
864
864
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
865
865
|
*/
|
|
866
866
|
fileURL: string;
|
|
867
867
|
}
|
|
868
|
-
export interface
|
|
868
|
+
export interface Output50Cxzsa2Jw {
|
|
869
869
|
/**
|
|
870
870
|
* Amount to be refunded for the cancellation
|
|
871
871
|
* @example 0
|
|
@@ -1156,7 +1156,7 @@ export interface CourseResponseEntity {
|
|
|
1156
1156
|
/** Justifications for overridden course restrictions */
|
|
1157
1157
|
overwrittenJustification?: OverwrittenJustification;
|
|
1158
1158
|
}
|
|
1159
|
-
export interface
|
|
1159
|
+
export interface OutputP2Duut4Rdr {
|
|
1160
1160
|
/**
|
|
1161
1161
|
* Signed URL for the course file
|
|
1162
1162
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
@@ -1174,14 +1174,14 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1174
1174
|
transactionID?: string | null;
|
|
1175
1175
|
}
|
|
1176
1176
|
/** Application Foreign Fill response type */
|
|
1177
|
-
export interface
|
|
1177
|
+
export interface Output5Ma5Cfwu78K {
|
|
1178
1178
|
items: {
|
|
1179
1179
|
userID: string;
|
|
1180
1180
|
createdOn?: number;
|
|
1181
1181
|
createdBy?: string;
|
|
1182
1182
|
updatedBy?: string;
|
|
1183
1183
|
updatedOn?: number;
|
|
1184
|
-
dbEntity
|
|
1184
|
+
dbEntity?: string;
|
|
1185
1185
|
tenantID: string;
|
|
1186
1186
|
compositeID: string;
|
|
1187
1187
|
timestamp: number;
|
|
@@ -1229,7 +1229,7 @@ export interface StudentHistoryResponseSchema {
|
|
|
1229
1229
|
/** Timestamp of the last update */
|
|
1230
1230
|
updateOn?: UpdateOn;
|
|
1231
1231
|
/** Fixed database entity identifier */
|
|
1232
|
-
dbEntity
|
|
1232
|
+
dbEntity?: DbEntity;
|
|
1233
1233
|
/** Composite ID (could be a derived or synthetic key) */
|
|
1234
1234
|
compositeID: CompositeID;
|
|
1235
1235
|
/** ID of the user associated with this history entry */
|
|
@@ -1397,7 +1397,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1397
1397
|
applicationItems?: Record<string, any>[];
|
|
1398
1398
|
transactionID?: string | null;
|
|
1399
1399
|
}
|
|
1400
|
-
export interface
|
|
1400
|
+
export interface InputJ86Ad2Cw25 {
|
|
1401
1401
|
issuedOn?: number;
|
|
1402
1402
|
expiresOn?: number;
|
|
1403
1403
|
fileItems?: {
|
|
@@ -1406,21 +1406,21 @@ export interface InputG8Kndhfwiy {
|
|
|
1406
1406
|
}[];
|
|
1407
1407
|
additionalNotes?: string | null;
|
|
1408
1408
|
}
|
|
1409
|
-
export interface
|
|
1409
|
+
export interface InputKnvh2Z7Rse {
|
|
1410
1410
|
/**
|
|
1411
1411
|
* Indicates whether the application is locked
|
|
1412
1412
|
* @example true
|
|
1413
1413
|
*/
|
|
1414
1414
|
isApplicationLocked: boolean;
|
|
1415
1415
|
}
|
|
1416
|
-
export interface
|
|
1416
|
+
export interface OutputI4R7Bcx3T7G {
|
|
1417
1417
|
/**
|
|
1418
1418
|
* Signed URL for the course file
|
|
1419
1419
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
1420
1420
|
*/
|
|
1421
1421
|
fileURL: string;
|
|
1422
1422
|
}
|
|
1423
|
-
export interface
|
|
1423
|
+
export interface InputPn24Tkrz5N {
|
|
1424
1424
|
/**
|
|
1425
1425
|
* Indicates whether the waiver is approved
|
|
1426
1426
|
* @example true
|
|
@@ -1432,14 +1432,14 @@ export interface InputIh5Tnf0P5L {
|
|
|
1432
1432
|
*/
|
|
1433
1433
|
additionalNotes?: string | null;
|
|
1434
1434
|
}
|
|
1435
|
-
export interface
|
|
1435
|
+
export interface Input2Dvhr78Yv {
|
|
1436
1436
|
/**
|
|
1437
1437
|
* Optional notes regarding the waiver
|
|
1438
1438
|
* @example "Waiver granted due to special circumstances."
|
|
1439
1439
|
*/
|
|
1440
1440
|
additionalNotes?: string | null;
|
|
1441
1441
|
}
|
|
1442
|
-
export interface
|
|
1442
|
+
export interface Input766Ii876Sj {
|
|
1443
1443
|
students: {
|
|
1444
1444
|
/**
|
|
1445
1445
|
* User ID of the student to redeem the course for
|
|
@@ -1473,7 +1473,7 @@ export interface Input70Owq1Kboh {
|
|
|
1473
1473
|
*/
|
|
1474
1474
|
autoEnrolSessionID?: string;
|
|
1475
1475
|
}
|
|
1476
|
-
export interface
|
|
1476
|
+
export interface InputG1V252Slib {
|
|
1477
1477
|
invites: {
|
|
1478
1478
|
/**
|
|
1479
1479
|
* Email address of the user to invite
|
|
@@ -1502,7 +1502,7 @@ export interface InputTh8Wdj68Dji {
|
|
|
1502
1502
|
*/
|
|
1503
1503
|
isReservedSeat: boolean;
|
|
1504
1504
|
}
|
|
1505
|
-
export interface
|
|
1505
|
+
export interface InputQfsksefyis {
|
|
1506
1506
|
/**
|
|
1507
1507
|
* Indicates whether to waive the certification process
|
|
1508
1508
|
* @example true
|
|
@@ -1515,7 +1515,7 @@ export interface InputBgtk2Vwgatg {
|
|
|
1515
1515
|
comments?: string | null;
|
|
1516
1516
|
}
|
|
1517
1517
|
/** Certification move response schema */
|
|
1518
|
-
export interface
|
|
1518
|
+
export interface OutputYon3Esf9Sd {
|
|
1519
1519
|
errors?: {
|
|
1520
1520
|
status: string;
|
|
1521
1521
|
object?: Record<string, any>;
|
|
@@ -1523,19 +1523,19 @@ export interface OutputV8Ym6Dzytn {
|
|
|
1523
1523
|
}[];
|
|
1524
1524
|
}
|
|
1525
1525
|
/** Schema for writing a certification trigger check. */
|
|
1526
|
-
export interface
|
|
1526
|
+
export interface Input0Ckjw53Cpo {
|
|
1527
1527
|
/**
|
|
1528
1528
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1529
1529
|
* @example "CHECKED"
|
|
1530
1530
|
*/
|
|
1531
|
-
value:
|
|
1531
|
+
value: Input0Ckjw53CpoValueEnum;
|
|
1532
1532
|
/**
|
|
1533
1533
|
* List of course IDs that are blocked by this trigger check.
|
|
1534
1534
|
* @example ["course1","course2"]
|
|
1535
1535
|
*/
|
|
1536
1536
|
blockedCourses?: string[];
|
|
1537
1537
|
}
|
|
1538
|
-
export interface
|
|
1538
|
+
export interface Input2D3A4F27Ipf {
|
|
1539
1539
|
/**
|
|
1540
1540
|
* Indicates whether the application item is approved
|
|
1541
1541
|
* @example true
|
|
@@ -1561,7 +1561,7 @@ export interface Input2Mhqs0Fnt2 {
|
|
|
1561
1561
|
export interface StudentHistoryRequestSchema {
|
|
1562
1562
|
requirements: string[];
|
|
1563
1563
|
}
|
|
1564
|
-
export interface
|
|
1564
|
+
export interface InputRw404Uorif {
|
|
1565
1565
|
/**
|
|
1566
1566
|
* Optional activation key for the application
|
|
1567
1567
|
* @example "AK-123456"
|
|
@@ -1569,7 +1569,7 @@ export interface InputWwtwfps7Vg {
|
|
|
1569
1569
|
activationKey?: string;
|
|
1570
1570
|
}
|
|
1571
1571
|
/** Schema for course submission item details post request. */
|
|
1572
|
-
export interface
|
|
1572
|
+
export interface InputAt2Qquee7L {
|
|
1573
1573
|
/**
|
|
1574
1574
|
* The ID of the file being submitted.
|
|
1575
1575
|
* @example "fileID123"
|
|
@@ -1582,7 +1582,7 @@ export interface Input63Gpw9Ssci {
|
|
|
1582
1582
|
fileName: string;
|
|
1583
1583
|
}
|
|
1584
1584
|
/** Schema for the response to course submission item details post request. */
|
|
1585
|
-
export interface
|
|
1585
|
+
export interface OutputAt2Qquee7L {
|
|
1586
1586
|
submissionItems: {
|
|
1587
1587
|
/**
|
|
1588
1588
|
* The ID of the file being submitted.
|
|
@@ -1597,7 +1597,7 @@ export interface Output63Gpw9Ssci {
|
|
|
1597
1597
|
}[];
|
|
1598
1598
|
}
|
|
1599
1599
|
/** Pending approval submission parameters */
|
|
1600
|
-
export interface
|
|
1600
|
+
export interface InputWoyg2Gtn48L {
|
|
1601
1601
|
/**
|
|
1602
1602
|
* Type of pending approval
|
|
1603
1603
|
* @example "certification"
|
|
@@ -1617,7 +1617,7 @@ export interface InputJ8Vv2F6Cn5 {
|
|
|
1617
1617
|
fileName: string;
|
|
1618
1618
|
}[];
|
|
1619
1619
|
}
|
|
1620
|
-
export interface
|
|
1620
|
+
export interface InputHd03Cx4Ul6 {
|
|
1621
1621
|
/**
|
|
1622
1622
|
* The ID of the course for which the license is being redeemed
|
|
1623
1623
|
* @example "courseID123"
|
|
@@ -1685,7 +1685,7 @@ export interface InputFj18Imcto0K {
|
|
|
1685
1685
|
acknowledgement?: string | null;
|
|
1686
1686
|
}
|
|
1687
1687
|
/** Validate certification move response schema */
|
|
1688
|
-
export interface
|
|
1688
|
+
export interface Output901E0Rl7D1K {
|
|
1689
1689
|
courses: {
|
|
1690
1690
|
name: string;
|
|
1691
1691
|
status: string;
|
|
@@ -1696,21 +1696,21 @@ export interface OutputHo5V7Vdsab {
|
|
|
1696
1696
|
validated: boolean;
|
|
1697
1697
|
mustCreateCP: boolean;
|
|
1698
1698
|
}
|
|
1699
|
-
export interface
|
|
1699
|
+
export interface InputLa0684Ab34 {
|
|
1700
1700
|
/**
|
|
1701
1701
|
* Comments regarding the end of the cooldown period
|
|
1702
1702
|
* @example "Cooldown period ended successfully."
|
|
1703
1703
|
*/
|
|
1704
1704
|
comments: string;
|
|
1705
1705
|
}
|
|
1706
|
-
export interface
|
|
1706
|
+
export interface Output6Xbu13Oam3 {
|
|
1707
1707
|
/**
|
|
1708
1708
|
* Signed URL for the course file
|
|
1709
1709
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
1710
1710
|
*/
|
|
1711
1711
|
fileURL: string;
|
|
1712
1712
|
}
|
|
1713
|
-
export interface
|
|
1713
|
+
export interface InputT28Ksq4Qbh {
|
|
1714
1714
|
/** @example true */
|
|
1715
1715
|
agreedWithCertTerms: boolean;
|
|
1716
1716
|
/** @example 1717230000000 */
|
|
@@ -1782,21 +1782,21 @@ export interface InputQu8Lbgia45L {
|
|
|
1782
1782
|
/** @example "EXT#999" */
|
|
1783
1783
|
externalID2?: string | null;
|
|
1784
1784
|
}
|
|
1785
|
-
export interface
|
|
1785
|
+
export interface Input80Urs698Ps {
|
|
1786
1786
|
/**
|
|
1787
1787
|
* Comments regarding the course unlock action
|
|
1788
1788
|
* @example "Course unlocked successfully."
|
|
1789
1789
|
*/
|
|
1790
1790
|
comments: string;
|
|
1791
1791
|
}
|
|
1792
|
-
export interface
|
|
1792
|
+
export interface InputThrd8Gc9Hsk {
|
|
1793
1793
|
/**
|
|
1794
1794
|
* ITA number to update for the user
|
|
1795
1795
|
* @example "ITA123456"
|
|
1796
1796
|
*/
|
|
1797
1797
|
itaNumber: string;
|
|
1798
1798
|
}
|
|
1799
|
-
export interface
|
|
1799
|
+
export interface InputR78Km2A863 {
|
|
1800
1800
|
/** @example true */
|
|
1801
1801
|
agreedWithCertTerms: boolean;
|
|
1802
1802
|
/** @example 1717230000000 */
|
|
@@ -1868,7 +1868,7 @@ export interface InputWi1Nu2Pkap {
|
|
|
1868
1868
|
/** @example "EXT#999" */
|
|
1869
1869
|
externalID2?: string | null;
|
|
1870
1870
|
}
|
|
1871
|
-
export interface
|
|
1871
|
+
export interface InputCo4Zlxh4K7 {
|
|
1872
1872
|
/**
|
|
1873
1873
|
* The grade to override the course result with
|
|
1874
1874
|
* @example "A"
|
|
@@ -1876,7 +1876,7 @@ export interface Input92Pwkq6Eon {
|
|
|
1876
1876
|
resultGrade: string;
|
|
1877
1877
|
}
|
|
1878
1878
|
/** Pending approval review parameters */
|
|
1879
|
-
export interface
|
|
1879
|
+
export interface InputDfj95F0L6A {
|
|
1880
1880
|
/**
|
|
1881
1881
|
* Notes provided by the reviewer for the pending approval
|
|
1882
1882
|
* @example "Please review the submitted documents."
|
|
@@ -1889,7 +1889,7 @@ export interface InputJ90M1Fgki9L {
|
|
|
1889
1889
|
approved: boolean;
|
|
1890
1890
|
}
|
|
1891
1891
|
/** Schema for overriding course result dates. */
|
|
1892
|
-
export interface
|
|
1892
|
+
export interface InputDfrz7Yoxs1 {
|
|
1893
1893
|
/**
|
|
1894
1894
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1895
1895
|
* @example 1735689600000
|
|
@@ -1901,14 +1901,14 @@ export interface Input2Thiin78V5 {
|
|
|
1901
1901
|
*/
|
|
1902
1902
|
completionDate?: number;
|
|
1903
1903
|
}
|
|
1904
|
-
export interface
|
|
1904
|
+
export interface InputI1Fdsdjf1C {
|
|
1905
1905
|
filter: {
|
|
1906
1906
|
from?: number;
|
|
1907
1907
|
sortOrder?: string;
|
|
1908
1908
|
sortField?: string;
|
|
1909
1909
|
};
|
|
1910
1910
|
}
|
|
1911
|
-
export interface
|
|
1911
|
+
export interface OutputI1Fdsdjf1C {
|
|
1912
1912
|
users: {
|
|
1913
1913
|
firstName: string;
|
|
1914
1914
|
lastName: string;
|
|
@@ -1928,7 +1928,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
1928
1928
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1929
1929
|
* @example "CHECKED"
|
|
1930
1930
|
*/
|
|
1931
|
-
export declare enum
|
|
1931
|
+
export declare enum Input0Ckjw53CpoValueEnum {
|
|
1932
1932
|
CHECKED = "CHECKED",
|
|
1933
1933
|
UNCHECKED = "UNCHECKED",
|
|
1934
1934
|
NOVALUE = "NOVALUE"
|
|
@@ -2021,7 +2021,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2021
2021
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2022
2022
|
export type CreateReportUsersSimpleData = any;
|
|
2023
2023
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2024
|
-
export type CreateSearchUsersCountData =
|
|
2024
|
+
export type CreateSearchUsersCountData = Output3Ic5X329Tg;
|
|
2025
2025
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2026
2026
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2027
2027
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2031,6 +2031,12 @@ export type CreateCertificationApplicationItemData = any;
|
|
|
2031
2031
|
export type CreateCertificationApplicationItemError = ErrorResponse;
|
|
2032
2032
|
export type DeleteCertificationApplicationBlacklistData = any;
|
|
2033
2033
|
export type DeleteCertificationApplicationBlacklistError = ErrorResponse;
|
|
2034
|
+
export type DeleteCertificationData = any;
|
|
2035
|
+
export type DeleteCertificationError = ErrorResponse;
|
|
2036
|
+
export type GetCertificationData = CertificationProcessResponseEntity;
|
|
2037
|
+
export type GetCertificationError = ErrorResponse;
|
|
2038
|
+
export type CreateCertificationData = any;
|
|
2039
|
+
export type CreateCertificationError = ErrorResponse;
|
|
2034
2040
|
export type DeleteCertificationApplicationData = any;
|
|
2035
2041
|
export type DeleteCertificationApplicationError = ErrorResponse;
|
|
2036
2042
|
export type GetCertificationApplicationData = CertificationApplicationResponseEntity;
|
|
@@ -2039,7 +2045,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2039
2045
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2040
2046
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2041
2047
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2042
|
-
export type GetCertificationCourseFileSignData =
|
|
2048
|
+
export type GetCertificationCourseFileSignData = OutputP2Duut4Rdr;
|
|
2043
2049
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2044
2050
|
export interface CreateCertificationCourseFileSignParams {
|
|
2045
2051
|
/** @example "pdf" */
|
|
@@ -2053,11 +2059,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2053
2059
|
/** @example "fileID" */
|
|
2054
2060
|
fileId: string;
|
|
2055
2061
|
}
|
|
2056
|
-
export type CreateCertificationCourseFileSignData =
|
|
2062
|
+
export type CreateCertificationCourseFileSignData = Output6Xbu13Oam3;
|
|
2057
2063
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2058
2064
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2059
2065
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2060
|
-
export type CreateCertificationCourseDocumentData =
|
|
2066
|
+
export type CreateCertificationCourseDocumentData = OutputAt2Qquee7L;
|
|
2061
2067
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2062
2068
|
export type DeleteUserData = any;
|
|
2063
2069
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2069,7 +2075,7 @@ export type UpdateUserData = any;
|
|
|
2069
2075
|
export type UpdateUserError = ErrorResponse;
|
|
2070
2076
|
export type DeleteCertificationCourseData = any;
|
|
2071
2077
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2072
|
-
export type GetCertificationApplicationItemFileData =
|
|
2078
|
+
export type GetCertificationApplicationItemFileData = OutputBwweo9Hk3I;
|
|
2073
2079
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2074
2080
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2075
2081
|
/** @example "pdf" */
|
|
@@ -2083,9 +2089,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2083
2089
|
/** @example "fileVersion" */
|
|
2084
2090
|
fileVersion: string;
|
|
2085
2091
|
}
|
|
2086
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2092
|
+
export type CreateCertificationApplicationItemFileData = OutputI4R7Bcx3T7G;
|
|
2087
2093
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2088
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2094
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = Output50Cxzsa2Jw;
|
|
2089
2095
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2090
2096
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2091
2097
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2093,7 +2099,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2093
2099
|
export type GetCourseError = ErrorResponse;
|
|
2094
2100
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2095
2101
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2096
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2102
|
+
export type GetCertificationApplicationForeignFillData = Output5Ma5Cfwu78K;
|
|
2097
2103
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2098
2104
|
export type GetCertificationPrintData = any;
|
|
2099
2105
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2103,10 +2109,6 @@ export type GetRequirementData = StudentHistoryResponseSchema;
|
|
|
2103
2109
|
export type GetRequirementError = ErrorResponse;
|
|
2104
2110
|
export type GetCertificationsUpcomingCoursesData = UserUpcomingCoursesResponseSchema;
|
|
2105
2111
|
export type GetCertificationsUpcomingCoursesError = ErrorResponse;
|
|
2106
|
-
export type GetCertificationData = CertificationProcessResponseEntity;
|
|
2107
|
-
export type GetCertificationError = ErrorResponse;
|
|
2108
|
-
export type CreateCertificationData = any;
|
|
2109
|
-
export type CreateCertificationError = ErrorResponse;
|
|
2110
2112
|
export type CreateCertificationApplicationLockData = any;
|
|
2111
2113
|
export type CreateCertificationApplicationLockError = ErrorResponse;
|
|
2112
2114
|
export type CreateSessionAddData = any;
|
|
@@ -2129,7 +2131,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2129
2131
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2130
2132
|
export type CreateCertificationWaiveData = any;
|
|
2131
2133
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2132
|
-
export type CreateCertificationMoveData =
|
|
2134
|
+
export type CreateCertificationMoveData = OutputYon3Esf9Sd;
|
|
2133
2135
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2134
2136
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2135
2137
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2157,7 +2159,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2157
2159
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2158
2160
|
export type CreateCertificationCourseRedeemData = any;
|
|
2159
2161
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2160
|
-
export type CreateCertificationMoveValidateData =
|
|
2162
|
+
export type CreateCertificationMoveValidateData = Output901E0Rl7D1K;
|
|
2161
2163
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2162
2164
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2163
2165
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2171,7 +2173,7 @@ export type UpdateCertificationSetDatesData = any;
|
|
|
2171
2173
|
export type UpdateCertificationSetDatesError = ErrorResponse;
|
|
2172
2174
|
export type CreateCertificationPublishInfoData = any;
|
|
2173
2175
|
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2174
|
-
export type CreateCertificationResult =
|
|
2176
|
+
export type CreateCertificationResult = OutputI1Fdsdjf1C;
|
|
2175
2177
|
export type CreateCertificationFail = ErrorResponse;
|
|
2176
2178
|
export type CreateCertificationPublishInfoResult = any;
|
|
2177
2179
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2218,7 +2220,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2218
2220
|
}
|
|
2219
2221
|
/**
|
|
2220
2222
|
* @title BCCSA Program API
|
|
2221
|
-
* @version 3.0.
|
|
2223
|
+
* @version 3.0.16
|
|
2222
2224
|
* @baseUrl http://localhost:8080
|
|
2223
2225
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2224
2226
|
*/
|
|
@@ -2233,7 +2235,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2233
2235
|
* @request POST:/contactUs
|
|
2234
2236
|
* @secure
|
|
2235
2237
|
*/
|
|
2236
|
-
listContactUs: (data:
|
|
2238
|
+
listContactUs: (data: InputUd1Py882Ha, params?: RequestParams) => Promise<any>;
|
|
2237
2239
|
};
|
|
2238
2240
|
customer: {
|
|
2239
2241
|
/**
|
|
@@ -2337,7 +2339,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2337
2339
|
* @request POST:/tenant/report/applicationExport
|
|
2338
2340
|
* @secure
|
|
2339
2341
|
*/
|
|
2340
|
-
createReportApplicationExport: (data:
|
|
2342
|
+
createReportApplicationExport: (data: InputD3Dhjn9Ys4, params?: RequestParams) => Promise<any>;
|
|
2341
2343
|
/**
|
|
2342
2344
|
* @description Export a report of applications based on the provided filters.
|
|
2343
2345
|
*
|
|
@@ -2347,7 +2349,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2347
2349
|
* @request POST:/tenant/report/applicationStatus
|
|
2348
2350
|
* @secure
|
|
2349
2351
|
*/
|
|
2350
|
-
listReportApplicationStatus: (data:
|
|
2352
|
+
listReportApplicationStatus: (data: InputTyyuqx8L2O, params?: RequestParams) => Promise<any>;
|
|
2351
2353
|
/**
|
|
2352
2354
|
* @description Export a report of applications based on the provided filters.
|
|
2353
2355
|
*
|
|
@@ -2357,7 +2359,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2357
2359
|
* @request POST:/tenant/report/applicationsReport
|
|
2358
2360
|
* @secure
|
|
2359
2361
|
*/
|
|
2360
|
-
createReportApplicationsReport: (data:
|
|
2362
|
+
createReportApplicationsReport: (data: InputJycvujxvg4H, params?: RequestParams) => Promise<any>;
|
|
2361
2363
|
/**
|
|
2362
2364
|
* @description This route allows you to post certificates email for the tenant.
|
|
2363
2365
|
*
|
|
@@ -2367,7 +2369,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2367
2369
|
* @request POST:/tenant/certificates/email
|
|
2368
2370
|
* @secure
|
|
2369
2371
|
*/
|
|
2370
|
-
createCertificatesEmail: (data:
|
|
2372
|
+
createCertificatesEmail: (data: InputOd8Hvevtkh, params?: RequestParams) => Promise<any>;
|
|
2371
2373
|
/**
|
|
2372
2374
|
* @description Generate a preview of the completed certifications report.
|
|
2373
2375
|
*
|
|
@@ -2397,7 +2399,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2397
2399
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2398
2400
|
* @secure
|
|
2399
2401
|
*/
|
|
2400
|
-
createLicenseRedeem: (userId: string, data:
|
|
2402
|
+
createLicenseRedeem: (userId: string, data: Input8Oiix3Elgyj, params?: RequestParams) => Promise<any>;
|
|
2401
2403
|
/**
|
|
2402
2404
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2403
2405
|
*
|
|
@@ -2407,7 +2409,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2407
2409
|
* @request POST:/tenant/report/orglicenses/
|
|
2408
2410
|
* @secure
|
|
2409
2411
|
*/
|
|
2410
|
-
listReportOrglicenses: (data:
|
|
2412
|
+
listReportOrglicenses: (data: InputFpgop3Isd5, params?: RequestParams) => Promise<any>;
|
|
2411
2413
|
/**
|
|
2412
2414
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2413
2415
|
*
|
|
@@ -2417,7 +2419,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2417
2419
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2418
2420
|
* @secure
|
|
2419
2421
|
*/
|
|
2420
|
-
createReportOrglicensesPreview: (data:
|
|
2422
|
+
createReportOrglicensesPreview: (data: InputIdt7Y9Ryz7L, params?: RequestParams) => Promise<any>;
|
|
2421
2423
|
/**
|
|
2422
2424
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2423
2425
|
*
|
|
@@ -2447,7 +2449,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2447
2449
|
* @request POST:/tenant/report/users/advanced
|
|
2448
2450
|
* @secure
|
|
2449
2451
|
*/
|
|
2450
|
-
createReportUsersAdvanced: (data:
|
|
2452
|
+
createReportUsersAdvanced: (data: InputOazpxrxma7, params?: RequestParams) => Promise<any>;
|
|
2451
2453
|
/**
|
|
2452
2454
|
* @description Searches for users in the tenant by their IDs.
|
|
2453
2455
|
*
|
|
@@ -2457,7 +2459,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2457
2459
|
* @request POST:/tenant/search/users/ids
|
|
2458
2460
|
* @secure
|
|
2459
2461
|
*/
|
|
2460
|
-
listSearchUsersIds: (data:
|
|
2462
|
+
listSearchUsersIds: (data: InputVwx4A531Dx, params?: RequestParams) => Promise<any>;
|
|
2461
2463
|
/**
|
|
2462
2464
|
* @description Searches for users in the tenant by term and filters.
|
|
2463
2465
|
*
|
|
@@ -2467,7 +2469,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2467
2469
|
* @request POST:/tenant/search/users/term
|
|
2468
2470
|
* @secure
|
|
2469
2471
|
*/
|
|
2470
|
-
createSearchUsersTerm: (data:
|
|
2472
|
+
createSearchUsersTerm: (data: InputRyccpgocqi, params?: RequestParams) => Promise<any>;
|
|
2471
2473
|
/**
|
|
2472
2474
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2473
2475
|
*
|
|
@@ -2477,7 +2479,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2477
2479
|
* @request POST:/tenant/report/users/simple
|
|
2478
2480
|
* @secure
|
|
2479
2481
|
*/
|
|
2480
|
-
createReportUsersSimple: (data:
|
|
2482
|
+
createReportUsersSimple: (data: InputVvhra13Jmh, params?: RequestParams) => Promise<any>;
|
|
2481
2483
|
/**
|
|
2482
2484
|
* @description Retrieve user by ID.
|
|
2483
2485
|
*
|
|
@@ -2487,7 +2489,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2487
2489
|
* @request POST:/tenant/search/users/count
|
|
2488
2490
|
* @secure
|
|
2489
2491
|
*/
|
|
2490
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2492
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<Output3Ic5X329Tg>;
|
|
2491
2493
|
};
|
|
2492
2494
|
user: {
|
|
2493
2495
|
/**
|
|
@@ -2519,7 +2521,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2519
2521
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2520
2522
|
* @secure
|
|
2521
2523
|
*/
|
|
2522
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2524
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: InputJ86Ad2Cw25, params?: RequestParams) => Promise<any>;
|
|
2523
2525
|
/**
|
|
2524
2526
|
* @description Delete a certification process application by type.
|
|
2525
2527
|
*
|
|
@@ -2530,6 +2532,36 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2530
2532
|
* @secure
|
|
2531
2533
|
*/
|
|
2532
2534
|
deleteCertificationApplicationBlacklist: (userId: string, certProcId: string, applicationType: string, sourceId: string, params?: RequestParams) => Promise<any>;
|
|
2535
|
+
/**
|
|
2536
|
+
* @description Delete certification process by user and certproc IDs.
|
|
2537
|
+
*
|
|
2538
|
+
* @tags Certification
|
|
2539
|
+
* @name DeleteCertification
|
|
2540
|
+
* @summary Delete Certification Process
|
|
2541
|
+
* @request DELETE:/user/{userID}/certification/{certProcID}
|
|
2542
|
+
* @secure
|
|
2543
|
+
*/
|
|
2544
|
+
deleteCertification: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
|
|
2545
|
+
/**
|
|
2546
|
+
* @description Retrieve course for a user by their user ID.
|
|
2547
|
+
*
|
|
2548
|
+
* @tags Certification
|
|
2549
|
+
* @name GetCertification
|
|
2550
|
+
* @summary Get Certification Process for User
|
|
2551
|
+
* @request GET:/user/{userID}/certification/{certProcID}
|
|
2552
|
+
* @secure
|
|
2553
|
+
*/
|
|
2554
|
+
getCertification: (userId: string, certProcId: string, params?: RequestParams) => Promise<CertificationProcessResponseEntity>;
|
|
2555
|
+
/**
|
|
2556
|
+
* @description This route allows you to start a certification process for a user.
|
|
2557
|
+
*
|
|
2558
|
+
* @tags Certification
|
|
2559
|
+
* @name CreateCertification
|
|
2560
|
+
* @summary Start Certification Process
|
|
2561
|
+
* @request POST:/user/{userID}/certification/{certProcID}
|
|
2562
|
+
* @secure
|
|
2563
|
+
*/
|
|
2564
|
+
createCertification: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
|
|
2533
2565
|
/**
|
|
2534
2566
|
* @description Delete a certification process application by type.
|
|
2535
2567
|
*
|
|
@@ -2579,7 +2611,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2579
2611
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2580
2612
|
* @secure
|
|
2581
2613
|
*/
|
|
2582
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2614
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputP2Duut4Rdr>;
|
|
2583
2615
|
/**
|
|
2584
2616
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2585
2617
|
*
|
|
@@ -2589,7 +2621,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2589
2621
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2590
2622
|
* @secure
|
|
2591
2623
|
*/
|
|
2592
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2624
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<Output6Xbu13Oam3>;
|
|
2593
2625
|
/**
|
|
2594
2626
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2595
2627
|
*
|
|
@@ -2609,7 +2641,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2609
2641
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2610
2642
|
* @secure
|
|
2611
2643
|
*/
|
|
2612
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2644
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputAt2Qquee7L, params?: RequestParams) => Promise<OutputAt2Qquee7L>;
|
|
2613
2645
|
/**
|
|
2614
2646
|
* @description Delete user by ID.
|
|
2615
2647
|
*
|
|
@@ -2639,7 +2671,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2639
2671
|
* @request POST:/user/{userID}
|
|
2640
2672
|
* @secure
|
|
2641
2673
|
*/
|
|
2642
|
-
createUser: (userId: string, data:
|
|
2674
|
+
createUser: (userId: string, data: InputT28Ksq4Qbh, params?: RequestParams) => Promise<any>;
|
|
2643
2675
|
/**
|
|
2644
2676
|
* @description Update user in the system. This endpoint allows you to update a user with the provided details. The user will be updated to the database and an email notification will be sent to the user.
|
|
2645
2677
|
*
|
|
@@ -2649,7 +2681,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2649
2681
|
* @request PUT:/user/{userID}
|
|
2650
2682
|
* @secure
|
|
2651
2683
|
*/
|
|
2652
|
-
updateUser: (userId: string, data:
|
|
2684
|
+
updateUser: (userId: string, data: InputR78Km2A863, params?: RequestParams) => Promise<any>;
|
|
2653
2685
|
/**
|
|
2654
2686
|
* @description Delete course from user
|
|
2655
2687
|
*
|
|
@@ -2669,7 +2701,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2669
2701
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2670
2702
|
* @secure
|
|
2671
2703
|
*/
|
|
2672
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2704
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputBwweo9Hk3I>;
|
|
2673
2705
|
/**
|
|
2674
2706
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2675
2707
|
*
|
|
@@ -2679,7 +2711,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2679
2711
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2680
2712
|
* @secure
|
|
2681
2713
|
*/
|
|
2682
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2714
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputI4R7Bcx3T7G>;
|
|
2683
2715
|
/**
|
|
2684
2716
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2685
2717
|
*
|
|
@@ -2689,7 +2721,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2689
2721
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2690
2722
|
* @secure
|
|
2691
2723
|
*/
|
|
2692
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2724
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<Output50Cxzsa2Jw>;
|
|
2693
2725
|
/**
|
|
2694
2726
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2695
2727
|
*
|
|
@@ -2729,7 +2761,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2729
2761
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2730
2762
|
* @secure
|
|
2731
2763
|
*/
|
|
2732
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2764
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<Output5Ma5Cfwu78K>;
|
|
2733
2765
|
/**
|
|
2734
2766
|
* @description This endpoint will print certificate
|
|
2735
2767
|
*
|
|
@@ -2770,26 +2802,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2770
2802
|
* @secure
|
|
2771
2803
|
*/
|
|
2772
2804
|
getCertificationsUpcomingCourses: (userId: string, params?: RequestParams) => Promise<UserUpcomingCoursesResponseSchema>;
|
|
2773
|
-
/**
|
|
2774
|
-
* @description Retrieve course for a user by their user ID.
|
|
2775
|
-
*
|
|
2776
|
-
* @tags Certification
|
|
2777
|
-
* @name GetCertification
|
|
2778
|
-
* @summary Get Certification Process for User
|
|
2779
|
-
* @request GET:/user/{userID}/certification/{certProcID}
|
|
2780
|
-
* @secure
|
|
2781
|
-
*/
|
|
2782
|
-
getCertification: (userId: string, certProcId: string, params?: RequestParams) => Promise<CertificationProcessResponseEntity>;
|
|
2783
|
-
/**
|
|
2784
|
-
* @description This route allows you to start a certification process for a user.
|
|
2785
|
-
*
|
|
2786
|
-
* @tags Certification
|
|
2787
|
-
* @name CreateCertification
|
|
2788
|
-
* @summary Start Certification Process
|
|
2789
|
-
* @request POST:/user/{userID}/certification/{certProcID}
|
|
2790
|
-
* @secure
|
|
2791
|
-
*/
|
|
2792
|
-
createCertification: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
|
|
2793
2805
|
/**
|
|
2794
2806
|
* @description This route indicates users should not be able to advance or make changes to applications in this certification.
|
|
2795
2807
|
*
|
|
@@ -2799,7 +2811,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2799
2811
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2800
2812
|
* @secure
|
|
2801
2813
|
*/
|
|
2802
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2814
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputKnvh2Z7Rse, params?: RequestParams) => Promise<any>;
|
|
2803
2815
|
/**
|
|
2804
2816
|
* @description This endpoint allows you to add a user to a session in a certification process. It requires the user ID, certification process ID, secondary user ID, course ID, and session ID as path parameters.
|
|
2805
2817
|
*
|
|
@@ -2829,7 +2841,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2829
2841
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2830
2842
|
* @secure
|
|
2831
2843
|
*/
|
|
2832
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2844
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputPn24Tkrz5N, params?: RequestParams) => Promise<any>;
|
|
2833
2845
|
/**
|
|
2834
2846
|
* @description This route allows you to pre approval review a certification application for a user. This is used to review applications before they are submitted for final approval.
|
|
2835
2847
|
*
|
|
@@ -2839,7 +2851,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2839
2851
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2840
2852
|
* @secure
|
|
2841
2853
|
*/
|
|
2842
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2854
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: Input2Dvhr78Yv, params?: RequestParams) => Promise<any>;
|
|
2843
2855
|
/**
|
|
2844
2856
|
* @description This endpoint allows the redemption of a batch course for a user in a certification process. It requires the user ID and certification process ID as path parameters, and the course redemption details in the request body.
|
|
2845
2857
|
*
|
|
@@ -2849,7 +2861,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2849
2861
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2850
2862
|
* @secure
|
|
2851
2863
|
*/
|
|
2852
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2864
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: Input766Ii876Sj, params?: RequestParams) => Promise<any>;
|
|
2853
2865
|
/**
|
|
2854
2866
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2855
2867
|
*
|
|
@@ -2859,7 +2871,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2859
2871
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2860
2872
|
* @secure
|
|
2861
2873
|
*/
|
|
2862
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2874
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputG1V252Slib, params?: RequestParams) => Promise<any>;
|
|
2863
2875
|
/**
|
|
2864
2876
|
* @description This endpoint allows you to cancel a certification enrolment for a user in a specific course session. It requires the user ID, certification process ID, course ID, and session ID as path parameters.
|
|
2865
2877
|
*
|
|
@@ -2899,7 +2911,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2899
2911
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2900
2912
|
* @secure
|
|
2901
2913
|
*/
|
|
2902
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2914
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputQfsksefyis, params?: RequestParams) => Promise<any>;
|
|
2903
2915
|
/**
|
|
2904
2916
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
2905
2917
|
*
|
|
@@ -2909,7 +2921,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2909
2921
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2910
2922
|
* @secure
|
|
2911
2923
|
*/
|
|
2912
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2924
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputYon3Esf9Sd>;
|
|
2913
2925
|
/**
|
|
2914
2926
|
* @description This endpoint allows you to replace a certification enrolment for a user in a specific course session. It requires the user ID, certification process ID, secondary user ID, course ID, and session ID as path parameters.
|
|
2915
2927
|
*
|
|
@@ -2939,7 +2951,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2939
2951
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2940
2952
|
* @secure
|
|
2941
2953
|
*/
|
|
2942
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
2954
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: Input0Ckjw53Cpo, params?: RequestParams) => Promise<any>;
|
|
2943
2955
|
/**
|
|
2944
2956
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
2945
2957
|
*
|
|
@@ -2989,7 +3001,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2989
3001
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
2990
3002
|
* @secure
|
|
2991
3003
|
*/
|
|
2992
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
3004
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: Input2D3A4F27Ipf, params?: RequestParams) => Promise<any>;
|
|
2993
3005
|
/**
|
|
2994
3006
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
2995
3007
|
*
|
|
@@ -3009,7 +3021,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3009
3021
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3010
3022
|
* @secure
|
|
3011
3023
|
*/
|
|
3012
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3024
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputRw404Uorif, params?: RequestParams) => Promise<any>;
|
|
3013
3025
|
/**
|
|
3014
3026
|
* @description This route allows you to submit a pending approval.
|
|
3015
3027
|
*
|
|
@@ -3019,7 +3031,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3019
3031
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3020
3032
|
* @secure
|
|
3021
3033
|
*/
|
|
3022
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3034
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputWoyg2Gtn48L, params?: RequestParams) => Promise<any>;
|
|
3023
3035
|
/**
|
|
3024
3036
|
* @description This route allows you to review a pending approval.
|
|
3025
3037
|
*
|
|
@@ -3029,7 +3041,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3029
3041
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3030
3042
|
* @secure
|
|
3031
3043
|
*/
|
|
3032
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3044
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputDfj95F0L6A, params?: RequestParams) => Promise<any>;
|
|
3033
3045
|
/**
|
|
3034
3046
|
* @description Redeems a license for a user by product ID.
|
|
3035
3047
|
*
|
|
@@ -3039,7 +3051,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3039
3051
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3040
3052
|
* @secure
|
|
3041
3053
|
*/
|
|
3042
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3054
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputHd03Cx4Ul6, params?: RequestParams) => Promise<any>;
|
|
3043
3055
|
/**
|
|
3044
3056
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3045
3057
|
*
|
|
@@ -3049,7 +3061,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3049
3061
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3050
3062
|
* @secure
|
|
3051
3063
|
*/
|
|
3052
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3064
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<Output901E0Rl7D1K>;
|
|
3053
3065
|
/**
|
|
3054
3066
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3055
3067
|
*
|
|
@@ -3059,7 +3071,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3059
3071
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3060
3072
|
* @secure
|
|
3061
3073
|
*/
|
|
3062
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3074
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputLa0684Ab34, params?: RequestParams) => Promise<any>;
|
|
3063
3075
|
/**
|
|
3064
3076
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3065
3077
|
*
|
|
@@ -3069,7 +3081,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3069
3081
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3070
3082
|
* @secure
|
|
3071
3083
|
*/
|
|
3072
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3084
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input80Urs698Ps, params?: RequestParams) => Promise<any>;
|
|
3073
3085
|
/**
|
|
3074
3086
|
* @description This endpoint allows updating the ITA number for a user. It requires the user ID as a path parameter and the new ITA number in the request body.
|
|
3075
3087
|
*
|
|
@@ -3079,7 +3091,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3079
3091
|
* @request POST:/user/{userID}/updateITA
|
|
3080
3092
|
* @secure
|
|
3081
3093
|
*/
|
|
3082
|
-
createUpdateIta: (userId: string, data:
|
|
3094
|
+
createUpdateIta: (userId: string, data: InputThrd8Gc9Hsk, params?: RequestParams) => Promise<any>;
|
|
3083
3095
|
/**
|
|
3084
3096
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3085
3097
|
*
|
|
@@ -3089,7 +3101,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3089
3101
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3090
3102
|
* @secure
|
|
3091
3103
|
*/
|
|
3092
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3104
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputCo4Zlxh4K7, params?: RequestParams) => Promise<any>;
|
|
3093
3105
|
/**
|
|
3094
3106
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3095
3107
|
*
|
|
@@ -3099,7 +3111,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3099
3111
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3100
3112
|
* @secure
|
|
3101
3113
|
*/
|
|
3102
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3114
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputDfrz7Yoxs1, params?: RequestParams) => Promise<any>;
|
|
3103
3115
|
/**
|
|
3104
3116
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3105
3117
|
*
|
|
@@ -3121,7 +3133,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3121
3133
|
* @request POST:/users/certification/{certSpecID}
|
|
3122
3134
|
* @secure
|
|
3123
3135
|
*/
|
|
3124
|
-
createCertification: (certSpecId: string, data:
|
|
3136
|
+
createCertification: (certSpecId: string, data: InputI1Fdsdjf1C, params?: RequestParams) => Promise<OutputI1Fdsdjf1C>;
|
|
3125
3137
|
/**
|
|
3126
3138
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3127
3139
|
*
|