@ikonintegration/bccsa-program-api 3.0.0

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/dist/Api.d.ts ADDED
@@ -0,0 +1,2972 @@
1
+ /** Default API Error response */
2
+ export interface ErrorResponse {
3
+ /** Error message */
4
+ err: string;
5
+ /** Error code */
6
+ errCode: string;
7
+ }
8
+ export interface InputTprol08O25K {
9
+ /**
10
+ * Name of the person filling out the contact form
11
+ * @example "John Doe"
12
+ */
13
+ name: string;
14
+ /**
15
+ * Email address of the person filling out the contact form
16
+ * @format email
17
+ * @example "john@mail"
18
+ */
19
+ email: string;
20
+ /**
21
+ * Comments or message from the person filling out the contact form
22
+ * @example "I have a question about my account."
23
+ */
24
+ comments: string;
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
+ /** Response schema for user data */
111
+ export interface UserResponseEntity {
112
+ userResp?: {
113
+ applications?: {
114
+ /** @example 1717230000000 */
115
+ createdOn?: number;
116
+ /** @example "USR#abc" */
117
+ createdBy?: string;
118
+ /** @example "USR#xyz" */
119
+ updatedBy?: string;
120
+ /** @example 1717230000000 */
121
+ updatedOn?: number;
122
+ /** @example "prgCertificationApplication" */
123
+ dbEntity?: string;
124
+ /** @example "CUST#123" */
125
+ customerID: string;
126
+ /** @example "TEN#456" */
127
+ tenantID: string;
128
+ /** @example "USR#789" */
129
+ userID: string;
130
+ /** @example "CP#0001" */
131
+ certProcID: string;
132
+ /** @example "CERT#01" */
133
+ certificationID?: string;
134
+ /** @example "initial" */
135
+ type: string;
136
+ /** @example "LIC#999" */
137
+ licenseID?: string;
138
+ /** @example "LICINV#555" */
139
+ licenseInvalidateID?: string;
140
+ /** @example "submitted" */
141
+ state?: string;
142
+ /** @example 1717231111111 */
143
+ submittedOn?: number;
144
+ /** @example "USR#sub" */
145
+ submittedBy?: string;
146
+ /** @example "USR#rev" */
147
+ reviewedBy?: string;
148
+ /** @example 1717232222222 */
149
+ reviewedOn?: number;
150
+ /** @example "Everything looks good." */
151
+ reviewNotes?: string;
152
+ /** @example 1 */
153
+ reviewAcknowledge?: number;
154
+ /** @example [{"id":"ITEM#1","version":1,"type":"doc"}] */
155
+ submissionItems?: {
156
+ /** @example "ITEM#1" */
157
+ id?: string;
158
+ /** @example 1 */
159
+ version?: number;
160
+ /** @example "doc" */
161
+ type?: string;
162
+ }[];
163
+ /** @example ["ITEM#2"] */
164
+ blacklistedItems?: string[];
165
+ }[];
166
+ certificationProcesses?: {
167
+ /** @example "abc123" */
168
+ id: string;
169
+ /** @example "tenant001" */
170
+ tenantID: string;
171
+ /** @example "user001" */
172
+ userID: string;
173
+ /** @example "cert001" */
174
+ certificationID: string;
175
+ /** @example 1717000000000 */
176
+ createdOn?: number;
177
+ /** @example "admin" */
178
+ createdBy?: string;
179
+ /** @example "admin" */
180
+ updatedBy?: string;
181
+ /** @example 1717000000000 */
182
+ updatedOn?: number;
183
+ /** @example "prgCertificationProcess" */
184
+ dbEntity?: string;
185
+ /** @example "CERT-2025-XYZ" */
186
+ certNumber?: string;
187
+ /** @example 1717000000000 */
188
+ completionDate?: number;
189
+ /** @example 1716000000000 */
190
+ originalCompletionDate?: number;
191
+ /** @example 1717000000000 */
192
+ cardPrintedOn?: number;
193
+ /** @example 1717000000000 */
194
+ certificatePrintedOn?: number;
195
+ /** @example 1717000000000 */
196
+ shippingDate?: number;
197
+ /** @example 1717000000000 */
198
+ lastCourseCompletionDate?: number;
199
+ /** @example ["course1","course2"] */
200
+ blockedCourses?: string[];
201
+ triggerState?: Record<string, {
202
+ /** @example "triggered" */
203
+ state?: string;
204
+ /** @example 1717000000000 */
205
+ updatedOn?: number;
206
+ /** @example "OK" */
207
+ requestResult?: any;
208
+ }>;
209
+ /** @example 85 */
210
+ pointsAchieved?: number;
211
+ /** @example ["email1","email2"] */
212
+ expireReminders?: string[];
213
+ /** @example 1718000000000 */
214
+ expiryDate?: number;
215
+ /** @example "active" */
216
+ state?: string;
217
+ /** @example "completed" */
218
+ stage?: string;
219
+ /** @example "passed" */
220
+ stageLastCourseState?: string;
221
+ /** @example 1717000000000 */
222
+ manualOverrideOn?: number;
223
+ /** @example 120.5 */
224
+ pendingPaymentValue?: number;
225
+ /** @example "Manual override" */
226
+ overwrittenJustification?: string;
227
+ /** @example 15 */
228
+ commissionAmount?: number;
229
+ /** @example "affiliate001" */
230
+ commissionPayTo?: string;
231
+ /** @example 15 */
232
+ commissionPaid?: number;
233
+ /** @example "manager" */
234
+ waivedBy?: string;
235
+ /** @example 1717000000000 */
236
+ waivedOn?: number;
237
+ /** @example "Waived due to exception" */
238
+ waivedComments?: string;
239
+ }[];
240
+ courses?: {
241
+ /** Timestamp of when the record was created */
242
+ createdOn?: CreatedOn;
243
+ /** User who created the record */
244
+ createdBy?: CreatedBy;
245
+ /** User who last updated the record */
246
+ updatedBy?: UpdatedBy;
247
+ /** Timestamp of last update */
248
+ updateOn?: UpdateOn;
249
+ /** Entity identifier for Course */
250
+ dbEntity?: DbEntity;
251
+ /** Unique identifier of the course record */
252
+ id: Id;
253
+ /** Certification process ID linked to this course */
254
+ certProcID: CertProcID;
255
+ /** User ID associated with the course */
256
+ userID: UserID;
257
+ /** Customer ID associated with the course */
258
+ customerID: CustomerID;
259
+ /** Tenant ID associated with the course */
260
+ tenantID: TenantID;
261
+ /** Course ID reference */
262
+ courseID?: CourseID;
263
+ /** When cooldown started */
264
+ cooldownStartedOn?: CooldownStartedOn;
265
+ /** When cooldown was overwritten */
266
+ cooldownOverwrittenOn?: CooldownOverwrittenOn;
267
+ /** When course was locked */
268
+ courseLockedOn?: CourseLockedOn;
269
+ /** When course lock was overwritten */
270
+ courseLockOverwrittenOn?: CourseLockOverwrittenOn;
271
+ /** Voucher code for the license */
272
+ licenseVoucherCode?: LicenseVoucherCode;
273
+ /** License ID used in the course */
274
+ licenseID?: LicenseID;
275
+ /** ID for license invalidation */
276
+ licenseInvalidateID?: LicenseInvalidateID;
277
+ /** Session ticket ID for course access */
278
+ sessionTicketID?: SessionTicketID;
279
+ /** Session ID for course tracking */
280
+ sessionID?: SessionID;
281
+ /** Result of the course */
282
+ courseResult?: CourseResult;
283
+ /** Certificate number for the course */
284
+ courseCertNumber?: CourseCertNumber;
285
+ /** Date of course completion */
286
+ completionDate?: CompletionDate;
287
+ /** Date when certificate was printed */
288
+ certificatePrintedOn?: CertificatePrintedOn;
289
+ /** Date when card was printed */
290
+ cardPrintedOnDate?: CardPrintedOnDate;
291
+ /** Date of certificate/card shipping */
292
+ shippingDate?: ShippingDate;
293
+ /** Whether data is copied from an alternate certification process */
294
+ isCopiedFromAlternateCP?: IsCopiedFromAlternateCP;
295
+ /** Reminders sent before course expiry */
296
+ expireReminders?: ExpireReminders;
297
+ /** Expiration date of the course */
298
+ expiryDate?: ExpiryDate;
299
+ /** Key used for indexing expiryDate */
300
+ expiryDateKey?: ExpiryDateKey;
301
+ /** Whether the course has been invalidated */
302
+ invalidated?: Invalidated;
303
+ /** Whether a course retake has been requested */
304
+ retakeRequested?: RetakeRequested;
305
+ /** Current state of the course */
306
+ state?: State;
307
+ /** Approval state of the course */
308
+ approvalState?: ApprovalState;
309
+ /** Notes about the course approval process */
310
+ approvalNotes?: ApprovalNotes;
311
+ /** List of submitted files for the course */
312
+ submissionItems?: SubmissionItems;
313
+ /** User who waived the course requirement */
314
+ waivedBy?: WaivedBy;
315
+ /** Date when course was waived */
316
+ waivedOn?: WaivedOn;
317
+ /** Justifications for overridden course restrictions */
318
+ overwrittenJustification?: OverwrittenJustification;
319
+ }[];
320
+ };
321
+ transactionID?: string | null;
322
+ }
323
+ /** Associated Certification ID */
324
+ export type CertificationID = string;
325
+ /** Type of application */
326
+ export type Type = string;
327
+ /** Timestamp when the application was submitted */
328
+ export type SubmittedOn = number;
329
+ /** User who submitted the application */
330
+ export type SubmittedBy = string;
331
+ /** User who reviewed the application */
332
+ export type ReviewedBy = string;
333
+ /** Timestamp when the application was reviewed */
334
+ export type ReviewedOn = number;
335
+ /** Notes related to the review process */
336
+ export type ReviewNotes = string;
337
+ /** Whether the review was acknowledged */
338
+ export type ReviewAcknowledge = number;
339
+ /** Version of the submission item */
340
+ export type Version = number;
341
+ /** List of blacklisted item IDs for this application */
342
+ export type BlacklistedItems = string[];
343
+ /** Response schema for applications */
344
+ export interface ApplicationResponseSchema {
345
+ applications: {
346
+ /** Timestamp of when the application was created */
347
+ createdOn?: CreatedOn;
348
+ /** User who created the application */
349
+ createdBy?: CreatedBy;
350
+ /** User who last updated the application */
351
+ updatedBy?: UpdatedBy;
352
+ /** Timestamp of the last update */
353
+ updateOn?: UpdateOn;
354
+ /** Static identifier for the entity type */
355
+ dbEntity?: DbEntity;
356
+ /** Customer ID associated with the application */
357
+ customerID: CustomerID;
358
+ /** Tenant ID associated with the application */
359
+ tenantID: TenantID;
360
+ /** User ID for whom the application was submitted */
361
+ userID: UserID;
362
+ /** Certification Process ID related to this application */
363
+ certProcID: CertProcID;
364
+ /** Associated Certification ID */
365
+ certificationID?: CertificationID;
366
+ /** Type of application */
367
+ type: Type;
368
+ /** ID of the license involved in the application */
369
+ licenseID?: LicenseID;
370
+ /** ID of the license invalidation record */
371
+ licenseInvalidateID?: LicenseInvalidateID;
372
+ /** Current state of the application */
373
+ state?: State;
374
+ /** Timestamp when the application was submitted */
375
+ submittedOn?: SubmittedOn;
376
+ /** User who submitted the application */
377
+ submittedBy?: SubmittedBy;
378
+ /** User who reviewed the application */
379
+ reviewedBy?: ReviewedBy;
380
+ /** Timestamp when the application was reviewed */
381
+ reviewedOn?: ReviewedOn;
382
+ /** Notes related to the review process */
383
+ reviewNotes?: ReviewNotes;
384
+ /** Whether the review was acknowledged */
385
+ reviewAcknowledge?: ReviewAcknowledge;
386
+ /** 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
+ }[];
395
+ /** List of blacklisted item IDs for this application */
396
+ blacklistedItems?: BlacklistedItems;
397
+ }[] | null;
398
+ transactionID?: string | null;
399
+ }
400
+ /** Timestamp when the entry was last updated */
401
+ export type UpdatedOn = number;
402
+ /** Name of the user or entity */
403
+ export type Name = string;
404
+ /** Title of the certification process */
405
+ export type CertTitle = string;
406
+ /** User display name */
407
+ export type DisplayName = string;
408
+ /** ID of the submitted file */
409
+ export type FileID = string;
410
+ /** Name of the submitted file */
411
+ export type FileName = string;
412
+ /** Response schema for pending approvals */
413
+ export interface PendingApprovalResponseSchema {
414
+ paItems: {
415
+ /** User who created the pending approval entry */
416
+ createdBy: CreatedBy;
417
+ /** Timestamp when the pending approval was created */
418
+ createdOn: CreatedOn;
419
+ /** User who last updated the entry */
420
+ updatedBy?: UpdatedBy;
421
+ /** Timestamp when the entry was last updated */
422
+ updatedOn?: UpdatedOn;
423
+ /** Static identifier for the entity type */
424
+ dbEntity: DbEntity;
425
+ /** ID of the pending approval */
426
+ id: Id;
427
+ /** Type of pending approval */
428
+ type: Type;
429
+ /** User ID associated with the pending approval */
430
+ userID: UserID;
431
+ /** Name of the user or entity */
432
+ name?: Name;
433
+ /** Certification Process ID */
434
+ certProcID?: CertProcID;
435
+ /** Title of the certification process */
436
+ certTitle?: CertTitle;
437
+ /** Tenant ID */
438
+ tenantID: TenantID;
439
+ /** Course ID if applicable */
440
+ courseID?: CourseID;
441
+ /** User display name */
442
+ displayName?: DisplayName;
443
+ /** 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
+ }[];
450
+ }[] | null;
451
+ }
452
+ export interface InputN4Ndusy4P2 {
453
+ /**
454
+ * ID of the certification to filter applications by
455
+ * @example "certification123"
456
+ */
457
+ certificationID: string;
458
+ /**
459
+ * Type of application, can be null or omitted
460
+ * @example "typeA"
461
+ */
462
+ type?: string | null;
463
+ /**
464
+ * State of the application
465
+ * @example "submitted"
466
+ */
467
+ state: string;
468
+ /**
469
+ * Timestamp for the start of the submission date range
470
+ * @example 1672531200
471
+ */
472
+ submittedFrom?: number | null;
473
+ /**
474
+ * Timestamp for the end of the submission date range
475
+ * @example 1672617600
476
+ */
477
+ submittedTo?: number | null;
478
+ /**
479
+ * Timestamp for the start of the review date range
480
+ * @example 1672704000
481
+ */
482
+ reviewedFrom?: number | null;
483
+ /**
484
+ * Timestamp for the end of the review date range
485
+ * @example 1672790400
486
+ */
487
+ reviewedTo?: number | null;
488
+ /**
489
+ * Timestamp for the start of the creation date range
490
+ * @example 1672876800
491
+ */
492
+ createdFrom?: number | null;
493
+ /**
494
+ * Timestamp for the end of the creation date range
495
+ * @example 1672963200
496
+ */
497
+ createdTo?: number | null;
498
+ /**
499
+ * User course status, can be null or omitted. Used to filter applications based on user course status.
500
+ * @example "completed"
501
+ */
502
+ userCourseStatus?: string | null;
503
+ /**
504
+ * Flag to ignore completed certifications when filtering applications. Defaults to false if not provided.
505
+ * @example true
506
+ */
507
+ ignoreCompletedCertifications?: boolean | null;
508
+ }
509
+ export interface InputHay4A10Oxo {
510
+ /**
511
+ * ID of the certification to filter applications by
512
+ * @example "certification123"
513
+ */
514
+ certificationID: string;
515
+ }
516
+ export interface Input39Rlhyxzj2 {
517
+ /**
518
+ * ID of the certification to filter applications by
519
+ * @example "certification123"
520
+ */
521
+ certificationID: string;
522
+ /**
523
+ * Type of application, can be null or omitted
524
+ * @example "typeA"
525
+ */
526
+ type?: string | null;
527
+ /**
528
+ * State of the application
529
+ * @example "submitted"
530
+ */
531
+ state: string;
532
+ /**
533
+ * Timestamp for the start of the submission date range
534
+ * @example 1672531200
535
+ */
536
+ submittedFrom?: number | null;
537
+ /**
538
+ * Timestamp for the end of the submission date range
539
+ * @example 1672617600
540
+ */
541
+ submittedTo?: number | null;
542
+ /**
543
+ * Timestamp for the start of the review date range
544
+ * @example 1672704000
545
+ */
546
+ reviewedFrom?: number | null;
547
+ /**
548
+ * Timestamp for the end of the review date range
549
+ * @example 1672790400
550
+ */
551
+ reviewedTo?: number | null;
552
+ /**
553
+ * Timestamp for the start of the creation date range
554
+ * @example 1672876800
555
+ */
556
+ createdFrom?: number | null;
557
+ /**
558
+ * Timestamp for the end of the creation date range
559
+ * @example 1672963200
560
+ */
561
+ createdTo?: number | null;
562
+ /**
563
+ * User course status, can be null or omitted. Used to filter applications based on user course status.
564
+ * @example "completed"
565
+ */
566
+ userCourseStatus?: string | null;
567
+ /**
568
+ * Flag to ignore completed certifications when filtering applications. Defaults to false if not provided.
569
+ * @example true
570
+ */
571
+ ignoreCompletedCertifications?: boolean | null;
572
+ }
573
+ export interface InputLop7Riutcm {
574
+ /**
575
+ * The ID of the certificate specifications to be used for the email
576
+ * @example "certSpecsID123"
577
+ */
578
+ certSpecsID: string;
579
+ /**
580
+ * The ID of the course associated with the certificate
581
+ * @example "courseID456"
582
+ */
583
+ courseID: string;
584
+ /**
585
+ * Whether to CC administrators in the email
586
+ * @example true
587
+ */
588
+ ccAdmins?: boolean;
589
+ /** List of recipients who will receive the certificate email */
590
+ recipients: {
591
+ /**
592
+ * Full name of the recipient
593
+ * @example "Jane Doe"
594
+ */
595
+ name: string;
596
+ /**
597
+ * The date the recipient completed the course (format: yyyy-mm-dd)
598
+ * @example "2025-06-01"
599
+ */
600
+ completionDate: string;
601
+ /**
602
+ * The certificate number assigned to the recipient
603
+ * @example "CERT-0001"
604
+ */
605
+ certNum: string;
606
+ /**
607
+ * Email address of the recipient
608
+ * @format email
609
+ * @example "jane.doe@example.com"
610
+ */
611
+ emailAddress: string;
612
+ }[];
613
+ }
614
+ export interface InputGikxez8Kaz {
615
+ /**
616
+ * The ID of the product for which the license is being redeemed
617
+ * @example "productID123"
618
+ */
619
+ productID: string;
620
+ /**
621
+ * The ID of the session associated with the license redemption
622
+ * @example "sessionID456"
623
+ */
624
+ sessionID?: string;
625
+ }
626
+ export interface InputK0Mnve89M3 {
627
+ /**
628
+ * Search term to filter licenses
629
+ * @example "active"
630
+ */
631
+ searchTerm?: string;
632
+ /**
633
+ * Order of sorting, e.g., "asc" or "desc"
634
+ * @example "asc"
635
+ */
636
+ sortOrder?: any;
637
+ /**
638
+ * Field by which to sort the report
639
+ * @example "created_at"
640
+ */
641
+ sortField?: any;
642
+ }
643
+ export interface Input560Aguh4X3 {
644
+ /**
645
+ * Search term to filter licenses
646
+ * @example "active"
647
+ */
648
+ searchTerm?: string;
649
+ /**
650
+ * Start date for the report
651
+ * @example "2023-01-01T00:00:00Z"
652
+ */
653
+ from?: any;
654
+ /**
655
+ * Order of sorting, e.g., "asc" or "desc"
656
+ * @example "asc"
657
+ */
658
+ sortOrder?: any;
659
+ /**
660
+ * Field by which to sort the report
661
+ * @example "created_at"
662
+ */
663
+ sortField?: any;
664
+ }
665
+ /** Filters offered for NCSO export report */
666
+ export interface NcsoReportRequestSchema {
667
+ filters: {
668
+ originalCompletionDateFrom?: number;
669
+ originalCompletionDateTo?: number;
670
+ completionDateFrom?: number;
671
+ completionDateTo?: number;
672
+ expiryDateFrom?: number;
673
+ expiryDateTo?: number;
674
+ hideExpired?: boolean;
675
+ };
676
+ }
677
+ /** Report export as xlsx */
678
+ export interface ReportXLSXSchema {
679
+ xlsxStream: any;
680
+ contentType: ReportXlsxSchemaContentTypeEnum;
681
+ }
682
+ export interface InputK49I8Qntjc {
683
+ /**
684
+ * Start date for the report
685
+ * @example "2023-01-01T00:00:00Z"
686
+ */
687
+ from?: any;
688
+ /**
689
+ * End date for the report
690
+ * @example "2023-12-31T23:59:59Z"
691
+ */
692
+ to?: any;
693
+ /**
694
+ * List of columns to include in the report
695
+ * @example ["name","email","created_at"]
696
+ */
697
+ columns: string[];
698
+ /**
699
+ * Type of date to filter by, e.g., "created_at", "updated_at"
700
+ * @example "created_at"
701
+ */
702
+ dateType?: string;
703
+ }
704
+ export interface InputWxkq7Niqao {
705
+ /** List of user IDs to search for in the tenant. */
706
+ IDs: (string | null)[];
707
+ }
708
+ export interface InputG5Bir0Wo4E {
709
+ /** The term to search for in the user profiles. */
710
+ searchTerm?: string | null;
711
+ /** Filter criteria for the user search. */
712
+ filter: {
713
+ /** Quantifier for advanced search, used when searchTerm is ignored. */
714
+ quantifier?: string;
715
+ advancedFilters?: {
716
+ field?: string;
717
+ qualifier?: string;
718
+ value?: string | string[];
719
+ }[];
720
+ status?: string | null;
721
+ from?: number | null;
722
+ sortOrder?: string | null;
723
+ sortField?: string | null;
724
+ courseSpecsID?: string | string[];
725
+ registerDate1?: string | null;
726
+ registerDate2?: string | null;
727
+ certSpecsID?: string | string[];
728
+ signinDate1?: string | null;
729
+ signinDate2?: string | null;
730
+ organization?: string | null;
731
+ employerID?: string | null;
732
+ certExpDate1?: string | null;
733
+ certExpDate2?: string | null;
734
+ userCourseStatus?: string | null;
735
+ applicationFilters?: {
736
+ createdDate1?: number | null;
737
+ createdDate2?: number | null;
738
+ submittedDate1?: number | null;
739
+ submittedDate2?: number | null;
740
+ reviewedDate1?: number | null;
741
+ reviewedDate2?: number | null;
742
+ status?: string | null;
743
+ type?: string | null;
744
+ ignoreCompletedCertifications?: boolean;
745
+ };
746
+ };
747
+ }
748
+ export interface InputNdh9V3T3Og {
749
+ /** The term to search for in the user profiles. */
750
+ searchTerm?: string | null;
751
+ /** Filter criteria for the user search. */
752
+ filter: {
753
+ /** Quantifier for advanced search, used when searchTerm is ignored. */
754
+ quantifier?: string;
755
+ advancedFilters?: {
756
+ field?: string;
757
+ qualifier?: string;
758
+ value?: string | string[];
759
+ }[];
760
+ status?: string | null;
761
+ from?: number | null;
762
+ sortOrder?: string | null;
763
+ sortField?: string | null;
764
+ courseSpecsID?: string | string[];
765
+ registerDate1?: string | null;
766
+ registerDate2?: string | null;
767
+ certSpecsID?: string | string[];
768
+ signinDate1?: string | null;
769
+ signinDate2?: string | null;
770
+ organization?: string | null;
771
+ employerID?: string | null;
772
+ certExpDate1?: string | null;
773
+ certExpDate2?: string | null;
774
+ userCourseStatus?: string | null;
775
+ applicationFilters?: {
776
+ createdDate1?: number | null;
777
+ createdDate2?: number | null;
778
+ submittedDate1?: number | null;
779
+ submittedDate2?: number | null;
780
+ reviewedDate1?: number | null;
781
+ reviewedDate2?: number | null;
782
+ status?: string | null;
783
+ type?: string | null;
784
+ ignoreCompletedCertifications?: boolean;
785
+ };
786
+ };
787
+ }
788
+ export interface OutputKin04Ituf7 {
789
+ /**
790
+ * Signed URL for the course file
791
+ * @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"
792
+ */
793
+ fileURL: string;
794
+ }
795
+ export interface OutputDwlxivng9Li {
796
+ /**
797
+ * Amount to be refunded for the cancellation
798
+ * @example 0
799
+ */
800
+ refundAmount: number;
801
+ /**
802
+ * Shipping charges applicable for the cancellation
803
+ * @example 0
804
+ */
805
+ shippingCharges: number;
806
+ /**
807
+ * Total value paid for the course
808
+ * @example 0
809
+ */
810
+ valuePaid: number;
811
+ /**
812
+ * Price of the product associated with the course
813
+ * @example 0
814
+ */
815
+ productPrice: number;
816
+ /**
817
+ * Charge applied for the cancellation
818
+ * @example 0
819
+ */
820
+ cancelationCharge: number;
821
+ /**
822
+ * Taxes applicable on the cancellation
823
+ * @example 0
824
+ */
825
+ taxes: number;
826
+ /**
827
+ * ID of the original order, if applicable
828
+ * @example null
829
+ */
830
+ originalOrderID: string | null;
831
+ /**
832
+ * Transaction ID for the cancellation process
833
+ * @example "cmbtgpcd800240byldq29bqt0-cmbtgpcd800250bylby45corg"
834
+ */
835
+ transactionID: string;
836
+ }
837
+ /** Certification number issued to the user */
838
+ export type CertNumber = string;
839
+ /** Original date of completion */
840
+ export type OriginalCompletionDate = number;
841
+ /** Date when the card was printed */
842
+ export type CardPrintedOn = number;
843
+ /** Completion date of the last related course */
844
+ export type LastCourseCompletionDate = number;
845
+ /** Date when manual override was applied */
846
+ export type ManualOverrideOn = number;
847
+ /** Stage of the certification process */
848
+ export type Stage = string;
849
+ /** Last state of the course within this stage */
850
+ export type StageLastCourseState = string;
851
+ /** Points achieved in the process */
852
+ export type PointsAchieved = number;
853
+ /** Pending payment value */
854
+ export type PendingPaymentValue = number;
855
+ /** Courses that are currently blocked */
856
+ export type BlockedCourses = string[];
857
+ /** Status information for trigger states (e.g., NEW, RENEW) */
858
+ export type TriggerState = Record<string, {
859
+ state?: string;
860
+ updatedOn?: number;
861
+ requestResult?: string;
862
+ }>;
863
+ /** Amount to be paid as commission */
864
+ export type CommissionAmount = number;
865
+ /** Recipient of the commission payment */
866
+ export type CommissionPayTo = string;
867
+ /** Amount of commission already paid */
868
+ export type CommissionPaid = number;
869
+ /** Comments related to the waiver */
870
+ export type WaivedComments = string;
871
+ /** Response with list of certification processes */
872
+ export interface CertificationProcessResponseSchema {
873
+ procs: {
874
+ /** Unique identifier for the certification process */
875
+ id: Id;
876
+ /** Tenant ID associated with this certification process */
877
+ tenantID: TenantID;
878
+ /** User ID associated with this certification process */
879
+ userID: UserID;
880
+ /** ID of the certification being processed */
881
+ certificationID: CertificationID;
882
+ /** Timestamp of when the record was created */
883
+ createdOn?: CreatedOn;
884
+ /** User who created the record */
885
+ createdBy?: CreatedBy;
886
+ /** Timestamp of last update */
887
+ updatedOn?: UpdatedOn;
888
+ /** User who last updated the record */
889
+ updatedBy?: UpdatedBy;
890
+ /** Internal database entity identifier */
891
+ dbEntity?: DbEntity;
892
+ /** Certification number issued to the user */
893
+ certNumber?: CertNumber;
894
+ /** Date of certification completion */
895
+ completionDate?: CompletionDate;
896
+ /** Original date of completion */
897
+ originalCompletionDate?: OriginalCompletionDate;
898
+ /** Date when the card was printed */
899
+ cardPrintedOn?: CardPrintedOn;
900
+ /** Date when the certificate was printed */
901
+ certificatePrintedOn?: CertificatePrintedOn;
902
+ /** Shipping date of the certificate/card */
903
+ shippingDate?: ShippingDate;
904
+ /** Completion date of the last related course */
905
+ lastCourseCompletionDate?: LastCourseCompletionDate;
906
+ /** Expiration date of the certification */
907
+ expiryDate?: ExpiryDate;
908
+ /** Date when manual override was applied */
909
+ manualOverrideOn?: ManualOverrideOn;
910
+ /** State of the certification process */
911
+ state?: State;
912
+ /** Stage of the certification process */
913
+ stage?: Stage;
914
+ /** Last state of the course within this stage */
915
+ stageLastCourseState?: StageLastCourseState;
916
+ /** Points achieved in the process */
917
+ pointsAchieved?: PointsAchieved;
918
+ /** Pending payment value */
919
+ pendingPaymentValue?: PendingPaymentValue;
920
+ /** Courses that are currently blocked */
921
+ blockedCourses?: BlockedCourses;
922
+ /** List of reminder IDs sent before expiry */
923
+ expireReminders?: ExpireReminders;
924
+ /** Status information for trigger states (e.g., NEW, RENEW) */
925
+ triggerState?: TriggerState;
926
+ /** Amount to be paid as commission */
927
+ commissionAmount?: CommissionAmount;
928
+ /** Recipient of the commission payment */
929
+ commissionPayTo?: CommissionPayTo;
930
+ /** Amount of commission already paid */
931
+ commissionPaid?: CommissionPaid;
932
+ /** User who waived the certification */
933
+ waivedBy?: WaivedBy;
934
+ /** Date when the waiver occurred */
935
+ waivedOn?: WaivedOn;
936
+ /** Comments related to the waiver */
937
+ waivedComments?: WaivedComments;
938
+ /** Justification text for overwritten actions */
939
+ overwrittenJustification?: OverwrittenJustification & string;
940
+ }[] | null;
941
+ transactionID?: string | null;
942
+ }
943
+ /** Response schema for certification application data */
944
+ export interface CertificationApplicationResponseEntity {
945
+ /** Certification application details */
946
+ applicationResp: {
947
+ /** @example 1717230000000 */
948
+ createdOn?: number;
949
+ /** @example "USR#abc" */
950
+ createdBy?: string;
951
+ /** @example "USR#xyz" */
952
+ updatedBy?: string;
953
+ /** @example 1717230000000 */
954
+ updatedOn?: number;
955
+ /** @example "prgCertificationApplication" */
956
+ dbEntity?: string;
957
+ /** @example "CUST#123" */
958
+ customerID: string;
959
+ /** @example "TEN#456" */
960
+ tenantID: string;
961
+ /** @example "USR#789" */
962
+ userID: string;
963
+ /** @example "CP#0001" */
964
+ certProcID: string;
965
+ /** @example "CERT#01" */
966
+ certificationID?: string;
967
+ /** @example "initial" */
968
+ type: string;
969
+ /** @example "LIC#999" */
970
+ licenseID?: string;
971
+ /** @example "LICINV#555" */
972
+ licenseInvalidateID?: string;
973
+ /** @example "submitted" */
974
+ state?: string;
975
+ /** @example 1717231111111 */
976
+ submittedOn?: number;
977
+ /** @example "USR#sub" */
978
+ submittedBy?: string;
979
+ /** @example "USR#rev" */
980
+ reviewedBy?: string;
981
+ /** @example 1717232222222 */
982
+ reviewedOn?: number;
983
+ /** @example "Everything looks good." */
984
+ reviewNotes?: string;
985
+ /** @example 1 */
986
+ reviewAcknowledge?: number;
987
+ /** @example [{"id":"ITEM#1","version":1,"type":"doc"}] */
988
+ submissionItems?: {
989
+ /** @example "ITEM#1" */
990
+ id?: string;
991
+ /** @example 1 */
992
+ version?: number;
993
+ /** @example "doc" */
994
+ type?: string;
995
+ }[];
996
+ /** @example ["ITEM#2"] */
997
+ blacklistedItems?: string[];
998
+ };
999
+ }
1000
+ /** Single course object */
1001
+ export interface CourseResponseEntity {
1002
+ /** Timestamp of when the record was created */
1003
+ createdOn?: CreatedOn;
1004
+ /** User who created the record */
1005
+ createdBy?: CreatedBy;
1006
+ /** User who last updated the record */
1007
+ updatedBy?: UpdatedBy;
1008
+ /** Timestamp of last update */
1009
+ updateOn?: UpdateOn;
1010
+ /** Entity identifier for Course */
1011
+ dbEntity?: DbEntity;
1012
+ /** Unique identifier of the course record */
1013
+ id: Id;
1014
+ /** Certification process ID linked to this course */
1015
+ certProcID: CertProcID;
1016
+ /** User ID associated with the course */
1017
+ userID: UserID;
1018
+ /** Customer ID associated with the course */
1019
+ customerID: CustomerID;
1020
+ /** Tenant ID associated with the course */
1021
+ tenantID: TenantID;
1022
+ /** Course ID reference */
1023
+ courseID?: CourseID;
1024
+ /** When cooldown started */
1025
+ cooldownStartedOn?: CooldownStartedOn;
1026
+ /** When cooldown was overwritten */
1027
+ cooldownOverwrittenOn?: CooldownOverwrittenOn;
1028
+ /** When course was locked */
1029
+ courseLockedOn?: CourseLockedOn;
1030
+ /** When course lock was overwritten */
1031
+ courseLockOverwrittenOn?: CourseLockOverwrittenOn;
1032
+ /** Voucher code for the license */
1033
+ licenseVoucherCode?: LicenseVoucherCode;
1034
+ /** License ID used in the course */
1035
+ licenseID?: LicenseID;
1036
+ /** ID for license invalidation */
1037
+ licenseInvalidateID?: LicenseInvalidateID;
1038
+ /** Session ticket ID for course access */
1039
+ sessionTicketID?: SessionTicketID;
1040
+ /** Session ID for course tracking */
1041
+ sessionID?: SessionID;
1042
+ /** Result of the course */
1043
+ courseResult?: CourseResult;
1044
+ /** Certificate number for the course */
1045
+ courseCertNumber?: CourseCertNumber;
1046
+ /** Date of course completion */
1047
+ completionDate?: CompletionDate;
1048
+ /** Date when certificate was printed */
1049
+ certificatePrintedOn?: CertificatePrintedOn;
1050
+ /** Date when card was printed */
1051
+ cardPrintedOnDate?: CardPrintedOnDate;
1052
+ /** Date of certificate/card shipping */
1053
+ shippingDate?: ShippingDate;
1054
+ /** Whether data is copied from an alternate certification process */
1055
+ isCopiedFromAlternateCP?: IsCopiedFromAlternateCP;
1056
+ /** Reminders sent before course expiry */
1057
+ expireReminders?: ExpireReminders;
1058
+ /** Expiration date of the course */
1059
+ expiryDate?: ExpiryDate;
1060
+ /** Key used for indexing expiryDate */
1061
+ expiryDateKey?: ExpiryDateKey;
1062
+ /** Whether the course has been invalidated */
1063
+ invalidated?: Invalidated;
1064
+ /** Whether a course retake has been requested */
1065
+ retakeRequested?: RetakeRequested;
1066
+ /** Current state of the course */
1067
+ state?: State;
1068
+ /** Approval state of the course */
1069
+ approvalState?: ApprovalState;
1070
+ /** Notes about the course approval process */
1071
+ approvalNotes?: ApprovalNotes;
1072
+ /** List of submitted files for the course */
1073
+ submissionItems?: SubmissionItems;
1074
+ /** User who waived the course requirement */
1075
+ waivedBy?: WaivedBy;
1076
+ /** Date when course was waived */
1077
+ waivedOn?: WaivedOn;
1078
+ /** Justifications for overridden course restrictions */
1079
+ overwrittenJustification?: OverwrittenJustification;
1080
+ }
1081
+ export interface OutputI9462Kgjk6 {
1082
+ /**
1083
+ * Signed URL for the course file
1084
+ * @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"
1085
+ */
1086
+ fileURL: string;
1087
+ }
1088
+ /** Response with list of expanded certification processeses */
1089
+ export interface UserExpandedCPResponseSchema {
1090
+ procs?: {
1091
+ user?: Record<string, any>;
1092
+ courses?: Record<string, any>[];
1093
+ certificationProcesses?: Record<string, any>[];
1094
+ applications?: Record<string, any>[];
1095
+ };
1096
+ transactionID?: string | null;
1097
+ }
1098
+ /** Application Foreign Fill response type */
1099
+ export interface Output2A58Aiskxik {
1100
+ items: {
1101
+ userID: string;
1102
+ createdOn?: number;
1103
+ createdBy?: string;
1104
+ updatedBy?: string;
1105
+ updatedOn?: number;
1106
+ dbEntity: string;
1107
+ tenantID: string;
1108
+ compositeID: string;
1109
+ timestamp: number;
1110
+ sourceID: string;
1111
+ expiresOn?: number;
1112
+ resultDate?: number;
1113
+ isHistoric?: boolean;
1114
+ type?: string;
1115
+ procID?: string;
1116
+ sourceType?: string;
1117
+ issuedOn?: number;
1118
+ approvedBy?: string;
1119
+ rejectedBy?: string;
1120
+ reviewedOn?: number;
1121
+ additionalNotes?: string;
1122
+ fileItems?: {
1123
+ fileID: string;
1124
+ fileName: string;
1125
+ }[];
1126
+ }[];
1127
+ }
1128
+ /** Composite ID (could be a derived or synthetic key) */
1129
+ export type CompositeID = string;
1130
+ /** Certification process ID */
1131
+ export type ProcID = string;
1132
+ /** Effective timestamp of this record (e.g., event time) */
1133
+ export type Timestamp = number;
1134
+ /** Source object ID (e.g., course, cert) */
1135
+ export type SourceID = string;
1136
+ /** Type of the source (e.g., COURSE or CERT) */
1137
+ export type SourceType = string;
1138
+ /** Expiration date of this entry, if applicable */
1139
+ export type ExpiresOn = number;
1140
+ /** Date when the result was achieved (e.g., passed) */
1141
+ export type ResultDate = number;
1142
+ /** Response containing student history records */
1143
+ export interface StudentHistoryResponseSchema {
1144
+ items: {
1145
+ /** ID of the user who created this record */
1146
+ createdBy?: CreatedBy;
1147
+ /** Timestamp when this record was created */
1148
+ createdOn?: CreatedOn;
1149
+ /** ID of the user who last updated this record */
1150
+ updatedBy?: UpdatedBy;
1151
+ /** Timestamp of the last update */
1152
+ updateOn?: UpdateOn;
1153
+ /** Fixed database entity identifier */
1154
+ dbEntity: DbEntity;
1155
+ /** Composite ID (could be a derived or synthetic key) */
1156
+ compositeID: CompositeID;
1157
+ /** ID of the user associated with this history entry */
1158
+ userID: UserID;
1159
+ /** Certification process ID */
1160
+ procID: ProcID;
1161
+ /** Effective timestamp of this record (e.g., event time) */
1162
+ timestamp: Timestamp;
1163
+ /** Tenant that owns this record */
1164
+ tenantID: TenantID;
1165
+ /** Source object ID (e.g., course, cert) */
1166
+ sourceID: SourceID;
1167
+ /** Type of the source (e.g., COURSE or CERT) */
1168
+ sourceType: SourceType;
1169
+ /** Expiration date of this entry, if applicable */
1170
+ expiresOn?: ExpiresOn;
1171
+ /** The type/category of the student history record */
1172
+ type: Type;
1173
+ /** Date when the result was achieved (e.g., passed) */
1174
+ resultDate?: ResultDate;
1175
+ }[];
1176
+ transactionID?: string | null;
1177
+ }
1178
+ /** Response with list of user certification processes and it's upcoming courses and sessions */
1179
+ export interface UserUpcomingCoursesResponseSchema {
1180
+ procs?: {
1181
+ user?: Record<string, any>;
1182
+ courses?: Record<string, any>[];
1183
+ certificationProcesses?: Record<string, any>[];
1184
+ sessions?: Record<string, any>[];
1185
+ };
1186
+ transactionID?: string | null;
1187
+ }
1188
+ /** Timestamp when user agreed to terms */
1189
+ export type AgreedOnTerms = number;
1190
+ /** Whether user agreed with certification terms */
1191
+ export type AgreedWithCertTerms = boolean;
1192
+ /** Map of member numbers keyed by string */
1193
+ export type MemberNumber = Record<string, string>;
1194
+ /** Name to appear on certificate */
1195
+ export type CertNameOnCertificate = string;
1196
+ /** Map of certification dates keyed by string */
1197
+ export type CertificationDate = Record<string, number>;
1198
+ /** Map of original certification dates keyed by string */
1199
+ export type CertificationOriginalDate = Record<string, number>;
1200
+ /** Map of certification expiration dates keyed by string */
1201
+ export type CertificationExpirationDate = Record<string, number>;
1202
+ /** Name of the company associated with the user */
1203
+ export type CompanyName = string;
1204
+ /** User email address */
1205
+ export type Email = string;
1206
+ /** Email address used to send emails on behalf of user */
1207
+ export type SendEmailAs = string;
1208
+ /** User first name */
1209
+ export type FirstName = string;
1210
+ /** User last name */
1211
+ export type LastName = string;
1212
+ /** Employer ID associated with the user */
1213
+ export type EmployerID = string;
1214
+ /** User phone number */
1215
+ export type PhoneNumber = string;
1216
+ /** ITA number of the user */
1217
+ export type ItaNumber = string;
1218
+ /** Whether user should receive gifts */
1219
+ export type SendGift = boolean;
1220
+ /** Preferred language of the user */
1221
+ export type PreferredLanguage = string;
1222
+ /** ID of the user who referred this user */
1223
+ export type ReferredByID = string;
1224
+ /** Name of the user who referred this user */
1225
+ export type ReferredByName = string;
1226
+ /** Timestamp of last signin */
1227
+ export type SigninDate = number;
1228
+ /** List of IDs of entities the user manages */
1229
+ export type ManagerOf = string[];
1230
+ /** List of IDs of entities the user is member of */
1231
+ export type MemberOf = string[];
1232
+ /** List of pending invitation IDs */
1233
+ export type PendingInvitations = string[];
1234
+ /** Whether the user is sponsored */
1235
+ export type IsSponsored = boolean;
1236
+ /** External system ID 1 */
1237
+ export type ExternalID = string;
1238
+ /** External system ID 2 */
1239
+ export type ExternalID2 = string;
1240
+ /** Response schema for certification process data */
1241
+ export interface CertificationProcessResponseEntity {
1242
+ /** @example "abc123" */
1243
+ id: string;
1244
+ /** @example "tenant001" */
1245
+ tenantID: string;
1246
+ /** @example "user001" */
1247
+ userID: string;
1248
+ /** @example "cert001" */
1249
+ certificationID: string;
1250
+ /** @example 1717000000000 */
1251
+ createdOn?: number;
1252
+ /** @example "admin" */
1253
+ createdBy?: string;
1254
+ /** @example "admin" */
1255
+ updatedBy?: string;
1256
+ /** @example 1717000000000 */
1257
+ updatedOn?: number;
1258
+ /** @example "prgCertificationProcess" */
1259
+ dbEntity?: string;
1260
+ /** @example "CERT-2025-XYZ" */
1261
+ certNumber?: string;
1262
+ /** @example 1717000000000 */
1263
+ completionDate?: number;
1264
+ /** @example 1716000000000 */
1265
+ originalCompletionDate?: number;
1266
+ /** @example 1717000000000 */
1267
+ cardPrintedOn?: number;
1268
+ /** @example 1717000000000 */
1269
+ certificatePrintedOn?: number;
1270
+ /** @example 1717000000000 */
1271
+ shippingDate?: number;
1272
+ /** @example 1717000000000 */
1273
+ lastCourseCompletionDate?: number;
1274
+ /** @example ["course1","course2"] */
1275
+ blockedCourses?: string[];
1276
+ triggerState?: Record<string, {
1277
+ /** @example "triggered" */
1278
+ state?: string;
1279
+ /** @example 1717000000000 */
1280
+ updatedOn?: number;
1281
+ /** @example "OK" */
1282
+ requestResult?: any;
1283
+ }>;
1284
+ /** @example 85 */
1285
+ pointsAchieved?: number;
1286
+ /** @example ["email1","email2"] */
1287
+ expireReminders?: string[];
1288
+ /** @example 1718000000000 */
1289
+ expiryDate?: number;
1290
+ /** @example "active" */
1291
+ state?: string;
1292
+ /** @example "completed" */
1293
+ stage?: string;
1294
+ /** @example "passed" */
1295
+ stageLastCourseState?: string;
1296
+ /** @example 1717000000000 */
1297
+ manualOverrideOn?: number;
1298
+ /** @example 120.5 */
1299
+ pendingPaymentValue?: number;
1300
+ /** @example "Manual override" */
1301
+ overwrittenJustification?: string;
1302
+ /** @example 15 */
1303
+ commissionAmount?: number;
1304
+ /** @example "affiliate001" */
1305
+ commissionPayTo?: string;
1306
+ /** @example 15 */
1307
+ commissionPaid?: number;
1308
+ /** @example "manager" */
1309
+ waivedBy?: string;
1310
+ /** @example 1717000000000 */
1311
+ waivedOn?: number;
1312
+ /** @example "Waived due to exception" */
1313
+ waivedComments?: string;
1314
+ user?: Record<string, any>;
1315
+ courses?: Record<string, any>[];
1316
+ applications?: Record<string, any>[];
1317
+ applicationItems?: Record<string, any>[];
1318
+ transactionID?: string | null;
1319
+ }
1320
+ export interface InputJmsh67C6I {
1321
+ issuedOn?: number;
1322
+ expiresOn?: number;
1323
+ fileItems?: {
1324
+ fileID: string;
1325
+ fileName: string;
1326
+ }[];
1327
+ additionalNotes?: string | null;
1328
+ }
1329
+ export interface OutputVyq6Ajd6Pbl {
1330
+ /**
1331
+ * Signed URL for the course file
1332
+ * @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"
1333
+ */
1334
+ fileURL: string;
1335
+ }
1336
+ export interface InputEi9E1V7Rpe {
1337
+ /**
1338
+ * Indicates whether the waiver is approved
1339
+ * @example true
1340
+ */
1341
+ approved: boolean;
1342
+ /**
1343
+ * Optional notes regarding the waiver
1344
+ * @example "Waiver granted due to special circumstances."
1345
+ */
1346
+ additionalNotes?: string | null;
1347
+ }
1348
+ export interface InputVczxcyab6W {
1349
+ /**
1350
+ * Optional notes regarding the waiver
1351
+ * @example "Waiver granted due to special circumstances."
1352
+ */
1353
+ additionalNotes?: string | null;
1354
+ }
1355
+ export interface InputF6S7Tcgt9H {
1356
+ students: {
1357
+ /**
1358
+ * User ID of the student to redeem the course for
1359
+ * @example "userID"
1360
+ */
1361
+ userID: string;
1362
+ /**
1363
+ * Activation code for the course, if applicable
1364
+ * @example "activationCode"
1365
+ */
1366
+ activationCode?: string;
1367
+ }[];
1368
+ /**
1369
+ * ID of the course to redeem
1370
+ * @example "courseID"
1371
+ */
1372
+ courseID: string;
1373
+ /**
1374
+ * Organization ID for the course redemption
1375
+ * @example "orgID"
1376
+ */
1377
+ orgID?: string;
1378
+ /**
1379
+ * Session ID for the course, if applicable
1380
+ * @example "sessionID"
1381
+ */
1382
+ sessionID?: string;
1383
+ /**
1384
+ * Session ID for automatic enrollment, if applicable
1385
+ * @example "autoEnrolSessionID"
1386
+ */
1387
+ autoEnrolSessionID?: string;
1388
+ }
1389
+ export interface InputTahl1X2Wos {
1390
+ invites: {
1391
+ /**
1392
+ * Email address of the user to invite
1393
+ * @example "mail@mail.com"
1394
+ */
1395
+ email: string;
1396
+ /**
1397
+ * User ID of the user to invite, if available
1398
+ * @example "userID"
1399
+ */
1400
+ userID?: string;
1401
+ }[];
1402
+ /**
1403
+ * ID of the course to redeem
1404
+ * @example "courseID"
1405
+ */
1406
+ courseID: string;
1407
+ /**
1408
+ * Session ID for the course, if applicable
1409
+ * @example "sessionID"
1410
+ */
1411
+ sessionID?: string;
1412
+ /**
1413
+ * Indicates if the invite is for a reserved seat
1414
+ * @example true
1415
+ */
1416
+ isReservedSeat: boolean;
1417
+ }
1418
+ export interface InputW0G08Trp2L {
1419
+ /**
1420
+ * Indicates whether to waive the certification process
1421
+ * @example true
1422
+ */
1423
+ waive: boolean;
1424
+ /**
1425
+ * Optional comments regarding the waiver
1426
+ * @example "Waive granted due to special circumstances."
1427
+ */
1428
+ comments?: string | null;
1429
+ }
1430
+ /** Certification move response schema */
1431
+ export interface OutputSc6Zw56Dzq {
1432
+ errors?: {
1433
+ status: string;
1434
+ object?: Record<string, any>;
1435
+ ignoreError?: boolean;
1436
+ }[];
1437
+ }
1438
+ /** Schema for writing a certification trigger check. */
1439
+ export interface Input7Vh389Cmk5 {
1440
+ /**
1441
+ * The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
1442
+ * @example "CHECKED"
1443
+ */
1444
+ value: Input7Vh389Cmk5ValueEnum;
1445
+ /**
1446
+ * List of course IDs that are blocked by this trigger check.
1447
+ * @example ["course1","course2"]
1448
+ */
1449
+ blockedCourses?: string[];
1450
+ }
1451
+ export interface InputJusp9Jdhxl {
1452
+ /**
1453
+ * Indicates whether the application item is approved
1454
+ * @example true
1455
+ */
1456
+ approved: boolean;
1457
+ /**
1458
+ * Optional notes regarding the review of the application item
1459
+ * @example "Reviewed and approved with no issues."
1460
+ */
1461
+ additionalNotes?: string | null;
1462
+ /**
1463
+ * Timestamp when the item was issued
1464
+ * @example 1672531199000
1465
+ */
1466
+ issuedOn?: number;
1467
+ /**
1468
+ * Timestamp when the item expires
1469
+ * @example 1704067199000
1470
+ */
1471
+ expiresOn?: number;
1472
+ }
1473
+ /** Create Student History requirements */
1474
+ export interface StudentHistoryRequestSchema {
1475
+ requirements: string[];
1476
+ }
1477
+ export interface InputVb1Vnjw2Eg {
1478
+ /**
1479
+ * Optional activation key for the application
1480
+ * @example "AK-123456"
1481
+ */
1482
+ activationKey?: string;
1483
+ }
1484
+ /** Schema for course submission item details post request. */
1485
+ export interface InputGby1J6Gkqr {
1486
+ /**
1487
+ * The ID of the file being submitted.
1488
+ * @example "fileID123"
1489
+ */
1490
+ fileID: string;
1491
+ /**
1492
+ * The name of the file being submitted.
1493
+ * @example "submissionFile.pdf"
1494
+ */
1495
+ fileName: string;
1496
+ }
1497
+ /** Schema for the response to course submission item details post request. */
1498
+ export interface OutputGby1J6Gkqr {
1499
+ submissionItems: {
1500
+ /**
1501
+ * The ID of the file being submitted.
1502
+ * @example "fileID123"
1503
+ */
1504
+ fileID: string;
1505
+ /**
1506
+ * The name of the file being submitted.
1507
+ * @example "submissionFile.pdf"
1508
+ */
1509
+ fileName: string;
1510
+ }[];
1511
+ }
1512
+ /** Pending approval submission parameters */
1513
+ export interface InputBkb7Btdukn {
1514
+ /**
1515
+ * Type of pending approval
1516
+ * @example "certification"
1517
+ */
1518
+ type: string;
1519
+ /** List of files submitted for pending approval */
1520
+ submissionItems: {
1521
+ /**
1522
+ * ID of the submitted file
1523
+ * @example "fileID123"
1524
+ */
1525
+ fileID: string;
1526
+ /**
1527
+ * Name of the submitted file
1528
+ * @example "document.pdf"
1529
+ */
1530
+ fileName: string;
1531
+ }[];
1532
+ }
1533
+ export interface InputBchr75Oc4N {
1534
+ /**
1535
+ * The ID of the course for which the license is being redeemed
1536
+ * @example "courseID123"
1537
+ */
1538
+ courseID: string;
1539
+ /**
1540
+ * The activation code for the license redemption
1541
+ * @example "activationCode456"
1542
+ */
1543
+ activationCode?: string;
1544
+ /**
1545
+ * The ID of the session associated with the license redemption
1546
+ * @example "sessionID789"
1547
+ */
1548
+ sessionID?: string;
1549
+ /**
1550
+ * The ID of the referral associated with the license redemption
1551
+ * @example "referralID123"
1552
+ */
1553
+ referralID?: string | null;
1554
+ /**
1555
+ * The name of the referral associated with the license redemption
1556
+ * @example "referralName456"
1557
+ */
1558
+ referralName?: string | null;
1559
+ /**
1560
+ * The ID of the employer associated with the license redemption
1561
+ * @example "employerID789"
1562
+ */
1563
+ employerID?: string | null;
1564
+ /**
1565
+ * The name of the employer associated with the license redemption
1566
+ * @example "employerName012"
1567
+ */
1568
+ employerName?: string | null;
1569
+ /**
1570
+ * The CUs associated with the employer for the license redemption
1571
+ * @example "employerCUsData"
1572
+ */
1573
+ employerCUs?: any;
1574
+ /**
1575
+ * Indicates if the order is a no-cost order
1576
+ * @example true
1577
+ */
1578
+ isNoCostOrder?: boolean | null;
1579
+ /**
1580
+ * The invitation code for the license redemption
1581
+ * @example "invitationCode345"
1582
+ */
1583
+ invitationCode?: string | null;
1584
+ /**
1585
+ * Shipping information for any materials associated with the license redemption
1586
+ * @example "materialShippingInfoData"
1587
+ */
1588
+ materialShippingInfo?: any;
1589
+ /**
1590
+ * The ID of the session for automatic enrollment
1591
+ * @example "autoEnrolSessionID678"
1592
+ */
1593
+ autoEnrolSessionID?: string | null;
1594
+ }
1595
+ /** Validate certification move response schema */
1596
+ export interface OutputIwzp4Ltfkm {
1597
+ courses: {
1598
+ name: string;
1599
+ status: string;
1600
+ state: string;
1601
+ }[];
1602
+ status: string;
1603
+ certProcID: string;
1604
+ validated: boolean;
1605
+ mustCreateCP: boolean;
1606
+ }
1607
+ export interface InputAa84W6Sw3E {
1608
+ /**
1609
+ * Comments regarding the end of the cooldown period
1610
+ * @example "Cooldown period ended successfully."
1611
+ */
1612
+ comments: string;
1613
+ }
1614
+ export interface OutputDqpjgt3Qitl {
1615
+ /**
1616
+ * Signed URL for the course file
1617
+ * @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"
1618
+ */
1619
+ fileURL: string;
1620
+ }
1621
+ export interface InputYa0N64R6Wk {
1622
+ /** @example true */
1623
+ agreedWithCertTerms: boolean;
1624
+ /** @example 1717230000000 */
1625
+ agreedOnTerms: number;
1626
+ /** @example "John" */
1627
+ firstName: string;
1628
+ /** @example "Doe" */
1629
+ lastName: string;
1630
+ /** @example "+1-555-5555" */
1631
+ phoneNumber?: string | null;
1632
+ /** @example "john.doe@example.com" */
1633
+ email: string;
1634
+ /** @example "legacy@domain.com" */
1635
+ sendAsEmail?: string;
1636
+ /** @example "alternate@domain.com" */
1637
+ sendEmailAs?: string;
1638
+ /** @example "John A. Doe" */
1639
+ certNameOnCertificate?: any;
1640
+ /** @example "ITA123456" */
1641
+ itaNumber?: any;
1642
+ /** @example false */
1643
+ sendGift?: boolean;
1644
+ /** @example "active" */
1645
+ state?: any;
1646
+ /** @example "USR#123" */
1647
+ id?: any;
1648
+ /** @example "TEN#001" */
1649
+ tenantID?: any;
1650
+ /** @example "USR#admin" */
1651
+ createdBy?: any;
1652
+ /** @example "USR#admin" */
1653
+ updatedBy?: any;
1654
+ /** @example "USR#ref001" */
1655
+ referredByID?: any;
1656
+ /** @example "Jane Smith" */
1657
+ referredByName?: any;
1658
+ /** @example "EMP#001" */
1659
+ employerID?: any;
1660
+ /** @example 1717231234567 */
1661
+ signinDate?: any;
1662
+ /** @example 1717231234567 */
1663
+ certificationDate?: any;
1664
+ /** @example 1750000000000 */
1665
+ certificationExpirationDate?: any;
1666
+ /** @example 1680000000000 */
1667
+ certificationOriginalDate?: any;
1668
+ /** @example "MBR#5678" */
1669
+ memberNumber?: any;
1670
+ /** @example 1717231111111 */
1671
+ updatedOn?: any;
1672
+ /** @example 1717000000000 */
1673
+ createdOn?: any;
1674
+ /** @example "TXN#abc123" */
1675
+ transactionID?: any;
1676
+ /** @example ["USR#789","USR#101"] */
1677
+ managerOf?: any;
1678
+ /** @example ["GRP#teamA"] */
1679
+ memberOf?: any;
1680
+ /** @example "prgUser" */
1681
+ dbEntity?: any;
1682
+ /** @example "+1-222-3333" */
1683
+ mobilePhone?: string | null;
1684
+ /** @example "en" */
1685
+ preferredLanguage?: string | null;
1686
+ /** @example false */
1687
+ certifiedUserOptOut?: boolean;
1688
+ /** @example "EXT#555" */
1689
+ externalID?: string | null;
1690
+ /** @example "EXT#999" */
1691
+ externalID2?: string | null;
1692
+ }
1693
+ export interface InputQwegrxedmt {
1694
+ /**
1695
+ * Comments regarding the course unlock action
1696
+ * @example "Course unlocked successfully."
1697
+ */
1698
+ comments: string;
1699
+ }
1700
+ export interface InputJkgsw7Yp8E {
1701
+ /**
1702
+ * ITA number to update for the user
1703
+ * @example "ITA123456"
1704
+ */
1705
+ itaNumber: string;
1706
+ }
1707
+ export interface InputCkiexmnlfz {
1708
+ /** @example true */
1709
+ agreedWithCertTerms: boolean;
1710
+ /** @example 1717230000000 */
1711
+ agreedOnTerms: number;
1712
+ /** @example "John" */
1713
+ firstName: string;
1714
+ /** @example "Doe" */
1715
+ lastName: string;
1716
+ /** @example "+1-555-5555" */
1717
+ phoneNumber?: string | null;
1718
+ /** @example "john.doe@example.com" */
1719
+ email: string;
1720
+ /** @example "legacy@domain.com" */
1721
+ sendAsEmail?: string;
1722
+ /** @example "alternate@domain.com" */
1723
+ sendEmailAs?: string;
1724
+ /** @example "John A. Doe" */
1725
+ certNameOnCertificate?: any;
1726
+ /** @example "ITA123456" */
1727
+ itaNumber?: any;
1728
+ /** @example false */
1729
+ sendGift?: boolean;
1730
+ /** @example "active" */
1731
+ state?: any;
1732
+ /** @example "USR#123" */
1733
+ id?: any;
1734
+ /** @example "TEN#001" */
1735
+ tenantID?: any;
1736
+ /** @example "USR#admin" */
1737
+ createdBy?: any;
1738
+ /** @example "USR#admin" */
1739
+ updatedBy?: any;
1740
+ /** @example "USR#ref001" */
1741
+ referredByID?: any;
1742
+ /** @example "Jane Smith" */
1743
+ referredByName?: any;
1744
+ /** @example "EMP#001" */
1745
+ employerID?: any;
1746
+ /** @example 1717231234567 */
1747
+ signinDate?: any;
1748
+ /** @example 1717231234567 */
1749
+ certificationDate?: any;
1750
+ /** @example 1750000000000 */
1751
+ certificationExpirationDate?: any;
1752
+ /** @example 1680000000000 */
1753
+ certificationOriginalDate?: any;
1754
+ /** @example "MBR#5678" */
1755
+ memberNumber?: any;
1756
+ /** @example 1717231111111 */
1757
+ updatedOn?: any;
1758
+ /** @example 1717000000000 */
1759
+ createdOn?: any;
1760
+ /** @example "TXN#abc123" */
1761
+ transactionID?: any;
1762
+ /** @example ["USR#789","USR#101"] */
1763
+ managerOf?: any;
1764
+ /** @example ["GRP#teamA"] */
1765
+ memberOf?: any;
1766
+ /** @example "prgUser" */
1767
+ dbEntity?: any;
1768
+ /** @example "+1-222-3333" */
1769
+ mobilePhone?: string | null;
1770
+ /** @example "en" */
1771
+ preferredLanguage?: string | null;
1772
+ /** @example false */
1773
+ certifiedUserOptOut?: boolean;
1774
+ /** @example "EXT#555" */
1775
+ externalID?: string | null;
1776
+ /** @example "EXT#999" */
1777
+ externalID2?: string | null;
1778
+ }
1779
+ export interface InputQogzfpjg52 {
1780
+ /**
1781
+ * The grade to override the course result with
1782
+ * @example "A"
1783
+ */
1784
+ resultGrade: string;
1785
+ }
1786
+ /** Pending approval review parameters */
1787
+ export interface InputC53Kuyqnej {
1788
+ /**
1789
+ * Notes provided by the reviewer for the pending approval
1790
+ * @example "Please review the submitted documents."
1791
+ */
1792
+ approvalNotes?: string | null;
1793
+ /**
1794
+ * Indicates whether the pending approval is approved or not
1795
+ * @example true
1796
+ */
1797
+ approved: boolean;
1798
+ }
1799
+ /** Schema for overriding course result dates. */
1800
+ export interface Input7Kqbtz8S05 {
1801
+ /**
1802
+ * The date when the course result expires, in milliseconds since epoch.
1803
+ * @example 1735689600000
1804
+ */
1805
+ expiryDate?: number;
1806
+ /**
1807
+ * The date when the course was completed, in milliseconds since epoch.
1808
+ * @example 1735689600000
1809
+ */
1810
+ completionDate?: number;
1811
+ }
1812
+ export interface InputPl0F8Ijrz3K {
1813
+ filter: {
1814
+ from?: number;
1815
+ sortOrder?: string;
1816
+ sortField?: string;
1817
+ };
1818
+ }
1819
+ export interface OutputPl0F8Ijrz3K {
1820
+ users: {
1821
+ firstName: string;
1822
+ lastName: string;
1823
+ /** @format email */
1824
+ email: string;
1825
+ phoneNumber?: string;
1826
+ certNumber: string;
1827
+ certDate: number;
1828
+ certExpiration: string;
1829
+ }[];
1830
+ total: number;
1831
+ }
1832
+ export declare enum ReportXlsxSchemaContentTypeEnum {
1833
+ ApplicationVndOpenxmlformatsOfficedocumentSpreadsheetmlSheet = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
1834
+ }
1835
+ /**
1836
+ * The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
1837
+ * @example "CHECKED"
1838
+ */
1839
+ export declare enum Input7Vh389Cmk5ValueEnum {
1840
+ CHECKED = "CHECKED",
1841
+ UNCHECKED = "UNCHECKED",
1842
+ NOVALUE = "NOVALUE"
1843
+ }
1844
+ export type ListContactUsData = any;
1845
+ export type ListContactUsError = ErrorResponse;
1846
+ export type ListConfigData = any;
1847
+ export type ListConfigError = ErrorResponse;
1848
+ export interface GetUserParams {
1849
+ /** @example "allFlag" */
1850
+ allFlag: string;
1851
+ /** @example "userID" */
1852
+ userId: string;
1853
+ }
1854
+ export type GetUserData = UserResponseEntity;
1855
+ export type GetUserError = ErrorResponse;
1856
+ export interface GetEventsParams {
1857
+ /** Exclude online events */
1858
+ excludeOnline?: string;
1859
+ /**
1860
+ * Start time of the event range
1861
+ * @example "1781158057000"
1862
+ */
1863
+ startTime: string;
1864
+ /**
1865
+ * End time of the event range
1866
+ * @example "1781158057000"
1867
+ */
1868
+ endTime: string;
1869
+ }
1870
+ export type GetEventsData = any;
1871
+ export type GetEventsError = ErrorResponse;
1872
+ export type DeleteOrgData = any;
1873
+ export type DeleteOrgError = ErrorResponse;
1874
+ export interface ListReportAffiliateParams {
1875
+ /** @example "1704067200" */
1876
+ fromDate: string;
1877
+ /** @example "1704153600" */
1878
+ toDate: string;
1879
+ }
1880
+ export type ListReportAffiliateData = any;
1881
+ export type ListReportAffiliateError = ErrorResponse;
1882
+ export type ListReportCompletedWithConsentData = any;
1883
+ export type ListReportCompletedWithConsentError = ErrorResponse;
1884
+ export type ListPendingApplicationsData = ApplicationResponseSchema;
1885
+ export type ListPendingApplicationsError = ErrorResponse;
1886
+ export type ListPendingApprovalsData = PendingApprovalResponseSchema;
1887
+ export type ListPendingApprovalsError = ErrorResponse;
1888
+ export type ListConfigResult = any;
1889
+ export type ListConfigFail = ErrorResponse;
1890
+ export type CreateReportApplicationExportData = any;
1891
+ export type CreateReportApplicationExportError = ErrorResponse;
1892
+ export type ListReportApplicationStatusData = any;
1893
+ export type ListReportApplicationStatusError = ErrorResponse;
1894
+ export type CreateReportApplicationsReportData = any;
1895
+ export type CreateReportApplicationsReportError = ErrorResponse;
1896
+ export type CreateCertificatesEmailData = any;
1897
+ export type CreateCertificatesEmailError = ErrorResponse;
1898
+ export interface CreateReportCompletedCertificationsPreviewParams {
1899
+ /** @example "1704067200" */
1900
+ fromDate: string;
1901
+ /** @example "1704153600" */
1902
+ toDate: string;
1903
+ }
1904
+ export type CreateReportCompletedCertificationsPreviewData = any;
1905
+ export type CreateReportCompletedCertificationsPreviewError = ErrorResponse;
1906
+ export interface ListReportCompletedCertificationsParams {
1907
+ /** @example "1704067200" */
1908
+ fromDate: string;
1909
+ /** @example "1704153600" */
1910
+ toDate: string;
1911
+ }
1912
+ export type ListReportCompletedCertificationsData = any;
1913
+ export type ListReportCompletedCertificationsError = ErrorResponse;
1914
+ export type CreateLicenseRedeemData = any;
1915
+ export type CreateLicenseRedeemError = ErrorResponse;
1916
+ export type ListReportOrglicensesData = any;
1917
+ export type ListReportOrglicensesError = ErrorResponse;
1918
+ export type CreateReportOrglicensesPreviewData = any;
1919
+ export type CreateReportOrglicensesPreviewError = ErrorResponse;
1920
+ export type CreateReportNcsoReportData = ReportXLSXSchema;
1921
+ export type CreateReportNcsoReportError = ErrorResponse;
1922
+ export type CreateReportUsersAdvancedData = any;
1923
+ export type CreateReportUsersAdvancedError = ErrorResponse;
1924
+ export type ListSearchUsersIdsData = any;
1925
+ export type ListSearchUsersIdsError = ErrorResponse;
1926
+ export type CreateSearchUsersTermData = any;
1927
+ export type CreateSearchUsersTermError = ErrorResponse;
1928
+ export type CreateReportUsersSimpleData = any;
1929
+ export type CreateReportUsersSimpleError = ErrorResponse;
1930
+ export type DeleteCertificationApplicationItemData = any;
1931
+ export type DeleteCertificationApplicationItemError = ErrorResponse;
1932
+ export type CreateCertificationApplicationItemData = any;
1933
+ export type CreateCertificationApplicationItemError = ErrorResponse;
1934
+ export type DeleteCertificationApplicationBlacklistData = any;
1935
+ export type DeleteCertificationApplicationBlacklistError = ErrorResponse;
1936
+ export type DeleteCertificationApplicationData = any;
1937
+ export type DeleteCertificationApplicationError = ErrorResponse;
1938
+ export type GetCertificationApplicationData = CertificationApplicationResponseEntity;
1939
+ export type GetCertificationApplicationError = ErrorResponse;
1940
+ export type CreateCertificationApplicationData = any;
1941
+ export type CreateCertificationApplicationError = ErrorResponse;
1942
+ export type DeleteCertificationCourseFileSignData = any;
1943
+ export type DeleteCertificationCourseFileSignError = ErrorResponse;
1944
+ export type GetCertificationCourseFileSignData = OutputI9462Kgjk6;
1945
+ export type GetCertificationCourseFileSignError = ErrorResponse;
1946
+ export interface CreateCertificationCourseFileSignParams {
1947
+ /** @example "pdf" */
1948
+ fileType: string;
1949
+ /** @example "userID" */
1950
+ userId: string;
1951
+ /** @example "certProcID" */
1952
+ certProcId: string;
1953
+ /** @example "courseID" */
1954
+ courseId: string;
1955
+ /** @example "fileID" */
1956
+ fileId: string;
1957
+ }
1958
+ export type CreateCertificationCourseFileSignData = OutputDqpjgt3Qitl;
1959
+ export type CreateCertificationCourseFileSignError = ErrorResponse;
1960
+ export type DeleteCertificationCourseDocumentData = any;
1961
+ export type DeleteCertificationCourseDocumentError = ErrorResponse;
1962
+ export type UpdateCertificationCourseDocumentData = OutputGby1J6Gkqr;
1963
+ export type UpdateCertificationCourseDocumentError = ErrorResponse;
1964
+ export type DeleteUserData = any;
1965
+ export type DeleteUserError = ErrorResponse;
1966
+ export type GetUserResult = UserResponseEntity;
1967
+ export type GetUserFail = ErrorResponse;
1968
+ export type CreateUserData = any;
1969
+ export type CreateUserError = ErrorResponse;
1970
+ export type UpdateUserData = any;
1971
+ export type UpdateUserError = ErrorResponse;
1972
+ export type DeleteCertificationCourseData = any;
1973
+ export type DeleteCertificationCourseError = ErrorResponse;
1974
+ export type GetCertificationApplicationItemFileData = OutputKin04Ituf7;
1975
+ export type GetCertificationApplicationItemFileError = ErrorResponse;
1976
+ export interface CreateCertificationApplicationItemFileParams {
1977
+ /** @example "pdf" */
1978
+ fileType: string;
1979
+ /** @example "userID" */
1980
+ userId: string;
1981
+ /** @example "certProcID" */
1982
+ certProcId: string;
1983
+ /** @example "sourceID" */
1984
+ sourceId: string;
1985
+ /** @example "fileVersion" */
1986
+ fileVersion: string;
1987
+ }
1988
+ export type CreateCertificationApplicationItemFileData = OutputVyq6Ajd6Pbl;
1989
+ export type CreateCertificationApplicationItemFileError = ErrorResponse;
1990
+ export type GetCertificationCourseSessionCalcCancelationChargesData = OutputDwlxivng9Li;
1991
+ export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
1992
+ export type GetCertificationsData = CertificationProcessResponseSchema;
1993
+ export type GetCertificationsError = ErrorResponse;
1994
+ export type GetCourseData = CourseResponseEntity;
1995
+ export type GetCourseError = ErrorResponse;
1996
+ export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
1997
+ export type GetCertificationsExpandedError = ErrorResponse;
1998
+ export type GetCertificationApplicationForeignFillData = Output2A58Aiskxik;
1999
+ export type GetCertificationApplicationForeignFillError = ErrorResponse;
2000
+ export type GetCertificationPrintData = any;
2001
+ export type GetCertificationPrintError = ErrorResponse;
2002
+ export type GetCertificationCoursePrintData = any;
2003
+ export type GetCertificationCoursePrintError = ErrorResponse;
2004
+ export type GetRequirementData = StudentHistoryResponseSchema;
2005
+ export type GetRequirementError = ErrorResponse;
2006
+ export type GetCertificationsUpcomingCoursesData = UserUpcomingCoursesResponseSchema;
2007
+ export type GetCertificationsUpcomingCoursesError = ErrorResponse;
2008
+ export type GetCertificationData = CertificationProcessResponseEntity;
2009
+ export type GetCertificationError = ErrorResponse;
2010
+ export type CreateCertificationData = any;
2011
+ export type CreateCertificationError = ErrorResponse;
2012
+ export type CreateSessionAddData = any;
2013
+ export type CreateSessionAddError = ErrorResponse;
2014
+ export type CreateCertificationApplicationPreApprovalData = any;
2015
+ export type CreateCertificationApplicationPreApprovalError = ErrorResponse;
2016
+ export type CreateCertificationApplicationReviewData = any;
2017
+ export type CreateCertificationApplicationReviewError = ErrorResponse;
2018
+ export type CreateCertificationApplicationPreApprovalReviewData = any;
2019
+ export type CreateCertificationApplicationPreApprovalReviewError = ErrorResponse;
2020
+ export type CreateCertificationCourseBatchRedeemData = any;
2021
+ export type CreateCertificationCourseBatchRedeemError = ErrorResponse;
2022
+ export type CreateCertificationCourseBatchInviteData = any;
2023
+ export type CreateCertificationCourseBatchInviteError = ErrorResponse;
2024
+ export type CreateCertificationCourseSessionCancelEnrolData = any;
2025
+ export type CreateCertificationCourseSessionCancelEnrolError = ErrorResponse;
2026
+ export type CreateCertificationRenewData = any;
2027
+ export type CreateCertificationRenewError = ErrorResponse;
2028
+ export type CreateCertificationRestartData = any;
2029
+ export type CreateCertificationRestartError = ErrorResponse;
2030
+ export type CreateCertificationWaiveData = any;
2031
+ export type CreateCertificationWaiveError = ErrorResponse;
2032
+ export type CreateCertificationMoveData = OutputSc6Zw56Dzq;
2033
+ export type CreateCertificationMoveError = ErrorResponse;
2034
+ export type CreateCertificationCourseSessionReplaceData = any;
2035
+ export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
2036
+ export type CreateCertificationTriggerCheckData = any;
2037
+ export type CreateCertificationTriggerCheckError = ErrorResponse;
2038
+ export type CreateCertificationTriggerSetData = any;
2039
+ export type CreateCertificationTriggerSetError = ErrorResponse;
2040
+ export type CreateRefreshOrgMembershipData = any;
2041
+ export type CreateRefreshOrgMembershipError = ErrorResponse;
2042
+ export type CreateCertificationCourseRetakeData = any;
2043
+ export type CreateCertificationCourseRetakeError = ErrorResponse;
2044
+ export type CreateCertificationCourseRevokeData = any;
2045
+ export type CreateCertificationCourseRevokeError = ErrorResponse;
2046
+ export type CreateCertificationApplicationItemRemoveData = any;
2047
+ export type CreateCertificationApplicationItemRemoveError = ErrorResponse;
2048
+ export type CreateCertificationApplicationItemReviewData = any;
2049
+ export type CreateCertificationApplicationItemReviewError = ErrorResponse;
2050
+ export type ListRequirementsData = StudentHistoryResponseSchema;
2051
+ export type ListRequirementsError = ErrorResponse;
2052
+ export type CreateCertificationApplicationSubmitData = any;
2053
+ export type CreateCertificationApplicationSubmitError = ErrorResponse;
2054
+ export type CreateCertificationCoursePendingApprovalData = any;
2055
+ export type CreateCertificationCoursePendingApprovalError = ErrorResponse;
2056
+ export type UpdateCertificationCoursePendingApprovalData = any;
2057
+ export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
2058
+ export type CreateCertificationCourseRedeemData = any;
2059
+ export type CreateCertificationCourseRedeemError = ErrorResponse;
2060
+ export type CreateCertificationMoveValidateData = OutputIwzp4Ltfkm;
2061
+ export type CreateCertificationMoveValidateError = ErrorResponse;
2062
+ export type CreateCertificationCourseEndCooldownData = any;
2063
+ export type CreateCertificationCourseEndCooldownError = ErrorResponse;
2064
+ export type CreateCertificationCourseUnlockCourseData = any;
2065
+ export type CreateCertificationCourseUnlockCourseError = ErrorResponse;
2066
+ export type CreateUpdateItaData = any;
2067
+ export type CreateUpdateItaError = ErrorResponse;
2068
+ export type UpdateCertificationCourseOverrideResultData = any;
2069
+ export type UpdateCertificationCourseOverrideResultError = ErrorResponse;
2070
+ export type UpdateCertificationSetDatesData = any;
2071
+ export type UpdateCertificationSetDatesError = ErrorResponse;
2072
+ export type CreateCertificationResult = OutputPl0F8Ijrz3K;
2073
+ export type CreateCertificationFail = ErrorResponse;
2074
+ import type { AxiosInstance, AxiosRequestConfig, ResponseType } from 'axios';
2075
+ export type QueryParamsType = Record<string | number, any>;
2076
+ export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
2077
+ /** set parameter to `true` for call `securityWorker` for this request */
2078
+ secure?: boolean;
2079
+ /** request path */
2080
+ path: string;
2081
+ /** content type of request body */
2082
+ type?: ContentType;
2083
+ /** query params */
2084
+ query?: QueryParamsType;
2085
+ /** format of response (i.e. response.json() -> format: "json") */
2086
+ format?: ResponseType;
2087
+ /** request body */
2088
+ body?: unknown;
2089
+ }
2090
+ export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>;
2091
+ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, 'data' | 'cancelToken'> {
2092
+ securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
2093
+ secure?: boolean;
2094
+ format?: ResponseType;
2095
+ }
2096
+ export declare enum ContentType {
2097
+ Json = "application/json",
2098
+ FormData = "multipart/form-data",
2099
+ UrlEncoded = "application/x-www-form-urlencoded",
2100
+ Text = "text/plain"
2101
+ }
2102
+ export declare class HttpClient<SecurityDataType = unknown> {
2103
+ instance: AxiosInstance;
2104
+ private securityData;
2105
+ private securityWorker?;
2106
+ private secure?;
2107
+ private format?;
2108
+ constructor({ securityWorker, secure, format, ...axiosConfig }?: ApiConfig<SecurityDataType>);
2109
+ setSecurityData: (data: SecurityDataType | null) => void;
2110
+ protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
2111
+ protected stringifyFormItem(formItem: unknown): string;
2112
+ protected createFormData(input: Record<string, unknown>): FormData;
2113
+ request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<T>;
2114
+ }
2115
+ /**
2116
+ * @title BCCSA Program API
2117
+ * @version 3.0.0
2118
+ * @baseUrl http://localhost:8080
2119
+ * @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
2120
+ */
2121
+ export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
2122
+ contactUs: {
2123
+ /**
2124
+ * @description This endpoint allows users to submit a contact form with their name, email, and comments. The form submission is processed and an email is sent to the admin recipient specified in the tenant configuration.
2125
+ *
2126
+ * @tags Contact Us
2127
+ * @name ListContactUs
2128
+ * @summary Contact Us
2129
+ * @request POST:/contactUs
2130
+ * @secure
2131
+ */
2132
+ listContactUs: (data: InputTprol08O25K, params?: RequestParams) => Promise<any>;
2133
+ };
2134
+ customer: {
2135
+ /**
2136
+ * @description Retrieve config from customer.
2137
+ *
2138
+ * @tags Config
2139
+ * @name ListConfig
2140
+ * @summary Get Config
2141
+ * @request GET:/customer/config
2142
+ * @secure
2143
+ */
2144
+ listConfig: (params?: RequestParams) => Promise<any>;
2145
+ /**
2146
+ * @description Retrieve user from customer.
2147
+ *
2148
+ * @tags User
2149
+ * @name GetUser
2150
+ * @summary Get User
2151
+ * @request GET:/customer/user/{userID}
2152
+ * @secure
2153
+ */
2154
+ getUser: ({ userId, ...query }: GetUserParams, params?: RequestParams) => Promise<UserResponseEntity>;
2155
+ /**
2156
+ * @description Retrieve user events from customer within a specified time range.
2157
+ *
2158
+ * @tags Events
2159
+ * @name GetEvents
2160
+ * @summary Get User Events
2161
+ * @request GET:/customer/events/{startTime}/{endTime}
2162
+ * @secure
2163
+ */
2164
+ getEvents: ({ startTime, endTime, ...query }: GetEventsParams, params?: RequestParams) => Promise<any>;
2165
+ };
2166
+ tenant: {
2167
+ /**
2168
+ * @description Delete bridge
2169
+ *
2170
+ * @tags Tenant
2171
+ * @name DeleteOrg
2172
+ * @summary Delete bridge
2173
+ * @request DELETE:/tenant/org/{orgID}
2174
+ * @secure
2175
+ */
2176
+ deleteOrg: (orgId: string, params?: RequestParams) => Promise<any>;
2177
+ /**
2178
+ * @description Retrieve Affiliate Payments for the tenant.
2179
+ *
2180
+ * @tags Tenant
2181
+ * @name ListReportAffiliate
2182
+ * @summary Get Affiliate Payments
2183
+ * @request GET:/tenant/report/affiliate
2184
+ * @secure
2185
+ */
2186
+ listReportAffiliate: (query: ListReportAffiliateParams, params?: RequestParams) => Promise<any>;
2187
+ /**
2188
+ * @description List users that achieved their designation and allow their data to be published.
2189
+ *
2190
+ * @tags Tenant
2191
+ * @name ListReportCompletedWithConsent
2192
+ * @summary Get users with completed designations and consent for publication
2193
+ * @request GET:/tenant/report/completedWithConsent
2194
+ * @secure
2195
+ */
2196
+ listReportCompletedWithConsent: (params?: RequestParams) => Promise<any>;
2197
+ /**
2198
+ * @description Retrieve pending applications for the tenant.
2199
+ *
2200
+ * @tags Tenant
2201
+ * @name ListPendingApplications
2202
+ * @summary Get Pending Applications
2203
+ * @request GET:/tenant/pendingApplications
2204
+ * @secure
2205
+ */
2206
+ listPendingApplications: (params?: RequestParams) => Promise<ApplicationResponseSchema>;
2207
+ /**
2208
+ * @description Retrieve pending approvals for the tenant.
2209
+ *
2210
+ * @tags Tenant
2211
+ * @name ListPendingApprovals
2212
+ * @summary Get Pending Approvals
2213
+ * @request GET:/tenant/pendingApprovals
2214
+ * @secure
2215
+ */
2216
+ listPendingApprovals: (params?: RequestParams) => Promise<PendingApprovalResponseSchema>;
2217
+ /**
2218
+ * @description Retrieve config for the tenant.
2219
+ *
2220
+ * @tags Tenant
2221
+ * @name ListConfig
2222
+ * @summary Get Tenant Config
2223
+ * @request GET:/tenant/config
2224
+ * @secure
2225
+ */
2226
+ listConfig: (params?: RequestParams) => Promise<any>;
2227
+ /**
2228
+ * @description Export a report of applications based on the provided filters.
2229
+ *
2230
+ * @tags Application
2231
+ * @name CreateReportApplicationExport
2232
+ * @summary Application report
2233
+ * @request POST:/tenant/report/applicationExport
2234
+ * @secure
2235
+ */
2236
+ createReportApplicationExport: (data: InputN4Ndusy4P2, params?: RequestParams) => Promise<any>;
2237
+ /**
2238
+ * @description Export a report of applications based on the provided filters.
2239
+ *
2240
+ * @tags Applications
2241
+ * @name ListReportApplicationStatus
2242
+ * @summary Applications report
2243
+ * @request POST:/tenant/report/applicationStatus
2244
+ * @secure
2245
+ */
2246
+ listReportApplicationStatus: (data: InputHay4A10Oxo, params?: RequestParams) => Promise<any>;
2247
+ /**
2248
+ * @description Export a report of applications based on the provided filters.
2249
+ *
2250
+ * @tags Applications
2251
+ * @name CreateReportApplicationsReport
2252
+ * @summary Applications report
2253
+ * @request POST:/tenant/report/applicationsReport
2254
+ * @secure
2255
+ */
2256
+ createReportApplicationsReport: (data: Input39Rlhyxzj2, params?: RequestParams) => Promise<any>;
2257
+ /**
2258
+ * @description This route allows you to post certificates email for the tenant.
2259
+ *
2260
+ * @tags Tenant
2261
+ * @name CreateCertificatesEmail
2262
+ * @summary Post Certificates Email
2263
+ * @request POST:/tenant/certificates/email
2264
+ * @secure
2265
+ */
2266
+ createCertificatesEmail: (data: InputLop7Riutcm, params?: RequestParams) => Promise<any>;
2267
+ /**
2268
+ * @description Generate a preview of the completed certifications report.
2269
+ *
2270
+ * @tags CompletedCertifications
2271
+ * @name CreateReportCompletedCertificationsPreview
2272
+ * @summary Preview Completed Certifications Report
2273
+ * @request POST:/tenant/report/completedCertifications/preview
2274
+ * @secure
2275
+ */
2276
+ createReportCompletedCertificationsPreview: (query: CreateReportCompletedCertificationsPreviewParams, params?: RequestParams) => Promise<any>;
2277
+ /**
2278
+ * @description Generates the completed certifications report.
2279
+ *
2280
+ * @tags CompletedCertifications
2281
+ * @name ListReportCompletedCertifications
2282
+ * @summary Completed Certifications Report
2283
+ * @request POST:/tenant/report/completedCertifications
2284
+ * @secure
2285
+ */
2286
+ listReportCompletedCertifications: (query: ListReportCompletedCertificationsParams, params?: RequestParams) => Promise<any>;
2287
+ /**
2288
+ * @description Redeems a license for a user by product ID.
2289
+ *
2290
+ * @tags License
2291
+ * @name CreateLicenseRedeem
2292
+ * @summary Redeem a License for a User
2293
+ * @request POST:/tenant/license/redeem/{userID}
2294
+ * @secure
2295
+ */
2296
+ createLicenseRedeem: (userId: string, data: InputGikxez8Kaz, params?: RequestParams) => Promise<any>;
2297
+ /**
2298
+ * @description Generate a of the organization licenses report based on search filters.
2299
+ *
2300
+ * @tags OrgLicenses
2301
+ * @name ListReportOrglicenses
2302
+ * @summary Org Licenses Report
2303
+ * @request POST:/tenant/report/orglicenses/
2304
+ * @secure
2305
+ */
2306
+ listReportOrglicenses: (data: InputK0Mnve89M3, params?: RequestParams) => Promise<any>;
2307
+ /**
2308
+ * @description Generate a preview of the organization licenses report based on search filters.
2309
+ *
2310
+ * @tags OrgLicenses
2311
+ * @name CreateReportOrglicensesPreview
2312
+ * @summary Preview Org Licenses Report
2313
+ * @request POST:/tenant/report/orglicenses/preview
2314
+ * @secure
2315
+ */
2316
+ createReportOrglicensesPreview: (data: Input560Aguh4X3, params?: RequestParams) => Promise<any>;
2317
+ /**
2318
+ * @description Custo NCSO scpecific export containing certification information for NCSO users.
2319
+ *
2320
+ * @tags Reports
2321
+ * @name CreateReportNcsoReport
2322
+ * @summary NCSO Export report
2323
+ * @request POST:/tenant/report/ncsoReport
2324
+ * @secure
2325
+ */
2326
+ createReportNcsoReport: (data: NcsoReportRequestSchema, params?: RequestParams) => Promise<ReportXLSXSchema>;
2327
+ /**
2328
+ * @description Advanced search for users in the tenant by filters, with report generation.
2329
+ *
2330
+ * @tags Users
2331
+ * @name CreateReportUsersAdvanced
2332
+ * @summary Advanced report generated by search users from tenant by filters
2333
+ * @request POST:/tenant/report/users/advanced
2334
+ * @secure
2335
+ */
2336
+ createReportUsersAdvanced: (data: InputK49I8Qntjc, params?: RequestParams) => Promise<any>;
2337
+ /**
2338
+ * @description Searches for users in the tenant by their IDs.
2339
+ *
2340
+ * @tags Users
2341
+ * @name ListSearchUsersIds
2342
+ * @summary Search Users from tenant by IDs
2343
+ * @request POST:/tenant/search/users/ids
2344
+ * @secure
2345
+ */
2346
+ listSearchUsersIds: (data: InputWxkq7Niqao, params?: RequestParams) => Promise<any>;
2347
+ /**
2348
+ * @description Searches for users in the tenant by term and filters.
2349
+ *
2350
+ * @tags Users
2351
+ * @name CreateSearchUsersTerm
2352
+ * @summary Search Users from tenant by term
2353
+ * @request POST:/tenant/search/users/term
2354
+ * @secure
2355
+ */
2356
+ createSearchUsersTerm: (data: InputG5Bir0Wo4E, params?: RequestParams) => Promise<any>;
2357
+ /**
2358
+ * @description Simple search for users in the tenant by term and filters, with report generation.
2359
+ *
2360
+ * @tags Users
2361
+ * @name CreateReportUsersSimple
2362
+ * @summary Simple report generated by search users from tenant by term
2363
+ * @request POST:/tenant/report/users/simple
2364
+ * @secure
2365
+ */
2366
+ createReportUsersSimple: (data: InputNdh9V3T3Og, params?: RequestParams) => Promise<any>;
2367
+ };
2368
+ user: {
2369
+ /**
2370
+ * @description Delete application item by type.
2371
+ *
2372
+ * @tags Application
2373
+ * @name DeleteCertificationApplicationItem
2374
+ * @summary Delete Application Item
2375
+ * @request DELETE:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
2376
+ * @secure
2377
+ */
2378
+ deleteCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, params?: RequestParams) => Promise<any>;
2379
+ /**
2380
+ * @description This route allows you to add an item to a certification application for a user.
2381
+ *
2382
+ * @tags Application
2383
+ * @name CreateCertificationApplicationItem
2384
+ * @summary Add Application Item
2385
+ * @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
2386
+ * @secure
2387
+ */
2388
+ createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: InputJmsh67C6I, params?: RequestParams) => Promise<any>;
2389
+ /**
2390
+ * @description Delete a certification process application by type.
2391
+ *
2392
+ * @tags Application
2393
+ * @name DeleteCertificationApplicationBlacklist
2394
+ * @summary Delete Certification Process Application
2395
+ * @request DELETE:/user/{userID}/certification/{certProcID}/application/{applicationType}/blacklist/{sourceID}
2396
+ * @secure
2397
+ */
2398
+ deleteCertificationApplicationBlacklist: (userId: string, certProcId: string, applicationType: string, sourceId: string, params?: RequestParams) => Promise<any>;
2399
+ /**
2400
+ * @description Delete a certification process application by type.
2401
+ *
2402
+ * @tags Application
2403
+ * @name DeleteCertificationApplication
2404
+ * @summary Delete Certification Process Application
2405
+ * @request DELETE:/user/{userID}/certification/{certProcID}/application/{applicationType}
2406
+ * @secure
2407
+ */
2408
+ deleteCertificationApplication: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<any>;
2409
+ /**
2410
+ * @description Get certification process application by type.
2411
+ *
2412
+ * @tags Application
2413
+ * @name GetCertificationApplication
2414
+ * @summary Get Certification Process
2415
+ * @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}
2416
+ * @secure
2417
+ */
2418
+ getCertificationApplication: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<CertificationApplicationResponseEntity>;
2419
+ /**
2420
+ * @description Start certification process application by type.
2421
+ *
2422
+ * @tags User
2423
+ * @name CreateCertificationApplication
2424
+ * @summary Start Certification Process Application
2425
+ * @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}
2426
+ * @secure
2427
+ */
2428
+ createCertificationApplication: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<any>;
2429
+ /**
2430
+ * @description Delete course file for a user by IDs.
2431
+ *
2432
+ * @tags Course
2433
+ * @name DeleteCertificationCourseFileSign
2434
+ * @summary Delete Course File
2435
+ * @request DELETE:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
2436
+ * @secure
2437
+ */
2438
+ deleteCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<any>;
2439
+ /**
2440
+ * @description Retrieve course file for a user by IDs.
2441
+ *
2442
+ * @tags Course
2443
+ * @name GetCertificationCourseFileSign
2444
+ * @summary Get Course File
2445
+ * @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
2446
+ * @secure
2447
+ */
2448
+ getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputI9462Kgjk6>;
2449
+ /**
2450
+ * @description This route allows you to create a signed URL for a course file for a user in a specific course.
2451
+ *
2452
+ * @tags Course
2453
+ * @name CreateCertificationCourseFileSign
2454
+ * @summary Course file
2455
+ * @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
2456
+ * @secure
2457
+ */
2458
+ createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputDqpjgt3Qitl>;
2459
+ /**
2460
+ * @description Delete submission item (file) for a user in a course by IDs.
2461
+ *
2462
+ * @tags Course
2463
+ * @name DeleteCertificationCourseDocument
2464
+ * @summary Delete Submission Item
2465
+ * @request DELETE:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
2466
+ * @secure
2467
+ */
2468
+ deleteCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<any>;
2469
+ /**
2470
+ * @description This route allows you to set or override a course submission item (file) for a user in a specific course.
2471
+ *
2472
+ * @tags Course
2473
+ * @name UpdateCertificationCourseDocument
2474
+ * @summary Set Course Submission Item
2475
+ * @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
2476
+ * @secure
2477
+ */
2478
+ updateCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputGby1J6Gkqr, params?: RequestParams) => Promise<OutputGby1J6Gkqr>;
2479
+ /**
2480
+ * @description Delete user by ID.
2481
+ *
2482
+ * @tags User
2483
+ * @name DeleteUser
2484
+ * @summary Delete User
2485
+ * @request DELETE:/user/{userID}
2486
+ * @secure
2487
+ */
2488
+ deleteUser: (userId: string, params?: RequestParams) => Promise<any>;
2489
+ /**
2490
+ * @description Retrieve user by ID.
2491
+ *
2492
+ * @tags User
2493
+ * @name GetUser
2494
+ * @summary Get User
2495
+ * @request GET:/user/{userID}
2496
+ * @secure
2497
+ */
2498
+ getUser: (userId: string, params?: RequestParams) => Promise<UserResponseEntity>;
2499
+ /**
2500
+ * @description Create a new user in the system. This endpoint allows you to create a user with the provided details. The user will be added to the database and an email notification will be sent to the user.
2501
+ *
2502
+ * @tags User
2503
+ * @name CreateUser
2504
+ * @summary CreateUser
2505
+ * @request POST:/user/{userID}
2506
+ * @secure
2507
+ */
2508
+ createUser: (userId: string, data: InputYa0N64R6Wk, params?: RequestParams) => Promise<any>;
2509
+ /**
2510
+ * @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.
2511
+ *
2512
+ * @tags User
2513
+ * @name UpdateUser
2514
+ * @summary Update User
2515
+ * @request PUT:/user/{userID}
2516
+ * @secure
2517
+ */
2518
+ updateUser: (userId: string, data: InputCkiexmnlfz, params?: RequestParams) => Promise<any>;
2519
+ /**
2520
+ * @description Delete course from user
2521
+ *
2522
+ * @tags User
2523
+ * @name DeleteCertificationCourse
2524
+ * @summary Delete course from user
2525
+ * @request DELETE:/user/{userID}/certification/{certProcID}/course/{courseID}
2526
+ * @secure
2527
+ */
2528
+ deleteCertificationCourse: (userId: string, certProcId: string, courseId: string, params?: RequestParams) => Promise<any>;
2529
+ /**
2530
+ * @description Retrieve a specific file version of an application item for a user in a certification process.
2531
+ *
2532
+ * @tags Application
2533
+ * @name GetCertificationApplicationItemFile
2534
+ * @summary Get Application Item File
2535
+ * @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
2536
+ * @secure
2537
+ */
2538
+ getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<OutputKin04Ituf7>;
2539
+ /**
2540
+ * @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
2541
+ *
2542
+ * @tags Application
2543
+ * @name CreateCertificationApplicationItemFile
2544
+ * @summary Post Application Item File
2545
+ * @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
2546
+ * @secure
2547
+ */
2548
+ createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputVyq6Ajd6Pbl>;
2549
+ /**
2550
+ * @description Retrieve the cancelation charges for a course based on the user, session, and course details.
2551
+ *
2552
+ * @tags Course
2553
+ * @name GetCertificationCourseSessionCalcCancelationCharges
2554
+ * @summary Get cancelation charges
2555
+ * @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
2556
+ * @secure
2557
+ */
2558
+ getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputDwlxivng9Li>;
2559
+ /**
2560
+ * @description Retrieves the certification processes for a user by their user ID.
2561
+ *
2562
+ * @tags Certifications
2563
+ * @name GetCertifications
2564
+ * @summary Certifications for User
2565
+ * @request GET:/user/{userID}/certifications
2566
+ * @secure
2567
+ */
2568
+ getCertifications: (userId: string, params?: RequestParams) => Promise<CertificationProcessResponseSchema>;
2569
+ /**
2570
+ * @description Retrieve course for a user by their user ID and courseID (cpID::examID).
2571
+ *
2572
+ * @tags Course
2573
+ * @name GetCourse
2574
+ * @summary Get Course
2575
+ * @request GET:/user/{userID}/course/{courseID}
2576
+ * @secure
2577
+ */
2578
+ getCourse: (userId: string, courseId: string, params?: RequestParams) => Promise<CourseResponseEntity>;
2579
+ /**
2580
+ * @description Retrieves the certification processes expanded for a user by their user ID.
2581
+ *
2582
+ * @tags Certifications
2583
+ * @name GetCertificationsExpanded
2584
+ * @summary Certifications expanded for User
2585
+ * @request GET:/user/{userID}/certifications/expanded
2586
+ * @secure
2587
+ */
2588
+ getCertificationsExpanded: (userId: string, params?: RequestParams) => Promise<UserExpandedCPResponseSchema>;
2589
+ /**
2590
+ * @description Get certification process application by type.
2591
+ *
2592
+ * @tags Application
2593
+ * @name GetCertificationApplicationForeignFill
2594
+ * @summary Get Certification Process
2595
+ * @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
2596
+ * @secure
2597
+ */
2598
+ getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<Output2A58Aiskxik>;
2599
+ /**
2600
+ * @description This endpoint will print certificate
2601
+ *
2602
+ * @tags Certification
2603
+ * @name GetCertificationPrint
2604
+ * @summary Print Certificate
2605
+ * @request GET:/user/{userID}/certification/{certProcID}/print
2606
+ * @secure
2607
+ */
2608
+ getCertificationPrint: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
2609
+ /**
2610
+ * @description This endpoint will print course
2611
+ *
2612
+ * @tags Course
2613
+ * @name GetCertificationCoursePrint
2614
+ * @summary Print Course
2615
+ * @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/print
2616
+ * @secure
2617
+ */
2618
+ getCertificationCoursePrint: (userId: string, certProcId: string, courseId: string, params?: RequestParams) => Promise<any>;
2619
+ /**
2620
+ * @description Returns the requirement status (e.g. student history) for a given user and source (e.g. course)
2621
+ *
2622
+ * @tags Requirement
2623
+ * @name GetRequirement
2624
+ * @summary Get user requirement status
2625
+ * @request GET:/user/{userID}/requirement/{sourceID}
2626
+ * @secure
2627
+ */
2628
+ getRequirement: (userId: string, sourceId: string, params?: RequestParams) => Promise<StudentHistoryResponseSchema>;
2629
+ /**
2630
+ * @description Retrieves the upcoming courses for a user by their user ID.
2631
+ *
2632
+ * @tags Certifications
2633
+ * @name GetCertificationsUpcomingCourses
2634
+ * @summary Get Upcoming Courses for User
2635
+ * @request GET:/user/{userID}/certifications/upcomingCourses
2636
+ * @secure
2637
+ */
2638
+ getCertificationsUpcomingCourses: (userId: string, params?: RequestParams) => Promise<UserUpcomingCoursesResponseSchema>;
2639
+ /**
2640
+ * @description Retrieve course for a user by their user ID.
2641
+ *
2642
+ * @tags Certification
2643
+ * @name GetCertification
2644
+ * @summary Get Certification Process for User
2645
+ * @request GET:/user/{userID}/certification/{certProcID}
2646
+ * @secure
2647
+ */
2648
+ getCertification: (userId: string, certProcId: string, params?: RequestParams) => Promise<CertificationProcessResponseEntity>;
2649
+ /**
2650
+ * @description This route allows you to start a certification process for a user.
2651
+ *
2652
+ * @tags Certification
2653
+ * @name CreateCertification
2654
+ * @summary Start Certification Process
2655
+ * @request POST:/user/{userID}/certification/{certProcID}
2656
+ * @secure
2657
+ */
2658
+ createCertification: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
2659
+ /**
2660
+ * @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.
2661
+ *
2662
+ * @tags User
2663
+ * @name CreateSessionAdd
2664
+ * @summary Add user to session
2665
+ * @request POST:/user/{userID}/session/{sessionID}/add
2666
+ * @secure
2667
+ */
2668
+ createSessionAdd: (userId: string, sessionId: string, params?: RequestParams) => Promise<any>;
2669
+ /**
2670
+ * @description This route allows a user to request pre-approval for an application type in a certification process.
2671
+ *
2672
+ * @tags Application
2673
+ * @name CreateCertificationApplicationPreApproval
2674
+ * @summary Certification Application Pre Approval
2675
+ * @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApproval
2676
+ * @secure
2677
+ */
2678
+ createCertificationApplicationPreApproval: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<any>;
2679
+ /**
2680
+ * @description This route allows you to review a certification application for a user.
2681
+ *
2682
+ * @tags Application
2683
+ * @name CreateCertificationApplicationReview
2684
+ * @summary Review Certification Application
2685
+ * @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
2686
+ * @secure
2687
+ */
2688
+ createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: InputEi9E1V7Rpe, params?: RequestParams) => Promise<any>;
2689
+ /**
2690
+ * @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.
2691
+ *
2692
+ * @tags Application
2693
+ * @name CreateCertificationApplicationPreApprovalReview
2694
+ * @summary Pre Approval Review Certification Application
2695
+ * @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
2696
+ * @secure
2697
+ */
2698
+ createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputVczxcyab6W, params?: RequestParams) => Promise<any>;
2699
+ /**
2700
+ * @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.
2701
+ *
2702
+ * @tags Certification
2703
+ * @name CreateCertificationCourseBatchRedeem
2704
+ * @summary Redeem Batch Course for User
2705
+ * @request POST:/user/certification/{certSpecID}/course/batchRedeem
2706
+ * @secure
2707
+ */
2708
+ createCertificationCourseBatchRedeem: (certSpecId: string, data: InputF6S7Tcgt9H, params?: RequestParams) => Promise<any>;
2709
+ /**
2710
+ * @description This endpoint allows for batch redeeming of course invites for a certification specification.
2711
+ *
2712
+ * @tags Course
2713
+ * @name CreateCertificationCourseBatchInvite
2714
+ * @summary Batch Course Invite
2715
+ * @request POST:/user/certification/{certSpecID}/course/batchInvite
2716
+ * @secure
2717
+ */
2718
+ createCertificationCourseBatchInvite: (certSpecId: string, data: InputTahl1X2Wos, params?: RequestParams) => Promise<any>;
2719
+ /**
2720
+ * @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.
2721
+ *
2722
+ * @tags Certification
2723
+ * @name CreateCertificationCourseSessionCancelEnrol
2724
+ * @summary Cancel Certification Enrolment
2725
+ * @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/cancelEnrol
2726
+ * @secure
2727
+ */
2728
+ createCertificationCourseSessionCancelEnrol: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<any>;
2729
+ /**
2730
+ * @description This route allows you to renew a certification process for a user. It will change the state of the certification process to "in progress" and reset the expiration date.
2731
+ *
2732
+ * @tags Certification
2733
+ * @name CreateCertificationRenew
2734
+ * @summary Renew Certification Process
2735
+ * @request POST:/user/{userID}/certification/{certProcID}/renew
2736
+ * @secure
2737
+ */
2738
+ createCertificationRenew: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
2739
+ /**
2740
+ * @description This route allows you to restart a certification process for a user.
2741
+ *
2742
+ * @tags Certification
2743
+ * @name CreateCertificationRestart
2744
+ * @summary Restart Certification Process
2745
+ * @request POST:/user/{userID}/certification/{certProcID}/restart
2746
+ * @secure
2747
+ */
2748
+ createCertificationRestart: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
2749
+ /**
2750
+ * @description This route allows you to waive a certification process for a user.
2751
+ *
2752
+ * @tags Certification
2753
+ * @name CreateCertificationWaive
2754
+ * @summary Waive Certification Process
2755
+ * @request POST:/user/{userID}/certification/{certProcID}/waive
2756
+ * @secure
2757
+ */
2758
+ createCertificationWaive: (userId: string, certProcId: string, data: InputW0G08Trp2L, params?: RequestParams) => Promise<any>;
2759
+ /**
2760
+ * @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
2761
+ *
2762
+ * @tags Certification
2763
+ * @name CreateCertificationMove
2764
+ * @summary Move Certification
2765
+ * @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
2766
+ * @secure
2767
+ */
2768
+ createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputSc6Zw56Dzq>;
2769
+ /**
2770
+ * @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.
2771
+ *
2772
+ * @tags Certification
2773
+ * @name CreateCertificationCourseSessionReplace
2774
+ * @summary Replace Certification Enrolment
2775
+ * @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/replace/{secUserID}
2776
+ * @secure
2777
+ */
2778
+ createCertificationCourseSessionReplace: (userId: string, certProcId: string, secUserId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<any>;
2779
+ /**
2780
+ * @description This route allows you to set a trigger check for a certification process, such as blocking courses.
2781
+ *
2782
+ * @tags Certification
2783
+ * @name CreateCertificationTriggerCheck
2784
+ * @summary Set trigger check for certification process
2785
+ * @request POST:/user/{userID}/certification/{certProcID}/trigger/check
2786
+ * @secure
2787
+ */
2788
+ createCertificationTriggerCheck: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
2789
+ /**
2790
+ * @description This route allows you to set a trigger for a certification process, such as blocking courses.
2791
+ *
2792
+ * @tags Certification
2793
+ * @name CreateCertificationTriggerSet
2794
+ * @summary Set trigger for certification process
2795
+ * @request POST:/user/{userID}/certification/{certProcID}/trigger/set
2796
+ * @secure
2797
+ */
2798
+ createCertificationTriggerSet: (userId: string, certProcId: string, data: Input7Vh389Cmk5, params?: RequestParams) => Promise<any>;
2799
+ /**
2800
+ * @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
2801
+ *
2802
+ * @tags User
2803
+ * @name CreateRefreshOrgMembership
2804
+ * @summary Refresh Organization Membership
2805
+ * @request POST:/user/{userID}/refreshOrgMembership
2806
+ * @secure
2807
+ */
2808
+ createRefreshOrgMembership: (userId: string, params?: RequestParams) => Promise<any>;
2809
+ /**
2810
+ * @description This route allows you to retake a course for a certification process for a user in a specific course.
2811
+ *
2812
+ * @tags Course
2813
+ * @name CreateCertificationCourseRetake
2814
+ * @summary Retake Course
2815
+ * @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/retake
2816
+ * @secure
2817
+ */
2818
+ createCertificationCourseRetake: (userId: string, certProcId: string, courseId: string, params?: RequestParams) => Promise<any>;
2819
+ /**
2820
+ * @description This route allows you to revoke a course for a certification process for a user in a specific course.
2821
+ *
2822
+ * @tags Course
2823
+ * @name CreateCertificationCourseRevoke
2824
+ * @summary Revoke Course
2825
+ * @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/revoke
2826
+ * @secure
2827
+ */
2828
+ createCertificationCourseRevoke: (userId: string, certProcId: string, courseId: string, params?: RequestParams) => Promise<any>;
2829
+ /**
2830
+ * @description Remove a specific version of an application item for a user in a certification process.
2831
+ *
2832
+ * @tags Application
2833
+ * @name CreateCertificationApplicationItemRemove
2834
+ * @summary Remove Application Item
2835
+ * @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/remove/{itemVersion}
2836
+ * @secure
2837
+ */
2838
+ createCertificationApplicationItemRemove: (userId: string, certProcId: string, sourceId: string, itemVersion: number, params?: RequestParams) => Promise<any>;
2839
+ /**
2840
+ * @description Remove a specific version of an application item for a user in a certification process.
2841
+ *
2842
+ * @tags Application
2843
+ * @name CreateCertificationApplicationItemReview
2844
+ * @summary Remove Application Item
2845
+ * @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
2846
+ * @secure
2847
+ */
2848
+ createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: number, data: InputJusp9Jdhxl, params?: RequestParams) => Promise<any>;
2849
+ /**
2850
+ * @description Returns the status of multiple requirements (e.g. student history) for a given user
2851
+ *
2852
+ * @tags Requirements
2853
+ * @name ListRequirements
2854
+ * @summary User requirements status
2855
+ * @request POST:/user/{userID}/requirements
2856
+ * @secure
2857
+ */
2858
+ listRequirements: (userId: string, data: StudentHistoryRequestSchema, params?: RequestParams) => Promise<StudentHistoryResponseSchema>;
2859
+ /**
2860
+ * @description Request certification process application submission approval
2861
+ *
2862
+ * @tags Application
2863
+ * @name CreateCertificationApplicationSubmit
2864
+ * @summary Submit Application Approval
2865
+ * @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
2866
+ * @secure
2867
+ */
2868
+ createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputVb1Vnjw2Eg, params?: RequestParams) => Promise<any>;
2869
+ /**
2870
+ * @description This route allows you to submit a pending approval.
2871
+ *
2872
+ * @tags Course
2873
+ * @name CreateCertificationCoursePendingApproval
2874
+ * @summary Submit Pending Approval
2875
+ * @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
2876
+ * @secure
2877
+ */
2878
+ createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputBkb7Btdukn, params?: RequestParams) => Promise<any>;
2879
+ /**
2880
+ * @description This route allows you to review a pending approval.
2881
+ *
2882
+ * @tags Course
2883
+ * @name UpdateCertificationCoursePendingApproval
2884
+ * @summary Review Pending Approval
2885
+ * @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
2886
+ * @secure
2887
+ */
2888
+ updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputC53Kuyqnej, params?: RequestParams) => Promise<any>;
2889
+ /**
2890
+ * @description Redeems a license for a user by product ID.
2891
+ *
2892
+ * @tags License
2893
+ * @name CreateCertificationCourseRedeem
2894
+ * @summary Redeem a License for a User
2895
+ * @request POST:/user/{userID}/certification/{certProcID}/course/redeem
2896
+ * @secure
2897
+ */
2898
+ createCertificationCourseRedeem: (userId: string, certProcId: string, data: InputBchr75Oc4N, params?: RequestParams) => Promise<any>;
2899
+ /**
2900
+ * @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
2901
+ *
2902
+ * @tags Certification
2903
+ * @name CreateCertificationMoveValidate
2904
+ * @summary Validate Certification Move
2905
+ * @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
2906
+ * @secure
2907
+ */
2908
+ createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputIwzp4Ltfkm>;
2909
+ /**
2910
+ * @description This route allows you to end the course period for a certification process for a user in a specific course.
2911
+ *
2912
+ * @tags Course
2913
+ * @name CreateCertificationCourseEndCooldown
2914
+ * @summary End Course Cooldown
2915
+ * @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
2916
+ * @secure
2917
+ */
2918
+ createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputAa84W6Sw3E, params?: RequestParams) => Promise<any>;
2919
+ /**
2920
+ * @description This route allows you to unlock a course for a certification process for a user in a specific course.
2921
+ *
2922
+ * @tags Course
2923
+ * @name CreateCertificationCourseUnlockCourse
2924
+ * @summary Unlock Course
2925
+ * @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
2926
+ * @secure
2927
+ */
2928
+ createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: InputQwegrxedmt, params?: RequestParams) => Promise<any>;
2929
+ /**
2930
+ * @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.
2931
+ *
2932
+ * @tags User
2933
+ * @name CreateUpdateIta
2934
+ * @summary Update User ITA Number
2935
+ * @request POST:/user/{userID}/updateITA
2936
+ * @secure
2937
+ */
2938
+ createUpdateIta: (userId: string, data: InputJkgsw7Yp8E, params?: RequestParams) => Promise<any>;
2939
+ /**
2940
+ * @description This route allows you to override the result of a course for a user in a certification process.
2941
+ *
2942
+ * @tags Course
2943
+ * @name UpdateCertificationCourseOverrideResult
2944
+ * @summary Override Course Result
2945
+ * @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
2946
+ * @secure
2947
+ */
2948
+ updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputQogzfpjg52, params?: RequestParams) => Promise<any>;
2949
+ /**
2950
+ * @description This route allows you to set or override the dates for a certification process for a user.
2951
+ *
2952
+ * @tags Certification
2953
+ * @name UpdateCertificationSetDates
2954
+ * @summary Set Certification Dates
2955
+ * @request PUT:/user/{userID}/certification/{certProcID}/setDates
2956
+ * @secure
2957
+ */
2958
+ updateCertificationSetDates: (userId: string, certProcId: string, data: Input7Kqbtz8S05, params?: RequestParams) => Promise<any>;
2959
+ };
2960
+ users: {
2961
+ /**
2962
+ * @description Searches for users by their certification specifications.
2963
+ *
2964
+ * @tags Users
2965
+ * @name CreateCertification
2966
+ * @summary Search Users by Certification
2967
+ * @request POST:/users/certification/{certSpecID}
2968
+ * @secure
2969
+ */
2970
+ createCertification: (certSpecId: string, data: InputPl0F8Ijrz3K, params?: RequestParams) => Promise<OutputPl0F8Ijrz3K>;
2971
+ };
2972
+ }