@ikonintegration/bccsa-program-api 3.0.24 → 3.0.26
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 +136 -94
- package/dist/Api.d.ts +140 -103
- package/dist/Api.js +10 -9
- 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 InputYeb4Rn34Wb {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -232,6 +232,10 @@ export interface UserResponseEntity {
|
|
|
232
232
|
waivedOn?: WaivedOn;
|
|
233
233
|
/** Justifications for overridden course restrictions */
|
|
234
234
|
overwrittenJustification?: OverwrittenJustification;
|
|
235
|
+
/** ID of the user who revoked the course */
|
|
236
|
+
revokedByID?: RevokedByID;
|
|
237
|
+
/** Display name of the user who revoked the course */
|
|
238
|
+
revokedByName?: RevokedByName;
|
|
235
239
|
}[];
|
|
236
240
|
};
|
|
237
241
|
transactionID?: string | null;
|
|
@@ -320,6 +324,10 @@ export interface OverwrittenJustification {
|
|
|
320
324
|
cooldown_override?: string;
|
|
321
325
|
course_unlock?: string;
|
|
322
326
|
}
|
|
327
|
+
/** ID of the user who revoked the course */
|
|
328
|
+
export type RevokedByID = string;
|
|
329
|
+
/** Display name of the user who revoked the course */
|
|
330
|
+
export type RevokedByName = string;
|
|
323
331
|
/** Response schema for applications */
|
|
324
332
|
export interface ApplicationResponseSchema {
|
|
325
333
|
applications: {
|
|
@@ -419,8 +427,18 @@ export interface PendingApprovalResponseSchema {
|
|
|
419
427
|
courseID?: CourseID;
|
|
420
428
|
/** User display name */
|
|
421
429
|
displayName?: DisplayName;
|
|
430
|
+
/** Email address of the user who submitted the pending approval */
|
|
431
|
+
email?: Email;
|
|
422
432
|
/** List of submitted files for approval */
|
|
423
433
|
submissionItems?: SubmissionItems;
|
|
434
|
+
/** Current review state of the request (PENDING, APPROVED, REJECTED) */
|
|
435
|
+
approvalState?: ApprovalState;
|
|
436
|
+
/** Notes entered by the admin during approval/rejection */
|
|
437
|
+
approvalNotes?: ApprovalNotes;
|
|
438
|
+
/** User ID of the admin that reviewed the request */
|
|
439
|
+
reviewedBy?: ReviewedBy;
|
|
440
|
+
/** Timestamp of the review */
|
|
441
|
+
reviewedOn?: ReviewedOn;
|
|
424
442
|
}[] | null;
|
|
425
443
|
}
|
|
426
444
|
/** Timestamp when the entry was last updated */
|
|
@@ -431,7 +449,9 @@ export type Name = string;
|
|
|
431
449
|
export type CertTitle = string;
|
|
432
450
|
/** User display name */
|
|
433
451
|
export type DisplayName = string;
|
|
434
|
-
|
|
452
|
+
/** Email address of the user who submitted the pending approval */
|
|
453
|
+
export type Email = string;
|
|
454
|
+
export interface InputWjvhhwwjzj {
|
|
435
455
|
/**
|
|
436
456
|
* ID of the certification to filter applications by
|
|
437
457
|
* @example "certification123"
|
|
@@ -488,7 +508,7 @@ export interface InputRygxm02Mdf {
|
|
|
488
508
|
*/
|
|
489
509
|
ignoreCompletedCertifications?: boolean | null;
|
|
490
510
|
}
|
|
491
|
-
export interface
|
|
511
|
+
export interface InputBxo37Hanrg {
|
|
492
512
|
/**
|
|
493
513
|
* ID of the certification to filter applications by
|
|
494
514
|
* @example "certification123"
|
|
@@ -545,7 +565,7 @@ export interface InputMfhgwhflhq {
|
|
|
545
565
|
*/
|
|
546
566
|
ignoreCompletedCertifications?: boolean | null;
|
|
547
567
|
}
|
|
548
|
-
export interface
|
|
568
|
+
export interface InputV4Xhzdev06J {
|
|
549
569
|
/**
|
|
550
570
|
* ID of the certification to filter applications by
|
|
551
571
|
* @example "certification123"
|
|
@@ -602,7 +622,7 @@ export interface InputO1Utmw3Ddv {
|
|
|
602
622
|
*/
|
|
603
623
|
ignoreCompletedCertifications?: boolean | null;
|
|
604
624
|
}
|
|
605
|
-
export interface
|
|
625
|
+
export interface InputAljvvm66Ck {
|
|
606
626
|
/**
|
|
607
627
|
* The ID of the certificate specifications to be used for the email
|
|
608
628
|
* @example "certSpecsID123"
|
|
@@ -643,7 +663,7 @@ export interface InputOx8B0Fn9M2L {
|
|
|
643
663
|
emailAddress: string;
|
|
644
664
|
}[];
|
|
645
665
|
}
|
|
646
|
-
export interface
|
|
666
|
+
export interface InputU67Bq82Arc {
|
|
647
667
|
/**
|
|
648
668
|
* The ID of the product for which the license is being redeemed
|
|
649
669
|
* @example "productID123"
|
|
@@ -655,7 +675,7 @@ export interface InputEqnnf7Kjev {
|
|
|
655
675
|
*/
|
|
656
676
|
sessionID?: string;
|
|
657
677
|
}
|
|
658
|
-
export interface
|
|
678
|
+
export interface InputYqle553Hqv {
|
|
659
679
|
/**
|
|
660
680
|
* Search term to filter licenses
|
|
661
681
|
* @example "active"
|
|
@@ -672,7 +692,7 @@ export interface InputVkbamnqi6Ih {
|
|
|
672
692
|
*/
|
|
673
693
|
sortField?: any;
|
|
674
694
|
}
|
|
675
|
-
export interface
|
|
695
|
+
export interface Input5Fqmx9Pmm3 {
|
|
676
696
|
/**
|
|
677
697
|
* Search term to filter licenses
|
|
678
698
|
* @example "active"
|
|
@@ -728,7 +748,7 @@ export interface ReportXLSXSchema {
|
|
|
728
748
|
xlsxStream: File;
|
|
729
749
|
contentType: ReportXlsxSchemaContentTypeEnum;
|
|
730
750
|
}
|
|
731
|
-
export interface
|
|
751
|
+
export interface Input2Scuq3Q9Gql {
|
|
732
752
|
/**
|
|
733
753
|
* Start date for the report
|
|
734
754
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -750,11 +770,11 @@ export interface InputXt5Pmzvupx {
|
|
|
750
770
|
*/
|
|
751
771
|
dateType?: string;
|
|
752
772
|
}
|
|
753
|
-
export interface
|
|
773
|
+
export interface InputI0Pem75C1Zl {
|
|
754
774
|
/** List of user IDs to search for in the tenant. */
|
|
755
775
|
IDs: (string | null)[];
|
|
756
776
|
}
|
|
757
|
-
export interface
|
|
777
|
+
export interface InputUz71Dia4Xk {
|
|
758
778
|
/** The term to search for in the user profiles. */
|
|
759
779
|
searchTerm?: string | null;
|
|
760
780
|
/** Filter criteria for the user search. */
|
|
@@ -794,7 +814,7 @@ export interface InputY60712Ei2U {
|
|
|
794
814
|
};
|
|
795
815
|
};
|
|
796
816
|
}
|
|
797
|
-
export interface
|
|
817
|
+
export interface InputEqeac55Z21K {
|
|
798
818
|
/** The term to search for in the user profiles. */
|
|
799
819
|
searchTerm?: string | null;
|
|
800
820
|
/** Filter criteria for the user search. */
|
|
@@ -834,21 +854,21 @@ export interface InputUthvuhm96N {
|
|
|
834
854
|
};
|
|
835
855
|
};
|
|
836
856
|
}
|
|
837
|
-
export interface
|
|
857
|
+
export interface OutputQviwgudgta {
|
|
838
858
|
/** External system ID 2 */
|
|
839
859
|
userCount: ExternalID2;
|
|
840
860
|
transactionID?: string | null;
|
|
841
861
|
}
|
|
842
862
|
/** External system ID 2 */
|
|
843
863
|
export type ExternalID2 = number;
|
|
844
|
-
export interface
|
|
864
|
+
export interface OutputTz6Zu9Fq9I {
|
|
845
865
|
/**
|
|
846
866
|
* Signed URL for the course file
|
|
847
867
|
* @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
868
|
*/
|
|
849
869
|
fileURL: string;
|
|
850
870
|
}
|
|
851
|
-
export interface
|
|
871
|
+
export interface OutputL02W2Vi6G3 {
|
|
852
872
|
/**
|
|
853
873
|
* Amount to be refunded for the cancellation
|
|
854
874
|
* @example 0
|
|
@@ -947,6 +967,11 @@ export interface CertificationProcessResponseSchema {
|
|
|
947
967
|
expireReminders?: ExpireReminders;
|
|
948
968
|
/** Status information for trigger states (e.g., NEW, RENEW) */
|
|
949
969
|
triggerState?: TriggerState;
|
|
970
|
+
/**
|
|
971
|
+
* Pending approval state per course. Keys are course spec IDs of courses in the certification, values are the approval state for that course (e.g. PENDING, APPROVED, REJECTED).
|
|
972
|
+
* @example {"course001":"PENDING","course002":"APPROVED"}
|
|
973
|
+
*/
|
|
974
|
+
paState?: Record<string, any>;
|
|
950
975
|
/** Amount to be paid as commission */
|
|
951
976
|
commissionAmount?: CommissionAmount;
|
|
952
977
|
/** Recipient of the commission payment */
|
|
@@ -1136,10 +1161,14 @@ export interface CourseResponseEntity {
|
|
|
1136
1161
|
onlineCourseLabel?: OnlineCourseLabel;
|
|
1137
1162
|
/** Justifications for overridden course restrictions */
|
|
1138
1163
|
overwrittenJustification?: OverwrittenJustification;
|
|
1164
|
+
/** ID of the user who revoked the course */
|
|
1165
|
+
revokedByID?: RevokedByID;
|
|
1166
|
+
/** Display name of the user who revoked the course */
|
|
1167
|
+
revokedByName?: RevokedByName;
|
|
1139
1168
|
}
|
|
1140
1169
|
/** Label of the course enrolled (course version) */
|
|
1141
1170
|
export type OnlineCourseLabel = string;
|
|
1142
|
-
export interface
|
|
1171
|
+
export interface OutputDxikprcb5M {
|
|
1143
1172
|
/**
|
|
1144
1173
|
* Signed URL for the course file
|
|
1145
1174
|
* @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 +1186,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1157
1186
|
transactionID?: string | null;
|
|
1158
1187
|
}
|
|
1159
1188
|
/** Application Foreign Fill response type */
|
|
1160
|
-
export interface
|
|
1189
|
+
export interface Output0W9Z5Lrfhg {
|
|
1161
1190
|
items: {
|
|
1162
1191
|
userID: string;
|
|
1163
1192
|
createdOn?: number;
|
|
@@ -1304,6 +1333,11 @@ export interface CertificationProcessResponseEntity {
|
|
|
1304
1333
|
/** @example "OK" */
|
|
1305
1334
|
requestResult?: any;
|
|
1306
1335
|
}>;
|
|
1336
|
+
/**
|
|
1337
|
+
* Pending approval state per course. Keys are course spec IDs of courses in the certification, values are the approval state for that course (e.g. PENDING, APPROVED, REJECTED).
|
|
1338
|
+
* @example {"course001":"PENDING","course002":"APPROVED"}
|
|
1339
|
+
*/
|
|
1340
|
+
paState?: Record<string, any>;
|
|
1307
1341
|
/** @example 85 */
|
|
1308
1342
|
pointsAchieved?: number;
|
|
1309
1343
|
/** @example ["email1","email2"] */
|
|
@@ -1340,7 +1374,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1340
1374
|
applicationItems?: Record<string, any>[];
|
|
1341
1375
|
transactionID?: string | null;
|
|
1342
1376
|
}
|
|
1343
|
-
export interface
|
|
1377
|
+
export interface Input3023Uh956Ji {
|
|
1344
1378
|
issuedOn?: number;
|
|
1345
1379
|
expiresOn?: number;
|
|
1346
1380
|
fileItems?: {
|
|
@@ -1349,21 +1383,21 @@ export interface InputI4T3Lq4Y4 {
|
|
|
1349
1383
|
}[];
|
|
1350
1384
|
additionalNotes?: string | null;
|
|
1351
1385
|
}
|
|
1352
|
-
export interface
|
|
1386
|
+
export interface Input0Njl4Pczs8 {
|
|
1353
1387
|
/**
|
|
1354
1388
|
* Indicates whether the application is locked
|
|
1355
1389
|
* @example true
|
|
1356
1390
|
*/
|
|
1357
1391
|
isApplicationLocked: boolean;
|
|
1358
1392
|
}
|
|
1359
|
-
export interface
|
|
1393
|
+
export interface Output5X986R6V0W {
|
|
1360
1394
|
/**
|
|
1361
1395
|
* Signed URL for the course file
|
|
1362
1396
|
* @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
1397
|
*/
|
|
1364
1398
|
fileURL: string;
|
|
1365
1399
|
}
|
|
1366
|
-
export interface
|
|
1400
|
+
export interface InputMl9Cx7Bruk {
|
|
1367
1401
|
/**
|
|
1368
1402
|
* Indicates whether the waiver is approved
|
|
1369
1403
|
* @example true
|
|
@@ -1375,14 +1409,14 @@ export interface InputQbz0M4Dqc3 {
|
|
|
1375
1409
|
*/
|
|
1376
1410
|
additionalNotes?: string | null;
|
|
1377
1411
|
}
|
|
1378
|
-
export interface
|
|
1412
|
+
export interface InputR41Z6O8Win {
|
|
1379
1413
|
/**
|
|
1380
1414
|
* Optional notes regarding the waiver
|
|
1381
1415
|
* @example "Waiver granted due to special circumstances."
|
|
1382
1416
|
*/
|
|
1383
1417
|
additionalNotes?: string | null;
|
|
1384
1418
|
}
|
|
1385
|
-
export interface
|
|
1419
|
+
export interface InputJtyee7Eb8 {
|
|
1386
1420
|
students: {
|
|
1387
1421
|
/**
|
|
1388
1422
|
* User ID of the student to redeem the course for
|
|
@@ -1416,7 +1450,7 @@ export interface InputJtey9Gkj4N {
|
|
|
1416
1450
|
*/
|
|
1417
1451
|
autoEnrolSessionID?: string;
|
|
1418
1452
|
}
|
|
1419
|
-
export interface
|
|
1453
|
+
export interface Input8Htjpriowr {
|
|
1420
1454
|
invites: {
|
|
1421
1455
|
/**
|
|
1422
1456
|
* Email address of the user to invite
|
|
@@ -1445,7 +1479,7 @@ export interface InputKk888In56 {
|
|
|
1445
1479
|
*/
|
|
1446
1480
|
isReservedSeat: boolean;
|
|
1447
1481
|
}
|
|
1448
|
-
export interface
|
|
1482
|
+
export interface Input7Nmaq3Dpgg {
|
|
1449
1483
|
/**
|
|
1450
1484
|
* Indicates whether to waive the certification process
|
|
1451
1485
|
* @example true
|
|
@@ -1458,7 +1492,7 @@ export interface InputF4Qkw71Af5 {
|
|
|
1458
1492
|
comments?: string | null;
|
|
1459
1493
|
}
|
|
1460
1494
|
/** Certification move response schema */
|
|
1461
|
-
export interface
|
|
1495
|
+
export interface OutputDfv06H0Dmfg {
|
|
1462
1496
|
errors?: {
|
|
1463
1497
|
status: string;
|
|
1464
1498
|
object?: Record<string, any>;
|
|
@@ -1466,19 +1500,19 @@ export interface Output16J18Ccnj2 {
|
|
|
1466
1500
|
}[];
|
|
1467
1501
|
}
|
|
1468
1502
|
/** Schema for writing a certification trigger check. */
|
|
1469
|
-
export interface
|
|
1503
|
+
export interface InputG8Y9G9Qq87 {
|
|
1470
1504
|
/**
|
|
1471
1505
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1472
1506
|
* @example "CHECKED"
|
|
1473
1507
|
*/
|
|
1474
|
-
value:
|
|
1508
|
+
value: InputG8Y9G9Qq87ValueEnum;
|
|
1475
1509
|
/**
|
|
1476
1510
|
* List of course IDs that are blocked by this trigger check.
|
|
1477
1511
|
* @example ["course1","course2"]
|
|
1478
1512
|
*/
|
|
1479
1513
|
blockedCourses?: string[];
|
|
1480
1514
|
}
|
|
1481
|
-
export interface
|
|
1515
|
+
export interface InputQkmwx5Xpx {
|
|
1482
1516
|
/**
|
|
1483
1517
|
* Indicates whether the application item is approved
|
|
1484
1518
|
* @example true
|
|
@@ -1504,7 +1538,7 @@ export interface Input4X96Bzl8Ls {
|
|
|
1504
1538
|
export interface StudentHistoryRequestSchema {
|
|
1505
1539
|
requirements: string[];
|
|
1506
1540
|
}
|
|
1507
|
-
export interface
|
|
1541
|
+
export interface InputEeq11Ik9Uq {
|
|
1508
1542
|
/**
|
|
1509
1543
|
* Optional activation key for the application
|
|
1510
1544
|
* @example "AK-123456"
|
|
@@ -1512,7 +1546,7 @@ export interface InputVp1Fgim6Yo {
|
|
|
1512
1546
|
activationKey?: string;
|
|
1513
1547
|
}
|
|
1514
1548
|
/** Schema for course submission item details post request. */
|
|
1515
|
-
export interface
|
|
1549
|
+
export interface InputP0Vxxq5Lvtl {
|
|
1516
1550
|
/**
|
|
1517
1551
|
* The ID of the file being submitted.
|
|
1518
1552
|
* @example "fileID123"
|
|
@@ -1525,7 +1559,7 @@ export interface InputJ33Sd4Ayqi {
|
|
|
1525
1559
|
fileName: string;
|
|
1526
1560
|
}
|
|
1527
1561
|
/** Schema for the response to course submission item details post request. */
|
|
1528
|
-
export interface
|
|
1562
|
+
export interface OutputP0Vxxq5Lvtl {
|
|
1529
1563
|
submissionItems: {
|
|
1530
1564
|
/**
|
|
1531
1565
|
* The ID of the file being submitted.
|
|
@@ -1540,7 +1574,7 @@ export interface OutputJ33Sd4Ayqi {
|
|
|
1540
1574
|
}[];
|
|
1541
1575
|
}
|
|
1542
1576
|
/** Pending approval submission parameters */
|
|
1543
|
-
export interface
|
|
1577
|
+
export interface InputP4C7Z75Art {
|
|
1544
1578
|
/**
|
|
1545
1579
|
* Type of pending approval
|
|
1546
1580
|
* @example "certification"
|
|
@@ -1560,7 +1594,7 @@ export interface InputC7Xaos72Zo {
|
|
|
1560
1594
|
fileName: string;
|
|
1561
1595
|
}[];
|
|
1562
1596
|
}
|
|
1563
|
-
export interface
|
|
1597
|
+
export interface InputZk6Mvqgvde {
|
|
1564
1598
|
/**
|
|
1565
1599
|
* The ID of the course for which the license is being redeemed
|
|
1566
1600
|
* @example "courseID123"
|
|
@@ -1628,7 +1662,7 @@ export interface InputS2K8Zhf0Z1 {
|
|
|
1628
1662
|
acknowledgement?: string | null;
|
|
1629
1663
|
}
|
|
1630
1664
|
/** Validate certification move response schema */
|
|
1631
|
-
export interface
|
|
1665
|
+
export interface OutputAdwnctqt8E {
|
|
1632
1666
|
courses: {
|
|
1633
1667
|
name: string;
|
|
1634
1668
|
status: string;
|
|
@@ -1639,21 +1673,21 @@ export interface OutputOqmbw6Fqjz {
|
|
|
1639
1673
|
validated: boolean;
|
|
1640
1674
|
mustCreateCP: boolean;
|
|
1641
1675
|
}
|
|
1642
|
-
export interface
|
|
1676
|
+
export interface InputTmwj7Csmmc {
|
|
1643
1677
|
/**
|
|
1644
1678
|
* Comments regarding the end of the cooldown period
|
|
1645
1679
|
* @example "Cooldown period ended successfully."
|
|
1646
1680
|
*/
|
|
1647
1681
|
comments: string;
|
|
1648
1682
|
}
|
|
1649
|
-
export interface
|
|
1683
|
+
export interface OutputDveoe61L2Q {
|
|
1650
1684
|
/**
|
|
1651
1685
|
* Signed URL for the course file
|
|
1652
1686
|
* @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
1687
|
*/
|
|
1654
1688
|
fileURL: string;
|
|
1655
1689
|
}
|
|
1656
|
-
export interface
|
|
1690
|
+
export interface InputGm3D7Dw52V {
|
|
1657
1691
|
/** @example true */
|
|
1658
1692
|
agreedWithCertTerms: boolean;
|
|
1659
1693
|
/** @example 1717230000000 */
|
|
@@ -1725,21 +1759,21 @@ export interface InputBii9Su5Lr6 {
|
|
|
1725
1759
|
/** @example "EXT#999" */
|
|
1726
1760
|
externalID2?: string | null;
|
|
1727
1761
|
}
|
|
1728
|
-
export interface
|
|
1762
|
+
export interface Input0A1Chlf8Fu {
|
|
1729
1763
|
/**
|
|
1730
1764
|
* Comments regarding the course unlock action
|
|
1731
1765
|
* @example "Course unlocked successfully."
|
|
1732
1766
|
*/
|
|
1733
1767
|
comments: string;
|
|
1734
1768
|
}
|
|
1735
|
-
export interface
|
|
1769
|
+
export interface Input0Wne7Pdule {
|
|
1736
1770
|
/**
|
|
1737
1771
|
* ITA number to update for the user
|
|
1738
1772
|
* @example "ITA123456"
|
|
1739
1773
|
*/
|
|
1740
1774
|
itaNumber: string;
|
|
1741
1775
|
}
|
|
1742
|
-
export interface
|
|
1776
|
+
export interface InputTf8Yi2E7Fh {
|
|
1743
1777
|
/** @example true */
|
|
1744
1778
|
agreedWithCertTerms: boolean;
|
|
1745
1779
|
/** @example 1717230000000 */
|
|
@@ -1811,7 +1845,7 @@ export interface InputRdlskcnfpv {
|
|
|
1811
1845
|
/** @example "EXT#999" */
|
|
1812
1846
|
externalID2?: string | null;
|
|
1813
1847
|
}
|
|
1814
|
-
export interface
|
|
1848
|
+
export interface InputMmshaoqcp4 {
|
|
1815
1849
|
/**
|
|
1816
1850
|
* The grade to override the course result with
|
|
1817
1851
|
* @example "A"
|
|
@@ -1819,7 +1853,7 @@ export interface Input4Dsobi1Hzx {
|
|
|
1819
1853
|
resultGrade: string;
|
|
1820
1854
|
}
|
|
1821
1855
|
/** Pending approval review parameters */
|
|
1822
|
-
export interface
|
|
1856
|
+
export interface InputAx226Ufgd5 {
|
|
1823
1857
|
/**
|
|
1824
1858
|
* Notes provided by the reviewer for the pending approval
|
|
1825
1859
|
* @example "Please review the submitted documents."
|
|
@@ -1832,7 +1866,7 @@ export interface InputAioiui29Q9 {
|
|
|
1832
1866
|
approved: boolean;
|
|
1833
1867
|
}
|
|
1834
1868
|
/** Schema for overriding course result dates. */
|
|
1835
|
-
export interface
|
|
1869
|
+
export interface InputN3Ihay0Vxz {
|
|
1836
1870
|
/**
|
|
1837
1871
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1838
1872
|
* @example 1735689600000
|
|
@@ -1844,14 +1878,14 @@ export interface Input0Yk8Sac5Su {
|
|
|
1844
1878
|
*/
|
|
1845
1879
|
completionDate?: number;
|
|
1846
1880
|
}
|
|
1847
|
-
export interface
|
|
1881
|
+
export interface Input9U3Fgb2Aj9 {
|
|
1848
1882
|
filter: {
|
|
1849
1883
|
from?: number;
|
|
1850
1884
|
sortOrder?: string;
|
|
1851
1885
|
sortField?: string;
|
|
1852
1886
|
};
|
|
1853
1887
|
}
|
|
1854
|
-
export interface
|
|
1888
|
+
export interface Output9U3Fgb2Aj9 {
|
|
1855
1889
|
users: {
|
|
1856
1890
|
firstName: string;
|
|
1857
1891
|
lastName: string;
|
|
@@ -1875,7 +1909,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
1875
1909
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1876
1910
|
* @example "CHECKED"
|
|
1877
1911
|
*/
|
|
1878
|
-
export declare enum
|
|
1912
|
+
export declare enum InputG8Y9G9Qq87ValueEnum {
|
|
1879
1913
|
CHECKED = "CHECKED",
|
|
1880
1914
|
UNCHECKED = "UNCHECKED",
|
|
1881
1915
|
NOVALUE = "NOVALUE"
|
|
@@ -1922,6 +1956,9 @@ export type ListReportCompletedWithConsentData = any;
|
|
|
1922
1956
|
export type ListReportCompletedWithConsentError = ErrorResponse;
|
|
1923
1957
|
export type ListPendingApplicationsData = ApplicationResponseSchema;
|
|
1924
1958
|
export type ListPendingApplicationsError = ErrorResponse;
|
|
1959
|
+
export interface ListPendingApprovalsParams {
|
|
1960
|
+
type?: string;
|
|
1961
|
+
}
|
|
1925
1962
|
export type ListPendingApprovalsData = PendingApprovalResponseSchema;
|
|
1926
1963
|
export type ListPendingApprovalsError = ErrorResponse;
|
|
1927
1964
|
export type ListConfigResult = any;
|
|
@@ -1968,7 +2005,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
1968
2005
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
1969
2006
|
export type CreateReportUsersSimpleData = any;
|
|
1970
2007
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
1971
|
-
export type CreateSearchUsersCountData =
|
|
2008
|
+
export type CreateSearchUsersCountData = OutputQviwgudgta;
|
|
1972
2009
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
1973
2010
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
1974
2011
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -1992,7 +2029,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
1992
2029
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
1993
2030
|
export type DeleteCertificationCourseFileSignData = any;
|
|
1994
2031
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
1995
|
-
export type GetCertificationCourseFileSignData =
|
|
2032
|
+
export type GetCertificationCourseFileSignData = OutputDxikprcb5M;
|
|
1996
2033
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
1997
2034
|
export interface CreateCertificationCourseFileSignParams {
|
|
1998
2035
|
/** @example "pdf" */
|
|
@@ -2006,11 +2043,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2006
2043
|
/** @example "fileID" */
|
|
2007
2044
|
fileId: string;
|
|
2008
2045
|
}
|
|
2009
|
-
export type CreateCertificationCourseFileSignData =
|
|
2046
|
+
export type CreateCertificationCourseFileSignData = OutputDveoe61L2Q;
|
|
2010
2047
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2011
2048
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2012
2049
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2013
|
-
export type CreateCertificationCourseDocumentData =
|
|
2050
|
+
export type CreateCertificationCourseDocumentData = OutputP0Vxxq5Lvtl;
|
|
2014
2051
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2015
2052
|
export type DeleteUserData = any;
|
|
2016
2053
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2022,7 +2059,7 @@ export type UpdateUserData = any;
|
|
|
2022
2059
|
export type UpdateUserError = ErrorResponse;
|
|
2023
2060
|
export type DeleteCertificationCourseData = any;
|
|
2024
2061
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2025
|
-
export type GetCertificationApplicationItemFileData =
|
|
2062
|
+
export type GetCertificationApplicationItemFileData = OutputTz6Zu9Fq9I;
|
|
2026
2063
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2027
2064
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2028
2065
|
/** @example "pdf" */
|
|
@@ -2036,9 +2073,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2036
2073
|
/** @example "fileVersion" */
|
|
2037
2074
|
fileVersion: string;
|
|
2038
2075
|
}
|
|
2039
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2076
|
+
export type CreateCertificationApplicationItemFileData = Output5X986R6V0W;
|
|
2040
2077
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2041
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2078
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputL02W2Vi6G3;
|
|
2042
2079
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2043
2080
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2044
2081
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2046,7 +2083,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2046
2083
|
export type GetCourseError = ErrorResponse;
|
|
2047
2084
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2048
2085
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2049
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2086
|
+
export type GetCertificationApplicationForeignFillData = Output0W9Z5Lrfhg;
|
|
2050
2087
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2051
2088
|
export type GetCertificationPrintData = any;
|
|
2052
2089
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2080,7 +2117,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2080
2117
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2081
2118
|
export type CreateCertificationWaiveData = any;
|
|
2082
2119
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2083
|
-
export type CreateCertificationMoveData =
|
|
2120
|
+
export type CreateCertificationMoveData = OutputDfv06H0Dmfg;
|
|
2084
2121
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2085
2122
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2086
2123
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2112,7 +2149,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2112
2149
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2113
2150
|
export type CreateCertificationCourseRedeemData = any;
|
|
2114
2151
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2115
|
-
export type CreateCertificationMoveValidateData =
|
|
2152
|
+
export type CreateCertificationMoveValidateData = OutputAdwnctqt8E;
|
|
2116
2153
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2117
2154
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2118
2155
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2128,7 +2165,7 @@ export type CreateCertificationPublishInfoData = any;
|
|
|
2128
2165
|
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2129
2166
|
export type CreateCertificationCourseRequestEnrolmentData = any;
|
|
2130
2167
|
export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse;
|
|
2131
|
-
export type CreateCertificationResult =
|
|
2168
|
+
export type CreateCertificationResult = Output9U3Fgb2Aj9;
|
|
2132
2169
|
export type CreateCertificationFail = ErrorResponse;
|
|
2133
2170
|
export type CreateCertificationPublishInfoResult = any;
|
|
2134
2171
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2175,7 +2212,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2175
2212
|
}
|
|
2176
2213
|
/**
|
|
2177
2214
|
* @title BCCSA Program API
|
|
2178
|
-
* @version 3.0.
|
|
2215
|
+
* @version 3.0.26
|
|
2179
2216
|
* @baseUrl http://localhost:8080
|
|
2180
2217
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2181
2218
|
*/
|
|
@@ -2190,7 +2227,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2190
2227
|
* @request POST:/contactUs
|
|
2191
2228
|
* @secure
|
|
2192
2229
|
*/
|
|
2193
|
-
listContactUs: (data:
|
|
2230
|
+
listContactUs: (data: InputYeb4Rn34Wb, params?: RequestParams) => Promise<any>;
|
|
2194
2231
|
};
|
|
2195
2232
|
customer: {
|
|
2196
2233
|
/**
|
|
@@ -2274,7 +2311,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2274
2311
|
* @request GET:/tenant/pendingApprovals
|
|
2275
2312
|
* @secure
|
|
2276
2313
|
*/
|
|
2277
|
-
listPendingApprovals: (params?: RequestParams) => Promise<PendingApprovalResponseSchema>;
|
|
2314
|
+
listPendingApprovals: (query: ListPendingApprovalsParams, params?: RequestParams) => Promise<PendingApprovalResponseSchema>;
|
|
2278
2315
|
/**
|
|
2279
2316
|
* @description Retrieve config for the tenant.
|
|
2280
2317
|
*
|
|
@@ -2294,7 +2331,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2294
2331
|
* @request POST:/tenant/report/applicationExport
|
|
2295
2332
|
* @secure
|
|
2296
2333
|
*/
|
|
2297
|
-
createReportApplicationExport: (data:
|
|
2334
|
+
createReportApplicationExport: (data: InputWjvhhwwjzj, params?: RequestParams) => Promise<any>;
|
|
2298
2335
|
/**
|
|
2299
2336
|
* @description Export a report of applications based on the provided filters.
|
|
2300
2337
|
*
|
|
@@ -2304,7 +2341,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2304
2341
|
* @request POST:/tenant/report/applicationStatus
|
|
2305
2342
|
* @secure
|
|
2306
2343
|
*/
|
|
2307
|
-
listReportApplicationStatus: (data:
|
|
2344
|
+
listReportApplicationStatus: (data: InputBxo37Hanrg, params?: RequestParams) => Promise<any>;
|
|
2308
2345
|
/**
|
|
2309
2346
|
* @description Export a report of applications based on the provided filters.
|
|
2310
2347
|
*
|
|
@@ -2314,7 +2351,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2314
2351
|
* @request POST:/tenant/report/applicationsReport
|
|
2315
2352
|
* @secure
|
|
2316
2353
|
*/
|
|
2317
|
-
createReportApplicationsReport: (data:
|
|
2354
|
+
createReportApplicationsReport: (data: InputV4Xhzdev06J, params?: RequestParams) => Promise<any>;
|
|
2318
2355
|
/**
|
|
2319
2356
|
* @description This route allows you to post certificates email for the tenant.
|
|
2320
2357
|
*
|
|
@@ -2324,7 +2361,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2324
2361
|
* @request POST:/tenant/certificates/email
|
|
2325
2362
|
* @secure
|
|
2326
2363
|
*/
|
|
2327
|
-
createCertificatesEmail: (data:
|
|
2364
|
+
createCertificatesEmail: (data: InputAljvvm66Ck, params?: RequestParams) => Promise<any>;
|
|
2328
2365
|
/**
|
|
2329
2366
|
* @description Generate a preview of the completed certifications report.
|
|
2330
2367
|
*
|
|
@@ -2354,7 +2391,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2354
2391
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2355
2392
|
* @secure
|
|
2356
2393
|
*/
|
|
2357
|
-
createLicenseRedeem: (userId: string, data:
|
|
2394
|
+
createLicenseRedeem: (userId: string, data: InputU67Bq82Arc, params?: RequestParams) => Promise<any>;
|
|
2358
2395
|
/**
|
|
2359
2396
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2360
2397
|
*
|
|
@@ -2364,7 +2401,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2364
2401
|
* @request POST:/tenant/report/orglicenses/
|
|
2365
2402
|
* @secure
|
|
2366
2403
|
*/
|
|
2367
|
-
listReportOrglicenses: (data:
|
|
2404
|
+
listReportOrglicenses: (data: InputYqle553Hqv, params?: RequestParams) => Promise<any>;
|
|
2368
2405
|
/**
|
|
2369
2406
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2370
2407
|
*
|
|
@@ -2374,7 +2411,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2374
2411
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2375
2412
|
* @secure
|
|
2376
2413
|
*/
|
|
2377
|
-
createReportOrglicensesPreview: (data:
|
|
2414
|
+
createReportOrglicensesPreview: (data: Input5Fqmx9Pmm3, params?: RequestParams) => Promise<any>;
|
|
2378
2415
|
/**
|
|
2379
2416
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2380
2417
|
*
|
|
@@ -2404,7 +2441,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2404
2441
|
* @request POST:/tenant/report/users/advanced
|
|
2405
2442
|
* @secure
|
|
2406
2443
|
*/
|
|
2407
|
-
createReportUsersAdvanced: (data:
|
|
2444
|
+
createReportUsersAdvanced: (data: Input2Scuq3Q9Gql, params?: RequestParams) => Promise<any>;
|
|
2408
2445
|
/**
|
|
2409
2446
|
* @description Searches for users in the tenant by their IDs.
|
|
2410
2447
|
*
|
|
@@ -2414,7 +2451,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2414
2451
|
* @request POST:/tenant/search/users/ids
|
|
2415
2452
|
* @secure
|
|
2416
2453
|
*/
|
|
2417
|
-
listSearchUsersIds: (data:
|
|
2454
|
+
listSearchUsersIds: (data: InputI0Pem75C1Zl, params?: RequestParams) => Promise<any>;
|
|
2418
2455
|
/**
|
|
2419
2456
|
* @description Searches for users in the tenant by term and filters.
|
|
2420
2457
|
*
|
|
@@ -2424,7 +2461,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2424
2461
|
* @request POST:/tenant/search/users/term
|
|
2425
2462
|
* @secure
|
|
2426
2463
|
*/
|
|
2427
|
-
createSearchUsersTerm: (data:
|
|
2464
|
+
createSearchUsersTerm: (data: InputUz71Dia4Xk, params?: RequestParams) => Promise<any>;
|
|
2428
2465
|
/**
|
|
2429
2466
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2430
2467
|
*
|
|
@@ -2434,7 +2471,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2434
2471
|
* @request POST:/tenant/report/users/simple
|
|
2435
2472
|
* @secure
|
|
2436
2473
|
*/
|
|
2437
|
-
createReportUsersSimple: (data:
|
|
2474
|
+
createReportUsersSimple: (data: InputEqeac55Z21K, params?: RequestParams) => Promise<any>;
|
|
2438
2475
|
/**
|
|
2439
2476
|
* @description Retrieve user by ID.
|
|
2440
2477
|
*
|
|
@@ -2444,7 +2481,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2444
2481
|
* @request POST:/tenant/search/users/count
|
|
2445
2482
|
* @secure
|
|
2446
2483
|
*/
|
|
2447
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2484
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<OutputQviwgudgta>;
|
|
2448
2485
|
};
|
|
2449
2486
|
user: {
|
|
2450
2487
|
/**
|
|
@@ -2476,7 +2513,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2476
2513
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2477
2514
|
* @secure
|
|
2478
2515
|
*/
|
|
2479
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2516
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: Input3023Uh956Ji, params?: RequestParams) => Promise<any>;
|
|
2480
2517
|
/**
|
|
2481
2518
|
* @description Delete a certification process application by type.
|
|
2482
2519
|
*
|
|
@@ -2566,7 +2603,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2566
2603
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2567
2604
|
* @secure
|
|
2568
2605
|
*/
|
|
2569
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2606
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputDxikprcb5M>;
|
|
2570
2607
|
/**
|
|
2571
2608
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2572
2609
|
*
|
|
@@ -2576,7 +2613,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2576
2613
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2577
2614
|
* @secure
|
|
2578
2615
|
*/
|
|
2579
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2616
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputDveoe61L2Q>;
|
|
2580
2617
|
/**
|
|
2581
2618
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2582
2619
|
*
|
|
@@ -2596,7 +2633,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2596
2633
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2597
2634
|
* @secure
|
|
2598
2635
|
*/
|
|
2599
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2636
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputP0Vxxq5Lvtl, params?: RequestParams) => Promise<OutputP0Vxxq5Lvtl>;
|
|
2600
2637
|
/**
|
|
2601
2638
|
* @description Delete user by ID.
|
|
2602
2639
|
*
|
|
@@ -2626,7 +2663,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2626
2663
|
* @request POST:/user/{userID}
|
|
2627
2664
|
* @secure
|
|
2628
2665
|
*/
|
|
2629
|
-
createUser: (userId: string, data:
|
|
2666
|
+
createUser: (userId: string, data: InputGm3D7Dw52V, params?: RequestParams) => Promise<any>;
|
|
2630
2667
|
/**
|
|
2631
2668
|
* @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.
|
|
2632
2669
|
*
|
|
@@ -2636,7 +2673,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2636
2673
|
* @request PUT:/user/{userID}
|
|
2637
2674
|
* @secure
|
|
2638
2675
|
*/
|
|
2639
|
-
updateUser: (userId: string, data:
|
|
2676
|
+
updateUser: (userId: string, data: InputTf8Yi2E7Fh, params?: RequestParams) => Promise<any>;
|
|
2640
2677
|
/**
|
|
2641
2678
|
* @description Delete course from user
|
|
2642
2679
|
*
|
|
@@ -2656,7 +2693,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2656
2693
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2657
2694
|
* @secure
|
|
2658
2695
|
*/
|
|
2659
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2696
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputTz6Zu9Fq9I>;
|
|
2660
2697
|
/**
|
|
2661
2698
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2662
2699
|
*
|
|
@@ -2666,7 +2703,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2666
2703
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2667
2704
|
* @secure
|
|
2668
2705
|
*/
|
|
2669
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2706
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<Output5X986R6V0W>;
|
|
2670
2707
|
/**
|
|
2671
2708
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2672
2709
|
*
|
|
@@ -2676,7 +2713,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2676
2713
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2677
2714
|
* @secure
|
|
2678
2715
|
*/
|
|
2679
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2716
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputL02W2Vi6G3>;
|
|
2680
2717
|
/**
|
|
2681
2718
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2682
2719
|
*
|
|
@@ -2716,7 +2753,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2716
2753
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2717
2754
|
* @secure
|
|
2718
2755
|
*/
|
|
2719
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2756
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<Output0W9Z5Lrfhg>;
|
|
2720
2757
|
/**
|
|
2721
2758
|
* @description This endpoint will print certificate
|
|
2722
2759
|
*
|
|
@@ -2776,7 +2813,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2776
2813
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2777
2814
|
* @secure
|
|
2778
2815
|
*/
|
|
2779
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2816
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: Input0Njl4Pczs8, params?: RequestParams) => Promise<any>;
|
|
2780
2817
|
/**
|
|
2781
2818
|
* @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.
|
|
2782
2819
|
*
|
|
@@ -2806,7 +2843,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2806
2843
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2807
2844
|
* @secure
|
|
2808
2845
|
*/
|
|
2809
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2846
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputMl9Cx7Bruk, params?: RequestParams) => Promise<any>;
|
|
2810
2847
|
/**
|
|
2811
2848
|
* @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.
|
|
2812
2849
|
*
|
|
@@ -2816,7 +2853,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2816
2853
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2817
2854
|
* @secure
|
|
2818
2855
|
*/
|
|
2819
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2856
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputR41Z6O8Win, params?: RequestParams) => Promise<any>;
|
|
2820
2857
|
/**
|
|
2821
2858
|
* @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.
|
|
2822
2859
|
*
|
|
@@ -2826,7 +2863,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2826
2863
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2827
2864
|
* @secure
|
|
2828
2865
|
*/
|
|
2829
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2866
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputJtyee7Eb8, params?: RequestParams) => Promise<any>;
|
|
2830
2867
|
/**
|
|
2831
2868
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2832
2869
|
*
|
|
@@ -2836,7 +2873,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2836
2873
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2837
2874
|
* @secure
|
|
2838
2875
|
*/
|
|
2839
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2876
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: Input8Htjpriowr, params?: RequestParams) => Promise<any>;
|
|
2840
2877
|
/**
|
|
2841
2878
|
* @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.
|
|
2842
2879
|
*
|
|
@@ -2876,7 +2913,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2876
2913
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2877
2914
|
* @secure
|
|
2878
2915
|
*/
|
|
2879
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2916
|
+
createCertificationWaive: (userId: string, certProcId: string, data: Input7Nmaq3Dpgg, params?: RequestParams) => Promise<any>;
|
|
2880
2917
|
/**
|
|
2881
2918
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
2882
2919
|
*
|
|
@@ -2886,7 +2923,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2886
2923
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2887
2924
|
* @secure
|
|
2888
2925
|
*/
|
|
2889
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2926
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputDfv06H0Dmfg>;
|
|
2890
2927
|
/**
|
|
2891
2928
|
* @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.
|
|
2892
2929
|
*
|
|
@@ -2926,7 +2963,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2926
2963
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2927
2964
|
* @secure
|
|
2928
2965
|
*/
|
|
2929
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
2966
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: InputG8Y9G9Qq87, params?: RequestParams) => Promise<any>;
|
|
2930
2967
|
/**
|
|
2931
2968
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
2932
2969
|
*
|
|
@@ -2986,7 +3023,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2986
3023
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
2987
3024
|
* @secure
|
|
2988
3025
|
*/
|
|
2989
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
3026
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: InputQkmwx5Xpx, params?: RequestParams) => Promise<any>;
|
|
2990
3027
|
/**
|
|
2991
3028
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
2992
3029
|
*
|
|
@@ -3006,7 +3043,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3006
3043
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3007
3044
|
* @secure
|
|
3008
3045
|
*/
|
|
3009
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
3046
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputEeq11Ik9Uq, params?: RequestParams) => Promise<any>;
|
|
3010
3047
|
/**
|
|
3011
3048
|
* @description This route allows you to submit a pending approval.
|
|
3012
3049
|
*
|
|
@@ -3016,7 +3053,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3016
3053
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3017
3054
|
* @secure
|
|
3018
3055
|
*/
|
|
3019
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3056
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputP4C7Z75Art, params?: RequestParams) => Promise<any>;
|
|
3020
3057
|
/**
|
|
3021
3058
|
* @description This route allows you to review a pending approval.
|
|
3022
3059
|
*
|
|
@@ -3026,7 +3063,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3026
3063
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3027
3064
|
* @secure
|
|
3028
3065
|
*/
|
|
3029
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3066
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputAx226Ufgd5, params?: RequestParams) => Promise<any>;
|
|
3030
3067
|
/**
|
|
3031
3068
|
* @description Redeems a license for a user by product ID.
|
|
3032
3069
|
*
|
|
@@ -3036,7 +3073,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3036
3073
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3037
3074
|
* @secure
|
|
3038
3075
|
*/
|
|
3039
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3076
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputZk6Mvqgvde, params?: RequestParams) => Promise<any>;
|
|
3040
3077
|
/**
|
|
3041
3078
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3042
3079
|
*
|
|
@@ -3046,7 +3083,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3046
3083
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3047
3084
|
* @secure
|
|
3048
3085
|
*/
|
|
3049
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3086
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputAdwnctqt8E>;
|
|
3050
3087
|
/**
|
|
3051
3088
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3052
3089
|
*
|
|
@@ -3056,7 +3093,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3056
3093
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3057
3094
|
* @secure
|
|
3058
3095
|
*/
|
|
3059
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3096
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputTmwj7Csmmc, params?: RequestParams) => Promise<any>;
|
|
3060
3097
|
/**
|
|
3061
3098
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3062
3099
|
*
|
|
@@ -3066,7 +3103,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3066
3103
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3067
3104
|
* @secure
|
|
3068
3105
|
*/
|
|
3069
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3106
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input0A1Chlf8Fu, params?: RequestParams) => Promise<any>;
|
|
3070
3107
|
/**
|
|
3071
3108
|
* @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.
|
|
3072
3109
|
*
|
|
@@ -3076,7 +3113,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3076
3113
|
* @request POST:/user/{userID}/updateITA
|
|
3077
3114
|
* @secure
|
|
3078
3115
|
*/
|
|
3079
|
-
createUpdateIta: (userId: string, data:
|
|
3116
|
+
createUpdateIta: (userId: string, data: Input0Wne7Pdule, params?: RequestParams) => Promise<any>;
|
|
3080
3117
|
/**
|
|
3081
3118
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3082
3119
|
*
|
|
@@ -3086,7 +3123,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3086
3123
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3087
3124
|
* @secure
|
|
3088
3125
|
*/
|
|
3089
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3126
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputMmshaoqcp4, params?: RequestParams) => Promise<any>;
|
|
3090
3127
|
/**
|
|
3091
3128
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3092
3129
|
*
|
|
@@ -3096,7 +3133,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3096
3133
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3097
3134
|
* @secure
|
|
3098
3135
|
*/
|
|
3099
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3136
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputN3Ihay0Vxz, params?: RequestParams) => Promise<any>;
|
|
3100
3137
|
/**
|
|
3101
3138
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3102
3139
|
*
|
|
@@ -3128,7 +3165,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3128
3165
|
* @request POST:/users/certification/{certSpecID}
|
|
3129
3166
|
* @secure
|
|
3130
3167
|
*/
|
|
3131
|
-
createCertification: (certSpecId: string, data:
|
|
3168
|
+
createCertification: (certSpecId: string, data: Input9U3Fgb2Aj9, params?: RequestParams) => Promise<Output9U3Fgb2Aj9>;
|
|
3132
3169
|
/**
|
|
3133
3170
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3134
3171
|
*
|