@ikonintegration/bccsa-program-api 3.0.19 → 3.0.21

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