@ikonintegration/bccsa-program-api 3.0.20 → 3.0.21
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 +338 -437
- package/dist/Api.d.ts +283 -350
- package/dist/Api.js +8 -8
- 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 InputIehpmmhp5S {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the person filling out the contact form
|
|
11
11
|
* @example "John Doe"
|
|
@@ -23,90 +23,6 @@ export interface InputC7J0Vk93Lo {
|
|
|
23
23
|
*/
|
|
24
24
|
comments: string;
|
|
25
25
|
}
|
|
26
|
-
/** Timestamp of when the record was created */
|
|
27
|
-
export type CreatedOn = number;
|
|
28
|
-
/** User who created the record */
|
|
29
|
-
export type CreatedBy = string;
|
|
30
|
-
/** User who last updated the record */
|
|
31
|
-
export type UpdatedBy = string;
|
|
32
|
-
/** Timestamp of last update */
|
|
33
|
-
export type UpdateOn = number;
|
|
34
|
-
/** Entity identifier for Course */
|
|
35
|
-
export type DbEntity = string;
|
|
36
|
-
/** Unique identifier of the course record */
|
|
37
|
-
export type Id = string;
|
|
38
|
-
/** Certification process ID linked to this course */
|
|
39
|
-
export type CertProcID = string;
|
|
40
|
-
/** User ID associated with the course */
|
|
41
|
-
export type UserID = string;
|
|
42
|
-
/** Customer ID associated with the course */
|
|
43
|
-
export type CustomerID = string;
|
|
44
|
-
/** Tenant ID associated with the course */
|
|
45
|
-
export type TenantID = string;
|
|
46
|
-
/** Course ID reference */
|
|
47
|
-
export type CourseID = string;
|
|
48
|
-
/** When cooldown started */
|
|
49
|
-
export type CooldownStartedOn = number;
|
|
50
|
-
/** When cooldown was overwritten */
|
|
51
|
-
export type CooldownOverwrittenOn = number;
|
|
52
|
-
/** When course was locked */
|
|
53
|
-
export type CourseLockedOn = number;
|
|
54
|
-
/** When course lock was overwritten */
|
|
55
|
-
export type CourseLockOverwrittenOn = number;
|
|
56
|
-
/** Voucher code for the license */
|
|
57
|
-
export type LicenseVoucherCode = string;
|
|
58
|
-
/** License ID used in the course */
|
|
59
|
-
export type LicenseID = string;
|
|
60
|
-
/** ID for license invalidation */
|
|
61
|
-
export type LicenseInvalidateID = string;
|
|
62
|
-
/** Session ticket ID for course access */
|
|
63
|
-
export type SessionTicketID = string;
|
|
64
|
-
/** Session ID for course tracking */
|
|
65
|
-
export type SessionID = string;
|
|
66
|
-
/** Result of the course */
|
|
67
|
-
export type CourseResult = string;
|
|
68
|
-
/** Certificate number for the course */
|
|
69
|
-
export type CourseCertNumber = string;
|
|
70
|
-
/** Date of course completion */
|
|
71
|
-
export type CompletionDate = number;
|
|
72
|
-
/** Date when certificate was printed */
|
|
73
|
-
export type CertificatePrintedOn = number;
|
|
74
|
-
/** Date when card was printed */
|
|
75
|
-
export type CardPrintedOnDate = number;
|
|
76
|
-
/** Date of certificate/card shipping */
|
|
77
|
-
export type ShippingDate = number;
|
|
78
|
-
/** Whether data is copied from an alternate certification process */
|
|
79
|
-
export type IsCopiedFromAlternateCP = boolean;
|
|
80
|
-
/** Reminders sent before course expiry */
|
|
81
|
-
export type ExpireReminders = string[];
|
|
82
|
-
/** Expiration date of the course */
|
|
83
|
-
export type ExpiryDate = number;
|
|
84
|
-
/** Key used for indexing expiryDate */
|
|
85
|
-
export type ExpiryDateKey = string;
|
|
86
|
-
/** Whether the course has been invalidated */
|
|
87
|
-
export type Invalidated = boolean;
|
|
88
|
-
/** Whether a course retake has been requested */
|
|
89
|
-
export type RetakeRequested = boolean;
|
|
90
|
-
/** Current state of the course */
|
|
91
|
-
export type State = string;
|
|
92
|
-
/** Approval state of the course */
|
|
93
|
-
export type ApprovalState = string;
|
|
94
|
-
/** Notes about the course approval process */
|
|
95
|
-
export type ApprovalNotes = string;
|
|
96
|
-
/** List of submitted files for the course */
|
|
97
|
-
export type SubmissionItems = {
|
|
98
|
-
fileID?: string;
|
|
99
|
-
fileName?: string;
|
|
100
|
-
}[];
|
|
101
|
-
/** User who waived the course requirement */
|
|
102
|
-
export type WaivedBy = string;
|
|
103
|
-
/** Date when course was waived */
|
|
104
|
-
export type WaivedOn = number;
|
|
105
|
-
/** Justifications for overridden course restrictions */
|
|
106
|
-
export interface OverwrittenJustification {
|
|
107
|
-
cooldown_override?: string;
|
|
108
|
-
course_unlock?: string;
|
|
109
|
-
}
|
|
110
26
|
/** Response schema for user data */
|
|
111
27
|
export interface UserResponseEntity {
|
|
112
28
|
userResp?: {
|
|
@@ -320,26 +236,90 @@ export interface UserResponseEntity {
|
|
|
320
236
|
};
|
|
321
237
|
transactionID?: string | null;
|
|
322
238
|
}
|
|
323
|
-
/**
|
|
324
|
-
export type
|
|
325
|
-
/**
|
|
326
|
-
export type
|
|
327
|
-
/**
|
|
328
|
-
export type
|
|
329
|
-
/**
|
|
330
|
-
export type
|
|
331
|
-
/**
|
|
332
|
-
export type
|
|
333
|
-
/**
|
|
334
|
-
export type
|
|
335
|
-
/**
|
|
336
|
-
export type
|
|
337
|
-
/**
|
|
338
|
-
export type
|
|
339
|
-
/**
|
|
340
|
-
export type
|
|
341
|
-
/**
|
|
342
|
-
export type
|
|
239
|
+
/** Timestamp of when the record was created */
|
|
240
|
+
export type CreatedOn = number;
|
|
241
|
+
/** User who created the record */
|
|
242
|
+
export type CreatedBy = string;
|
|
243
|
+
/** User who last updated the record */
|
|
244
|
+
export type UpdatedBy = string;
|
|
245
|
+
/** Timestamp of last update */
|
|
246
|
+
export type UpdateOn = number;
|
|
247
|
+
/** Entity identifier for Course */
|
|
248
|
+
export type DbEntity = string;
|
|
249
|
+
/** Unique identifier of the course record */
|
|
250
|
+
export type Id = string;
|
|
251
|
+
/** Certification process ID linked to this course */
|
|
252
|
+
export type CertProcID = string;
|
|
253
|
+
/** User ID associated with the course */
|
|
254
|
+
export type UserID = string;
|
|
255
|
+
/** Customer ID associated with the course */
|
|
256
|
+
export type CustomerID = string;
|
|
257
|
+
/** Tenant ID associated with the course */
|
|
258
|
+
export type TenantID = string;
|
|
259
|
+
/** Course ID reference */
|
|
260
|
+
export type CourseID = string;
|
|
261
|
+
/** When cooldown started */
|
|
262
|
+
export type CooldownStartedOn = number;
|
|
263
|
+
/** When cooldown was overwritten */
|
|
264
|
+
export type CooldownOverwrittenOn = number;
|
|
265
|
+
/** When course was locked */
|
|
266
|
+
export type CourseLockedOn = number;
|
|
267
|
+
/** When course lock was overwritten */
|
|
268
|
+
export type CourseLockOverwrittenOn = number;
|
|
269
|
+
/** Voucher code for the license */
|
|
270
|
+
export type LicenseVoucherCode = string;
|
|
271
|
+
/** License ID used in the course */
|
|
272
|
+
export type LicenseID = string;
|
|
273
|
+
/** ID for license invalidation */
|
|
274
|
+
export type LicenseInvalidateID = string;
|
|
275
|
+
/** Session ticket ID for course access */
|
|
276
|
+
export type SessionTicketID = string;
|
|
277
|
+
/** Session ID for course tracking */
|
|
278
|
+
export type SessionID = string;
|
|
279
|
+
/** Result of the course */
|
|
280
|
+
export type CourseResult = string;
|
|
281
|
+
/** Certificate number for the course */
|
|
282
|
+
export type CourseCertNumber = string;
|
|
283
|
+
/** Date of course completion */
|
|
284
|
+
export type CompletionDate = number;
|
|
285
|
+
/** Date when certificate was printed */
|
|
286
|
+
export type CertificatePrintedOn = number;
|
|
287
|
+
/** Date when card was printed */
|
|
288
|
+
export type CardPrintedOnDate = number;
|
|
289
|
+
/** Date of certificate/card shipping */
|
|
290
|
+
export type ShippingDate = number;
|
|
291
|
+
/** Whether data is copied from an alternate certification process */
|
|
292
|
+
export type IsCopiedFromAlternateCP = boolean;
|
|
293
|
+
/** Reminders sent before course expiry */
|
|
294
|
+
export type ExpireReminders = string[];
|
|
295
|
+
/** Expiration date of the course */
|
|
296
|
+
export type ExpiryDate = number;
|
|
297
|
+
/** Key used for indexing expiryDate */
|
|
298
|
+
export type ExpiryDateKey = string;
|
|
299
|
+
/** Whether the course has been invalidated */
|
|
300
|
+
export type Invalidated = boolean;
|
|
301
|
+
/** Whether a course retake has been requested */
|
|
302
|
+
export type RetakeRequested = boolean;
|
|
303
|
+
/** Current state of the course */
|
|
304
|
+
export type State = string;
|
|
305
|
+
/** Approval state of the course */
|
|
306
|
+
export type ApprovalState = string;
|
|
307
|
+
/** Notes about the course approval process */
|
|
308
|
+
export type ApprovalNotes = string;
|
|
309
|
+
/** List of submitted files for the course */
|
|
310
|
+
export type SubmissionItems = {
|
|
311
|
+
fileID?: string;
|
|
312
|
+
fileName?: string;
|
|
313
|
+
}[];
|
|
314
|
+
/** User who waived the course requirement */
|
|
315
|
+
export type WaivedBy = string;
|
|
316
|
+
/** Date when course was waived */
|
|
317
|
+
export type WaivedOn = number;
|
|
318
|
+
/** Justifications for overridden course restrictions */
|
|
319
|
+
export interface OverwrittenJustification {
|
|
320
|
+
cooldown_override?: string;
|
|
321
|
+
course_unlock?: string;
|
|
322
|
+
}
|
|
343
323
|
/** Response schema for applications */
|
|
344
324
|
export interface ApplicationResponseSchema {
|
|
345
325
|
applications: {
|
|
@@ -384,31 +364,30 @@ export interface ApplicationResponseSchema {
|
|
|
384
364
|
/** Whether the review was acknowledged */
|
|
385
365
|
reviewAcknowledge?: ReviewAcknowledge;
|
|
386
366
|
/** List of submission items attached to the application */
|
|
387
|
-
submissionItems?: SubmissionItems
|
|
388
|
-
/** ID of the submission item */
|
|
389
|
-
id?: Id;
|
|
390
|
-
/** Version of the submission item */
|
|
391
|
-
version?: Version;
|
|
392
|
-
/** Type of the submission item */
|
|
393
|
-
type?: Type;
|
|
394
|
-
}[];
|
|
367
|
+
submissionItems?: SubmissionItems;
|
|
395
368
|
/** List of blacklisted item IDs for this application */
|
|
396
369
|
blacklistedItems?: BlacklistedItems;
|
|
397
370
|
}[] | null;
|
|
398
371
|
transactionID?: string | null;
|
|
399
372
|
}
|
|
400
|
-
/**
|
|
401
|
-
export type
|
|
402
|
-
/**
|
|
403
|
-
export type
|
|
404
|
-
/**
|
|
405
|
-
export type
|
|
406
|
-
/** User
|
|
407
|
-
export type
|
|
408
|
-
/**
|
|
409
|
-
export type
|
|
410
|
-
/**
|
|
411
|
-
export type
|
|
373
|
+
/** Associated Certification ID */
|
|
374
|
+
export type CertificationID = string;
|
|
375
|
+
/** Type of application */
|
|
376
|
+
export type Type = string;
|
|
377
|
+
/** Timestamp when the application was submitted */
|
|
378
|
+
export type SubmittedOn = number;
|
|
379
|
+
/** User who submitted the application */
|
|
380
|
+
export type SubmittedBy = string;
|
|
381
|
+
/** User who reviewed the application */
|
|
382
|
+
export type ReviewedBy = string;
|
|
383
|
+
/** Timestamp when the application was reviewed */
|
|
384
|
+
export type ReviewedOn = number;
|
|
385
|
+
/** Notes related to the review process */
|
|
386
|
+
export type ReviewNotes = string;
|
|
387
|
+
/** Whether the review was acknowledged */
|
|
388
|
+
export type ReviewAcknowledge = number;
|
|
389
|
+
/** List of blacklisted item IDs for this application */
|
|
390
|
+
export type BlacklistedItems = string[];
|
|
412
391
|
/** Response schema for pending approvals */
|
|
413
392
|
export interface PendingApprovalResponseSchema {
|
|
414
393
|
paItems: {
|
|
@@ -441,15 +420,18 @@ export interface PendingApprovalResponseSchema {
|
|
|
441
420
|
/** User display name */
|
|
442
421
|
displayName?: DisplayName;
|
|
443
422
|
/** List of submitted files for approval */
|
|
444
|
-
submissionItems?: SubmissionItems
|
|
445
|
-
/** ID of the submitted file */
|
|
446
|
-
fileID?: FileID;
|
|
447
|
-
/** Name of the submitted file */
|
|
448
|
-
fileName?: FileName;
|
|
449
|
-
}[];
|
|
423
|
+
submissionItems?: SubmissionItems;
|
|
450
424
|
}[] | null;
|
|
451
425
|
}
|
|
452
|
-
|
|
426
|
+
/** Timestamp when the entry was last updated */
|
|
427
|
+
export type UpdatedOn = number;
|
|
428
|
+
/** Name of the user or entity */
|
|
429
|
+
export type Name = string;
|
|
430
|
+
/** Title of the certification process */
|
|
431
|
+
export type CertTitle = string;
|
|
432
|
+
/** User display name */
|
|
433
|
+
export type DisplayName = string;
|
|
434
|
+
export interface InputFkhhceghyzl {
|
|
453
435
|
/**
|
|
454
436
|
* ID of the certification to filter applications by
|
|
455
437
|
* @example "certification123"
|
|
@@ -506,7 +488,7 @@ export interface Input6Gwyovjhwz {
|
|
|
506
488
|
*/
|
|
507
489
|
ignoreCompletedCertifications?: boolean | null;
|
|
508
490
|
}
|
|
509
|
-
export interface
|
|
491
|
+
export interface InputTqw0Engz1K {
|
|
510
492
|
/**
|
|
511
493
|
* ID of the certification to filter applications by
|
|
512
494
|
* @example "certification123"
|
|
@@ -563,7 +545,7 @@ export interface Input36F4Tt4Jxa {
|
|
|
563
545
|
*/
|
|
564
546
|
ignoreCompletedCertifications?: boolean | null;
|
|
565
547
|
}
|
|
566
|
-
export interface
|
|
548
|
+
export interface InputW6Ogy13Eka {
|
|
567
549
|
/**
|
|
568
550
|
* ID of the certification to filter applications by
|
|
569
551
|
* @example "certification123"
|
|
@@ -620,7 +602,7 @@ export interface Input2Xewbjzunb {
|
|
|
620
602
|
*/
|
|
621
603
|
ignoreCompletedCertifications?: boolean | null;
|
|
622
604
|
}
|
|
623
|
-
export interface
|
|
605
|
+
export interface InputPv1T1Jl6F2 {
|
|
624
606
|
/**
|
|
625
607
|
* The ID of the certificate specifications to be used for the email
|
|
626
608
|
* @example "certSpecsID123"
|
|
@@ -661,7 +643,7 @@ export interface InputV3Qfis9943 {
|
|
|
661
643
|
emailAddress: string;
|
|
662
644
|
}[];
|
|
663
645
|
}
|
|
664
|
-
export interface
|
|
646
|
+
export interface Input8Cpolmn5Gd {
|
|
665
647
|
/**
|
|
666
648
|
* The ID of the product for which the license is being redeemed
|
|
667
649
|
* @example "productID123"
|
|
@@ -673,7 +655,7 @@ export interface InputLjapkp800K {
|
|
|
673
655
|
*/
|
|
674
656
|
sessionID?: string;
|
|
675
657
|
}
|
|
676
|
-
export interface
|
|
658
|
+
export interface Input9Majdwna3Q {
|
|
677
659
|
/**
|
|
678
660
|
* Search term to filter licenses
|
|
679
661
|
* @example "active"
|
|
@@ -690,7 +672,7 @@ export interface InputCsz2Jddceqg {
|
|
|
690
672
|
*/
|
|
691
673
|
sortField?: any;
|
|
692
674
|
}
|
|
693
|
-
export interface
|
|
675
|
+
export interface InputLtxjeae09S {
|
|
694
676
|
/**
|
|
695
677
|
* Search term to filter licenses
|
|
696
678
|
* @example "active"
|
|
@@ -742,10 +724,11 @@ export interface NcsoReportExportRequestSchema {
|
|
|
742
724
|
}
|
|
743
725
|
/** Report export as xlsx */
|
|
744
726
|
export interface ReportXLSXSchema {
|
|
745
|
-
|
|
727
|
+
/** @format binary */
|
|
728
|
+
xlsxStream: File;
|
|
746
729
|
contentType: ReportXlsxSchemaContentTypeEnum;
|
|
747
730
|
}
|
|
748
|
-
export interface
|
|
731
|
+
export interface Input7Edbrvo147 {
|
|
749
732
|
/**
|
|
750
733
|
* Start date for the report
|
|
751
734
|
* @example "2023-01-01T00:00:00Z"
|
|
@@ -767,11 +750,11 @@ export interface Input80Fhicjw8R {
|
|
|
767
750
|
*/
|
|
768
751
|
dateType?: string;
|
|
769
752
|
}
|
|
770
|
-
export interface
|
|
753
|
+
export interface InputXvj8A557B8 {
|
|
771
754
|
/** List of user IDs to search for in the tenant. */
|
|
772
755
|
IDs: (string | null)[];
|
|
773
756
|
}
|
|
774
|
-
export interface
|
|
757
|
+
export interface Input5Me4Tjplpx {
|
|
775
758
|
/** The term to search for in the user profiles. */
|
|
776
759
|
searchTerm?: string | null;
|
|
777
760
|
/** Filter criteria for the user search. */
|
|
@@ -811,7 +794,7 @@ export interface InputJx8Xphf53G {
|
|
|
811
794
|
};
|
|
812
795
|
};
|
|
813
796
|
}
|
|
814
|
-
export interface
|
|
797
|
+
export interface InputWn5Qm2Uk5Fg {
|
|
815
798
|
/** The term to search for in the user profiles. */
|
|
816
799
|
searchTerm?: string | null;
|
|
817
800
|
/** Filter criteria for the user search. */
|
|
@@ -851,21 +834,21 @@ export interface InputVyjyqo4Fqig {
|
|
|
851
834
|
};
|
|
852
835
|
};
|
|
853
836
|
}
|
|
854
|
-
|
|
855
|
-
export type ExternalID2 = number;
|
|
856
|
-
export interface Output2Ap8L2U1E4 {
|
|
837
|
+
export interface Output9Z8H0F51Tv {
|
|
857
838
|
/** External system ID 2 */
|
|
858
839
|
userCount: ExternalID2;
|
|
859
840
|
transactionID?: string | null;
|
|
860
841
|
}
|
|
861
|
-
|
|
842
|
+
/** External system ID 2 */
|
|
843
|
+
export type ExternalID2 = number;
|
|
844
|
+
export interface OutputIfjt2Mvan9 {
|
|
862
845
|
/**
|
|
863
846
|
* Signed URL for the course file
|
|
864
847
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
865
848
|
*/
|
|
866
849
|
fileURL: string;
|
|
867
850
|
}
|
|
868
|
-
export interface
|
|
851
|
+
export interface OutputRzdosg9Ruk {
|
|
869
852
|
/**
|
|
870
853
|
* Amount to be refunded for the cancellation
|
|
871
854
|
* @example 0
|
|
@@ -907,42 +890,6 @@ export interface OutputU7Gnd99Lsg {
|
|
|
907
890
|
*/
|
|
908
891
|
transactionID: string;
|
|
909
892
|
}
|
|
910
|
-
/** Timestamp when the application will be auto-unlocked */
|
|
911
|
-
export type AutoUnlockOn = number;
|
|
912
|
-
/** Certification number issued to the user */
|
|
913
|
-
export type CertNumber = string;
|
|
914
|
-
/** Original date of completion */
|
|
915
|
-
export type OriginalCompletionDate = number;
|
|
916
|
-
/** Date when the card was printed */
|
|
917
|
-
export type CardPrintedOn = number;
|
|
918
|
-
/** Completion date of the last related course */
|
|
919
|
-
export type LastCourseCompletionDate = number;
|
|
920
|
-
/** Date when manual override was applied */
|
|
921
|
-
export type ManualOverrideOn = number;
|
|
922
|
-
/** Stage of the certification process */
|
|
923
|
-
export type Stage = string;
|
|
924
|
-
/** Last state of the course within this stage */
|
|
925
|
-
export type StageLastCourseState = string;
|
|
926
|
-
/** Points achieved in the process */
|
|
927
|
-
export type PointsAchieved = number;
|
|
928
|
-
/** Pending payment value */
|
|
929
|
-
export type PendingPaymentValue = number;
|
|
930
|
-
/** Courses that are currently blocked */
|
|
931
|
-
export type BlockedCourses = string[];
|
|
932
|
-
/** Status information for trigger states (e.g., NEW, RENEW) */
|
|
933
|
-
export type TriggerState = Record<string, {
|
|
934
|
-
state?: string;
|
|
935
|
-
updatedOn?: number;
|
|
936
|
-
requestResult?: string;
|
|
937
|
-
}>;
|
|
938
|
-
/** Amount to be paid as commission */
|
|
939
|
-
export type CommissionAmount = number;
|
|
940
|
-
/** Recipient of the commission payment */
|
|
941
|
-
export type CommissionPayTo = string;
|
|
942
|
-
/** Amount of commission already paid */
|
|
943
|
-
export type CommissionPaid = number;
|
|
944
|
-
/** Comments related to the waiver */
|
|
945
|
-
export type WaivedComments = string;
|
|
946
893
|
/** Response with list of certification processes */
|
|
947
894
|
export interface CertificationProcessResponseSchema {
|
|
948
895
|
procs: {
|
|
@@ -1013,10 +960,46 @@ export interface CertificationProcessResponseSchema {
|
|
|
1013
960
|
/** Comments related to the waiver */
|
|
1014
961
|
waivedComments?: WaivedComments;
|
|
1015
962
|
/** Justification text for overwritten actions */
|
|
1016
|
-
overwrittenJustification?: OverwrittenJustification
|
|
963
|
+
overwrittenJustification?: OverwrittenJustification;
|
|
1017
964
|
}[] | null;
|
|
1018
965
|
transactionID?: string | null;
|
|
1019
966
|
}
|
|
967
|
+
/** Timestamp when the application will be auto-unlocked */
|
|
968
|
+
export type AutoUnlockOn = number;
|
|
969
|
+
/** Certification number issued to the user */
|
|
970
|
+
export type CertNumber = string;
|
|
971
|
+
/** Original date of completion */
|
|
972
|
+
export type OriginalCompletionDate = number;
|
|
973
|
+
/** Date when the card was printed */
|
|
974
|
+
export type CardPrintedOn = number;
|
|
975
|
+
/** Completion date of the last related course */
|
|
976
|
+
export type LastCourseCompletionDate = number;
|
|
977
|
+
/** Date when manual override was applied */
|
|
978
|
+
export type ManualOverrideOn = number;
|
|
979
|
+
/** Stage of the certification process */
|
|
980
|
+
export type Stage = string;
|
|
981
|
+
/** Last state of the course within this stage */
|
|
982
|
+
export type StageLastCourseState = string;
|
|
983
|
+
/** Points achieved in the process */
|
|
984
|
+
export type PointsAchieved = number;
|
|
985
|
+
/** Pending payment value */
|
|
986
|
+
export type PendingPaymentValue = number;
|
|
987
|
+
/** Courses that are currently blocked */
|
|
988
|
+
export type BlockedCourses = string[];
|
|
989
|
+
/** Status information for trigger states (e.g., NEW, RENEW) */
|
|
990
|
+
export type TriggerState = Record<string, {
|
|
991
|
+
state?: string;
|
|
992
|
+
updatedOn?: number;
|
|
993
|
+
requestResult?: string;
|
|
994
|
+
}>;
|
|
995
|
+
/** Amount to be paid as commission */
|
|
996
|
+
export type CommissionAmount = number;
|
|
997
|
+
/** Recipient of the commission payment */
|
|
998
|
+
export type CommissionPayTo = string;
|
|
999
|
+
/** Amount of commission already paid */
|
|
1000
|
+
export type CommissionPaid = number;
|
|
1001
|
+
/** Comments related to the waiver */
|
|
1002
|
+
export type WaivedComments = string;
|
|
1020
1003
|
/** Response schema for certification application data */
|
|
1021
1004
|
export interface CertificationApplicationResponseEntity {
|
|
1022
1005
|
/** @example 1717230000000 */
|
|
@@ -1071,8 +1054,6 @@ export interface CertificationApplicationResponseEntity {
|
|
|
1071
1054
|
/** @example ["ITEM#2"] */
|
|
1072
1055
|
blacklistedItems?: string[];
|
|
1073
1056
|
}
|
|
1074
|
-
/** Label of the course enrolled (course version) */
|
|
1075
|
-
export type OnlineCourseLabel = string;
|
|
1076
1057
|
/** Single course object */
|
|
1077
1058
|
export interface CourseResponseEntity {
|
|
1078
1059
|
/** Timestamp of when the record was created */
|
|
@@ -1156,7 +1137,9 @@ export interface CourseResponseEntity {
|
|
|
1156
1137
|
/** Justifications for overridden course restrictions */
|
|
1157
1138
|
overwrittenJustification?: OverwrittenJustification;
|
|
1158
1139
|
}
|
|
1159
|
-
|
|
1140
|
+
/** Label of the course enrolled (course version) */
|
|
1141
|
+
export type OnlineCourseLabel = string;
|
|
1142
|
+
export interface OutputQiqqw2Zinb {
|
|
1160
1143
|
/**
|
|
1161
1144
|
* Signed URL for the course file
|
|
1162
1145
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
@@ -1174,7 +1157,7 @@ export interface UserExpandedCPResponseSchema {
|
|
|
1174
1157
|
transactionID?: string | null;
|
|
1175
1158
|
}
|
|
1176
1159
|
/** Application Foreign Fill response type */
|
|
1177
|
-
export interface
|
|
1160
|
+
export interface OutputTj7Nzk0Ozcf {
|
|
1178
1161
|
items: {
|
|
1179
1162
|
userID: string;
|
|
1180
1163
|
createdOn?: number;
|
|
@@ -1203,20 +1186,6 @@ export interface OutputYh2G6Inklt {
|
|
|
1203
1186
|
}[];
|
|
1204
1187
|
}[];
|
|
1205
1188
|
}
|
|
1206
|
-
/** Composite ID (could be a derived or synthetic key) */
|
|
1207
|
-
export type CompositeID = string;
|
|
1208
|
-
/** Certification process ID */
|
|
1209
|
-
export type ProcID = string;
|
|
1210
|
-
/** Effective timestamp of this record (e.g., event time) */
|
|
1211
|
-
export type Timestamp = number;
|
|
1212
|
-
/** Source object ID (e.g., course, cert) */
|
|
1213
|
-
export type SourceID = string;
|
|
1214
|
-
/** Type of the source (e.g., COURSE or CERT) */
|
|
1215
|
-
export type SourceType = string;
|
|
1216
|
-
/** Expiration date of this entry, if applicable */
|
|
1217
|
-
export type ExpiresOn = number;
|
|
1218
|
-
/** Date when the result was achieved (e.g., passed) */
|
|
1219
|
-
export type ResultDate = number;
|
|
1220
1189
|
/** Response containing student history records */
|
|
1221
1190
|
export interface StudentHistoryResponseSchema {
|
|
1222
1191
|
items: {
|
|
@@ -1253,6 +1222,20 @@ export interface StudentHistoryResponseSchema {
|
|
|
1253
1222
|
}[];
|
|
1254
1223
|
transactionID?: string | null;
|
|
1255
1224
|
}
|
|
1225
|
+
/** Composite ID (could be a derived or synthetic key) */
|
|
1226
|
+
export type CompositeID = string;
|
|
1227
|
+
/** Certification process ID */
|
|
1228
|
+
export type ProcID = string;
|
|
1229
|
+
/** Effective timestamp of this record (e.g., event time) */
|
|
1230
|
+
export type Timestamp = number;
|
|
1231
|
+
/** Source object ID (e.g., course, cert) */
|
|
1232
|
+
export type SourceID = string;
|
|
1233
|
+
/** Type of the source (e.g., COURSE or CERT) */
|
|
1234
|
+
export type SourceType = string;
|
|
1235
|
+
/** Expiration date of this entry, if applicable */
|
|
1236
|
+
export type ExpiresOn = number;
|
|
1237
|
+
/** Date when the result was achieved (e.g., passed) */
|
|
1238
|
+
export type ResultDate = number;
|
|
1256
1239
|
/** Response with list of user certification processes and it's upcoming courses and sessions */
|
|
1257
1240
|
export interface UserUpcomingCoursesResponseSchema {
|
|
1258
1241
|
procs?: {
|
|
@@ -1263,67 +1246,6 @@ export interface UserUpcomingCoursesResponseSchema {
|
|
|
1263
1246
|
};
|
|
1264
1247
|
transactionID?: string | null;
|
|
1265
1248
|
}
|
|
1266
|
-
/** Timestamp when user agreed to terms */
|
|
1267
|
-
export type AgreedOnTerms = number;
|
|
1268
|
-
/** Whether user agreed with certification terms */
|
|
1269
|
-
export type AgreedWithCertTerms = boolean;
|
|
1270
|
-
/** Map of member numbers keyed by string */
|
|
1271
|
-
export type MemberNumber = Record<string, string>;
|
|
1272
|
-
/** Name to appear on certificate */
|
|
1273
|
-
export type CertNameOnCertificate = string;
|
|
1274
|
-
/** Map of certification dates keyed by string */
|
|
1275
|
-
export type CertificationDate = Record<string, number>;
|
|
1276
|
-
/** Map of original certification dates keyed by string */
|
|
1277
|
-
export type CertificationOriginalDate = Record<string, number>;
|
|
1278
|
-
/** Map of certification expiration dates keyed by string */
|
|
1279
|
-
export type CertificationExpirationDate = Record<string, number>;
|
|
1280
|
-
/** Name of the company associated with the user */
|
|
1281
|
-
export type CompanyName = string;
|
|
1282
|
-
/** User email address */
|
|
1283
|
-
export type Email = string;
|
|
1284
|
-
/** Email address used to send emails on behalf of user */
|
|
1285
|
-
export type SendEmailAs = string;
|
|
1286
|
-
/** User first name */
|
|
1287
|
-
export type FirstName = string;
|
|
1288
|
-
/** User last name */
|
|
1289
|
-
export type LastName = string;
|
|
1290
|
-
/** Employer ID associated with the user */
|
|
1291
|
-
export type EmployerID = string;
|
|
1292
|
-
/** User phone number */
|
|
1293
|
-
export type PhoneNumber = string;
|
|
1294
|
-
/** ITA number of the user */
|
|
1295
|
-
export type ItaNumber = string;
|
|
1296
|
-
/** Whether user should receive gifts */
|
|
1297
|
-
export type SendGift = boolean;
|
|
1298
|
-
/** Preferred language of the user */
|
|
1299
|
-
export type PreferredLanguage = string;
|
|
1300
|
-
/** ID of the user who referred this user */
|
|
1301
|
-
export type ReferredByID = string;
|
|
1302
|
-
/** Name of the user who referred this user */
|
|
1303
|
-
export type ReferredByName = string;
|
|
1304
|
-
/** Timestamp of last signin */
|
|
1305
|
-
export type SigninDate = number;
|
|
1306
|
-
/** List of IDs of entities the user manages */
|
|
1307
|
-
export type ManagerOf = string[];
|
|
1308
|
-
/** List of IDs of entities the user is member of */
|
|
1309
|
-
export type MemberOf = string[];
|
|
1310
|
-
/** List of pending invitation IDs */
|
|
1311
|
-
export type PendingInvitations = string[];
|
|
1312
|
-
/** Whether the user is sponsored */
|
|
1313
|
-
export type IsSponsored = boolean;
|
|
1314
|
-
/** External system ID 1 */
|
|
1315
|
-
export type ExternalID = string;
|
|
1316
|
-
/** Whether the user is enabled */
|
|
1317
|
-
export type IsEnabled = boolean;
|
|
1318
|
-
/** Whether the user has opted out of having their certification information published to 3rd party integrations */
|
|
1319
|
-
export type CertifiedUserOptOut = boolean;
|
|
1320
|
-
export interface PartitionEntry {
|
|
1321
|
-
partID: string;
|
|
1322
|
-
userID: string;
|
|
1323
|
-
updateByApp?: string;
|
|
1324
|
-
updateOn?: number;
|
|
1325
|
-
value?: any;
|
|
1326
|
-
}
|
|
1327
1249
|
/** User data from IDM including user profile and partition data */
|
|
1328
1250
|
export interface UserDataResponse {
|
|
1329
1251
|
/** IDM user object */
|
|
@@ -1331,6 +1253,13 @@ export interface UserDataResponse {
|
|
|
1331
1253
|
/** User partition data from IDM */
|
|
1332
1254
|
partitions: PartitionEntry[];
|
|
1333
1255
|
}
|
|
1256
|
+
export interface PartitionEntry {
|
|
1257
|
+
partID: string;
|
|
1258
|
+
userID: string;
|
|
1259
|
+
updateByApp?: string;
|
|
1260
|
+
updateOn?: number;
|
|
1261
|
+
value?: any;
|
|
1262
|
+
}
|
|
1334
1263
|
/** Response schema for certification process data */
|
|
1335
1264
|
export interface CertificationProcessResponseEntity {
|
|
1336
1265
|
/** @example "abc123" */
|
|
@@ -1411,7 +1340,7 @@ export interface CertificationProcessResponseEntity {
|
|
|
1411
1340
|
applicationItems?: Record<string, any>[];
|
|
1412
1341
|
transactionID?: string | null;
|
|
1413
1342
|
}
|
|
1414
|
-
export interface
|
|
1343
|
+
export interface Input99Zaw9Tk82 {
|
|
1415
1344
|
issuedOn?: number;
|
|
1416
1345
|
expiresOn?: number;
|
|
1417
1346
|
fileItems?: {
|
|
@@ -1420,21 +1349,21 @@ export interface InputGhzia6Oe3O {
|
|
|
1420
1349
|
}[];
|
|
1421
1350
|
additionalNotes?: string | null;
|
|
1422
1351
|
}
|
|
1423
|
-
export interface
|
|
1352
|
+
export interface InputQ3Do7Gofkg {
|
|
1424
1353
|
/**
|
|
1425
1354
|
* Indicates whether the application is locked
|
|
1426
1355
|
* @example true
|
|
1427
1356
|
*/
|
|
1428
1357
|
isApplicationLocked: boolean;
|
|
1429
1358
|
}
|
|
1430
|
-
export interface
|
|
1359
|
+
export interface OutputIaczoxpov7 {
|
|
1431
1360
|
/**
|
|
1432
1361
|
* Signed URL for the course file
|
|
1433
1362
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
1434
1363
|
*/
|
|
1435
1364
|
fileURL: string;
|
|
1436
1365
|
}
|
|
1437
|
-
export interface
|
|
1366
|
+
export interface InputXnsxgjvb1H {
|
|
1438
1367
|
/**
|
|
1439
1368
|
* Indicates whether the waiver is approved
|
|
1440
1369
|
* @example true
|
|
@@ -1446,14 +1375,14 @@ export interface Input399F4Vzf2A {
|
|
|
1446
1375
|
*/
|
|
1447
1376
|
additionalNotes?: string | null;
|
|
1448
1377
|
}
|
|
1449
|
-
export interface
|
|
1378
|
+
export interface Input70Sgzfc3Wx {
|
|
1450
1379
|
/**
|
|
1451
1380
|
* Optional notes regarding the waiver
|
|
1452
1381
|
* @example "Waiver granted due to special circumstances."
|
|
1453
1382
|
*/
|
|
1454
1383
|
additionalNotes?: string | null;
|
|
1455
1384
|
}
|
|
1456
|
-
export interface
|
|
1385
|
+
export interface InputSroppfojv6K {
|
|
1457
1386
|
students: {
|
|
1458
1387
|
/**
|
|
1459
1388
|
* User ID of the student to redeem the course for
|
|
@@ -1487,7 +1416,7 @@ export interface InputWipuiyq3Gx {
|
|
|
1487
1416
|
*/
|
|
1488
1417
|
autoEnrolSessionID?: string;
|
|
1489
1418
|
}
|
|
1490
|
-
export interface
|
|
1419
|
+
export interface Input5Ugfzw40C7 {
|
|
1491
1420
|
invites: {
|
|
1492
1421
|
/**
|
|
1493
1422
|
* Email address of the user to invite
|
|
@@ -1516,7 +1445,7 @@ export interface InputS9Wa09Jr5M {
|
|
|
1516
1445
|
*/
|
|
1517
1446
|
isReservedSeat: boolean;
|
|
1518
1447
|
}
|
|
1519
|
-
export interface
|
|
1448
|
+
export interface InputFslpxre9K5 {
|
|
1520
1449
|
/**
|
|
1521
1450
|
* Indicates whether to waive the certification process
|
|
1522
1451
|
* @example true
|
|
@@ -1529,7 +1458,7 @@ export interface Input9Idwlxns6V {
|
|
|
1529
1458
|
comments?: string | null;
|
|
1530
1459
|
}
|
|
1531
1460
|
/** Certification move response schema */
|
|
1532
|
-
export interface
|
|
1461
|
+
export interface OutputOznnc1Tiod {
|
|
1533
1462
|
errors?: {
|
|
1534
1463
|
status: string;
|
|
1535
1464
|
object?: Record<string, any>;
|
|
@@ -1537,19 +1466,19 @@ export interface OutputAwpe8Eohm3 {
|
|
|
1537
1466
|
}[];
|
|
1538
1467
|
}
|
|
1539
1468
|
/** Schema for writing a certification trigger check. */
|
|
1540
|
-
export interface
|
|
1469
|
+
export interface Input855Mqx9Ife {
|
|
1541
1470
|
/**
|
|
1542
1471
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1543
1472
|
* @example "CHECKED"
|
|
1544
1473
|
*/
|
|
1545
|
-
value:
|
|
1474
|
+
value: Input855Mqx9IfeValueEnum;
|
|
1546
1475
|
/**
|
|
1547
1476
|
* List of course IDs that are blocked by this trigger check.
|
|
1548
1477
|
* @example ["course1","course2"]
|
|
1549
1478
|
*/
|
|
1550
1479
|
blockedCourses?: string[];
|
|
1551
1480
|
}
|
|
1552
|
-
export interface
|
|
1481
|
+
export interface Input2Gs17Nd76T {
|
|
1553
1482
|
/**
|
|
1554
1483
|
* Indicates whether the application item is approved
|
|
1555
1484
|
* @example true
|
|
@@ -1575,7 +1504,7 @@ export interface InputTnjt9Libv1 {
|
|
|
1575
1504
|
export interface StudentHistoryRequestSchema {
|
|
1576
1505
|
requirements: string[];
|
|
1577
1506
|
}
|
|
1578
|
-
export interface
|
|
1507
|
+
export interface InputLujyu5Wksr {
|
|
1579
1508
|
/**
|
|
1580
1509
|
* Optional activation key for the application
|
|
1581
1510
|
* @example "AK-123456"
|
|
@@ -1583,7 +1512,7 @@ export interface InputXx8Af8Xgud {
|
|
|
1583
1512
|
activationKey?: string;
|
|
1584
1513
|
}
|
|
1585
1514
|
/** Schema for course submission item details post request. */
|
|
1586
|
-
export interface
|
|
1515
|
+
export interface Input6I1Bxs84H3L {
|
|
1587
1516
|
/**
|
|
1588
1517
|
* The ID of the file being submitted.
|
|
1589
1518
|
* @example "fileID123"
|
|
@@ -1596,7 +1525,7 @@ export interface InputW1Wygqy1G9 {
|
|
|
1596
1525
|
fileName: string;
|
|
1597
1526
|
}
|
|
1598
1527
|
/** Schema for the response to course submission item details post request. */
|
|
1599
|
-
export interface
|
|
1528
|
+
export interface Output6I1Bxs84H3L {
|
|
1600
1529
|
submissionItems: {
|
|
1601
1530
|
/**
|
|
1602
1531
|
* The ID of the file being submitted.
|
|
@@ -1611,7 +1540,7 @@ export interface OutputW1Wygqy1G9 {
|
|
|
1611
1540
|
}[];
|
|
1612
1541
|
}
|
|
1613
1542
|
/** Pending approval submission parameters */
|
|
1614
|
-
export interface
|
|
1543
|
+
export interface Input3Rcv6Yb00R {
|
|
1615
1544
|
/**
|
|
1616
1545
|
* Type of pending approval
|
|
1617
1546
|
* @example "certification"
|
|
@@ -1631,7 +1560,7 @@ export interface InputKat1Qr6Mvq {
|
|
|
1631
1560
|
fileName: string;
|
|
1632
1561
|
}[];
|
|
1633
1562
|
}
|
|
1634
|
-
export interface
|
|
1563
|
+
export interface InputGlc2E59Kk9L {
|
|
1635
1564
|
/**
|
|
1636
1565
|
* The ID of the course for which the license is being redeemed
|
|
1637
1566
|
* @example "courseID123"
|
|
@@ -1699,7 +1628,7 @@ export interface Input5C1Vlfuer8 {
|
|
|
1699
1628
|
acknowledgement?: string | null;
|
|
1700
1629
|
}
|
|
1701
1630
|
/** Validate certification move response schema */
|
|
1702
|
-
export interface
|
|
1631
|
+
export interface Output76O169Co6C {
|
|
1703
1632
|
courses: {
|
|
1704
1633
|
name: string;
|
|
1705
1634
|
status: string;
|
|
@@ -1710,21 +1639,21 @@ export interface Output14Cjbffl65 {
|
|
|
1710
1639
|
validated: boolean;
|
|
1711
1640
|
mustCreateCP: boolean;
|
|
1712
1641
|
}
|
|
1713
|
-
export interface
|
|
1642
|
+
export interface InputL2P1Z0Aqu4 {
|
|
1714
1643
|
/**
|
|
1715
1644
|
* Comments regarding the end of the cooldown period
|
|
1716
1645
|
* @example "Cooldown period ended successfully."
|
|
1717
1646
|
*/
|
|
1718
1647
|
comments: string;
|
|
1719
1648
|
}
|
|
1720
|
-
export interface
|
|
1649
|
+
export interface Output4Ke1Srrjkh {
|
|
1721
1650
|
/**
|
|
1722
1651
|
* Signed URL for the course file
|
|
1723
1652
|
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
1724
1653
|
*/
|
|
1725
1654
|
fileURL: string;
|
|
1726
1655
|
}
|
|
1727
|
-
export interface
|
|
1656
|
+
export interface InputL85Rf6Yu4S {
|
|
1728
1657
|
/** @example true */
|
|
1729
1658
|
agreedWithCertTerms: boolean;
|
|
1730
1659
|
/** @example 1717230000000 */
|
|
@@ -1796,21 +1725,21 @@ export interface Input7All4Ddetf {
|
|
|
1796
1725
|
/** @example "EXT#999" */
|
|
1797
1726
|
externalID2?: string | null;
|
|
1798
1727
|
}
|
|
1799
|
-
export interface
|
|
1728
|
+
export interface InputSptz2Tlpfx {
|
|
1800
1729
|
/**
|
|
1801
1730
|
* Comments regarding the course unlock action
|
|
1802
1731
|
* @example "Course unlocked successfully."
|
|
1803
1732
|
*/
|
|
1804
1733
|
comments: string;
|
|
1805
1734
|
}
|
|
1806
|
-
export interface
|
|
1735
|
+
export interface InputD671Cmn9Zuh {
|
|
1807
1736
|
/**
|
|
1808
1737
|
* ITA number to update for the user
|
|
1809
1738
|
* @example "ITA123456"
|
|
1810
1739
|
*/
|
|
1811
1740
|
itaNumber: string;
|
|
1812
1741
|
}
|
|
1813
|
-
export interface
|
|
1742
|
+
export interface InputHsvokuuejrk {
|
|
1814
1743
|
/** @example true */
|
|
1815
1744
|
agreedWithCertTerms: boolean;
|
|
1816
1745
|
/** @example 1717230000000 */
|
|
@@ -1882,7 +1811,7 @@ export interface InputIqnpk7Aisr {
|
|
|
1882
1811
|
/** @example "EXT#999" */
|
|
1883
1812
|
externalID2?: string | null;
|
|
1884
1813
|
}
|
|
1885
|
-
export interface
|
|
1814
|
+
export interface InputHk2P73692C {
|
|
1886
1815
|
/**
|
|
1887
1816
|
* The grade to override the course result with
|
|
1888
1817
|
* @example "A"
|
|
@@ -1890,7 +1819,7 @@ export interface InputDafkg0Qaax {
|
|
|
1890
1819
|
resultGrade: string;
|
|
1891
1820
|
}
|
|
1892
1821
|
/** Pending approval review parameters */
|
|
1893
|
-
export interface
|
|
1822
|
+
export interface InputW84Bczs916 {
|
|
1894
1823
|
/**
|
|
1895
1824
|
* Notes provided by the reviewer for the pending approval
|
|
1896
1825
|
* @example "Please review the submitted documents."
|
|
@@ -1903,7 +1832,7 @@ export interface Input11X2Ed4Ag4 {
|
|
|
1903
1832
|
approved: boolean;
|
|
1904
1833
|
}
|
|
1905
1834
|
/** Schema for overriding course result dates. */
|
|
1906
|
-
export interface
|
|
1835
|
+
export interface InputWzlofwtvg7 {
|
|
1907
1836
|
/**
|
|
1908
1837
|
* The date when the course result expires, in milliseconds since epoch.
|
|
1909
1838
|
* @example 1735689600000
|
|
@@ -1915,18 +1844,22 @@ export interface Input61Papmu6Rw {
|
|
|
1915
1844
|
*/
|
|
1916
1845
|
completionDate?: number;
|
|
1917
1846
|
}
|
|
1918
|
-
export interface
|
|
1847
|
+
export interface Input0H8Vqfn2La {
|
|
1919
1848
|
filter: {
|
|
1920
1849
|
from?: number;
|
|
1921
1850
|
sortOrder?: string;
|
|
1922
1851
|
sortField?: string;
|
|
1923
1852
|
};
|
|
1924
1853
|
}
|
|
1925
|
-
export interface
|
|
1854
|
+
export interface Output0H8Vqfn2La {
|
|
1926
1855
|
users: {
|
|
1927
1856
|
firstName: string;
|
|
1928
1857
|
lastName: string;
|
|
1929
|
-
/**
|
|
1858
|
+
/**
|
|
1859
|
+
* Email address of the recipient
|
|
1860
|
+
* @format email
|
|
1861
|
+
* @example "jane.doe@example.com"
|
|
1862
|
+
*/
|
|
1930
1863
|
email: string;
|
|
1931
1864
|
phoneNumber?: string;
|
|
1932
1865
|
certNumber: string;
|
|
@@ -1942,7 +1875,7 @@ export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
|
1942
1875
|
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1943
1876
|
* @example "CHECKED"
|
|
1944
1877
|
*/
|
|
1945
|
-
export declare enum
|
|
1878
|
+
export declare enum Input855Mqx9IfeValueEnum {
|
|
1946
1879
|
CHECKED = "CHECKED",
|
|
1947
1880
|
UNCHECKED = "UNCHECKED",
|
|
1948
1881
|
NOVALUE = "NOVALUE"
|
|
@@ -2035,7 +1968,7 @@ export type CreateSearchUsersTermData = any;
|
|
|
2035
1968
|
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2036
1969
|
export type CreateReportUsersSimpleData = any;
|
|
2037
1970
|
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2038
|
-
export type CreateSearchUsersCountData =
|
|
1971
|
+
export type CreateSearchUsersCountData = Output9Z8H0F51Tv;
|
|
2039
1972
|
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2040
1973
|
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2041
1974
|
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
@@ -2059,7 +1992,7 @@ export type CreateCertificationApplicationData = any;
|
|
|
2059
1992
|
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2060
1993
|
export type DeleteCertificationCourseFileSignData = any;
|
|
2061
1994
|
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2062
|
-
export type GetCertificationCourseFileSignData =
|
|
1995
|
+
export type GetCertificationCourseFileSignData = OutputQiqqw2Zinb;
|
|
2063
1996
|
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2064
1997
|
export interface CreateCertificationCourseFileSignParams {
|
|
2065
1998
|
/** @example "pdf" */
|
|
@@ -2073,11 +2006,11 @@ export interface CreateCertificationCourseFileSignParams {
|
|
|
2073
2006
|
/** @example "fileID" */
|
|
2074
2007
|
fileId: string;
|
|
2075
2008
|
}
|
|
2076
|
-
export type CreateCertificationCourseFileSignData =
|
|
2009
|
+
export type CreateCertificationCourseFileSignData = Output4Ke1Srrjkh;
|
|
2077
2010
|
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2078
2011
|
export type DeleteCertificationCourseDocumentData = any;
|
|
2079
2012
|
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2080
|
-
export type CreateCertificationCourseDocumentData =
|
|
2013
|
+
export type CreateCertificationCourseDocumentData = Output6I1Bxs84H3L;
|
|
2081
2014
|
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2082
2015
|
export type DeleteUserData = any;
|
|
2083
2016
|
export type DeleteUserError = ErrorResponse;
|
|
@@ -2089,7 +2022,7 @@ export type UpdateUserData = any;
|
|
|
2089
2022
|
export type UpdateUserError = ErrorResponse;
|
|
2090
2023
|
export type DeleteCertificationCourseData = any;
|
|
2091
2024
|
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2092
|
-
export type GetCertificationApplicationItemFileData =
|
|
2025
|
+
export type GetCertificationApplicationItemFileData = OutputIfjt2Mvan9;
|
|
2093
2026
|
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2094
2027
|
export interface CreateCertificationApplicationItemFileParams {
|
|
2095
2028
|
/** @example "pdf" */
|
|
@@ -2103,9 +2036,9 @@ export interface CreateCertificationApplicationItemFileParams {
|
|
|
2103
2036
|
/** @example "fileVersion" */
|
|
2104
2037
|
fileVersion: string;
|
|
2105
2038
|
}
|
|
2106
|
-
export type CreateCertificationApplicationItemFileData =
|
|
2039
|
+
export type CreateCertificationApplicationItemFileData = OutputIaczoxpov7;
|
|
2107
2040
|
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2108
|
-
export type GetCertificationCourseSessionCalcCancelationChargesData =
|
|
2041
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputRzdosg9Ruk;
|
|
2109
2042
|
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2110
2043
|
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2111
2044
|
export type GetCertificationsError = ErrorResponse;
|
|
@@ -2113,7 +2046,7 @@ export type GetCourseData = CourseResponseEntity;
|
|
|
2113
2046
|
export type GetCourseError = ErrorResponse;
|
|
2114
2047
|
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2115
2048
|
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2116
|
-
export type GetCertificationApplicationForeignFillData =
|
|
2049
|
+
export type GetCertificationApplicationForeignFillData = OutputTj7Nzk0Ozcf;
|
|
2117
2050
|
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2118
2051
|
export type GetCertificationPrintData = any;
|
|
2119
2052
|
export type GetCertificationPrintError = ErrorResponse;
|
|
@@ -2147,7 +2080,7 @@ export type CreateCertificationRestartData = any;
|
|
|
2147
2080
|
export type CreateCertificationRestartError = ErrorResponse;
|
|
2148
2081
|
export type CreateCertificationWaiveData = any;
|
|
2149
2082
|
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2150
|
-
export type CreateCertificationMoveData =
|
|
2083
|
+
export type CreateCertificationMoveData = OutputOznnc1Tiod;
|
|
2151
2084
|
export type CreateCertificationMoveError = ErrorResponse;
|
|
2152
2085
|
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2153
2086
|
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
@@ -2175,7 +2108,7 @@ export type UpdateCertificationCoursePendingApprovalData = any;
|
|
|
2175
2108
|
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2176
2109
|
export type CreateCertificationCourseRedeemData = any;
|
|
2177
2110
|
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2178
|
-
export type CreateCertificationMoveValidateData =
|
|
2111
|
+
export type CreateCertificationMoveValidateData = Output76O169Co6C;
|
|
2179
2112
|
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2180
2113
|
export type CreateCertificationCourseEndCooldownData = any;
|
|
2181
2114
|
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
@@ -2189,7 +2122,7 @@ export type UpdateCertificationSetDatesData = any;
|
|
|
2189
2122
|
export type UpdateCertificationSetDatesError = ErrorResponse;
|
|
2190
2123
|
export type CreateCertificationPublishInfoData = any;
|
|
2191
2124
|
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2192
|
-
export type CreateCertificationResult =
|
|
2125
|
+
export type CreateCertificationResult = Output0H8Vqfn2La;
|
|
2193
2126
|
export type CreateCertificationFail = ErrorResponse;
|
|
2194
2127
|
export type CreateCertificationPublishInfoResult = any;
|
|
2195
2128
|
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
@@ -2236,7 +2169,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2236
2169
|
}
|
|
2237
2170
|
/**
|
|
2238
2171
|
* @title BCCSA Program API
|
|
2239
|
-
* @version 3.0.
|
|
2172
|
+
* @version 3.0.21
|
|
2240
2173
|
* @baseUrl http://localhost:8080
|
|
2241
2174
|
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2242
2175
|
*/
|
|
@@ -2251,7 +2184,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2251
2184
|
* @request POST:/contactUs
|
|
2252
2185
|
* @secure
|
|
2253
2186
|
*/
|
|
2254
|
-
listContactUs: (data:
|
|
2187
|
+
listContactUs: (data: InputIehpmmhp5S, params?: RequestParams) => Promise<any>;
|
|
2255
2188
|
};
|
|
2256
2189
|
customer: {
|
|
2257
2190
|
/**
|
|
@@ -2355,7 +2288,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2355
2288
|
* @request POST:/tenant/report/applicationExport
|
|
2356
2289
|
* @secure
|
|
2357
2290
|
*/
|
|
2358
|
-
createReportApplicationExport: (data:
|
|
2291
|
+
createReportApplicationExport: (data: InputFkhhceghyzl, params?: RequestParams) => Promise<any>;
|
|
2359
2292
|
/**
|
|
2360
2293
|
* @description Export a report of applications based on the provided filters.
|
|
2361
2294
|
*
|
|
@@ -2365,7 +2298,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2365
2298
|
* @request POST:/tenant/report/applicationStatus
|
|
2366
2299
|
* @secure
|
|
2367
2300
|
*/
|
|
2368
|
-
listReportApplicationStatus: (data:
|
|
2301
|
+
listReportApplicationStatus: (data: InputTqw0Engz1K, params?: RequestParams) => Promise<any>;
|
|
2369
2302
|
/**
|
|
2370
2303
|
* @description Export a report of applications based on the provided filters.
|
|
2371
2304
|
*
|
|
@@ -2375,7 +2308,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2375
2308
|
* @request POST:/tenant/report/applicationsReport
|
|
2376
2309
|
* @secure
|
|
2377
2310
|
*/
|
|
2378
|
-
createReportApplicationsReport: (data:
|
|
2311
|
+
createReportApplicationsReport: (data: InputW6Ogy13Eka, params?: RequestParams) => Promise<any>;
|
|
2379
2312
|
/**
|
|
2380
2313
|
* @description This route allows you to post certificates email for the tenant.
|
|
2381
2314
|
*
|
|
@@ -2385,7 +2318,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2385
2318
|
* @request POST:/tenant/certificates/email
|
|
2386
2319
|
* @secure
|
|
2387
2320
|
*/
|
|
2388
|
-
createCertificatesEmail: (data:
|
|
2321
|
+
createCertificatesEmail: (data: InputPv1T1Jl6F2, params?: RequestParams) => Promise<any>;
|
|
2389
2322
|
/**
|
|
2390
2323
|
* @description Generate a preview of the completed certifications report.
|
|
2391
2324
|
*
|
|
@@ -2415,7 +2348,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2415
2348
|
* @request POST:/tenant/license/redeem/{userID}
|
|
2416
2349
|
* @secure
|
|
2417
2350
|
*/
|
|
2418
|
-
createLicenseRedeem: (userId: string, data:
|
|
2351
|
+
createLicenseRedeem: (userId: string, data: Input8Cpolmn5Gd, params?: RequestParams) => Promise<any>;
|
|
2419
2352
|
/**
|
|
2420
2353
|
* @description Generate a of the organization licenses report based on search filters.
|
|
2421
2354
|
*
|
|
@@ -2425,7 +2358,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2425
2358
|
* @request POST:/tenant/report/orglicenses/
|
|
2426
2359
|
* @secure
|
|
2427
2360
|
*/
|
|
2428
|
-
listReportOrglicenses: (data:
|
|
2361
|
+
listReportOrglicenses: (data: Input9Majdwna3Q, params?: RequestParams) => Promise<any>;
|
|
2429
2362
|
/**
|
|
2430
2363
|
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2431
2364
|
*
|
|
@@ -2435,7 +2368,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2435
2368
|
* @request POST:/tenant/report/orglicenses/preview
|
|
2436
2369
|
* @secure
|
|
2437
2370
|
*/
|
|
2438
|
-
createReportOrglicensesPreview: (data:
|
|
2371
|
+
createReportOrglicensesPreview: (data: InputLtxjeae09S, params?: RequestParams) => Promise<any>;
|
|
2439
2372
|
/**
|
|
2440
2373
|
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2441
2374
|
*
|
|
@@ -2465,7 +2398,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2465
2398
|
* @request POST:/tenant/report/users/advanced
|
|
2466
2399
|
* @secure
|
|
2467
2400
|
*/
|
|
2468
|
-
createReportUsersAdvanced: (data:
|
|
2401
|
+
createReportUsersAdvanced: (data: Input7Edbrvo147, params?: RequestParams) => Promise<any>;
|
|
2469
2402
|
/**
|
|
2470
2403
|
* @description Searches for users in the tenant by their IDs.
|
|
2471
2404
|
*
|
|
@@ -2475,7 +2408,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2475
2408
|
* @request POST:/tenant/search/users/ids
|
|
2476
2409
|
* @secure
|
|
2477
2410
|
*/
|
|
2478
|
-
listSearchUsersIds: (data:
|
|
2411
|
+
listSearchUsersIds: (data: InputXvj8A557B8, params?: RequestParams) => Promise<any>;
|
|
2479
2412
|
/**
|
|
2480
2413
|
* @description Searches for users in the tenant by term and filters.
|
|
2481
2414
|
*
|
|
@@ -2485,7 +2418,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2485
2418
|
* @request POST:/tenant/search/users/term
|
|
2486
2419
|
* @secure
|
|
2487
2420
|
*/
|
|
2488
|
-
createSearchUsersTerm: (data:
|
|
2421
|
+
createSearchUsersTerm: (data: Input5Me4Tjplpx, params?: RequestParams) => Promise<any>;
|
|
2489
2422
|
/**
|
|
2490
2423
|
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2491
2424
|
*
|
|
@@ -2495,7 +2428,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2495
2428
|
* @request POST:/tenant/report/users/simple
|
|
2496
2429
|
* @secure
|
|
2497
2430
|
*/
|
|
2498
|
-
createReportUsersSimple: (data:
|
|
2431
|
+
createReportUsersSimple: (data: InputWn5Qm2Uk5Fg, params?: RequestParams) => Promise<any>;
|
|
2499
2432
|
/**
|
|
2500
2433
|
* @description Retrieve user by ID.
|
|
2501
2434
|
*
|
|
@@ -2505,7 +2438,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2505
2438
|
* @request POST:/tenant/search/users/count
|
|
2506
2439
|
* @secure
|
|
2507
2440
|
*/
|
|
2508
|
-
createSearchUsersCount: (params?: RequestParams) => Promise<
|
|
2441
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<Output9Z8H0F51Tv>;
|
|
2509
2442
|
};
|
|
2510
2443
|
user: {
|
|
2511
2444
|
/**
|
|
@@ -2537,7 +2470,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2537
2470
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2538
2471
|
* @secure
|
|
2539
2472
|
*/
|
|
2540
|
-
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data:
|
|
2473
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: Input99Zaw9Tk82, params?: RequestParams) => Promise<any>;
|
|
2541
2474
|
/**
|
|
2542
2475
|
* @description Delete a certification process application by type.
|
|
2543
2476
|
*
|
|
@@ -2627,7 +2560,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2627
2560
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2628
2561
|
* @secure
|
|
2629
2562
|
*/
|
|
2630
|
-
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<
|
|
2563
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputQiqqw2Zinb>;
|
|
2631
2564
|
/**
|
|
2632
2565
|
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2633
2566
|
*
|
|
@@ -2637,7 +2570,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2637
2570
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2638
2571
|
* @secure
|
|
2639
2572
|
*/
|
|
2640
|
-
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<
|
|
2573
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<Output4Ke1Srrjkh>;
|
|
2641
2574
|
/**
|
|
2642
2575
|
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2643
2576
|
*
|
|
@@ -2657,7 +2590,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2657
2590
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2658
2591
|
* @secure
|
|
2659
2592
|
*/
|
|
2660
|
-
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data:
|
|
2593
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: Input6I1Bxs84H3L, params?: RequestParams) => Promise<Output6I1Bxs84H3L>;
|
|
2661
2594
|
/**
|
|
2662
2595
|
* @description Delete user by ID.
|
|
2663
2596
|
*
|
|
@@ -2687,7 +2620,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2687
2620
|
* @request POST:/user/{userID}
|
|
2688
2621
|
* @secure
|
|
2689
2622
|
*/
|
|
2690
|
-
createUser: (userId: string, data:
|
|
2623
|
+
createUser: (userId: string, data: InputL85Rf6Yu4S, params?: RequestParams) => Promise<any>;
|
|
2691
2624
|
/**
|
|
2692
2625
|
* @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.
|
|
2693
2626
|
*
|
|
@@ -2697,7 +2630,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2697
2630
|
* @request PUT:/user/{userID}
|
|
2698
2631
|
* @secure
|
|
2699
2632
|
*/
|
|
2700
|
-
updateUser: (userId: string, data:
|
|
2633
|
+
updateUser: (userId: string, data: InputHsvokuuejrk, params?: RequestParams) => Promise<any>;
|
|
2701
2634
|
/**
|
|
2702
2635
|
* @description Delete course from user
|
|
2703
2636
|
*
|
|
@@ -2717,7 +2650,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2717
2650
|
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2718
2651
|
* @secure
|
|
2719
2652
|
*/
|
|
2720
|
-
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<
|
|
2653
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputIfjt2Mvan9>;
|
|
2721
2654
|
/**
|
|
2722
2655
|
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2723
2656
|
*
|
|
@@ -2727,7 +2660,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2727
2660
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2728
2661
|
* @secure
|
|
2729
2662
|
*/
|
|
2730
|
-
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<
|
|
2663
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputIaczoxpov7>;
|
|
2731
2664
|
/**
|
|
2732
2665
|
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2733
2666
|
*
|
|
@@ -2737,7 +2670,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2737
2670
|
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2738
2671
|
* @secure
|
|
2739
2672
|
*/
|
|
2740
|
-
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<
|
|
2673
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputRzdosg9Ruk>;
|
|
2741
2674
|
/**
|
|
2742
2675
|
* @description Retrieves the certification processes for a user by their user ID.
|
|
2743
2676
|
*
|
|
@@ -2777,7 +2710,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2777
2710
|
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2778
2711
|
* @secure
|
|
2779
2712
|
*/
|
|
2780
|
-
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<
|
|
2713
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputTj7Nzk0Ozcf>;
|
|
2781
2714
|
/**
|
|
2782
2715
|
* @description This endpoint will print certificate
|
|
2783
2716
|
*
|
|
@@ -2837,7 +2770,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2837
2770
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2838
2771
|
* @secure
|
|
2839
2772
|
*/
|
|
2840
|
-
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data:
|
|
2773
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: InputQ3Do7Gofkg, params?: RequestParams) => Promise<any>;
|
|
2841
2774
|
/**
|
|
2842
2775
|
* @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.
|
|
2843
2776
|
*
|
|
@@ -2867,7 +2800,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2867
2800
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2868
2801
|
* @secure
|
|
2869
2802
|
*/
|
|
2870
|
-
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2803
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputXnsxgjvb1H, params?: RequestParams) => Promise<any>;
|
|
2871
2804
|
/**
|
|
2872
2805
|
* @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.
|
|
2873
2806
|
*
|
|
@@ -2877,7 +2810,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2877
2810
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2878
2811
|
* @secure
|
|
2879
2812
|
*/
|
|
2880
|
-
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data:
|
|
2813
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: Input70Sgzfc3Wx, params?: RequestParams) => Promise<any>;
|
|
2881
2814
|
/**
|
|
2882
2815
|
* @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.
|
|
2883
2816
|
*
|
|
@@ -2887,7 +2820,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2887
2820
|
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2888
2821
|
* @secure
|
|
2889
2822
|
*/
|
|
2890
|
-
createCertificationCourseBatchRedeem: (certSpecId: string, data:
|
|
2823
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputSroppfojv6K, params?: RequestParams) => Promise<any>;
|
|
2891
2824
|
/**
|
|
2892
2825
|
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2893
2826
|
*
|
|
@@ -2897,7 +2830,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2897
2830
|
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2898
2831
|
* @secure
|
|
2899
2832
|
*/
|
|
2900
|
-
createCertificationCourseBatchInvite: (certSpecId: string, data:
|
|
2833
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: Input5Ugfzw40C7, params?: RequestParams) => Promise<any>;
|
|
2901
2834
|
/**
|
|
2902
2835
|
* @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.
|
|
2903
2836
|
*
|
|
@@ -2937,7 +2870,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2937
2870
|
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2938
2871
|
* @secure
|
|
2939
2872
|
*/
|
|
2940
|
-
createCertificationWaive: (userId: string, certProcId: string, data:
|
|
2873
|
+
createCertificationWaive: (userId: string, certProcId: string, data: InputFslpxre9K5, params?: RequestParams) => Promise<any>;
|
|
2941
2874
|
/**
|
|
2942
2875
|
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
2943
2876
|
*
|
|
@@ -2947,7 +2880,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2947
2880
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2948
2881
|
* @secure
|
|
2949
2882
|
*/
|
|
2950
|
-
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
2883
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputOznnc1Tiod>;
|
|
2951
2884
|
/**
|
|
2952
2885
|
* @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.
|
|
2953
2886
|
*
|
|
@@ -2977,7 +2910,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2977
2910
|
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2978
2911
|
* @secure
|
|
2979
2912
|
*/
|
|
2980
|
-
createCertificationTriggerSet: (userId: string, certProcId: string, data:
|
|
2913
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: Input855Mqx9Ife, params?: RequestParams) => Promise<any>;
|
|
2981
2914
|
/**
|
|
2982
2915
|
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
2983
2916
|
*
|
|
@@ -3027,7 +2960,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3027
2960
|
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3028
2961
|
* @secure
|
|
3029
2962
|
*/
|
|
3030
|
-
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data:
|
|
2963
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: Input2Gs17Nd76T, params?: RequestParams) => Promise<any>;
|
|
3031
2964
|
/**
|
|
3032
2965
|
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3033
2966
|
*
|
|
@@ -3047,7 +2980,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3047
2980
|
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3048
2981
|
* @secure
|
|
3049
2982
|
*/
|
|
3050
|
-
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data:
|
|
2983
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputLujyu5Wksr, params?: RequestParams) => Promise<any>;
|
|
3051
2984
|
/**
|
|
3052
2985
|
* @description This route allows you to submit a pending approval.
|
|
3053
2986
|
*
|
|
@@ -3057,7 +2990,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3057
2990
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3058
2991
|
* @secure
|
|
3059
2992
|
*/
|
|
3060
|
-
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
2993
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: Input3Rcv6Yb00R, params?: RequestParams) => Promise<any>;
|
|
3061
2994
|
/**
|
|
3062
2995
|
* @description This route allows you to review a pending approval.
|
|
3063
2996
|
*
|
|
@@ -3067,7 +3000,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3067
3000
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3068
3001
|
* @secure
|
|
3069
3002
|
*/
|
|
3070
|
-
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data:
|
|
3003
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputW84Bczs916, params?: RequestParams) => Promise<any>;
|
|
3071
3004
|
/**
|
|
3072
3005
|
* @description Redeems a license for a user by product ID.
|
|
3073
3006
|
*
|
|
@@ -3077,7 +3010,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3077
3010
|
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3078
3011
|
* @secure
|
|
3079
3012
|
*/
|
|
3080
|
-
createCertificationCourseRedeem: (userId: string, certProcId: string, data:
|
|
3013
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputGlc2E59Kk9L, params?: RequestParams) => Promise<any>;
|
|
3081
3014
|
/**
|
|
3082
3015
|
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3083
3016
|
*
|
|
@@ -3087,7 +3020,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3087
3020
|
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3088
3021
|
* @secure
|
|
3089
3022
|
*/
|
|
3090
|
-
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<
|
|
3023
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<Output76O169Co6C>;
|
|
3091
3024
|
/**
|
|
3092
3025
|
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3093
3026
|
*
|
|
@@ -3097,7 +3030,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3097
3030
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3098
3031
|
* @secure
|
|
3099
3032
|
*/
|
|
3100
|
-
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data:
|
|
3033
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputL2P1Z0Aqu4, params?: RequestParams) => Promise<any>;
|
|
3101
3034
|
/**
|
|
3102
3035
|
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3103
3036
|
*
|
|
@@ -3107,7 +3040,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3107
3040
|
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3108
3041
|
* @secure
|
|
3109
3042
|
*/
|
|
3110
|
-
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data:
|
|
3043
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputSptz2Tlpfx, params?: RequestParams) => Promise<any>;
|
|
3111
3044
|
/**
|
|
3112
3045
|
* @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.
|
|
3113
3046
|
*
|
|
@@ -3117,7 +3050,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3117
3050
|
* @request POST:/user/{userID}/updateITA
|
|
3118
3051
|
* @secure
|
|
3119
3052
|
*/
|
|
3120
|
-
createUpdateIta: (userId: string, data:
|
|
3053
|
+
createUpdateIta: (userId: string, data: InputD671Cmn9Zuh, params?: RequestParams) => Promise<any>;
|
|
3121
3054
|
/**
|
|
3122
3055
|
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3123
3056
|
*
|
|
@@ -3127,7 +3060,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3127
3060
|
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3128
3061
|
* @secure
|
|
3129
3062
|
*/
|
|
3130
|
-
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data:
|
|
3063
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputHk2P73692C, params?: RequestParams) => Promise<any>;
|
|
3131
3064
|
/**
|
|
3132
3065
|
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3133
3066
|
*
|
|
@@ -3137,7 +3070,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3137
3070
|
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3138
3071
|
* @secure
|
|
3139
3072
|
*/
|
|
3140
|
-
updateCertificationSetDates: (userId: string, certProcId: string, data:
|
|
3073
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: InputWzlofwtvg7, params?: RequestParams) => Promise<any>;
|
|
3141
3074
|
/**
|
|
3142
3075
|
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3143
3076
|
*
|
|
@@ -3159,7 +3092,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3159
3092
|
* @request POST:/users/certification/{certSpecID}
|
|
3160
3093
|
* @secure
|
|
3161
3094
|
*/
|
|
3162
|
-
createCertification: (certSpecId: string, data:
|
|
3095
|
+
createCertification: (certSpecId: string, data: Input0H8Vqfn2La, params?: RequestParams) => Promise<Output0H8Vqfn2La>;
|
|
3163
3096
|
/**
|
|
3164
3097
|
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3165
3098
|
*
|