@ikonintegration/bccsa-program-api 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/Api.ts ADDED
@@ -0,0 +1,4317 @@
1
+ /* eslint-disable */
2
+ /* tslint:disable */
3
+ /*
4
+ * ---------------------------------------------------------------
5
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API ##
6
+ * ## ##
7
+ * ## AUTHOR: acacode ##
8
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
9
+ * ---------------------------------------------------------------
10
+ */
11
+
12
+ /** Default API Error response */
13
+ export interface ErrorResponse {
14
+ /** Error message */
15
+ err: string
16
+ /** Error code */
17
+ errCode: string
18
+ }
19
+
20
+ export interface InputTprol08O25K {
21
+ /**
22
+ * Name of the person filling out the contact form
23
+ * @example "John Doe"
24
+ */
25
+ name: string
26
+ /**
27
+ * Email address of the person filling out the contact form
28
+ * @format email
29
+ * @example "john@mail"
30
+ */
31
+ email: string
32
+ /**
33
+ * Comments or message from the person filling out the contact form
34
+ * @example "I have a question about my account."
35
+ */
36
+ comments: string
37
+ }
38
+
39
+ /** Timestamp of when the record was created */
40
+ export type CreatedOn = number
41
+
42
+ /** User who created the record */
43
+ export type CreatedBy = string
44
+
45
+ /** User who last updated the record */
46
+ export type UpdatedBy = string
47
+
48
+ /** Timestamp of last update */
49
+ export type UpdateOn = number
50
+
51
+ /** Entity identifier for Course */
52
+ export type DbEntity = string
53
+
54
+ /** Unique identifier of the course record */
55
+ export type Id = string
56
+
57
+ /** Certification process ID linked to this course */
58
+ export type CertProcID = string
59
+
60
+ /** User ID associated with the course */
61
+ export type UserID = string
62
+
63
+ /** Customer ID associated with the course */
64
+ export type CustomerID = string
65
+
66
+ /** Tenant ID associated with the course */
67
+ export type TenantID = string
68
+
69
+ /** Course ID reference */
70
+ export type CourseID = string
71
+
72
+ /** When cooldown started */
73
+ export type CooldownStartedOn = number
74
+
75
+ /** When cooldown was overwritten */
76
+ export type CooldownOverwrittenOn = number
77
+
78
+ /** When course was locked */
79
+ export type CourseLockedOn = number
80
+
81
+ /** When course lock was overwritten */
82
+ export type CourseLockOverwrittenOn = number
83
+
84
+ /** Voucher code for the license */
85
+ export type LicenseVoucherCode = string
86
+
87
+ /** License ID used in the course */
88
+ export type LicenseID = string
89
+
90
+ /** ID for license invalidation */
91
+ export type LicenseInvalidateID = string
92
+
93
+ /** Session ticket ID for course access */
94
+ export type SessionTicketID = string
95
+
96
+ /** Session ID for course tracking */
97
+ export type SessionID = string
98
+
99
+ /** Result of the course */
100
+ export type CourseResult = string
101
+
102
+ /** Certificate number for the course */
103
+ export type CourseCertNumber = string
104
+
105
+ /** Date of course completion */
106
+ export type CompletionDate = number
107
+
108
+ /** Date when certificate was printed */
109
+ export type CertificatePrintedOn = number
110
+
111
+ /** Date when card was printed */
112
+ export type CardPrintedOnDate = number
113
+
114
+ /** Date of certificate/card shipping */
115
+ export type ShippingDate = number
116
+
117
+ /** Whether data is copied from an alternate certification process */
118
+ export type IsCopiedFromAlternateCP = boolean
119
+
120
+ /** Reminders sent before course expiry */
121
+ export type ExpireReminders = string[]
122
+
123
+ /** Expiration date of the course */
124
+ export type ExpiryDate = number
125
+
126
+ /** Key used for indexing expiryDate */
127
+ export type ExpiryDateKey = string
128
+
129
+ /** Whether the course has been invalidated */
130
+ export type Invalidated = boolean
131
+
132
+ /** Whether a course retake has been requested */
133
+ export type RetakeRequested = boolean
134
+
135
+ /** Current state of the course */
136
+ export type State = string
137
+
138
+ /** Approval state of the course */
139
+ export type ApprovalState = string
140
+
141
+ /** Notes about the course approval process */
142
+ export type ApprovalNotes = string
143
+
144
+ /** List of submitted files for the course */
145
+ export type SubmissionItems = {
146
+ fileID?: string
147
+ fileName?: string
148
+ }[]
149
+
150
+ /** User who waived the course requirement */
151
+ export type WaivedBy = string
152
+
153
+ /** Date when course was waived */
154
+ export type WaivedOn = number
155
+
156
+ /** Justifications for overridden course restrictions */
157
+ export interface OverwrittenJustification {
158
+ cooldown_override?: string
159
+ course_unlock?: string
160
+ }
161
+
162
+ /** Response schema for user data */
163
+ export interface UserResponseEntity {
164
+ userResp?: {
165
+ applications?: {
166
+ /** @example 1717230000000 */
167
+ createdOn?: number
168
+ /** @example "USR#abc" */
169
+ createdBy?: string
170
+ /** @example "USR#xyz" */
171
+ updatedBy?: string
172
+ /** @example 1717230000000 */
173
+ updatedOn?: number
174
+ /** @example "prgCertificationApplication" */
175
+ dbEntity?: string
176
+ /** @example "CUST#123" */
177
+ customerID: string
178
+ /** @example "TEN#456" */
179
+ tenantID: string
180
+ /** @example "USR#789" */
181
+ userID: string
182
+ /** @example "CP#0001" */
183
+ certProcID: string
184
+ /** @example "CERT#01" */
185
+ certificationID?: string
186
+ /** @example "initial" */
187
+ type: string
188
+ /** @example "LIC#999" */
189
+ licenseID?: string
190
+ /** @example "LICINV#555" */
191
+ licenseInvalidateID?: string
192
+ /** @example "submitted" */
193
+ state?: string
194
+ /** @example 1717231111111 */
195
+ submittedOn?: number
196
+ /** @example "USR#sub" */
197
+ submittedBy?: string
198
+ /** @example "USR#rev" */
199
+ reviewedBy?: string
200
+ /** @example 1717232222222 */
201
+ reviewedOn?: number
202
+ /** @example "Everything looks good." */
203
+ reviewNotes?: string
204
+ /** @example 1 */
205
+ reviewAcknowledge?: number
206
+ /** @example [{"id":"ITEM#1","version":1,"type":"doc"}] */
207
+ submissionItems?: {
208
+ /** @example "ITEM#1" */
209
+ id?: string
210
+ /** @example 1 */
211
+ version?: number
212
+ /** @example "doc" */
213
+ type?: string
214
+ }[]
215
+ /** @example ["ITEM#2"] */
216
+ blacklistedItems?: string[]
217
+ }[]
218
+ certificationProcesses?: {
219
+ /** @example "abc123" */
220
+ id: string
221
+ /** @example "tenant001" */
222
+ tenantID: string
223
+ /** @example "user001" */
224
+ userID: string
225
+ /** @example "cert001" */
226
+ certificationID: string
227
+ /** @example 1717000000000 */
228
+ createdOn?: number
229
+ /** @example "admin" */
230
+ createdBy?: string
231
+ /** @example "admin" */
232
+ updatedBy?: string
233
+ /** @example 1717000000000 */
234
+ updatedOn?: number
235
+ /** @example "prgCertificationProcess" */
236
+ dbEntity?: string
237
+ /** @example "CERT-2025-XYZ" */
238
+ certNumber?: string
239
+ /** @example 1717000000000 */
240
+ completionDate?: number
241
+ /** @example 1716000000000 */
242
+ originalCompletionDate?: number
243
+ /** @example 1717000000000 */
244
+ cardPrintedOn?: number
245
+ /** @example 1717000000000 */
246
+ certificatePrintedOn?: number
247
+ /** @example 1717000000000 */
248
+ shippingDate?: number
249
+ /** @example 1717000000000 */
250
+ lastCourseCompletionDate?: number
251
+ /** @example ["course1","course2"] */
252
+ blockedCourses?: string[]
253
+ triggerState?: Record<
254
+ string,
255
+ {
256
+ /** @example "triggered" */
257
+ state?: string
258
+ /** @example 1717000000000 */
259
+ updatedOn?: number
260
+ /** @example "OK" */
261
+ requestResult?: any
262
+ }
263
+ >
264
+ /** @example 85 */
265
+ pointsAchieved?: number
266
+ /** @example ["email1","email2"] */
267
+ expireReminders?: string[]
268
+ /** @example 1718000000000 */
269
+ expiryDate?: number
270
+ /** @example "active" */
271
+ state?: string
272
+ /** @example "completed" */
273
+ stage?: string
274
+ /** @example "passed" */
275
+ stageLastCourseState?: string
276
+ /** @example 1717000000000 */
277
+ manualOverrideOn?: number
278
+ /** @example 120.5 */
279
+ pendingPaymentValue?: number
280
+ /** @example "Manual override" */
281
+ overwrittenJustification?: string
282
+ /** @example 15 */
283
+ commissionAmount?: number
284
+ /** @example "affiliate001" */
285
+ commissionPayTo?: string
286
+ /** @example 15 */
287
+ commissionPaid?: number
288
+ /** @example "manager" */
289
+ waivedBy?: string
290
+ /** @example 1717000000000 */
291
+ waivedOn?: number
292
+ /** @example "Waived due to exception" */
293
+ waivedComments?: string
294
+ }[]
295
+ courses?: {
296
+ /** Timestamp of when the record was created */
297
+ createdOn?: CreatedOn
298
+ /** User who created the record */
299
+ createdBy?: CreatedBy
300
+ /** User who last updated the record */
301
+ updatedBy?: UpdatedBy
302
+ /** Timestamp of last update */
303
+ updateOn?: UpdateOn
304
+ /** Entity identifier for Course */
305
+ dbEntity?: DbEntity
306
+ /** Unique identifier of the course record */
307
+ id: Id
308
+ /** Certification process ID linked to this course */
309
+ certProcID: CertProcID
310
+ /** User ID associated with the course */
311
+ userID: UserID
312
+ /** Customer ID associated with the course */
313
+ customerID: CustomerID
314
+ /** Tenant ID associated with the course */
315
+ tenantID: TenantID
316
+ /** Course ID reference */
317
+ courseID?: CourseID
318
+ /** When cooldown started */
319
+ cooldownStartedOn?: CooldownStartedOn
320
+ /** When cooldown was overwritten */
321
+ cooldownOverwrittenOn?: CooldownOverwrittenOn
322
+ /** When course was locked */
323
+ courseLockedOn?: CourseLockedOn
324
+ /** When course lock was overwritten */
325
+ courseLockOverwrittenOn?: CourseLockOverwrittenOn
326
+ /** Voucher code for the license */
327
+ licenseVoucherCode?: LicenseVoucherCode
328
+ /** License ID used in the course */
329
+ licenseID?: LicenseID
330
+ /** ID for license invalidation */
331
+ licenseInvalidateID?: LicenseInvalidateID
332
+ /** Session ticket ID for course access */
333
+ sessionTicketID?: SessionTicketID
334
+ /** Session ID for course tracking */
335
+ sessionID?: SessionID
336
+ /** Result of the course */
337
+ courseResult?: CourseResult
338
+ /** Certificate number for the course */
339
+ courseCertNumber?: CourseCertNumber
340
+ /** Date of course completion */
341
+ completionDate?: CompletionDate
342
+ /** Date when certificate was printed */
343
+ certificatePrintedOn?: CertificatePrintedOn
344
+ /** Date when card was printed */
345
+ cardPrintedOnDate?: CardPrintedOnDate
346
+ /** Date of certificate/card shipping */
347
+ shippingDate?: ShippingDate
348
+ /** Whether data is copied from an alternate certification process */
349
+ isCopiedFromAlternateCP?: IsCopiedFromAlternateCP
350
+ /** Reminders sent before course expiry */
351
+ expireReminders?: ExpireReminders
352
+ /** Expiration date of the course */
353
+ expiryDate?: ExpiryDate
354
+ /** Key used for indexing expiryDate */
355
+ expiryDateKey?: ExpiryDateKey
356
+ /** Whether the course has been invalidated */
357
+ invalidated?: Invalidated
358
+ /** Whether a course retake has been requested */
359
+ retakeRequested?: RetakeRequested
360
+ /** Current state of the course */
361
+ state?: State
362
+ /** Approval state of the course */
363
+ approvalState?: ApprovalState
364
+ /** Notes about the course approval process */
365
+ approvalNotes?: ApprovalNotes
366
+ /** List of submitted files for the course */
367
+ submissionItems?: SubmissionItems
368
+ /** User who waived the course requirement */
369
+ waivedBy?: WaivedBy
370
+ /** Date when course was waived */
371
+ waivedOn?: WaivedOn
372
+ /** Justifications for overridden course restrictions */
373
+ overwrittenJustification?: OverwrittenJustification
374
+ }[]
375
+ }
376
+ transactionID?: string | null
377
+ }
378
+
379
+ /** Associated Certification ID */
380
+ export type CertificationID = string
381
+
382
+ /** Type of application */
383
+ export type Type = string
384
+
385
+ /** Timestamp when the application was submitted */
386
+ export type SubmittedOn = number
387
+
388
+ /** User who submitted the application */
389
+ export type SubmittedBy = string
390
+
391
+ /** User who reviewed the application */
392
+ export type ReviewedBy = string
393
+
394
+ /** Timestamp when the application was reviewed */
395
+ export type ReviewedOn = number
396
+
397
+ /** Notes related to the review process */
398
+ export type ReviewNotes = string
399
+
400
+ /** Whether the review was acknowledged */
401
+ export type ReviewAcknowledge = number
402
+
403
+ /** Version of the submission item */
404
+ export type Version = number
405
+
406
+ /** List of blacklisted item IDs for this application */
407
+ export type BlacklistedItems = string[]
408
+
409
+ /** Response schema for applications */
410
+ export interface ApplicationResponseSchema {
411
+ applications:
412
+ | {
413
+ /** Timestamp of when the application was created */
414
+ createdOn?: CreatedOn
415
+ /** User who created the application */
416
+ createdBy?: CreatedBy
417
+ /** User who last updated the application */
418
+ updatedBy?: UpdatedBy
419
+ /** Timestamp of the last update */
420
+ updateOn?: UpdateOn
421
+ /** Static identifier for the entity type */
422
+ dbEntity?: DbEntity
423
+ /** Customer ID associated with the application */
424
+ customerID: CustomerID
425
+ /** Tenant ID associated with the application */
426
+ tenantID: TenantID
427
+ /** User ID for whom the application was submitted */
428
+ userID: UserID
429
+ /** Certification Process ID related to this application */
430
+ certProcID: CertProcID
431
+ /** Associated Certification ID */
432
+ certificationID?: CertificationID
433
+ /** Type of application */
434
+ type: Type
435
+ /** ID of the license involved in the application */
436
+ licenseID?: LicenseID
437
+ /** ID of the license invalidation record */
438
+ licenseInvalidateID?: LicenseInvalidateID
439
+ /** Current state of the application */
440
+ state?: State
441
+ /** Timestamp when the application was submitted */
442
+ submittedOn?: SubmittedOn
443
+ /** User who submitted the application */
444
+ submittedBy?: SubmittedBy
445
+ /** User who reviewed the application */
446
+ reviewedBy?: ReviewedBy
447
+ /** Timestamp when the application was reviewed */
448
+ reviewedOn?: ReviewedOn
449
+ /** Notes related to the review process */
450
+ reviewNotes?: ReviewNotes
451
+ /** Whether the review was acknowledged */
452
+ reviewAcknowledge?: ReviewAcknowledge
453
+ /** List of submission items attached to the application */
454
+ submissionItems?: SubmissionItems &
455
+ {
456
+ /** ID of the submission item */
457
+ id?: Id
458
+ /** Version of the submission item */
459
+ version?: Version
460
+ /** Type of the submission item */
461
+ type?: Type
462
+ }[]
463
+ /** List of blacklisted item IDs for this application */
464
+ blacklistedItems?: BlacklistedItems
465
+ }[]
466
+ | null
467
+ transactionID?: string | null
468
+ }
469
+
470
+ /** Timestamp when the entry was last updated */
471
+ export type UpdatedOn = number
472
+
473
+ /** Name of the user or entity */
474
+ export type Name = string
475
+
476
+ /** Title of the certification process */
477
+ export type CertTitle = string
478
+
479
+ /** User display name */
480
+ export type DisplayName = string
481
+
482
+ /** ID of the submitted file */
483
+ export type FileID = string
484
+
485
+ /** Name of the submitted file */
486
+ export type FileName = string
487
+
488
+ /** Response schema for pending approvals */
489
+ export interface PendingApprovalResponseSchema {
490
+ paItems:
491
+ | {
492
+ /** User who created the pending approval entry */
493
+ createdBy: CreatedBy
494
+ /** Timestamp when the pending approval was created */
495
+ createdOn: CreatedOn
496
+ /** User who last updated the entry */
497
+ updatedBy?: UpdatedBy
498
+ /** Timestamp when the entry was last updated */
499
+ updatedOn?: UpdatedOn
500
+ /** Static identifier for the entity type */
501
+ dbEntity: DbEntity
502
+ /** ID of the pending approval */
503
+ id: Id
504
+ /** Type of pending approval */
505
+ type: Type
506
+ /** User ID associated with the pending approval */
507
+ userID: UserID
508
+ /** Name of the user or entity */
509
+ name?: Name
510
+ /** Certification Process ID */
511
+ certProcID?: CertProcID
512
+ /** Title of the certification process */
513
+ certTitle?: CertTitle
514
+ /** Tenant ID */
515
+ tenantID: TenantID
516
+ /** Course ID if applicable */
517
+ courseID?: CourseID
518
+ /** User display name */
519
+ displayName?: DisplayName
520
+ /** List of submitted files for approval */
521
+ submissionItems?: SubmissionItems &
522
+ {
523
+ /** ID of the submitted file */
524
+ fileID?: FileID
525
+ /** Name of the submitted file */
526
+ fileName?: FileName
527
+ }[]
528
+ }[]
529
+ | null
530
+ }
531
+
532
+ export interface InputN4Ndusy4P2 {
533
+ /**
534
+ * ID of the certification to filter applications by
535
+ * @example "certification123"
536
+ */
537
+ certificationID: string
538
+ /**
539
+ * Type of application, can be null or omitted
540
+ * @example "typeA"
541
+ */
542
+ type?: string | null
543
+ /**
544
+ * State of the application
545
+ * @example "submitted"
546
+ */
547
+ state: string
548
+ /**
549
+ * Timestamp for the start of the submission date range
550
+ * @example 1672531200
551
+ */
552
+ submittedFrom?: number | null
553
+ /**
554
+ * Timestamp for the end of the submission date range
555
+ * @example 1672617600
556
+ */
557
+ submittedTo?: number | null
558
+ /**
559
+ * Timestamp for the start of the review date range
560
+ * @example 1672704000
561
+ */
562
+ reviewedFrom?: number | null
563
+ /**
564
+ * Timestamp for the end of the review date range
565
+ * @example 1672790400
566
+ */
567
+ reviewedTo?: number | null
568
+ /**
569
+ * Timestamp for the start of the creation date range
570
+ * @example 1672876800
571
+ */
572
+ createdFrom?: number | null
573
+ /**
574
+ * Timestamp for the end of the creation date range
575
+ * @example 1672963200
576
+ */
577
+ createdTo?: number | null
578
+ /**
579
+ * User course status, can be null or omitted. Used to filter applications based on user course status.
580
+ * @example "completed"
581
+ */
582
+ userCourseStatus?: string | null
583
+ /**
584
+ * Flag to ignore completed certifications when filtering applications. Defaults to false if not provided.
585
+ * @example true
586
+ */
587
+ ignoreCompletedCertifications?: boolean | null
588
+ }
589
+
590
+ export interface InputHay4A10Oxo {
591
+ /**
592
+ * ID of the certification to filter applications by
593
+ * @example "certification123"
594
+ */
595
+ certificationID: string
596
+ }
597
+
598
+ export interface Input39Rlhyxzj2 {
599
+ /**
600
+ * ID of the certification to filter applications by
601
+ * @example "certification123"
602
+ */
603
+ certificationID: string
604
+ /**
605
+ * Type of application, can be null or omitted
606
+ * @example "typeA"
607
+ */
608
+ type?: string | null
609
+ /**
610
+ * State of the application
611
+ * @example "submitted"
612
+ */
613
+ state: string
614
+ /**
615
+ * Timestamp for the start of the submission date range
616
+ * @example 1672531200
617
+ */
618
+ submittedFrom?: number | null
619
+ /**
620
+ * Timestamp for the end of the submission date range
621
+ * @example 1672617600
622
+ */
623
+ submittedTo?: number | null
624
+ /**
625
+ * Timestamp for the start of the review date range
626
+ * @example 1672704000
627
+ */
628
+ reviewedFrom?: number | null
629
+ /**
630
+ * Timestamp for the end of the review date range
631
+ * @example 1672790400
632
+ */
633
+ reviewedTo?: number | null
634
+ /**
635
+ * Timestamp for the start of the creation date range
636
+ * @example 1672876800
637
+ */
638
+ createdFrom?: number | null
639
+ /**
640
+ * Timestamp for the end of the creation date range
641
+ * @example 1672963200
642
+ */
643
+ createdTo?: number | null
644
+ /**
645
+ * User course status, can be null or omitted. Used to filter applications based on user course status.
646
+ * @example "completed"
647
+ */
648
+ userCourseStatus?: string | null
649
+ /**
650
+ * Flag to ignore completed certifications when filtering applications. Defaults to false if not provided.
651
+ * @example true
652
+ */
653
+ ignoreCompletedCertifications?: boolean | null
654
+ }
655
+
656
+ export interface InputLop7Riutcm {
657
+ /**
658
+ * The ID of the certificate specifications to be used for the email
659
+ * @example "certSpecsID123"
660
+ */
661
+ certSpecsID: string
662
+ /**
663
+ * The ID of the course associated with the certificate
664
+ * @example "courseID456"
665
+ */
666
+ courseID: string
667
+ /**
668
+ * Whether to CC administrators in the email
669
+ * @example true
670
+ */
671
+ ccAdmins?: boolean
672
+ /** List of recipients who will receive the certificate email */
673
+ recipients: {
674
+ /**
675
+ * Full name of the recipient
676
+ * @example "Jane Doe"
677
+ */
678
+ name: string
679
+ /**
680
+ * The date the recipient completed the course (format: yyyy-mm-dd)
681
+ * @example "2025-06-01"
682
+ */
683
+ completionDate: string
684
+ /**
685
+ * The certificate number assigned to the recipient
686
+ * @example "CERT-0001"
687
+ */
688
+ certNum: string
689
+ /**
690
+ * Email address of the recipient
691
+ * @format email
692
+ * @example "jane.doe@example.com"
693
+ */
694
+ emailAddress: string
695
+ }[]
696
+ }
697
+
698
+ export interface InputGikxez8Kaz {
699
+ /**
700
+ * The ID of the product for which the license is being redeemed
701
+ * @example "productID123"
702
+ */
703
+ productID: string
704
+ /**
705
+ * The ID of the session associated with the license redemption
706
+ * @example "sessionID456"
707
+ */
708
+ sessionID?: string
709
+ }
710
+
711
+ export interface InputK0Mnve89M3 {
712
+ /**
713
+ * Search term to filter licenses
714
+ * @example "active"
715
+ */
716
+ searchTerm?: string
717
+ /**
718
+ * Order of sorting, e.g., "asc" or "desc"
719
+ * @example "asc"
720
+ */
721
+ sortOrder?: any
722
+ /**
723
+ * Field by which to sort the report
724
+ * @example "created_at"
725
+ */
726
+ sortField?: any
727
+ }
728
+
729
+ export interface Input560Aguh4X3 {
730
+ /**
731
+ * Search term to filter licenses
732
+ * @example "active"
733
+ */
734
+ searchTerm?: string
735
+ /**
736
+ * Start date for the report
737
+ * @example "2023-01-01T00:00:00Z"
738
+ */
739
+ from?: any
740
+ /**
741
+ * Order of sorting, e.g., "asc" or "desc"
742
+ * @example "asc"
743
+ */
744
+ sortOrder?: any
745
+ /**
746
+ * Field by which to sort the report
747
+ * @example "created_at"
748
+ */
749
+ sortField?: any
750
+ }
751
+
752
+ /** Filters offered for NCSO export report */
753
+ export interface NcsoReportRequestSchema {
754
+ filters: {
755
+ originalCompletionDateFrom?: number
756
+ originalCompletionDateTo?: number
757
+ completionDateFrom?: number
758
+ completionDateTo?: number
759
+ expiryDateFrom?: number
760
+ expiryDateTo?: number
761
+ hideExpired?: boolean
762
+ }
763
+ }
764
+
765
+ /** Report export as xlsx */
766
+ export interface ReportXLSXSchema {
767
+ xlsxStream: any
768
+ contentType: ReportXlsxSchemaContentTypeEnum
769
+ }
770
+
771
+ export interface InputK49I8Qntjc {
772
+ /**
773
+ * Start date for the report
774
+ * @example "2023-01-01T00:00:00Z"
775
+ */
776
+ from?: any
777
+ /**
778
+ * End date for the report
779
+ * @example "2023-12-31T23:59:59Z"
780
+ */
781
+ to?: any
782
+ /**
783
+ * List of columns to include in the report
784
+ * @example ["name","email","created_at"]
785
+ */
786
+ columns: string[]
787
+ /**
788
+ * Type of date to filter by, e.g., "created_at", "updated_at"
789
+ * @example "created_at"
790
+ */
791
+ dateType?: string
792
+ }
793
+
794
+ export interface InputWxkq7Niqao {
795
+ /** List of user IDs to search for in the tenant. */
796
+ IDs: (string | null)[]
797
+ }
798
+
799
+ export interface InputG5Bir0Wo4E {
800
+ /** The term to search for in the user profiles. */
801
+ searchTerm?: string | null
802
+ /** Filter criteria for the user search. */
803
+ filter: {
804
+ /** Quantifier for advanced search, used when searchTerm is ignored. */
805
+ quantifier?: string
806
+ advancedFilters?: {
807
+ field?: string
808
+ qualifier?: string
809
+ value?: string | string[]
810
+ }[]
811
+ status?: string | null
812
+ from?: number | null
813
+ sortOrder?: string | null
814
+ sortField?: string | null
815
+ courseSpecsID?: string | string[]
816
+ registerDate1?: string | null
817
+ registerDate2?: string | null
818
+ certSpecsID?: string | string[]
819
+ signinDate1?: string | null
820
+ signinDate2?: string | null
821
+ organization?: string | null
822
+ employerID?: string | null
823
+ certExpDate1?: string | null
824
+ certExpDate2?: string | null
825
+ userCourseStatus?: string | null
826
+ applicationFilters?: {
827
+ createdDate1?: number | null
828
+ createdDate2?: number | null
829
+ submittedDate1?: number | null
830
+ submittedDate2?: number | null
831
+ reviewedDate1?: number | null
832
+ reviewedDate2?: number | null
833
+ status?: string | null
834
+ type?: string | null
835
+ ignoreCompletedCertifications?: boolean
836
+ }
837
+ }
838
+ }
839
+
840
+ export interface InputNdh9V3T3Og {
841
+ /** The term to search for in the user profiles. */
842
+ searchTerm?: string | null
843
+ /** Filter criteria for the user search. */
844
+ filter: {
845
+ /** Quantifier for advanced search, used when searchTerm is ignored. */
846
+ quantifier?: string
847
+ advancedFilters?: {
848
+ field?: string
849
+ qualifier?: string
850
+ value?: string | string[]
851
+ }[]
852
+ status?: string | null
853
+ from?: number | null
854
+ sortOrder?: string | null
855
+ sortField?: string | null
856
+ courseSpecsID?: string | string[]
857
+ registerDate1?: string | null
858
+ registerDate2?: string | null
859
+ certSpecsID?: string | string[]
860
+ signinDate1?: string | null
861
+ signinDate2?: string | null
862
+ organization?: string | null
863
+ employerID?: string | null
864
+ certExpDate1?: string | null
865
+ certExpDate2?: string | null
866
+ userCourseStatus?: string | null
867
+ applicationFilters?: {
868
+ createdDate1?: number | null
869
+ createdDate2?: number | null
870
+ submittedDate1?: number | null
871
+ submittedDate2?: number | null
872
+ reviewedDate1?: number | null
873
+ reviewedDate2?: number | null
874
+ status?: string | null
875
+ type?: string | null
876
+ ignoreCompletedCertifications?: boolean
877
+ }
878
+ }
879
+ }
880
+
881
+ export interface OutputKin04Ituf7 {
882
+ /**
883
+ * Signed URL for the course file
884
+ * @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"
885
+ */
886
+ fileURL: string
887
+ }
888
+
889
+ export interface OutputDwlxivng9Li {
890
+ /**
891
+ * Amount to be refunded for the cancellation
892
+ * @example 0
893
+ */
894
+ refundAmount: number
895
+ /**
896
+ * Shipping charges applicable for the cancellation
897
+ * @example 0
898
+ */
899
+ shippingCharges: number
900
+ /**
901
+ * Total value paid for the course
902
+ * @example 0
903
+ */
904
+ valuePaid: number
905
+ /**
906
+ * Price of the product associated with the course
907
+ * @example 0
908
+ */
909
+ productPrice: number
910
+ /**
911
+ * Charge applied for the cancellation
912
+ * @example 0
913
+ */
914
+ cancelationCharge: number
915
+ /**
916
+ * Taxes applicable on the cancellation
917
+ * @example 0
918
+ */
919
+ taxes: number
920
+ /**
921
+ * ID of the original order, if applicable
922
+ * @example null
923
+ */
924
+ originalOrderID: string | null
925
+ /**
926
+ * Transaction ID for the cancellation process
927
+ * @example "cmbtgpcd800240byldq29bqt0-cmbtgpcd800250bylby45corg"
928
+ */
929
+ transactionID: string
930
+ }
931
+
932
+ /** Certification number issued to the user */
933
+ export type CertNumber = string
934
+
935
+ /** Original date of completion */
936
+ export type OriginalCompletionDate = number
937
+
938
+ /** Date when the card was printed */
939
+ export type CardPrintedOn = number
940
+
941
+ /** Completion date of the last related course */
942
+ export type LastCourseCompletionDate = number
943
+
944
+ /** Date when manual override was applied */
945
+ export type ManualOverrideOn = number
946
+
947
+ /** Stage of the certification process */
948
+ export type Stage = string
949
+
950
+ /** Last state of the course within this stage */
951
+ export type StageLastCourseState = string
952
+
953
+ /** Points achieved in the process */
954
+ export type PointsAchieved = number
955
+
956
+ /** Pending payment value */
957
+ export type PendingPaymentValue = number
958
+
959
+ /** Courses that are currently blocked */
960
+ export type BlockedCourses = string[]
961
+
962
+ /** Status information for trigger states (e.g., NEW, RENEW) */
963
+ export type TriggerState = Record<
964
+ string,
965
+ {
966
+ state?: string
967
+ updatedOn?: number
968
+ requestResult?: string
969
+ }
970
+ >
971
+
972
+ /** Amount to be paid as commission */
973
+ export type CommissionAmount = number
974
+
975
+ /** Recipient of the commission payment */
976
+ export type CommissionPayTo = string
977
+
978
+ /** Amount of commission already paid */
979
+ export type CommissionPaid = number
980
+
981
+ /** Comments related to the waiver */
982
+ export type WaivedComments = string
983
+
984
+ /** Response with list of certification processes */
985
+ export interface CertificationProcessResponseSchema {
986
+ procs:
987
+ | {
988
+ /** Unique identifier for the certification process */
989
+ id: Id
990
+ /** Tenant ID associated with this certification process */
991
+ tenantID: TenantID
992
+ /** User ID associated with this certification process */
993
+ userID: UserID
994
+ /** ID of the certification being processed */
995
+ certificationID: CertificationID
996
+ /** Timestamp of when the record was created */
997
+ createdOn?: CreatedOn
998
+ /** User who created the record */
999
+ createdBy?: CreatedBy
1000
+ /** Timestamp of last update */
1001
+ updatedOn?: UpdatedOn
1002
+ /** User who last updated the record */
1003
+ updatedBy?: UpdatedBy
1004
+ /** Internal database entity identifier */
1005
+ dbEntity?: DbEntity
1006
+ /** Certification number issued to the user */
1007
+ certNumber?: CertNumber
1008
+ /** Date of certification completion */
1009
+ completionDate?: CompletionDate
1010
+ /** Original date of completion */
1011
+ originalCompletionDate?: OriginalCompletionDate
1012
+ /** Date when the card was printed */
1013
+ cardPrintedOn?: CardPrintedOn
1014
+ /** Date when the certificate was printed */
1015
+ certificatePrintedOn?: CertificatePrintedOn
1016
+ /** Shipping date of the certificate/card */
1017
+ shippingDate?: ShippingDate
1018
+ /** Completion date of the last related course */
1019
+ lastCourseCompletionDate?: LastCourseCompletionDate
1020
+ /** Expiration date of the certification */
1021
+ expiryDate?: ExpiryDate
1022
+ /** Date when manual override was applied */
1023
+ manualOverrideOn?: ManualOverrideOn
1024
+ /** State of the certification process */
1025
+ state?: State
1026
+ /** Stage of the certification process */
1027
+ stage?: Stage
1028
+ /** Last state of the course within this stage */
1029
+ stageLastCourseState?: StageLastCourseState
1030
+ /** Points achieved in the process */
1031
+ pointsAchieved?: PointsAchieved
1032
+ /** Pending payment value */
1033
+ pendingPaymentValue?: PendingPaymentValue
1034
+ /** Courses that are currently blocked */
1035
+ blockedCourses?: BlockedCourses
1036
+ /** List of reminder IDs sent before expiry */
1037
+ expireReminders?: ExpireReminders
1038
+ /** Status information for trigger states (e.g., NEW, RENEW) */
1039
+ triggerState?: TriggerState
1040
+ /** Amount to be paid as commission */
1041
+ commissionAmount?: CommissionAmount
1042
+ /** Recipient of the commission payment */
1043
+ commissionPayTo?: CommissionPayTo
1044
+ /** Amount of commission already paid */
1045
+ commissionPaid?: CommissionPaid
1046
+ /** User who waived the certification */
1047
+ waivedBy?: WaivedBy
1048
+ /** Date when the waiver occurred */
1049
+ waivedOn?: WaivedOn
1050
+ /** Comments related to the waiver */
1051
+ waivedComments?: WaivedComments
1052
+ /** Justification text for overwritten actions */
1053
+ overwrittenJustification?: OverwrittenJustification & string
1054
+ }[]
1055
+ | null
1056
+ transactionID?: string | null
1057
+ }
1058
+
1059
+ /** Response schema for certification application data */
1060
+ export interface CertificationApplicationResponseEntity {
1061
+ /** Certification application details */
1062
+ applicationResp: {
1063
+ /** @example 1717230000000 */
1064
+ createdOn?: number
1065
+ /** @example "USR#abc" */
1066
+ createdBy?: string
1067
+ /** @example "USR#xyz" */
1068
+ updatedBy?: string
1069
+ /** @example 1717230000000 */
1070
+ updatedOn?: number
1071
+ /** @example "prgCertificationApplication" */
1072
+ dbEntity?: string
1073
+ /** @example "CUST#123" */
1074
+ customerID: string
1075
+ /** @example "TEN#456" */
1076
+ tenantID: string
1077
+ /** @example "USR#789" */
1078
+ userID: string
1079
+ /** @example "CP#0001" */
1080
+ certProcID: string
1081
+ /** @example "CERT#01" */
1082
+ certificationID?: string
1083
+ /** @example "initial" */
1084
+ type: string
1085
+ /** @example "LIC#999" */
1086
+ licenseID?: string
1087
+ /** @example "LICINV#555" */
1088
+ licenseInvalidateID?: string
1089
+ /** @example "submitted" */
1090
+ state?: string
1091
+ /** @example 1717231111111 */
1092
+ submittedOn?: number
1093
+ /** @example "USR#sub" */
1094
+ submittedBy?: string
1095
+ /** @example "USR#rev" */
1096
+ reviewedBy?: string
1097
+ /** @example 1717232222222 */
1098
+ reviewedOn?: number
1099
+ /** @example "Everything looks good." */
1100
+ reviewNotes?: string
1101
+ /** @example 1 */
1102
+ reviewAcknowledge?: number
1103
+ /** @example [{"id":"ITEM#1","version":1,"type":"doc"}] */
1104
+ submissionItems?: {
1105
+ /** @example "ITEM#1" */
1106
+ id?: string
1107
+ /** @example 1 */
1108
+ version?: number
1109
+ /** @example "doc" */
1110
+ type?: string
1111
+ }[]
1112
+ /** @example ["ITEM#2"] */
1113
+ blacklistedItems?: string[]
1114
+ }
1115
+ }
1116
+
1117
+ /** Single course object */
1118
+ export interface CourseResponseEntity {
1119
+ /** Timestamp of when the record was created */
1120
+ createdOn?: CreatedOn
1121
+ /** User who created the record */
1122
+ createdBy?: CreatedBy
1123
+ /** User who last updated the record */
1124
+ updatedBy?: UpdatedBy
1125
+ /** Timestamp of last update */
1126
+ updateOn?: UpdateOn
1127
+ /** Entity identifier for Course */
1128
+ dbEntity?: DbEntity
1129
+ /** Unique identifier of the course record */
1130
+ id: Id
1131
+ /** Certification process ID linked to this course */
1132
+ certProcID: CertProcID
1133
+ /** User ID associated with the course */
1134
+ userID: UserID
1135
+ /** Customer ID associated with the course */
1136
+ customerID: CustomerID
1137
+ /** Tenant ID associated with the course */
1138
+ tenantID: TenantID
1139
+ /** Course ID reference */
1140
+ courseID?: CourseID
1141
+ /** When cooldown started */
1142
+ cooldownStartedOn?: CooldownStartedOn
1143
+ /** When cooldown was overwritten */
1144
+ cooldownOverwrittenOn?: CooldownOverwrittenOn
1145
+ /** When course was locked */
1146
+ courseLockedOn?: CourseLockedOn
1147
+ /** When course lock was overwritten */
1148
+ courseLockOverwrittenOn?: CourseLockOverwrittenOn
1149
+ /** Voucher code for the license */
1150
+ licenseVoucherCode?: LicenseVoucherCode
1151
+ /** License ID used in the course */
1152
+ licenseID?: LicenseID
1153
+ /** ID for license invalidation */
1154
+ licenseInvalidateID?: LicenseInvalidateID
1155
+ /** Session ticket ID for course access */
1156
+ sessionTicketID?: SessionTicketID
1157
+ /** Session ID for course tracking */
1158
+ sessionID?: SessionID
1159
+ /** Result of the course */
1160
+ courseResult?: CourseResult
1161
+ /** Certificate number for the course */
1162
+ courseCertNumber?: CourseCertNumber
1163
+ /** Date of course completion */
1164
+ completionDate?: CompletionDate
1165
+ /** Date when certificate was printed */
1166
+ certificatePrintedOn?: CertificatePrintedOn
1167
+ /** Date when card was printed */
1168
+ cardPrintedOnDate?: CardPrintedOnDate
1169
+ /** Date of certificate/card shipping */
1170
+ shippingDate?: ShippingDate
1171
+ /** Whether data is copied from an alternate certification process */
1172
+ isCopiedFromAlternateCP?: IsCopiedFromAlternateCP
1173
+ /** Reminders sent before course expiry */
1174
+ expireReminders?: ExpireReminders
1175
+ /** Expiration date of the course */
1176
+ expiryDate?: ExpiryDate
1177
+ /** Key used for indexing expiryDate */
1178
+ expiryDateKey?: ExpiryDateKey
1179
+ /** Whether the course has been invalidated */
1180
+ invalidated?: Invalidated
1181
+ /** Whether a course retake has been requested */
1182
+ retakeRequested?: RetakeRequested
1183
+ /** Current state of the course */
1184
+ state?: State
1185
+ /** Approval state of the course */
1186
+ approvalState?: ApprovalState
1187
+ /** Notes about the course approval process */
1188
+ approvalNotes?: ApprovalNotes
1189
+ /** List of submitted files for the course */
1190
+ submissionItems?: SubmissionItems
1191
+ /** User who waived the course requirement */
1192
+ waivedBy?: WaivedBy
1193
+ /** Date when course was waived */
1194
+ waivedOn?: WaivedOn
1195
+ /** Justifications for overridden course restrictions */
1196
+ overwrittenJustification?: OverwrittenJustification
1197
+ }
1198
+
1199
+ export interface OutputI9462Kgjk6 {
1200
+ /**
1201
+ * Signed URL for the course file
1202
+ * @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"
1203
+ */
1204
+ fileURL: string
1205
+ }
1206
+
1207
+ /** Response with list of expanded certification processeses */
1208
+ export interface UserExpandedCPResponseSchema {
1209
+ procs?: {
1210
+ user?: Record<string, any>
1211
+ courses?: Record<string, any>[]
1212
+ certificationProcesses?: Record<string, any>[]
1213
+ applications?: Record<string, any>[]
1214
+ }
1215
+ transactionID?: string | null
1216
+ }
1217
+
1218
+ /** Application Foreign Fill response type */
1219
+ export interface Output2A58Aiskxik {
1220
+ items: {
1221
+ userID: string
1222
+ createdOn?: number
1223
+ createdBy?: string
1224
+ updatedBy?: string
1225
+ updatedOn?: number
1226
+ dbEntity: string
1227
+ tenantID: string
1228
+ compositeID: string
1229
+ timestamp: number
1230
+ sourceID: string
1231
+ expiresOn?: number
1232
+ resultDate?: number
1233
+ isHistoric?: boolean
1234
+ type?: string
1235
+ procID?: string
1236
+ sourceType?: string
1237
+ issuedOn?: number
1238
+ approvedBy?: string
1239
+ rejectedBy?: string
1240
+ reviewedOn?: number
1241
+ additionalNotes?: string
1242
+ fileItems?: {
1243
+ fileID: string
1244
+ fileName: string
1245
+ }[]
1246
+ }[]
1247
+ }
1248
+
1249
+ /** Composite ID (could be a derived or synthetic key) */
1250
+ export type CompositeID = string
1251
+
1252
+ /** Certification process ID */
1253
+ export type ProcID = string
1254
+
1255
+ /** Effective timestamp of this record (e.g., event time) */
1256
+ export type Timestamp = number
1257
+
1258
+ /** Source object ID (e.g., course, cert) */
1259
+ export type SourceID = string
1260
+
1261
+ /** Type of the source (e.g., COURSE or CERT) */
1262
+ export type SourceType = string
1263
+
1264
+ /** Expiration date of this entry, if applicable */
1265
+ export type ExpiresOn = number
1266
+
1267
+ /** Date when the result was achieved (e.g., passed) */
1268
+ export type ResultDate = number
1269
+
1270
+ /** Response containing student history records */
1271
+ export interface StudentHistoryResponseSchema {
1272
+ items: {
1273
+ /** ID of the user who created this record */
1274
+ createdBy?: CreatedBy
1275
+ /** Timestamp when this record was created */
1276
+ createdOn?: CreatedOn
1277
+ /** ID of the user who last updated this record */
1278
+ updatedBy?: UpdatedBy
1279
+ /** Timestamp of the last update */
1280
+ updateOn?: UpdateOn
1281
+ /** Fixed database entity identifier */
1282
+ dbEntity: DbEntity
1283
+ /** Composite ID (could be a derived or synthetic key) */
1284
+ compositeID: CompositeID
1285
+ /** ID of the user associated with this history entry */
1286
+ userID: UserID
1287
+ /** Certification process ID */
1288
+ procID: ProcID
1289
+ /** Effective timestamp of this record (e.g., event time) */
1290
+ timestamp: Timestamp
1291
+ /** Tenant that owns this record */
1292
+ tenantID: TenantID
1293
+ /** Source object ID (e.g., course, cert) */
1294
+ sourceID: SourceID
1295
+ /** Type of the source (e.g., COURSE or CERT) */
1296
+ sourceType: SourceType
1297
+ /** Expiration date of this entry, if applicable */
1298
+ expiresOn?: ExpiresOn
1299
+ /** The type/category of the student history record */
1300
+ type: Type
1301
+ /** Date when the result was achieved (e.g., passed) */
1302
+ resultDate?: ResultDate
1303
+ }[]
1304
+ transactionID?: string | null
1305
+ }
1306
+
1307
+ /** Response with list of user certification processes and it's upcoming courses and sessions */
1308
+ export interface UserUpcomingCoursesResponseSchema {
1309
+ procs?: {
1310
+ user?: Record<string, any>
1311
+ courses?: Record<string, any>[]
1312
+ certificationProcesses?: Record<string, any>[]
1313
+ sessions?: Record<string, any>[]
1314
+ }
1315
+ transactionID?: string | null
1316
+ }
1317
+
1318
+ /** Timestamp when user agreed to terms */
1319
+ export type AgreedOnTerms = number
1320
+
1321
+ /** Whether user agreed with certification terms */
1322
+ export type AgreedWithCertTerms = boolean
1323
+
1324
+ /** Map of member numbers keyed by string */
1325
+ export type MemberNumber = Record<string, string>
1326
+
1327
+ /** Name to appear on certificate */
1328
+ export type CertNameOnCertificate = string
1329
+
1330
+ /** Map of certification dates keyed by string */
1331
+ export type CertificationDate = Record<string, number>
1332
+
1333
+ /** Map of original certification dates keyed by string */
1334
+ export type CertificationOriginalDate = Record<string, number>
1335
+
1336
+ /** Map of certification expiration dates keyed by string */
1337
+ export type CertificationExpirationDate = Record<string, number>
1338
+
1339
+ /** Name of the company associated with the user */
1340
+ export type CompanyName = string
1341
+
1342
+ /** User email address */
1343
+ export type Email = string
1344
+
1345
+ /** Email address used to send emails on behalf of user */
1346
+ export type SendEmailAs = string
1347
+
1348
+ /** User first name */
1349
+ export type FirstName = string
1350
+
1351
+ /** User last name */
1352
+ export type LastName = string
1353
+
1354
+ /** Employer ID associated with the user */
1355
+ export type EmployerID = string
1356
+
1357
+ /** User phone number */
1358
+ export type PhoneNumber = string
1359
+
1360
+ /** ITA number of the user */
1361
+ export type ItaNumber = string
1362
+
1363
+ /** Whether user should receive gifts */
1364
+ export type SendGift = boolean
1365
+
1366
+ /** Preferred language of the user */
1367
+ export type PreferredLanguage = string
1368
+
1369
+ /** ID of the user who referred this user */
1370
+ export type ReferredByID = string
1371
+
1372
+ /** Name of the user who referred this user */
1373
+ export type ReferredByName = string
1374
+
1375
+ /** Timestamp of last signin */
1376
+ export type SigninDate = number
1377
+
1378
+ /** List of IDs of entities the user manages */
1379
+ export type ManagerOf = string[]
1380
+
1381
+ /** List of IDs of entities the user is member of */
1382
+ export type MemberOf = string[]
1383
+
1384
+ /** List of pending invitation IDs */
1385
+ export type PendingInvitations = string[]
1386
+
1387
+ /** Whether the user is sponsored */
1388
+ export type IsSponsored = boolean
1389
+
1390
+ /** External system ID 1 */
1391
+ export type ExternalID = string
1392
+
1393
+ /** External system ID 2 */
1394
+ export type ExternalID2 = string
1395
+
1396
+ /** Response schema for certification process data */
1397
+ export interface CertificationProcessResponseEntity {
1398
+ /** @example "abc123" */
1399
+ id: string
1400
+ /** @example "tenant001" */
1401
+ tenantID: string
1402
+ /** @example "user001" */
1403
+ userID: string
1404
+ /** @example "cert001" */
1405
+ certificationID: string
1406
+ /** @example 1717000000000 */
1407
+ createdOn?: number
1408
+ /** @example "admin" */
1409
+ createdBy?: string
1410
+ /** @example "admin" */
1411
+ updatedBy?: string
1412
+ /** @example 1717000000000 */
1413
+ updatedOn?: number
1414
+ /** @example "prgCertificationProcess" */
1415
+ dbEntity?: string
1416
+ /** @example "CERT-2025-XYZ" */
1417
+ certNumber?: string
1418
+ /** @example 1717000000000 */
1419
+ completionDate?: number
1420
+ /** @example 1716000000000 */
1421
+ originalCompletionDate?: number
1422
+ /** @example 1717000000000 */
1423
+ cardPrintedOn?: number
1424
+ /** @example 1717000000000 */
1425
+ certificatePrintedOn?: number
1426
+ /** @example 1717000000000 */
1427
+ shippingDate?: number
1428
+ /** @example 1717000000000 */
1429
+ lastCourseCompletionDate?: number
1430
+ /** @example ["course1","course2"] */
1431
+ blockedCourses?: string[]
1432
+ triggerState?: Record<
1433
+ string,
1434
+ {
1435
+ /** @example "triggered" */
1436
+ state?: string
1437
+ /** @example 1717000000000 */
1438
+ updatedOn?: number
1439
+ /** @example "OK" */
1440
+ requestResult?: any
1441
+ }
1442
+ >
1443
+ /** @example 85 */
1444
+ pointsAchieved?: number
1445
+ /** @example ["email1","email2"] */
1446
+ expireReminders?: string[]
1447
+ /** @example 1718000000000 */
1448
+ expiryDate?: number
1449
+ /** @example "active" */
1450
+ state?: string
1451
+ /** @example "completed" */
1452
+ stage?: string
1453
+ /** @example "passed" */
1454
+ stageLastCourseState?: string
1455
+ /** @example 1717000000000 */
1456
+ manualOverrideOn?: number
1457
+ /** @example 120.5 */
1458
+ pendingPaymentValue?: number
1459
+ /** @example "Manual override" */
1460
+ overwrittenJustification?: string
1461
+ /** @example 15 */
1462
+ commissionAmount?: number
1463
+ /** @example "affiliate001" */
1464
+ commissionPayTo?: string
1465
+ /** @example 15 */
1466
+ commissionPaid?: number
1467
+ /** @example "manager" */
1468
+ waivedBy?: string
1469
+ /** @example 1717000000000 */
1470
+ waivedOn?: number
1471
+ /** @example "Waived due to exception" */
1472
+ waivedComments?: string
1473
+ user?: Record<string, any>
1474
+ courses?: Record<string, any>[]
1475
+ applications?: Record<string, any>[]
1476
+ applicationItems?: Record<string, any>[]
1477
+ transactionID?: string | null
1478
+ }
1479
+
1480
+ export interface InputJmsh67C6I {
1481
+ issuedOn?: number
1482
+ expiresOn?: number
1483
+ fileItems?: {
1484
+ fileID: string
1485
+ fileName: string
1486
+ }[]
1487
+ additionalNotes?: string | null
1488
+ }
1489
+
1490
+ export interface OutputVyq6Ajd6Pbl {
1491
+ /**
1492
+ * Signed URL for the course file
1493
+ * @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"
1494
+ */
1495
+ fileURL: string
1496
+ }
1497
+
1498
+ export interface InputEi9E1V7Rpe {
1499
+ /**
1500
+ * Indicates whether the waiver is approved
1501
+ * @example true
1502
+ */
1503
+ approved: boolean
1504
+ /**
1505
+ * Optional notes regarding the waiver
1506
+ * @example "Waiver granted due to special circumstances."
1507
+ */
1508
+ additionalNotes?: string | null
1509
+ }
1510
+
1511
+ export interface InputVczxcyab6W {
1512
+ /**
1513
+ * Optional notes regarding the waiver
1514
+ * @example "Waiver granted due to special circumstances."
1515
+ */
1516
+ additionalNotes?: string | null
1517
+ }
1518
+
1519
+ export interface InputF6S7Tcgt9H {
1520
+ students: {
1521
+ /**
1522
+ * User ID of the student to redeem the course for
1523
+ * @example "userID"
1524
+ */
1525
+ userID: string
1526
+ /**
1527
+ * Activation code for the course, if applicable
1528
+ * @example "activationCode"
1529
+ */
1530
+ activationCode?: string
1531
+ }[]
1532
+ /**
1533
+ * ID of the course to redeem
1534
+ * @example "courseID"
1535
+ */
1536
+ courseID: string
1537
+ /**
1538
+ * Organization ID for the course redemption
1539
+ * @example "orgID"
1540
+ */
1541
+ orgID?: string
1542
+ /**
1543
+ * Session ID for the course, if applicable
1544
+ * @example "sessionID"
1545
+ */
1546
+ sessionID?: string
1547
+ /**
1548
+ * Session ID for automatic enrollment, if applicable
1549
+ * @example "autoEnrolSessionID"
1550
+ */
1551
+ autoEnrolSessionID?: string
1552
+ }
1553
+
1554
+ export interface InputTahl1X2Wos {
1555
+ invites: {
1556
+ /**
1557
+ * Email address of the user to invite
1558
+ * @example "mail@mail.com"
1559
+ */
1560
+ email: string
1561
+ /**
1562
+ * User ID of the user to invite, if available
1563
+ * @example "userID"
1564
+ */
1565
+ userID?: string
1566
+ }[]
1567
+ /**
1568
+ * ID of the course to redeem
1569
+ * @example "courseID"
1570
+ */
1571
+ courseID: string
1572
+ /**
1573
+ * Session ID for the course, if applicable
1574
+ * @example "sessionID"
1575
+ */
1576
+ sessionID?: string
1577
+ /**
1578
+ * Indicates if the invite is for a reserved seat
1579
+ * @example true
1580
+ */
1581
+ isReservedSeat: boolean
1582
+ }
1583
+
1584
+ export interface InputW0G08Trp2L {
1585
+ /**
1586
+ * Indicates whether to waive the certification process
1587
+ * @example true
1588
+ */
1589
+ waive: boolean
1590
+ /**
1591
+ * Optional comments regarding the waiver
1592
+ * @example "Waive granted due to special circumstances."
1593
+ */
1594
+ comments?: string | null
1595
+ }
1596
+
1597
+ /** Certification move response schema */
1598
+ export interface OutputSc6Zw56Dzq {
1599
+ errors?: {
1600
+ status: string
1601
+ object?: Record<string, any>
1602
+ ignoreError?: boolean
1603
+ }[]
1604
+ }
1605
+
1606
+ /** Schema for writing a certification trigger check. */
1607
+ export interface Input7Vh389Cmk5 {
1608
+ /**
1609
+ * The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
1610
+ * @example "CHECKED"
1611
+ */
1612
+ value: Input7Vh389Cmk5ValueEnum
1613
+ /**
1614
+ * List of course IDs that are blocked by this trigger check.
1615
+ * @example ["course1","course2"]
1616
+ */
1617
+ blockedCourses?: string[]
1618
+ }
1619
+
1620
+ export interface InputJusp9Jdhxl {
1621
+ /**
1622
+ * Indicates whether the application item is approved
1623
+ * @example true
1624
+ */
1625
+ approved: boolean
1626
+ /**
1627
+ * Optional notes regarding the review of the application item
1628
+ * @example "Reviewed and approved with no issues."
1629
+ */
1630
+ additionalNotes?: string | null
1631
+ /**
1632
+ * Timestamp when the item was issued
1633
+ * @example 1672531199000
1634
+ */
1635
+ issuedOn?: number
1636
+ /**
1637
+ * Timestamp when the item expires
1638
+ * @example 1704067199000
1639
+ */
1640
+ expiresOn?: number
1641
+ }
1642
+
1643
+ /** Create Student History requirements */
1644
+ export interface StudentHistoryRequestSchema {
1645
+ requirements: string[]
1646
+ }
1647
+
1648
+ export interface InputVb1Vnjw2Eg {
1649
+ /**
1650
+ * Optional activation key for the application
1651
+ * @example "AK-123456"
1652
+ */
1653
+ activationKey?: string
1654
+ }
1655
+
1656
+ /** Schema for course submission item details post request. */
1657
+ export interface InputGby1J6Gkqr {
1658
+ /**
1659
+ * The ID of the file being submitted.
1660
+ * @example "fileID123"
1661
+ */
1662
+ fileID: string
1663
+ /**
1664
+ * The name of the file being submitted.
1665
+ * @example "submissionFile.pdf"
1666
+ */
1667
+ fileName: string
1668
+ }
1669
+
1670
+ /** Schema for the response to course submission item details post request. */
1671
+ export interface OutputGby1J6Gkqr {
1672
+ submissionItems: {
1673
+ /**
1674
+ * The ID of the file being submitted.
1675
+ * @example "fileID123"
1676
+ */
1677
+ fileID: string
1678
+ /**
1679
+ * The name of the file being submitted.
1680
+ * @example "submissionFile.pdf"
1681
+ */
1682
+ fileName: string
1683
+ }[]
1684
+ }
1685
+
1686
+ /** Pending approval submission parameters */
1687
+ export interface InputBkb7Btdukn {
1688
+ /**
1689
+ * Type of pending approval
1690
+ * @example "certification"
1691
+ */
1692
+ type: string
1693
+ /** List of files submitted for pending approval */
1694
+ submissionItems: {
1695
+ /**
1696
+ * ID of the submitted file
1697
+ * @example "fileID123"
1698
+ */
1699
+ fileID: string
1700
+ /**
1701
+ * Name of the submitted file
1702
+ * @example "document.pdf"
1703
+ */
1704
+ fileName: string
1705
+ }[]
1706
+ }
1707
+
1708
+ export interface InputBchr75Oc4N {
1709
+ /**
1710
+ * The ID of the course for which the license is being redeemed
1711
+ * @example "courseID123"
1712
+ */
1713
+ courseID: string
1714
+ /**
1715
+ * The activation code for the license redemption
1716
+ * @example "activationCode456"
1717
+ */
1718
+ activationCode?: string
1719
+ /**
1720
+ * The ID of the session associated with the license redemption
1721
+ * @example "sessionID789"
1722
+ */
1723
+ sessionID?: string
1724
+ /**
1725
+ * The ID of the referral associated with the license redemption
1726
+ * @example "referralID123"
1727
+ */
1728
+ referralID?: string | null
1729
+ /**
1730
+ * The name of the referral associated with the license redemption
1731
+ * @example "referralName456"
1732
+ */
1733
+ referralName?: string | null
1734
+ /**
1735
+ * The ID of the employer associated with the license redemption
1736
+ * @example "employerID789"
1737
+ */
1738
+ employerID?: string | null
1739
+ /**
1740
+ * The name of the employer associated with the license redemption
1741
+ * @example "employerName012"
1742
+ */
1743
+ employerName?: string | null
1744
+ /**
1745
+ * The CUs associated with the employer for the license redemption
1746
+ * @example "employerCUsData"
1747
+ */
1748
+ employerCUs?: any
1749
+ /**
1750
+ * Indicates if the order is a no-cost order
1751
+ * @example true
1752
+ */
1753
+ isNoCostOrder?: boolean | null
1754
+ /**
1755
+ * The invitation code for the license redemption
1756
+ * @example "invitationCode345"
1757
+ */
1758
+ invitationCode?: string | null
1759
+ /**
1760
+ * Shipping information for any materials associated with the license redemption
1761
+ * @example "materialShippingInfoData"
1762
+ */
1763
+ materialShippingInfo?: any
1764
+ /**
1765
+ * The ID of the session for automatic enrollment
1766
+ * @example "autoEnrolSessionID678"
1767
+ */
1768
+ autoEnrolSessionID?: string | null
1769
+ }
1770
+
1771
+ /** Validate certification move response schema */
1772
+ export interface OutputIwzp4Ltfkm {
1773
+ courses: {
1774
+ name: string
1775
+ status: string
1776
+ state: string
1777
+ }[]
1778
+ status: string
1779
+ certProcID: string
1780
+ validated: boolean
1781
+ mustCreateCP: boolean
1782
+ }
1783
+
1784
+ export interface InputAa84W6Sw3E {
1785
+ /**
1786
+ * Comments regarding the end of the cooldown period
1787
+ * @example "Cooldown period ended successfully."
1788
+ */
1789
+ comments: string
1790
+ }
1791
+
1792
+ export interface OutputDqpjgt3Qitl {
1793
+ /**
1794
+ * Signed URL for the course file
1795
+ * @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"
1796
+ */
1797
+ fileURL: string
1798
+ }
1799
+
1800
+ export interface InputYa0N64R6Wk {
1801
+ /** @example true */
1802
+ agreedWithCertTerms: boolean
1803
+ /** @example 1717230000000 */
1804
+ agreedOnTerms: number
1805
+ /** @example "John" */
1806
+ firstName: string
1807
+ /** @example "Doe" */
1808
+ lastName: string
1809
+ /** @example "+1-555-5555" */
1810
+ phoneNumber?: string | null
1811
+ /** @example "john.doe@example.com" */
1812
+ email: string
1813
+ /** @example "legacy@domain.com" */
1814
+ sendAsEmail?: string
1815
+ /** @example "alternate@domain.com" */
1816
+ sendEmailAs?: string
1817
+ /** @example "John A. Doe" */
1818
+ certNameOnCertificate?: any
1819
+ /** @example "ITA123456" */
1820
+ itaNumber?: any
1821
+ /** @example false */
1822
+ sendGift?: boolean
1823
+ /** @example "active" */
1824
+ state?: any
1825
+ /** @example "USR#123" */
1826
+ id?: any
1827
+ /** @example "TEN#001" */
1828
+ tenantID?: any
1829
+ /** @example "USR#admin" */
1830
+ createdBy?: any
1831
+ /** @example "USR#admin" */
1832
+ updatedBy?: any
1833
+ /** @example "USR#ref001" */
1834
+ referredByID?: any
1835
+ /** @example "Jane Smith" */
1836
+ referredByName?: any
1837
+ /** @example "EMP#001" */
1838
+ employerID?: any
1839
+ /** @example 1717231234567 */
1840
+ signinDate?: any
1841
+ /** @example 1717231234567 */
1842
+ certificationDate?: any
1843
+ /** @example 1750000000000 */
1844
+ certificationExpirationDate?: any
1845
+ /** @example 1680000000000 */
1846
+ certificationOriginalDate?: any
1847
+ /** @example "MBR#5678" */
1848
+ memberNumber?: any
1849
+ /** @example 1717231111111 */
1850
+ updatedOn?: any
1851
+ /** @example 1717000000000 */
1852
+ createdOn?: any
1853
+ /** @example "TXN#abc123" */
1854
+ transactionID?: any
1855
+ /** @example ["USR#789","USR#101"] */
1856
+ managerOf?: any
1857
+ /** @example ["GRP#teamA"] */
1858
+ memberOf?: any
1859
+ /** @example "prgUser" */
1860
+ dbEntity?: any
1861
+ /** @example "+1-222-3333" */
1862
+ mobilePhone?: string | null
1863
+ /** @example "en" */
1864
+ preferredLanguage?: string | null
1865
+ /** @example false */
1866
+ certifiedUserOptOut?: boolean
1867
+ /** @example "EXT#555" */
1868
+ externalID?: string | null
1869
+ /** @example "EXT#999" */
1870
+ externalID2?: string | null
1871
+ }
1872
+
1873
+ export interface InputQwegrxedmt {
1874
+ /**
1875
+ * Comments regarding the course unlock action
1876
+ * @example "Course unlocked successfully."
1877
+ */
1878
+ comments: string
1879
+ }
1880
+
1881
+ export interface InputJkgsw7Yp8E {
1882
+ /**
1883
+ * ITA number to update for the user
1884
+ * @example "ITA123456"
1885
+ */
1886
+ itaNumber: string
1887
+ }
1888
+
1889
+ export interface InputCkiexmnlfz {
1890
+ /** @example true */
1891
+ agreedWithCertTerms: boolean
1892
+ /** @example 1717230000000 */
1893
+ agreedOnTerms: number
1894
+ /** @example "John" */
1895
+ firstName: string
1896
+ /** @example "Doe" */
1897
+ lastName: string
1898
+ /** @example "+1-555-5555" */
1899
+ phoneNumber?: string | null
1900
+ /** @example "john.doe@example.com" */
1901
+ email: string
1902
+ /** @example "legacy@domain.com" */
1903
+ sendAsEmail?: string
1904
+ /** @example "alternate@domain.com" */
1905
+ sendEmailAs?: string
1906
+ /** @example "John A. Doe" */
1907
+ certNameOnCertificate?: any
1908
+ /** @example "ITA123456" */
1909
+ itaNumber?: any
1910
+ /** @example false */
1911
+ sendGift?: boolean
1912
+ /** @example "active" */
1913
+ state?: any
1914
+ /** @example "USR#123" */
1915
+ id?: any
1916
+ /** @example "TEN#001" */
1917
+ tenantID?: any
1918
+ /** @example "USR#admin" */
1919
+ createdBy?: any
1920
+ /** @example "USR#admin" */
1921
+ updatedBy?: any
1922
+ /** @example "USR#ref001" */
1923
+ referredByID?: any
1924
+ /** @example "Jane Smith" */
1925
+ referredByName?: any
1926
+ /** @example "EMP#001" */
1927
+ employerID?: any
1928
+ /** @example 1717231234567 */
1929
+ signinDate?: any
1930
+ /** @example 1717231234567 */
1931
+ certificationDate?: any
1932
+ /** @example 1750000000000 */
1933
+ certificationExpirationDate?: any
1934
+ /** @example 1680000000000 */
1935
+ certificationOriginalDate?: any
1936
+ /** @example "MBR#5678" */
1937
+ memberNumber?: any
1938
+ /** @example 1717231111111 */
1939
+ updatedOn?: any
1940
+ /** @example 1717000000000 */
1941
+ createdOn?: any
1942
+ /** @example "TXN#abc123" */
1943
+ transactionID?: any
1944
+ /** @example ["USR#789","USR#101"] */
1945
+ managerOf?: any
1946
+ /** @example ["GRP#teamA"] */
1947
+ memberOf?: any
1948
+ /** @example "prgUser" */
1949
+ dbEntity?: any
1950
+ /** @example "+1-222-3333" */
1951
+ mobilePhone?: string | null
1952
+ /** @example "en" */
1953
+ preferredLanguage?: string | null
1954
+ /** @example false */
1955
+ certifiedUserOptOut?: boolean
1956
+ /** @example "EXT#555" */
1957
+ externalID?: string | null
1958
+ /** @example "EXT#999" */
1959
+ externalID2?: string | null
1960
+ }
1961
+
1962
+ export interface InputQogzfpjg52 {
1963
+ /**
1964
+ * The grade to override the course result with
1965
+ * @example "A"
1966
+ */
1967
+ resultGrade: string
1968
+ }
1969
+
1970
+ /** Pending approval review parameters */
1971
+ export interface InputC53Kuyqnej {
1972
+ /**
1973
+ * Notes provided by the reviewer for the pending approval
1974
+ * @example "Please review the submitted documents."
1975
+ */
1976
+ approvalNotes?: string | null
1977
+ /**
1978
+ * Indicates whether the pending approval is approved or not
1979
+ * @example true
1980
+ */
1981
+ approved: boolean
1982
+ }
1983
+
1984
+ /** Schema for overriding course result dates. */
1985
+ export interface Input7Kqbtz8S05 {
1986
+ /**
1987
+ * The date when the course result expires, in milliseconds since epoch.
1988
+ * @example 1735689600000
1989
+ */
1990
+ expiryDate?: number
1991
+ /**
1992
+ * The date when the course was completed, in milliseconds since epoch.
1993
+ * @example 1735689600000
1994
+ */
1995
+ completionDate?: number
1996
+ }
1997
+
1998
+ export interface InputPl0F8Ijrz3K {
1999
+ filter: {
2000
+ from?: number
2001
+ sortOrder?: string
2002
+ sortField?: string
2003
+ }
2004
+ }
2005
+
2006
+ export interface OutputPl0F8Ijrz3K {
2007
+ users: {
2008
+ firstName: string
2009
+ lastName: string
2010
+ /** @format email */
2011
+ email: string
2012
+ phoneNumber?: string
2013
+ certNumber: string
2014
+ certDate: number
2015
+ certExpiration: string
2016
+ }[]
2017
+ total: number
2018
+ }
2019
+
2020
+ export enum ReportXlsxSchemaContentTypeEnum {
2021
+ ApplicationVndOpenxmlformatsOfficedocumentSpreadsheetmlSheet = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
2022
+ }
2023
+
2024
+ /**
2025
+ * The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
2026
+ * @example "CHECKED"
2027
+ */
2028
+ export enum Input7Vh389Cmk5ValueEnum {
2029
+ CHECKED = 'CHECKED',
2030
+ UNCHECKED = 'UNCHECKED',
2031
+ NOVALUE = 'NOVALUE',
2032
+ }
2033
+
2034
+ export type ListContactUsData = any
2035
+
2036
+ export type ListContactUsError = ErrorResponse
2037
+
2038
+ export type ListConfigData = any
2039
+
2040
+ export type ListConfigError = ErrorResponse
2041
+
2042
+ export interface GetUserParams {
2043
+ /** @example "allFlag" */
2044
+ allFlag: string
2045
+ /** @example "userID" */
2046
+ userId: string
2047
+ }
2048
+
2049
+ export type GetUserData = UserResponseEntity
2050
+
2051
+ export type GetUserError = ErrorResponse
2052
+
2053
+ export interface GetEventsParams {
2054
+ /** Exclude online events */
2055
+ excludeOnline?: string
2056
+ /**
2057
+ * Start time of the event range
2058
+ * @example "1781158057000"
2059
+ */
2060
+ startTime: string
2061
+ /**
2062
+ * End time of the event range
2063
+ * @example "1781158057000"
2064
+ */
2065
+ endTime: string
2066
+ }
2067
+
2068
+ export type GetEventsData = any
2069
+
2070
+ export type GetEventsError = ErrorResponse
2071
+
2072
+ export type DeleteOrgData = any
2073
+
2074
+ export type DeleteOrgError = ErrorResponse
2075
+
2076
+ export interface ListReportAffiliateParams {
2077
+ /** @example "1704067200" */
2078
+ fromDate: string
2079
+ /** @example "1704153600" */
2080
+ toDate: string
2081
+ }
2082
+
2083
+ export type ListReportAffiliateData = any
2084
+
2085
+ export type ListReportAffiliateError = ErrorResponse
2086
+
2087
+ export type ListReportCompletedWithConsentData = any
2088
+
2089
+ export type ListReportCompletedWithConsentError = ErrorResponse
2090
+
2091
+ export type ListPendingApplicationsData = ApplicationResponseSchema
2092
+
2093
+ export type ListPendingApplicationsError = ErrorResponse
2094
+
2095
+ export type ListPendingApprovalsData = PendingApprovalResponseSchema
2096
+
2097
+ export type ListPendingApprovalsError = ErrorResponse
2098
+
2099
+ export type ListConfigResult = any
2100
+
2101
+ export type ListConfigFail = ErrorResponse
2102
+
2103
+ export type CreateReportApplicationExportData = any
2104
+
2105
+ export type CreateReportApplicationExportError = ErrorResponse
2106
+
2107
+ export type ListReportApplicationStatusData = any
2108
+
2109
+ export type ListReportApplicationStatusError = ErrorResponse
2110
+
2111
+ export type CreateReportApplicationsReportData = any
2112
+
2113
+ export type CreateReportApplicationsReportError = ErrorResponse
2114
+
2115
+ export type CreateCertificatesEmailData = any
2116
+
2117
+ export type CreateCertificatesEmailError = ErrorResponse
2118
+
2119
+ export interface CreateReportCompletedCertificationsPreviewParams {
2120
+ /** @example "1704067200" */
2121
+ fromDate: string
2122
+ /** @example "1704153600" */
2123
+ toDate: string
2124
+ }
2125
+
2126
+ export type CreateReportCompletedCertificationsPreviewData = any
2127
+
2128
+ export type CreateReportCompletedCertificationsPreviewError = ErrorResponse
2129
+
2130
+ export interface ListReportCompletedCertificationsParams {
2131
+ /** @example "1704067200" */
2132
+ fromDate: string
2133
+ /** @example "1704153600" */
2134
+ toDate: string
2135
+ }
2136
+
2137
+ export type ListReportCompletedCertificationsData = any
2138
+
2139
+ export type ListReportCompletedCertificationsError = ErrorResponse
2140
+
2141
+ export type CreateLicenseRedeemData = any
2142
+
2143
+ export type CreateLicenseRedeemError = ErrorResponse
2144
+
2145
+ export type ListReportOrglicensesData = any
2146
+
2147
+ export type ListReportOrglicensesError = ErrorResponse
2148
+
2149
+ export type CreateReportOrglicensesPreviewData = any
2150
+
2151
+ export type CreateReportOrglicensesPreviewError = ErrorResponse
2152
+
2153
+ export type CreateReportNcsoReportData = ReportXLSXSchema
2154
+
2155
+ export type CreateReportNcsoReportError = ErrorResponse
2156
+
2157
+ export type CreateReportUsersAdvancedData = any
2158
+
2159
+ export type CreateReportUsersAdvancedError = ErrorResponse
2160
+
2161
+ export type ListSearchUsersIdsData = any
2162
+
2163
+ export type ListSearchUsersIdsError = ErrorResponse
2164
+
2165
+ export type CreateSearchUsersTermData = any
2166
+
2167
+ export type CreateSearchUsersTermError = ErrorResponse
2168
+
2169
+ export type CreateReportUsersSimpleData = any
2170
+
2171
+ export type CreateReportUsersSimpleError = ErrorResponse
2172
+
2173
+ export type DeleteCertificationApplicationItemData = any
2174
+
2175
+ export type DeleteCertificationApplicationItemError = ErrorResponse
2176
+
2177
+ export type CreateCertificationApplicationItemData = any
2178
+
2179
+ export type CreateCertificationApplicationItemError = ErrorResponse
2180
+
2181
+ export type DeleteCertificationApplicationBlacklistData = any
2182
+
2183
+ export type DeleteCertificationApplicationBlacklistError = ErrorResponse
2184
+
2185
+ export type DeleteCertificationApplicationData = any
2186
+
2187
+ export type DeleteCertificationApplicationError = ErrorResponse
2188
+
2189
+ export type GetCertificationApplicationData = CertificationApplicationResponseEntity
2190
+
2191
+ export type GetCertificationApplicationError = ErrorResponse
2192
+
2193
+ export type CreateCertificationApplicationData = any
2194
+
2195
+ export type CreateCertificationApplicationError = ErrorResponse
2196
+
2197
+ export type DeleteCertificationCourseFileSignData = any
2198
+
2199
+ export type DeleteCertificationCourseFileSignError = ErrorResponse
2200
+
2201
+ export type GetCertificationCourseFileSignData = OutputI9462Kgjk6
2202
+
2203
+ export type GetCertificationCourseFileSignError = ErrorResponse
2204
+
2205
+ export interface CreateCertificationCourseFileSignParams {
2206
+ /** @example "pdf" */
2207
+ fileType: string
2208
+ /** @example "userID" */
2209
+ userId: string
2210
+ /** @example "certProcID" */
2211
+ certProcId: string
2212
+ /** @example "courseID" */
2213
+ courseId: string
2214
+ /** @example "fileID" */
2215
+ fileId: string
2216
+ }
2217
+
2218
+ export type CreateCertificationCourseFileSignData = OutputDqpjgt3Qitl
2219
+
2220
+ export type CreateCertificationCourseFileSignError = ErrorResponse
2221
+
2222
+ export type DeleteCertificationCourseDocumentData = any
2223
+
2224
+ export type DeleteCertificationCourseDocumentError = ErrorResponse
2225
+
2226
+ export type UpdateCertificationCourseDocumentData = OutputGby1J6Gkqr
2227
+
2228
+ export type UpdateCertificationCourseDocumentError = ErrorResponse
2229
+
2230
+ export type DeleteUserData = any
2231
+
2232
+ export type DeleteUserError = ErrorResponse
2233
+
2234
+ export type GetUserResult = UserResponseEntity
2235
+
2236
+ export type GetUserFail = ErrorResponse
2237
+
2238
+ export type CreateUserData = any
2239
+
2240
+ export type CreateUserError = ErrorResponse
2241
+
2242
+ export type UpdateUserData = any
2243
+
2244
+ export type UpdateUserError = ErrorResponse
2245
+
2246
+ export type DeleteCertificationCourseData = any
2247
+
2248
+ export type DeleteCertificationCourseError = ErrorResponse
2249
+
2250
+ export type GetCertificationApplicationItemFileData = OutputKin04Ituf7
2251
+
2252
+ export type GetCertificationApplicationItemFileError = ErrorResponse
2253
+
2254
+ export interface CreateCertificationApplicationItemFileParams {
2255
+ /** @example "pdf" */
2256
+ fileType: string
2257
+ /** @example "userID" */
2258
+ userId: string
2259
+ /** @example "certProcID" */
2260
+ certProcId: string
2261
+ /** @example "sourceID" */
2262
+ sourceId: string
2263
+ /** @example "fileVersion" */
2264
+ fileVersion: string
2265
+ }
2266
+
2267
+ export type CreateCertificationApplicationItemFileData = OutputVyq6Ajd6Pbl
2268
+
2269
+ export type CreateCertificationApplicationItemFileError = ErrorResponse
2270
+
2271
+ export type GetCertificationCourseSessionCalcCancelationChargesData = OutputDwlxivng9Li
2272
+
2273
+ export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse
2274
+
2275
+ export type GetCertificationsData = CertificationProcessResponseSchema
2276
+
2277
+ export type GetCertificationsError = ErrorResponse
2278
+
2279
+ export type GetCourseData = CourseResponseEntity
2280
+
2281
+ export type GetCourseError = ErrorResponse
2282
+
2283
+ export type GetCertificationsExpandedData = UserExpandedCPResponseSchema
2284
+
2285
+ export type GetCertificationsExpandedError = ErrorResponse
2286
+
2287
+ export type GetCertificationApplicationForeignFillData = Output2A58Aiskxik
2288
+
2289
+ export type GetCertificationApplicationForeignFillError = ErrorResponse
2290
+
2291
+ export type GetCertificationPrintData = any
2292
+
2293
+ export type GetCertificationPrintError = ErrorResponse
2294
+
2295
+ export type GetCertificationCoursePrintData = any
2296
+
2297
+ export type GetCertificationCoursePrintError = ErrorResponse
2298
+
2299
+ export type GetRequirementData = StudentHistoryResponseSchema
2300
+
2301
+ export type GetRequirementError = ErrorResponse
2302
+
2303
+ export type GetCertificationsUpcomingCoursesData = UserUpcomingCoursesResponseSchema
2304
+
2305
+ export type GetCertificationsUpcomingCoursesError = ErrorResponse
2306
+
2307
+ export type GetCertificationData = CertificationProcessResponseEntity
2308
+
2309
+ export type GetCertificationError = ErrorResponse
2310
+
2311
+ export type CreateCertificationData = any
2312
+
2313
+ export type CreateCertificationError = ErrorResponse
2314
+
2315
+ export type CreateSessionAddData = any
2316
+
2317
+ export type CreateSessionAddError = ErrorResponse
2318
+
2319
+ export type CreateCertificationApplicationPreApprovalData = any
2320
+
2321
+ export type CreateCertificationApplicationPreApprovalError = ErrorResponse
2322
+
2323
+ export type CreateCertificationApplicationReviewData = any
2324
+
2325
+ export type CreateCertificationApplicationReviewError = ErrorResponse
2326
+
2327
+ export type CreateCertificationApplicationPreApprovalReviewData = any
2328
+
2329
+ export type CreateCertificationApplicationPreApprovalReviewError = ErrorResponse
2330
+
2331
+ export type CreateCertificationCourseBatchRedeemData = any
2332
+
2333
+ export type CreateCertificationCourseBatchRedeemError = ErrorResponse
2334
+
2335
+ export type CreateCertificationCourseBatchInviteData = any
2336
+
2337
+ export type CreateCertificationCourseBatchInviteError = ErrorResponse
2338
+
2339
+ export type CreateCertificationCourseSessionCancelEnrolData = any
2340
+
2341
+ export type CreateCertificationCourseSessionCancelEnrolError = ErrorResponse
2342
+
2343
+ export type CreateCertificationRenewData = any
2344
+
2345
+ export type CreateCertificationRenewError = ErrorResponse
2346
+
2347
+ export type CreateCertificationRestartData = any
2348
+
2349
+ export type CreateCertificationRestartError = ErrorResponse
2350
+
2351
+ export type CreateCertificationWaiveData = any
2352
+
2353
+ export type CreateCertificationWaiveError = ErrorResponse
2354
+
2355
+ export type CreateCertificationMoveData = OutputSc6Zw56Dzq
2356
+
2357
+ export type CreateCertificationMoveError = ErrorResponse
2358
+
2359
+ export type CreateCertificationCourseSessionReplaceData = any
2360
+
2361
+ export type CreateCertificationCourseSessionReplaceError = ErrorResponse
2362
+
2363
+ export type CreateCertificationTriggerCheckData = any
2364
+
2365
+ export type CreateCertificationTriggerCheckError = ErrorResponse
2366
+
2367
+ export type CreateCertificationTriggerSetData = any
2368
+
2369
+ export type CreateCertificationTriggerSetError = ErrorResponse
2370
+
2371
+ export type CreateRefreshOrgMembershipData = any
2372
+
2373
+ export type CreateRefreshOrgMembershipError = ErrorResponse
2374
+
2375
+ export type CreateCertificationCourseRetakeData = any
2376
+
2377
+ export type CreateCertificationCourseRetakeError = ErrorResponse
2378
+
2379
+ export type CreateCertificationCourseRevokeData = any
2380
+
2381
+ export type CreateCertificationCourseRevokeError = ErrorResponse
2382
+
2383
+ export type CreateCertificationApplicationItemRemoveData = any
2384
+
2385
+ export type CreateCertificationApplicationItemRemoveError = ErrorResponse
2386
+
2387
+ export type CreateCertificationApplicationItemReviewData = any
2388
+
2389
+ export type CreateCertificationApplicationItemReviewError = ErrorResponse
2390
+
2391
+ export type ListRequirementsData = StudentHistoryResponseSchema
2392
+
2393
+ export type ListRequirementsError = ErrorResponse
2394
+
2395
+ export type CreateCertificationApplicationSubmitData = any
2396
+
2397
+ export type CreateCertificationApplicationSubmitError = ErrorResponse
2398
+
2399
+ export type CreateCertificationCoursePendingApprovalData = any
2400
+
2401
+ export type CreateCertificationCoursePendingApprovalError = ErrorResponse
2402
+
2403
+ export type UpdateCertificationCoursePendingApprovalData = any
2404
+
2405
+ export type UpdateCertificationCoursePendingApprovalError = ErrorResponse
2406
+
2407
+ export type CreateCertificationCourseRedeemData = any
2408
+
2409
+ export type CreateCertificationCourseRedeemError = ErrorResponse
2410
+
2411
+ export type CreateCertificationMoveValidateData = OutputIwzp4Ltfkm
2412
+
2413
+ export type CreateCertificationMoveValidateError = ErrorResponse
2414
+
2415
+ export type CreateCertificationCourseEndCooldownData = any
2416
+
2417
+ export type CreateCertificationCourseEndCooldownError = ErrorResponse
2418
+
2419
+ export type CreateCertificationCourseUnlockCourseData = any
2420
+
2421
+ export type CreateCertificationCourseUnlockCourseError = ErrorResponse
2422
+
2423
+ export type CreateUpdateItaData = any
2424
+
2425
+ export type CreateUpdateItaError = ErrorResponse
2426
+
2427
+ export type UpdateCertificationCourseOverrideResultData = any
2428
+
2429
+ export type UpdateCertificationCourseOverrideResultError = ErrorResponse
2430
+
2431
+ export type UpdateCertificationSetDatesData = any
2432
+
2433
+ export type UpdateCertificationSetDatesError = ErrorResponse
2434
+
2435
+ export type CreateCertificationResult = OutputPl0F8Ijrz3K
2436
+
2437
+ export type CreateCertificationFail = ErrorResponse
2438
+
2439
+ import type { AxiosInstance, AxiosRequestConfig, HeadersDefaults, ResponseType } from 'axios'
2440
+ import axios from 'axios'
2441
+
2442
+ export type QueryParamsType = Record<string | number, any>
2443
+
2444
+ export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
2445
+ /** set parameter to `true` for call `securityWorker` for this request */
2446
+ secure?: boolean
2447
+ /** request path */
2448
+ path: string
2449
+ /** content type of request body */
2450
+ type?: ContentType
2451
+ /** query params */
2452
+ query?: QueryParamsType
2453
+ /** format of response (i.e. response.json() -> format: "json") */
2454
+ format?: ResponseType
2455
+ /** request body */
2456
+ body?: unknown
2457
+ }
2458
+
2459
+ export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>
2460
+
2461
+ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, 'data' | 'cancelToken'> {
2462
+ securityWorker?: (
2463
+ securityData: SecurityDataType | null
2464
+ ) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void
2465
+ secure?: boolean
2466
+ format?: ResponseType
2467
+ }
2468
+
2469
+ export enum ContentType {
2470
+ Json = 'application/json',
2471
+ FormData = 'multipart/form-data',
2472
+ UrlEncoded = 'application/x-www-form-urlencoded',
2473
+ Text = 'text/plain',
2474
+ }
2475
+
2476
+ export class HttpClient<SecurityDataType = unknown> {
2477
+ public instance: AxiosInstance
2478
+ private securityData: SecurityDataType | null = null
2479
+ private securityWorker?: ApiConfig<SecurityDataType>['securityWorker']
2480
+ private secure?: boolean
2481
+ private format?: ResponseType
2482
+
2483
+ constructor({ securityWorker, secure, format, ...axiosConfig }: ApiConfig<SecurityDataType> = {}) {
2484
+ this.instance = axios.create({ ...axiosConfig, baseURL: axiosConfig.baseURL || 'http://localhost:8080' })
2485
+ this.secure = secure
2486
+ this.format = format
2487
+ this.securityWorker = securityWorker
2488
+ }
2489
+
2490
+ public setSecurityData = (data: SecurityDataType | null) => {
2491
+ this.securityData = data
2492
+ }
2493
+
2494
+ protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig {
2495
+ const method = params1.method || (params2 && params2.method)
2496
+
2497
+ return {
2498
+ ...this.instance.defaults,
2499
+ ...params1,
2500
+ ...(params2 || {}),
2501
+ headers: {
2502
+ ...((method && this.instance.defaults.headers[method.toLowerCase() as keyof HeadersDefaults]) || {}),
2503
+ ...(params1.headers || {}),
2504
+ ...((params2 && params2.headers) || {}),
2505
+ },
2506
+ }
2507
+ }
2508
+
2509
+ protected stringifyFormItem(formItem: unknown) {
2510
+ if (typeof formItem === 'object' && formItem !== null) {
2511
+ return JSON.stringify(formItem)
2512
+ } else {
2513
+ return `${formItem}`
2514
+ }
2515
+ }
2516
+
2517
+ protected createFormData(input: Record<string, unknown>): FormData {
2518
+ if (input instanceof FormData) {
2519
+ return input
2520
+ }
2521
+ return Object.keys(input || {}).reduce((formData, key) => {
2522
+ const property = input[key]
2523
+ const propertyContent: any[] = property instanceof Array ? property : [property]
2524
+
2525
+ for (const formItem of propertyContent) {
2526
+ const isFileType = formItem instanceof Blob || formItem instanceof File
2527
+ formData.append(key, isFileType ? formItem : this.stringifyFormItem(formItem))
2528
+ }
2529
+
2530
+ return formData
2531
+ }, new FormData())
2532
+ }
2533
+
2534
+ public request = async <T = any, _E = any>({
2535
+ secure,
2536
+ path,
2537
+ type,
2538
+ query,
2539
+ format,
2540
+ body,
2541
+ ...params
2542
+ }: FullRequestParams): Promise<T> => {
2543
+ const secureParams =
2544
+ ((typeof secure === 'boolean' ? secure : this.secure) &&
2545
+ this.securityWorker &&
2546
+ (await this.securityWorker(this.securityData))) ||
2547
+ {}
2548
+ const requestParams = this.mergeRequestParams(params, secureParams)
2549
+ const responseFormat = format || this.format || undefined
2550
+
2551
+ if (type === ContentType.FormData && body && body !== null && typeof body === 'object') {
2552
+ body = this.createFormData(body as Record<string, unknown>)
2553
+ }
2554
+
2555
+ if (type === ContentType.Text && body && body !== null && typeof body !== 'string') {
2556
+ body = JSON.stringify(body)
2557
+ }
2558
+
2559
+ return this.instance
2560
+ .request({
2561
+ ...requestParams,
2562
+ headers: {
2563
+ ...(requestParams.headers || {}),
2564
+ ...(type ? { 'Content-Type': type } : {}),
2565
+ },
2566
+ params: query,
2567
+ responseType: responseFormat,
2568
+ data: body,
2569
+ url: path,
2570
+ })
2571
+ .then(response => response.data)
2572
+ }
2573
+ }
2574
+
2575
+ /**
2576
+ * @title BCCSA Program API
2577
+ * @version 3.0.0
2578
+ * @baseUrl http://localhost:8080
2579
+ * @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
2580
+ */
2581
+ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
2582
+ contactUs = {
2583
+ /**
2584
+ * @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.
2585
+ *
2586
+ * @tags Contact Us
2587
+ * @name ListContactUs
2588
+ * @summary Contact Us
2589
+ * @request POST:/contactUs
2590
+ * @secure
2591
+ */
2592
+ listContactUs: (data: InputTprol08O25K, params: RequestParams = {}) =>
2593
+ this.request<ListContactUsData, ListContactUsError>({
2594
+ path: `/contactUs`,
2595
+ method: 'POST',
2596
+ body: data,
2597
+ secure: true,
2598
+ type: ContentType.Json,
2599
+ ...params,
2600
+ }),
2601
+ }
2602
+ customer = {
2603
+ /**
2604
+ * @description Retrieve config from customer.
2605
+ *
2606
+ * @tags Config
2607
+ * @name ListConfig
2608
+ * @summary Get Config
2609
+ * @request GET:/customer/config
2610
+ * @secure
2611
+ */
2612
+ listConfig: (params: RequestParams = {}) =>
2613
+ this.request<ListConfigData, ListConfigError>({
2614
+ path: `/customer/config`,
2615
+ method: 'GET',
2616
+ secure: true,
2617
+ ...params,
2618
+ }),
2619
+
2620
+ /**
2621
+ * @description Retrieve user from customer.
2622
+ *
2623
+ * @tags User
2624
+ * @name GetUser
2625
+ * @summary Get User
2626
+ * @request GET:/customer/user/{userID}
2627
+ * @secure
2628
+ */
2629
+ getUser: ({ userId, ...query }: GetUserParams, params: RequestParams = {}) =>
2630
+ this.request<GetUserData, GetUserError>({
2631
+ path: `/customer/user/${userId}`,
2632
+ method: 'GET',
2633
+ query: query,
2634
+ secure: true,
2635
+ format: 'json',
2636
+ ...params,
2637
+ }),
2638
+
2639
+ /**
2640
+ * @description Retrieve user events from customer within a specified time range.
2641
+ *
2642
+ * @tags Events
2643
+ * @name GetEvents
2644
+ * @summary Get User Events
2645
+ * @request GET:/customer/events/{startTime}/{endTime}
2646
+ * @secure
2647
+ */
2648
+ getEvents: ({ startTime, endTime, ...query }: GetEventsParams, params: RequestParams = {}) =>
2649
+ this.request<GetEventsData, GetEventsError>({
2650
+ path: `/customer/events/${startTime}/${endTime}`,
2651
+ method: 'GET',
2652
+ query: query,
2653
+ secure: true,
2654
+ ...params,
2655
+ }),
2656
+ }
2657
+ tenant = {
2658
+ /**
2659
+ * @description Delete bridge
2660
+ *
2661
+ * @tags Tenant
2662
+ * @name DeleteOrg
2663
+ * @summary Delete bridge
2664
+ * @request DELETE:/tenant/org/{orgID}
2665
+ * @secure
2666
+ */
2667
+ deleteOrg: (orgId: string, params: RequestParams = {}) =>
2668
+ this.request<DeleteOrgData, DeleteOrgError>({
2669
+ path: `/tenant/org/${orgId}`,
2670
+ method: 'DELETE',
2671
+ secure: true,
2672
+ ...params,
2673
+ }),
2674
+
2675
+ /**
2676
+ * @description Retrieve Affiliate Payments for the tenant.
2677
+ *
2678
+ * @tags Tenant
2679
+ * @name ListReportAffiliate
2680
+ * @summary Get Affiliate Payments
2681
+ * @request GET:/tenant/report/affiliate
2682
+ * @secure
2683
+ */
2684
+ listReportAffiliate: (query: ListReportAffiliateParams, params: RequestParams = {}) =>
2685
+ this.request<ListReportAffiliateData, ListReportAffiliateError>({
2686
+ path: `/tenant/report/affiliate`,
2687
+ method: 'GET',
2688
+ query: query,
2689
+ secure: true,
2690
+ ...params,
2691
+ }),
2692
+
2693
+ /**
2694
+ * @description List users that achieved their designation and allow their data to be published.
2695
+ *
2696
+ * @tags Tenant
2697
+ * @name ListReportCompletedWithConsent
2698
+ * @summary Get users with completed designations and consent for publication
2699
+ * @request GET:/tenant/report/completedWithConsent
2700
+ * @secure
2701
+ */
2702
+ listReportCompletedWithConsent: (params: RequestParams = {}) =>
2703
+ this.request<ListReportCompletedWithConsentData, ListReportCompletedWithConsentError>({
2704
+ path: `/tenant/report/completedWithConsent`,
2705
+ method: 'GET',
2706
+ secure: true,
2707
+ ...params,
2708
+ }),
2709
+
2710
+ /**
2711
+ * @description Retrieve pending applications for the tenant.
2712
+ *
2713
+ * @tags Tenant
2714
+ * @name ListPendingApplications
2715
+ * @summary Get Pending Applications
2716
+ * @request GET:/tenant/pendingApplications
2717
+ * @secure
2718
+ */
2719
+ listPendingApplications: (params: RequestParams = {}) =>
2720
+ this.request<ListPendingApplicationsData, ListPendingApplicationsError>({
2721
+ path: `/tenant/pendingApplications`,
2722
+ method: 'GET',
2723
+ secure: true,
2724
+ format: 'json',
2725
+ ...params,
2726
+ }),
2727
+
2728
+ /**
2729
+ * @description Retrieve pending approvals for the tenant.
2730
+ *
2731
+ * @tags Tenant
2732
+ * @name ListPendingApprovals
2733
+ * @summary Get Pending Approvals
2734
+ * @request GET:/tenant/pendingApprovals
2735
+ * @secure
2736
+ */
2737
+ listPendingApprovals: (params: RequestParams = {}) =>
2738
+ this.request<ListPendingApprovalsData, ListPendingApprovalsError>({
2739
+ path: `/tenant/pendingApprovals`,
2740
+ method: 'GET',
2741
+ secure: true,
2742
+ format: 'json',
2743
+ ...params,
2744
+ }),
2745
+
2746
+ /**
2747
+ * @description Retrieve config for the tenant.
2748
+ *
2749
+ * @tags Tenant
2750
+ * @name ListConfig
2751
+ * @summary Get Tenant Config
2752
+ * @request GET:/tenant/config
2753
+ * @secure
2754
+ */
2755
+ listConfig: (params: RequestParams = {}) =>
2756
+ this.request<ListConfigResult, ListConfigFail>({
2757
+ path: `/tenant/config`,
2758
+ method: 'GET',
2759
+ secure: true,
2760
+ ...params,
2761
+ }),
2762
+
2763
+ /**
2764
+ * @description Export a report of applications based on the provided filters.
2765
+ *
2766
+ * @tags Application
2767
+ * @name CreateReportApplicationExport
2768
+ * @summary Application report
2769
+ * @request POST:/tenant/report/applicationExport
2770
+ * @secure
2771
+ */
2772
+ createReportApplicationExport: (data: InputN4Ndusy4P2, params: RequestParams = {}) =>
2773
+ this.request<CreateReportApplicationExportData, CreateReportApplicationExportError>({
2774
+ path: `/tenant/report/applicationExport`,
2775
+ method: 'POST',
2776
+ body: data,
2777
+ secure: true,
2778
+ type: ContentType.Json,
2779
+ ...params,
2780
+ }),
2781
+
2782
+ /**
2783
+ * @description Export a report of applications based on the provided filters.
2784
+ *
2785
+ * @tags Applications
2786
+ * @name ListReportApplicationStatus
2787
+ * @summary Applications report
2788
+ * @request POST:/tenant/report/applicationStatus
2789
+ * @secure
2790
+ */
2791
+ listReportApplicationStatus: (data: InputHay4A10Oxo, params: RequestParams = {}) =>
2792
+ this.request<ListReportApplicationStatusData, ListReportApplicationStatusError>({
2793
+ path: `/tenant/report/applicationStatus`,
2794
+ method: 'POST',
2795
+ body: data,
2796
+ secure: true,
2797
+ type: ContentType.Json,
2798
+ ...params,
2799
+ }),
2800
+
2801
+ /**
2802
+ * @description Export a report of applications based on the provided filters.
2803
+ *
2804
+ * @tags Applications
2805
+ * @name CreateReportApplicationsReport
2806
+ * @summary Applications report
2807
+ * @request POST:/tenant/report/applicationsReport
2808
+ * @secure
2809
+ */
2810
+ createReportApplicationsReport: (data: Input39Rlhyxzj2, params: RequestParams = {}) =>
2811
+ this.request<CreateReportApplicationsReportData, CreateReportApplicationsReportError>({
2812
+ path: `/tenant/report/applicationsReport`,
2813
+ method: 'POST',
2814
+ body: data,
2815
+ secure: true,
2816
+ type: ContentType.Json,
2817
+ ...params,
2818
+ }),
2819
+
2820
+ /**
2821
+ * @description This route allows you to post certificates email for the tenant.
2822
+ *
2823
+ * @tags Tenant
2824
+ * @name CreateCertificatesEmail
2825
+ * @summary Post Certificates Email
2826
+ * @request POST:/tenant/certificates/email
2827
+ * @secure
2828
+ */
2829
+ createCertificatesEmail: (data: InputLop7Riutcm, params: RequestParams = {}) =>
2830
+ this.request<CreateCertificatesEmailData, CreateCertificatesEmailError>({
2831
+ path: `/tenant/certificates/email`,
2832
+ method: 'POST',
2833
+ body: data,
2834
+ secure: true,
2835
+ type: ContentType.Json,
2836
+ ...params,
2837
+ }),
2838
+
2839
+ /**
2840
+ * @description Generate a preview of the completed certifications report.
2841
+ *
2842
+ * @tags CompletedCertifications
2843
+ * @name CreateReportCompletedCertificationsPreview
2844
+ * @summary Preview Completed Certifications Report
2845
+ * @request POST:/tenant/report/completedCertifications/preview
2846
+ * @secure
2847
+ */
2848
+ createReportCompletedCertificationsPreview: (
2849
+ query: CreateReportCompletedCertificationsPreviewParams,
2850
+ params: RequestParams = {}
2851
+ ) =>
2852
+ this.request<CreateReportCompletedCertificationsPreviewData, CreateReportCompletedCertificationsPreviewError>({
2853
+ path: `/tenant/report/completedCertifications/preview`,
2854
+ method: 'POST',
2855
+ query: query,
2856
+ secure: true,
2857
+ ...params,
2858
+ }),
2859
+
2860
+ /**
2861
+ * @description Generates the completed certifications report.
2862
+ *
2863
+ * @tags CompletedCertifications
2864
+ * @name ListReportCompletedCertifications
2865
+ * @summary Completed Certifications Report
2866
+ * @request POST:/tenant/report/completedCertifications
2867
+ * @secure
2868
+ */
2869
+ listReportCompletedCertifications: (query: ListReportCompletedCertificationsParams, params: RequestParams = {}) =>
2870
+ this.request<ListReportCompletedCertificationsData, ListReportCompletedCertificationsError>({
2871
+ path: `/tenant/report/completedCertifications`,
2872
+ method: 'POST',
2873
+ query: query,
2874
+ secure: true,
2875
+ ...params,
2876
+ }),
2877
+
2878
+ /**
2879
+ * @description Redeems a license for a user by product ID.
2880
+ *
2881
+ * @tags License
2882
+ * @name CreateLicenseRedeem
2883
+ * @summary Redeem a License for a User
2884
+ * @request POST:/tenant/license/redeem/{userID}
2885
+ * @secure
2886
+ */
2887
+ createLicenseRedeem: (userId: string, data: InputGikxez8Kaz, params: RequestParams = {}) =>
2888
+ this.request<CreateLicenseRedeemData, CreateLicenseRedeemError>({
2889
+ path: `/tenant/license/redeem/${userId}`,
2890
+ method: 'POST',
2891
+ body: data,
2892
+ secure: true,
2893
+ type: ContentType.Json,
2894
+ ...params,
2895
+ }),
2896
+
2897
+ /**
2898
+ * @description Generate a of the organization licenses report based on search filters.
2899
+ *
2900
+ * @tags OrgLicenses
2901
+ * @name ListReportOrglicenses
2902
+ * @summary Org Licenses Report
2903
+ * @request POST:/tenant/report/orglicenses/
2904
+ * @secure
2905
+ */
2906
+ listReportOrglicenses: (data: InputK0Mnve89M3, params: RequestParams = {}) =>
2907
+ this.request<ListReportOrglicensesData, ListReportOrglicensesError>({
2908
+ path: `/tenant/report/orglicenses/`,
2909
+ method: 'POST',
2910
+ body: data,
2911
+ secure: true,
2912
+ type: ContentType.Json,
2913
+ ...params,
2914
+ }),
2915
+
2916
+ /**
2917
+ * @description Generate a preview of the organization licenses report based on search filters.
2918
+ *
2919
+ * @tags OrgLicenses
2920
+ * @name CreateReportOrglicensesPreview
2921
+ * @summary Preview Org Licenses Report
2922
+ * @request POST:/tenant/report/orglicenses/preview
2923
+ * @secure
2924
+ */
2925
+ createReportOrglicensesPreview: (data: Input560Aguh4X3, params: RequestParams = {}) =>
2926
+ this.request<CreateReportOrglicensesPreviewData, CreateReportOrglicensesPreviewError>({
2927
+ path: `/tenant/report/orglicenses/preview`,
2928
+ method: 'POST',
2929
+ body: data,
2930
+ secure: true,
2931
+ type: ContentType.Json,
2932
+ ...params,
2933
+ }),
2934
+
2935
+ /**
2936
+ * @description Custo NCSO scpecific export containing certification information for NCSO users.
2937
+ *
2938
+ * @tags Reports
2939
+ * @name CreateReportNcsoReport
2940
+ * @summary NCSO Export report
2941
+ * @request POST:/tenant/report/ncsoReport
2942
+ * @secure
2943
+ */
2944
+ createReportNcsoReport: (data: NcsoReportRequestSchema, params: RequestParams = {}) =>
2945
+ this.request<CreateReportNcsoReportData, CreateReportNcsoReportError>({
2946
+ path: `/tenant/report/ncsoReport`,
2947
+ method: 'POST',
2948
+ body: data,
2949
+ secure: true,
2950
+ type: ContentType.Json,
2951
+ format: 'json',
2952
+ ...params,
2953
+ }),
2954
+
2955
+ /**
2956
+ * @description Advanced search for users in the tenant by filters, with report generation.
2957
+ *
2958
+ * @tags Users
2959
+ * @name CreateReportUsersAdvanced
2960
+ * @summary Advanced report generated by search users from tenant by filters
2961
+ * @request POST:/tenant/report/users/advanced
2962
+ * @secure
2963
+ */
2964
+ createReportUsersAdvanced: (data: InputK49I8Qntjc, params: RequestParams = {}) =>
2965
+ this.request<CreateReportUsersAdvancedData, CreateReportUsersAdvancedError>({
2966
+ path: `/tenant/report/users/advanced`,
2967
+ method: 'POST',
2968
+ body: data,
2969
+ secure: true,
2970
+ type: ContentType.Json,
2971
+ ...params,
2972
+ }),
2973
+
2974
+ /**
2975
+ * @description Searches for users in the tenant by their IDs.
2976
+ *
2977
+ * @tags Users
2978
+ * @name ListSearchUsersIds
2979
+ * @summary Search Users from tenant by IDs
2980
+ * @request POST:/tenant/search/users/ids
2981
+ * @secure
2982
+ */
2983
+ listSearchUsersIds: (data: InputWxkq7Niqao, params: RequestParams = {}) =>
2984
+ this.request<ListSearchUsersIdsData, ListSearchUsersIdsError>({
2985
+ path: `/tenant/search/users/ids`,
2986
+ method: 'POST',
2987
+ body: data,
2988
+ secure: true,
2989
+ type: ContentType.Json,
2990
+ ...params,
2991
+ }),
2992
+
2993
+ /**
2994
+ * @description Searches for users in the tenant by term and filters.
2995
+ *
2996
+ * @tags Users
2997
+ * @name CreateSearchUsersTerm
2998
+ * @summary Search Users from tenant by term
2999
+ * @request POST:/tenant/search/users/term
3000
+ * @secure
3001
+ */
3002
+ createSearchUsersTerm: (data: InputG5Bir0Wo4E, params: RequestParams = {}) =>
3003
+ this.request<CreateSearchUsersTermData, CreateSearchUsersTermError>({
3004
+ path: `/tenant/search/users/term`,
3005
+ method: 'POST',
3006
+ body: data,
3007
+ secure: true,
3008
+ type: ContentType.Json,
3009
+ ...params,
3010
+ }),
3011
+
3012
+ /**
3013
+ * @description Simple search for users in the tenant by term and filters, with report generation.
3014
+ *
3015
+ * @tags Users
3016
+ * @name CreateReportUsersSimple
3017
+ * @summary Simple report generated by search users from tenant by term
3018
+ * @request POST:/tenant/report/users/simple
3019
+ * @secure
3020
+ */
3021
+ createReportUsersSimple: (data: InputNdh9V3T3Og, params: RequestParams = {}) =>
3022
+ this.request<CreateReportUsersSimpleData, CreateReportUsersSimpleError>({
3023
+ path: `/tenant/report/users/simple`,
3024
+ method: 'POST',
3025
+ body: data,
3026
+ secure: true,
3027
+ type: ContentType.Json,
3028
+ ...params,
3029
+ }),
3030
+ }
3031
+ user = {
3032
+ /**
3033
+ * @description Delete application item by type.
3034
+ *
3035
+ * @tags Application
3036
+ * @name DeleteCertificationApplicationItem
3037
+ * @summary Delete Application Item
3038
+ * @request DELETE:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
3039
+ * @secure
3040
+ */
3041
+ deleteCertificationApplicationItem: (
3042
+ userId: string,
3043
+ certProcId: string,
3044
+ applicationType: string,
3045
+ sourceId: string,
3046
+ params: RequestParams = {}
3047
+ ) =>
3048
+ this.request<DeleteCertificationApplicationItemData, DeleteCertificationApplicationItemError>({
3049
+ path: `/user/${userId}/certification/${certProcId}/application/${applicationType}/item/${sourceId}`,
3050
+ method: 'DELETE',
3051
+ secure: true,
3052
+ ...params,
3053
+ }),
3054
+
3055
+ /**
3056
+ * @description This route allows you to add an item to a certification application for a user.
3057
+ *
3058
+ * @tags Application
3059
+ * @name CreateCertificationApplicationItem
3060
+ * @summary Add Application Item
3061
+ * @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
3062
+ * @secure
3063
+ */
3064
+ createCertificationApplicationItem: (
3065
+ userId: string,
3066
+ certProcId: string,
3067
+ applicationType: string,
3068
+ sourceId: string,
3069
+ data: InputJmsh67C6I,
3070
+ params: RequestParams = {}
3071
+ ) =>
3072
+ this.request<CreateCertificationApplicationItemData, CreateCertificationApplicationItemError>({
3073
+ path: `/user/${userId}/certification/${certProcId}/application/${applicationType}/item/${sourceId}`,
3074
+ method: 'POST',
3075
+ body: data,
3076
+ secure: true,
3077
+ type: ContentType.Json,
3078
+ ...params,
3079
+ }),
3080
+
3081
+ /**
3082
+ * @description Delete a certification process application by type.
3083
+ *
3084
+ * @tags Application
3085
+ * @name DeleteCertificationApplicationBlacklist
3086
+ * @summary Delete Certification Process Application
3087
+ * @request DELETE:/user/{userID}/certification/{certProcID}/application/{applicationType}/blacklist/{sourceID}
3088
+ * @secure
3089
+ */
3090
+ deleteCertificationApplicationBlacklist: (
3091
+ userId: string,
3092
+ certProcId: string,
3093
+ applicationType: string,
3094
+ sourceId: string,
3095
+ params: RequestParams = {}
3096
+ ) =>
3097
+ this.request<DeleteCertificationApplicationBlacklistData, DeleteCertificationApplicationBlacklistError>({
3098
+ path: `/user/${userId}/certification/${certProcId}/application/${applicationType}/blacklist/${sourceId}`,
3099
+ method: 'DELETE',
3100
+ secure: true,
3101
+ ...params,
3102
+ }),
3103
+
3104
+ /**
3105
+ * @description Delete a certification process application by type.
3106
+ *
3107
+ * @tags Application
3108
+ * @name DeleteCertificationApplication
3109
+ * @summary Delete Certification Process Application
3110
+ * @request DELETE:/user/{userID}/certification/{certProcID}/application/{applicationType}
3111
+ * @secure
3112
+ */
3113
+ deleteCertificationApplication: (
3114
+ userId: string,
3115
+ certProcId: string,
3116
+ applicationType: string,
3117
+ params: RequestParams = {}
3118
+ ) =>
3119
+ this.request<DeleteCertificationApplicationData, DeleteCertificationApplicationError>({
3120
+ path: `/user/${userId}/certification/${certProcId}/application/${applicationType}`,
3121
+ method: 'DELETE',
3122
+ secure: true,
3123
+ ...params,
3124
+ }),
3125
+
3126
+ /**
3127
+ * @description Get certification process application by type.
3128
+ *
3129
+ * @tags Application
3130
+ * @name GetCertificationApplication
3131
+ * @summary Get Certification Process
3132
+ * @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}
3133
+ * @secure
3134
+ */
3135
+ getCertificationApplication: (
3136
+ userId: string,
3137
+ certProcId: string,
3138
+ applicationType: string,
3139
+ params: RequestParams = {}
3140
+ ) =>
3141
+ this.request<GetCertificationApplicationData, GetCertificationApplicationError>({
3142
+ path: `/user/${userId}/certification/${certProcId}/application/${applicationType}`,
3143
+ method: 'GET',
3144
+ secure: true,
3145
+ format: 'json',
3146
+ ...params,
3147
+ }),
3148
+
3149
+ /**
3150
+ * @description Start certification process application by type.
3151
+ *
3152
+ * @tags User
3153
+ * @name CreateCertificationApplication
3154
+ * @summary Start Certification Process Application
3155
+ * @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}
3156
+ * @secure
3157
+ */
3158
+ createCertificationApplication: (
3159
+ userId: string,
3160
+ certProcId: string,
3161
+ applicationType: string,
3162
+ params: RequestParams = {}
3163
+ ) =>
3164
+ this.request<CreateCertificationApplicationData, CreateCertificationApplicationError>({
3165
+ path: `/user/${userId}/certification/${certProcId}/application/${applicationType}`,
3166
+ method: 'POST',
3167
+ secure: true,
3168
+ ...params,
3169
+ }),
3170
+
3171
+ /**
3172
+ * @description Delete course file for a user by IDs.
3173
+ *
3174
+ * @tags Course
3175
+ * @name DeleteCertificationCourseFileSign
3176
+ * @summary Delete Course File
3177
+ * @request DELETE:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
3178
+ * @secure
3179
+ */
3180
+ deleteCertificationCourseFileSign: (
3181
+ userId: string,
3182
+ certProcId: string,
3183
+ courseId: string,
3184
+ fileId: string,
3185
+ params: RequestParams = {}
3186
+ ) =>
3187
+ this.request<DeleteCertificationCourseFileSignData, DeleteCertificationCourseFileSignError>({
3188
+ path: `/user/${userId}/certification/${certProcId}/course/${courseId}/fileSign/${fileId}`,
3189
+ method: 'DELETE',
3190
+ secure: true,
3191
+ ...params,
3192
+ }),
3193
+
3194
+ /**
3195
+ * @description Retrieve course file for a user by IDs.
3196
+ *
3197
+ * @tags Course
3198
+ * @name GetCertificationCourseFileSign
3199
+ * @summary Get Course File
3200
+ * @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
3201
+ * @secure
3202
+ */
3203
+ getCertificationCourseFileSign: (
3204
+ userId: string,
3205
+ certProcId: string,
3206
+ courseId: string,
3207
+ fileId: string,
3208
+ params: RequestParams = {}
3209
+ ) =>
3210
+ this.request<GetCertificationCourseFileSignData, GetCertificationCourseFileSignError>({
3211
+ path: `/user/${userId}/certification/${certProcId}/course/${courseId}/fileSign/${fileId}`,
3212
+ method: 'GET',
3213
+ secure: true,
3214
+ format: 'json',
3215
+ ...params,
3216
+ }),
3217
+
3218
+ /**
3219
+ * @description This route allows you to create a signed URL for a course file for a user in a specific course.
3220
+ *
3221
+ * @tags Course
3222
+ * @name CreateCertificationCourseFileSign
3223
+ * @summary Course file
3224
+ * @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
3225
+ * @secure
3226
+ */
3227
+ createCertificationCourseFileSign: (
3228
+ { userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams,
3229
+ params: RequestParams = {}
3230
+ ) =>
3231
+ this.request<CreateCertificationCourseFileSignData, CreateCertificationCourseFileSignError>({
3232
+ path: `/user/${userId}/certification/${certProcId}/course/${courseId}/fileSign/${fileId}`,
3233
+ method: 'POST',
3234
+ query: query,
3235
+ secure: true,
3236
+ format: 'json',
3237
+ ...params,
3238
+ }),
3239
+
3240
+ /**
3241
+ * @description Delete submission item (file) for a user in a course by IDs.
3242
+ *
3243
+ * @tags Course
3244
+ * @name DeleteCertificationCourseDocument
3245
+ * @summary Delete Submission Item
3246
+ * @request DELETE:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
3247
+ * @secure
3248
+ */
3249
+ deleteCertificationCourseDocument: (
3250
+ userId: string,
3251
+ certProcId: string,
3252
+ courseId: string,
3253
+ fileId: string,
3254
+ params: RequestParams = {}
3255
+ ) =>
3256
+ this.request<DeleteCertificationCourseDocumentData, DeleteCertificationCourseDocumentError>({
3257
+ path: `/user/${userId}/certification/${certProcId}/course/${courseId}/document/${fileId}`,
3258
+ method: 'DELETE',
3259
+ secure: true,
3260
+ ...params,
3261
+ }),
3262
+
3263
+ /**
3264
+ * @description This route allows you to set or override a course submission item (file) for a user in a specific course.
3265
+ *
3266
+ * @tags Course
3267
+ * @name UpdateCertificationCourseDocument
3268
+ * @summary Set Course Submission Item
3269
+ * @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
3270
+ * @secure
3271
+ */
3272
+ updateCertificationCourseDocument: (
3273
+ userId: string,
3274
+ certProcId: string,
3275
+ courseId: string,
3276
+ fileId: string,
3277
+ data: InputGby1J6Gkqr,
3278
+ params: RequestParams = {}
3279
+ ) =>
3280
+ this.request<UpdateCertificationCourseDocumentData, UpdateCertificationCourseDocumentError>({
3281
+ path: `/user/${userId}/certification/${certProcId}/course/${courseId}/document/${fileId}`,
3282
+ method: 'PUT',
3283
+ body: data,
3284
+ secure: true,
3285
+ type: ContentType.Json,
3286
+ format: 'json',
3287
+ ...params,
3288
+ }),
3289
+
3290
+ /**
3291
+ * @description Delete user by ID.
3292
+ *
3293
+ * @tags User
3294
+ * @name DeleteUser
3295
+ * @summary Delete User
3296
+ * @request DELETE:/user/{userID}
3297
+ * @secure
3298
+ */
3299
+ deleteUser: (userId: string, params: RequestParams = {}) =>
3300
+ this.request<DeleteUserData, DeleteUserError>({
3301
+ path: `/user/${userId}`,
3302
+ method: 'DELETE',
3303
+ secure: true,
3304
+ ...params,
3305
+ }),
3306
+
3307
+ /**
3308
+ * @description Retrieve user by ID.
3309
+ *
3310
+ * @tags User
3311
+ * @name GetUser
3312
+ * @summary Get User
3313
+ * @request GET:/user/{userID}
3314
+ * @secure
3315
+ */
3316
+ getUser: (userId: string, params: RequestParams = {}) =>
3317
+ this.request<GetUserResult, GetUserFail>({
3318
+ path: `/user/${userId}`,
3319
+ method: 'GET',
3320
+ secure: true,
3321
+ format: 'json',
3322
+ ...params,
3323
+ }),
3324
+
3325
+ /**
3326
+ * @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.
3327
+ *
3328
+ * @tags User
3329
+ * @name CreateUser
3330
+ * @summary CreateUser
3331
+ * @request POST:/user/{userID}
3332
+ * @secure
3333
+ */
3334
+ createUser: (userId: string, data: InputYa0N64R6Wk, params: RequestParams = {}) =>
3335
+ this.request<CreateUserData, CreateUserError>({
3336
+ path: `/user/${userId}`,
3337
+ method: 'POST',
3338
+ body: data,
3339
+ secure: true,
3340
+ type: ContentType.Json,
3341
+ ...params,
3342
+ }),
3343
+
3344
+ /**
3345
+ * @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.
3346
+ *
3347
+ * @tags User
3348
+ * @name UpdateUser
3349
+ * @summary Update User
3350
+ * @request PUT:/user/{userID}
3351
+ * @secure
3352
+ */
3353
+ updateUser: (userId: string, data: InputCkiexmnlfz, params: RequestParams = {}) =>
3354
+ this.request<UpdateUserData, UpdateUserError>({
3355
+ path: `/user/${userId}`,
3356
+ method: 'PUT',
3357
+ body: data,
3358
+ secure: true,
3359
+ type: ContentType.Json,
3360
+ ...params,
3361
+ }),
3362
+
3363
+ /**
3364
+ * @description Delete course from user
3365
+ *
3366
+ * @tags User
3367
+ * @name DeleteCertificationCourse
3368
+ * @summary Delete course from user
3369
+ * @request DELETE:/user/{userID}/certification/{certProcID}/course/{courseID}
3370
+ * @secure
3371
+ */
3372
+ deleteCertificationCourse: (userId: string, certProcId: string, courseId: string, params: RequestParams = {}) =>
3373
+ this.request<DeleteCertificationCourseData, DeleteCertificationCourseError>({
3374
+ path: `/user/${userId}/certification/${certProcId}/course/${courseId}`,
3375
+ method: 'DELETE',
3376
+ secure: true,
3377
+ ...params,
3378
+ }),
3379
+
3380
+ /**
3381
+ * @description Retrieve a specific file version of an application item for a user in a certification process.
3382
+ *
3383
+ * @tags Application
3384
+ * @name GetCertificationApplicationItemFile
3385
+ * @summary Get Application Item File
3386
+ * @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
3387
+ * @secure
3388
+ */
3389
+ getCertificationApplicationItemFile: (
3390
+ userId: string,
3391
+ certProcId: string,
3392
+ sourceId: string,
3393
+ fileVersion: string,
3394
+ params: RequestParams = {}
3395
+ ) =>
3396
+ this.request<GetCertificationApplicationItemFileData, GetCertificationApplicationItemFileError>({
3397
+ path: `/user/${userId}/certification/${certProcId}/applicationItem/${sourceId}/file/${fileVersion}`,
3398
+ method: 'GET',
3399
+ secure: true,
3400
+ format: 'json',
3401
+ ...params,
3402
+ }),
3403
+
3404
+ /**
3405
+ * @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
3406
+ *
3407
+ * @tags Application
3408
+ * @name CreateCertificationApplicationItemFile
3409
+ * @summary Post Application Item File
3410
+ * @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
3411
+ * @secure
3412
+ */
3413
+ createCertificationApplicationItemFile: (
3414
+ { userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams,
3415
+ params: RequestParams = {}
3416
+ ) =>
3417
+ this.request<CreateCertificationApplicationItemFileData, CreateCertificationApplicationItemFileError>({
3418
+ path: `/user/${userId}/certification/${certProcId}/applicationItem/${sourceId}/file/${fileVersion}`,
3419
+ method: 'POST',
3420
+ query: query,
3421
+ secure: true,
3422
+ format: 'json',
3423
+ ...params,
3424
+ }),
3425
+
3426
+ /**
3427
+ * @description Retrieve the cancelation charges for a course based on the user, session, and course details.
3428
+ *
3429
+ * @tags Course
3430
+ * @name GetCertificationCourseSessionCalcCancelationCharges
3431
+ * @summary Get cancelation charges
3432
+ * @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
3433
+ * @secure
3434
+ */
3435
+ getCertificationCourseSessionCalcCancelationCharges: (
3436
+ userId: string,
3437
+ certProcId: string,
3438
+ courseId: string,
3439
+ sessionId: string,
3440
+ params: RequestParams = {}
3441
+ ) =>
3442
+ this.request<
3443
+ GetCertificationCourseSessionCalcCancelationChargesData,
3444
+ GetCertificationCourseSessionCalcCancelationChargesError
3445
+ >({
3446
+ path: `/user/${userId}/certification/${certProcId}/course/${courseId}/session/${sessionId}/calcCancelationCharges`,
3447
+ method: 'GET',
3448
+ secure: true,
3449
+ format: 'json',
3450
+ ...params,
3451
+ }),
3452
+
3453
+ /**
3454
+ * @description Retrieves the certification processes for a user by their user ID.
3455
+ *
3456
+ * @tags Certifications
3457
+ * @name GetCertifications
3458
+ * @summary Certifications for User
3459
+ * @request GET:/user/{userID}/certifications
3460
+ * @secure
3461
+ */
3462
+ getCertifications: (userId: string, params: RequestParams = {}) =>
3463
+ this.request<GetCertificationsData, GetCertificationsError>({
3464
+ path: `/user/${userId}/certifications`,
3465
+ method: 'GET',
3466
+ secure: true,
3467
+ format: 'json',
3468
+ ...params,
3469
+ }),
3470
+
3471
+ /**
3472
+ * @description Retrieve course for a user by their user ID and courseID (cpID::examID).
3473
+ *
3474
+ * @tags Course
3475
+ * @name GetCourse
3476
+ * @summary Get Course
3477
+ * @request GET:/user/{userID}/course/{courseID}
3478
+ * @secure
3479
+ */
3480
+ getCourse: (userId: string, courseId: string, params: RequestParams = {}) =>
3481
+ this.request<GetCourseData, GetCourseError>({
3482
+ path: `/user/${userId}/course/${courseId}`,
3483
+ method: 'GET',
3484
+ secure: true,
3485
+ format: 'json',
3486
+ ...params,
3487
+ }),
3488
+
3489
+ /**
3490
+ * @description Retrieves the certification processes expanded for a user by their user ID.
3491
+ *
3492
+ * @tags Certifications
3493
+ * @name GetCertificationsExpanded
3494
+ * @summary Certifications expanded for User
3495
+ * @request GET:/user/{userID}/certifications/expanded
3496
+ * @secure
3497
+ */
3498
+ getCertificationsExpanded: (userId: string, params: RequestParams = {}) =>
3499
+ this.request<GetCertificationsExpandedData, GetCertificationsExpandedError>({
3500
+ path: `/user/${userId}/certifications/expanded`,
3501
+ method: 'GET',
3502
+ secure: true,
3503
+ format: 'json',
3504
+ ...params,
3505
+ }),
3506
+
3507
+ /**
3508
+ * @description Get certification process application by type.
3509
+ *
3510
+ * @tags Application
3511
+ * @name GetCertificationApplicationForeignFill
3512
+ * @summary Get Certification Process
3513
+ * @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
3514
+ * @secure
3515
+ */
3516
+ getCertificationApplicationForeignFill: (
3517
+ userId: string,
3518
+ certProcId: string,
3519
+ applicationType: string,
3520
+ params: RequestParams = {}
3521
+ ) =>
3522
+ this.request<GetCertificationApplicationForeignFillData, GetCertificationApplicationForeignFillError>({
3523
+ path: `/user/${userId}/certification/${certProcId}/application/${applicationType}/foreignFill`,
3524
+ method: 'GET',
3525
+ secure: true,
3526
+ format: 'json',
3527
+ ...params,
3528
+ }),
3529
+
3530
+ /**
3531
+ * @description This endpoint will print certificate
3532
+ *
3533
+ * @tags Certification
3534
+ * @name GetCertificationPrint
3535
+ * @summary Print Certificate
3536
+ * @request GET:/user/{userID}/certification/{certProcID}/print
3537
+ * @secure
3538
+ */
3539
+ getCertificationPrint: (userId: string, certProcId: string, params: RequestParams = {}) =>
3540
+ this.request<GetCertificationPrintData, GetCertificationPrintError>({
3541
+ path: `/user/${userId}/certification/${certProcId}/print`,
3542
+ method: 'GET',
3543
+ secure: true,
3544
+ ...params,
3545
+ }),
3546
+
3547
+ /**
3548
+ * @description This endpoint will print course
3549
+ *
3550
+ * @tags Course
3551
+ * @name GetCertificationCoursePrint
3552
+ * @summary Print Course
3553
+ * @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/print
3554
+ * @secure
3555
+ */
3556
+ getCertificationCoursePrint: (userId: string, certProcId: string, courseId: string, params: RequestParams = {}) =>
3557
+ this.request<GetCertificationCoursePrintData, GetCertificationCoursePrintError>({
3558
+ path: `/user/${userId}/certification/${certProcId}/course/${courseId}/print`,
3559
+ method: 'GET',
3560
+ secure: true,
3561
+ ...params,
3562
+ }),
3563
+
3564
+ /**
3565
+ * @description Returns the requirement status (e.g. student history) for a given user and source (e.g. course)
3566
+ *
3567
+ * @tags Requirement
3568
+ * @name GetRequirement
3569
+ * @summary Get user requirement status
3570
+ * @request GET:/user/{userID}/requirement/{sourceID}
3571
+ * @secure
3572
+ */
3573
+ getRequirement: (userId: string, sourceId: string, params: RequestParams = {}) =>
3574
+ this.request<GetRequirementData, GetRequirementError>({
3575
+ path: `/user/${userId}/requirement/${sourceId}`,
3576
+ method: 'GET',
3577
+ secure: true,
3578
+ format: 'json',
3579
+ ...params,
3580
+ }),
3581
+
3582
+ /**
3583
+ * @description Retrieves the upcoming courses for a user by their user ID.
3584
+ *
3585
+ * @tags Certifications
3586
+ * @name GetCertificationsUpcomingCourses
3587
+ * @summary Get Upcoming Courses for User
3588
+ * @request GET:/user/{userID}/certifications/upcomingCourses
3589
+ * @secure
3590
+ */
3591
+ getCertificationsUpcomingCourses: (userId: string, params: RequestParams = {}) =>
3592
+ this.request<GetCertificationsUpcomingCoursesData, GetCertificationsUpcomingCoursesError>({
3593
+ path: `/user/${userId}/certifications/upcomingCourses`,
3594
+ method: 'GET',
3595
+ secure: true,
3596
+ format: 'json',
3597
+ ...params,
3598
+ }),
3599
+
3600
+ /**
3601
+ * @description Retrieve course for a user by their user ID.
3602
+ *
3603
+ * @tags Certification
3604
+ * @name GetCertification
3605
+ * @summary Get Certification Process for User
3606
+ * @request GET:/user/{userID}/certification/{certProcID}
3607
+ * @secure
3608
+ */
3609
+ getCertification: (userId: string, certProcId: string, params: RequestParams = {}) =>
3610
+ this.request<GetCertificationData, GetCertificationError>({
3611
+ path: `/user/${userId}/certification/${certProcId}`,
3612
+ method: 'GET',
3613
+ secure: true,
3614
+ format: 'json',
3615
+ ...params,
3616
+ }),
3617
+
3618
+ /**
3619
+ * @description This route allows you to start a certification process for a user.
3620
+ *
3621
+ * @tags Certification
3622
+ * @name CreateCertification
3623
+ * @summary Start Certification Process
3624
+ * @request POST:/user/{userID}/certification/{certProcID}
3625
+ * @secure
3626
+ */
3627
+ createCertification: (userId: string, certProcId: string, params: RequestParams = {}) =>
3628
+ this.request<CreateCertificationData, CreateCertificationError>({
3629
+ path: `/user/${userId}/certification/${certProcId}`,
3630
+ method: 'POST',
3631
+ secure: true,
3632
+ ...params,
3633
+ }),
3634
+
3635
+ /**
3636
+ * @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.
3637
+ *
3638
+ * @tags User
3639
+ * @name CreateSessionAdd
3640
+ * @summary Add user to session
3641
+ * @request POST:/user/{userID}/session/{sessionID}/add
3642
+ * @secure
3643
+ */
3644
+ createSessionAdd: (userId: string, sessionId: string, params: RequestParams = {}) =>
3645
+ this.request<CreateSessionAddData, CreateSessionAddError>({
3646
+ path: `/user/${userId}/session/${sessionId}/add`,
3647
+ method: 'POST',
3648
+ secure: true,
3649
+ ...params,
3650
+ }),
3651
+
3652
+ /**
3653
+ * @description This route allows a user to request pre-approval for an application type in a certification process.
3654
+ *
3655
+ * @tags Application
3656
+ * @name CreateCertificationApplicationPreApproval
3657
+ * @summary Certification Application Pre Approval
3658
+ * @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApproval
3659
+ * @secure
3660
+ */
3661
+ createCertificationApplicationPreApproval: (
3662
+ userId: string,
3663
+ certProcId: string,
3664
+ applicationType: string,
3665
+ params: RequestParams = {}
3666
+ ) =>
3667
+ this.request<CreateCertificationApplicationPreApprovalData, CreateCertificationApplicationPreApprovalError>({
3668
+ path: `/user/${userId}/certification/${certProcId}/application/${applicationType}/preApproval`,
3669
+ method: 'POST',
3670
+ secure: true,
3671
+ ...params,
3672
+ }),
3673
+
3674
+ /**
3675
+ * @description This route allows you to review a certification application for a user.
3676
+ *
3677
+ * @tags Application
3678
+ * @name CreateCertificationApplicationReview
3679
+ * @summary Review Certification Application
3680
+ * @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
3681
+ * @secure
3682
+ */
3683
+ createCertificationApplicationReview: (
3684
+ userId: string,
3685
+ certProcId: string,
3686
+ applicationType: string,
3687
+ data: InputEi9E1V7Rpe,
3688
+ params: RequestParams = {}
3689
+ ) =>
3690
+ this.request<CreateCertificationApplicationReviewData, CreateCertificationApplicationReviewError>({
3691
+ path: `/user/${userId}/certification/${certProcId}/application/${applicationType}/review`,
3692
+ method: 'POST',
3693
+ body: data,
3694
+ secure: true,
3695
+ type: ContentType.Json,
3696
+ ...params,
3697
+ }),
3698
+
3699
+ /**
3700
+ * @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.
3701
+ *
3702
+ * @tags Application
3703
+ * @name CreateCertificationApplicationPreApprovalReview
3704
+ * @summary Pre Approval Review Certification Application
3705
+ * @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
3706
+ * @secure
3707
+ */
3708
+ createCertificationApplicationPreApprovalReview: (
3709
+ userId: string,
3710
+ certProcId: string,
3711
+ applicationType: string,
3712
+ data: InputVczxcyab6W,
3713
+ params: RequestParams = {}
3714
+ ) =>
3715
+ this.request<
3716
+ CreateCertificationApplicationPreApprovalReviewData,
3717
+ CreateCertificationApplicationPreApprovalReviewError
3718
+ >({
3719
+ path: `/user/${userId}/certification/${certProcId}/application/${applicationType}/preApprovalReview`,
3720
+ method: 'POST',
3721
+ body: data,
3722
+ secure: true,
3723
+ type: ContentType.Json,
3724
+ ...params,
3725
+ }),
3726
+
3727
+ /**
3728
+ * @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.
3729
+ *
3730
+ * @tags Certification
3731
+ * @name CreateCertificationCourseBatchRedeem
3732
+ * @summary Redeem Batch Course for User
3733
+ * @request POST:/user/certification/{certSpecID}/course/batchRedeem
3734
+ * @secure
3735
+ */
3736
+ createCertificationCourseBatchRedeem: (certSpecId: string, data: InputF6S7Tcgt9H, params: RequestParams = {}) =>
3737
+ this.request<CreateCertificationCourseBatchRedeemData, CreateCertificationCourseBatchRedeemError>({
3738
+ path: `/user/certification/${certSpecId}/course/batchRedeem`,
3739
+ method: 'POST',
3740
+ body: data,
3741
+ secure: true,
3742
+ type: ContentType.Json,
3743
+ ...params,
3744
+ }),
3745
+
3746
+ /**
3747
+ * @description This endpoint allows for batch redeeming of course invites for a certification specification.
3748
+ *
3749
+ * @tags Course
3750
+ * @name CreateCertificationCourseBatchInvite
3751
+ * @summary Batch Course Invite
3752
+ * @request POST:/user/certification/{certSpecID}/course/batchInvite
3753
+ * @secure
3754
+ */
3755
+ createCertificationCourseBatchInvite: (certSpecId: string, data: InputTahl1X2Wos, params: RequestParams = {}) =>
3756
+ this.request<CreateCertificationCourseBatchInviteData, CreateCertificationCourseBatchInviteError>({
3757
+ path: `/user/certification/${certSpecId}/course/batchInvite`,
3758
+ method: 'POST',
3759
+ body: data,
3760
+ secure: true,
3761
+ type: ContentType.Json,
3762
+ ...params,
3763
+ }),
3764
+
3765
+ /**
3766
+ * @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.
3767
+ *
3768
+ * @tags Certification
3769
+ * @name CreateCertificationCourseSessionCancelEnrol
3770
+ * @summary Cancel Certification Enrolment
3771
+ * @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/cancelEnrol
3772
+ * @secure
3773
+ */
3774
+ createCertificationCourseSessionCancelEnrol: (
3775
+ userId: string,
3776
+ certProcId: string,
3777
+ courseId: string,
3778
+ sessionId: string,
3779
+ params: RequestParams = {}
3780
+ ) =>
3781
+ this.request<CreateCertificationCourseSessionCancelEnrolData, CreateCertificationCourseSessionCancelEnrolError>({
3782
+ path: `/user/${userId}/certification/${certProcId}/course/${courseId}/session/${sessionId}/cancelEnrol`,
3783
+ method: 'POST',
3784
+ secure: true,
3785
+ ...params,
3786
+ }),
3787
+
3788
+ /**
3789
+ * @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.
3790
+ *
3791
+ * @tags Certification
3792
+ * @name CreateCertificationRenew
3793
+ * @summary Renew Certification Process
3794
+ * @request POST:/user/{userID}/certification/{certProcID}/renew
3795
+ * @secure
3796
+ */
3797
+ createCertificationRenew: (userId: string, certProcId: string, params: RequestParams = {}) =>
3798
+ this.request<CreateCertificationRenewData, CreateCertificationRenewError>({
3799
+ path: `/user/${userId}/certification/${certProcId}/renew`,
3800
+ method: 'POST',
3801
+ secure: true,
3802
+ ...params,
3803
+ }),
3804
+
3805
+ /**
3806
+ * @description This route allows you to restart a certification process for a user.
3807
+ *
3808
+ * @tags Certification
3809
+ * @name CreateCertificationRestart
3810
+ * @summary Restart Certification Process
3811
+ * @request POST:/user/{userID}/certification/{certProcID}/restart
3812
+ * @secure
3813
+ */
3814
+ createCertificationRestart: (userId: string, certProcId: string, params: RequestParams = {}) =>
3815
+ this.request<CreateCertificationRestartData, CreateCertificationRestartError>({
3816
+ path: `/user/${userId}/certification/${certProcId}/restart`,
3817
+ method: 'POST',
3818
+ secure: true,
3819
+ ...params,
3820
+ }),
3821
+
3822
+ /**
3823
+ * @description This route allows you to waive a certification process for a user.
3824
+ *
3825
+ * @tags Certification
3826
+ * @name CreateCertificationWaive
3827
+ * @summary Waive Certification Process
3828
+ * @request POST:/user/{userID}/certification/{certProcID}/waive
3829
+ * @secure
3830
+ */
3831
+ createCertificationWaive: (userId: string, certProcId: string, data: InputW0G08Trp2L, params: RequestParams = {}) =>
3832
+ this.request<CreateCertificationWaiveData, CreateCertificationWaiveError>({
3833
+ path: `/user/${userId}/certification/${certProcId}/waive`,
3834
+ method: 'POST',
3835
+ body: data,
3836
+ secure: true,
3837
+ type: ContentType.Json,
3838
+ ...params,
3839
+ }),
3840
+
3841
+ /**
3842
+ * @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
3843
+ *
3844
+ * @tags Certification
3845
+ * @name CreateCertificationMove
3846
+ * @summary Move Certification
3847
+ * @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
3848
+ * @secure
3849
+ */
3850
+ createCertificationMove: (userId: string, certProcId: string, secUserId: string, params: RequestParams = {}) =>
3851
+ this.request<CreateCertificationMoveData, CreateCertificationMoveError>({
3852
+ path: `/user/${userId}/certification/${certProcId}/move/${secUserId}`,
3853
+ method: 'POST',
3854
+ secure: true,
3855
+ format: 'json',
3856
+ ...params,
3857
+ }),
3858
+
3859
+ /**
3860
+ * @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.
3861
+ *
3862
+ * @tags Certification
3863
+ * @name CreateCertificationCourseSessionReplace
3864
+ * @summary Replace Certification Enrolment
3865
+ * @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/replace/{secUserID}
3866
+ * @secure
3867
+ */
3868
+ createCertificationCourseSessionReplace: (
3869
+ userId: string,
3870
+ certProcId: string,
3871
+ secUserId: string,
3872
+ courseId: string,
3873
+ sessionId: string,
3874
+ params: RequestParams = {}
3875
+ ) =>
3876
+ this.request<CreateCertificationCourseSessionReplaceData, CreateCertificationCourseSessionReplaceError>({
3877
+ path: `/user/${userId}/certification/${certProcId}/course/${courseId}/session/${sessionId}/replace/${secUserId}`,
3878
+ method: 'POST',
3879
+ secure: true,
3880
+ ...params,
3881
+ }),
3882
+
3883
+ /**
3884
+ * @description This route allows you to set a trigger check for a certification process, such as blocking courses.
3885
+ *
3886
+ * @tags Certification
3887
+ * @name CreateCertificationTriggerCheck
3888
+ * @summary Set trigger check for certification process
3889
+ * @request POST:/user/{userID}/certification/{certProcID}/trigger/check
3890
+ * @secure
3891
+ */
3892
+ createCertificationTriggerCheck: (userId: string, certProcId: string, params: RequestParams = {}) =>
3893
+ this.request<CreateCertificationTriggerCheckData, CreateCertificationTriggerCheckError>({
3894
+ path: `/user/${userId}/certification/${certProcId}/trigger/check`,
3895
+ method: 'POST',
3896
+ secure: true,
3897
+ ...params,
3898
+ }),
3899
+
3900
+ /**
3901
+ * @description This route allows you to set a trigger for a certification process, such as blocking courses.
3902
+ *
3903
+ * @tags Certification
3904
+ * @name CreateCertificationTriggerSet
3905
+ * @summary Set trigger for certification process
3906
+ * @request POST:/user/{userID}/certification/{certProcID}/trigger/set
3907
+ * @secure
3908
+ */
3909
+ createCertificationTriggerSet: (
3910
+ userId: string,
3911
+ certProcId: string,
3912
+ data: Input7Vh389Cmk5,
3913
+ params: RequestParams = {}
3914
+ ) =>
3915
+ this.request<CreateCertificationTriggerSetData, CreateCertificationTriggerSetError>({
3916
+ path: `/user/${userId}/certification/${certProcId}/trigger/set`,
3917
+ method: 'POST',
3918
+ body: data,
3919
+ secure: true,
3920
+ type: ContentType.Json,
3921
+ ...params,
3922
+ }),
3923
+
3924
+ /**
3925
+ * @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
3926
+ *
3927
+ * @tags User
3928
+ * @name CreateRefreshOrgMembership
3929
+ * @summary Refresh Organization Membership
3930
+ * @request POST:/user/{userID}/refreshOrgMembership
3931
+ * @secure
3932
+ */
3933
+ createRefreshOrgMembership: (userId: string, params: RequestParams = {}) =>
3934
+ this.request<CreateRefreshOrgMembershipData, CreateRefreshOrgMembershipError>({
3935
+ path: `/user/${userId}/refreshOrgMembership`,
3936
+ method: 'POST',
3937
+ secure: true,
3938
+ ...params,
3939
+ }),
3940
+
3941
+ /**
3942
+ * @description This route allows you to retake a course for a certification process for a user in a specific course.
3943
+ *
3944
+ * @tags Course
3945
+ * @name CreateCertificationCourseRetake
3946
+ * @summary Retake Course
3947
+ * @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/retake
3948
+ * @secure
3949
+ */
3950
+ createCertificationCourseRetake: (
3951
+ userId: string,
3952
+ certProcId: string,
3953
+ courseId: string,
3954
+ params: RequestParams = {}
3955
+ ) =>
3956
+ this.request<CreateCertificationCourseRetakeData, CreateCertificationCourseRetakeError>({
3957
+ path: `/user/${userId}/certification/${certProcId}/course/${courseId}/retake`,
3958
+ method: 'POST',
3959
+ secure: true,
3960
+ ...params,
3961
+ }),
3962
+
3963
+ /**
3964
+ * @description This route allows you to revoke a course for a certification process for a user in a specific course.
3965
+ *
3966
+ * @tags Course
3967
+ * @name CreateCertificationCourseRevoke
3968
+ * @summary Revoke Course
3969
+ * @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/revoke
3970
+ * @secure
3971
+ */
3972
+ createCertificationCourseRevoke: (
3973
+ userId: string,
3974
+ certProcId: string,
3975
+ courseId: string,
3976
+ params: RequestParams = {}
3977
+ ) =>
3978
+ this.request<CreateCertificationCourseRevokeData, CreateCertificationCourseRevokeError>({
3979
+ path: `/user/${userId}/certification/${certProcId}/course/${courseId}/revoke`,
3980
+ method: 'POST',
3981
+ secure: true,
3982
+ ...params,
3983
+ }),
3984
+
3985
+ /**
3986
+ * @description Remove a specific version of an application item for a user in a certification process.
3987
+ *
3988
+ * @tags Application
3989
+ * @name CreateCertificationApplicationItemRemove
3990
+ * @summary Remove Application Item
3991
+ * @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/remove/{itemVersion}
3992
+ * @secure
3993
+ */
3994
+ createCertificationApplicationItemRemove: (
3995
+ userId: string,
3996
+ certProcId: string,
3997
+ sourceId: string,
3998
+ itemVersion: number,
3999
+ params: RequestParams = {}
4000
+ ) =>
4001
+ this.request<CreateCertificationApplicationItemRemoveData, CreateCertificationApplicationItemRemoveError>({
4002
+ path: `/user/${userId}/certification/${certProcId}/applicationItem/${sourceId}/remove/${itemVersion}`,
4003
+ method: 'POST',
4004
+ secure: true,
4005
+ ...params,
4006
+ }),
4007
+
4008
+ /**
4009
+ * @description Remove a specific version of an application item for a user in a certification process.
4010
+ *
4011
+ * @tags Application
4012
+ * @name CreateCertificationApplicationItemReview
4013
+ * @summary Remove Application Item
4014
+ * @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
4015
+ * @secure
4016
+ */
4017
+ createCertificationApplicationItemReview: (
4018
+ userId: string,
4019
+ certProcId: string,
4020
+ sourceId: string,
4021
+ itemVersion: number,
4022
+ data: InputJusp9Jdhxl,
4023
+ params: RequestParams = {}
4024
+ ) =>
4025
+ this.request<CreateCertificationApplicationItemReviewData, CreateCertificationApplicationItemReviewError>({
4026
+ path: `/user/${userId}/certification/${certProcId}/applicationItem/${sourceId}/review/${itemVersion}`,
4027
+ method: 'POST',
4028
+ body: data,
4029
+ secure: true,
4030
+ type: ContentType.Json,
4031
+ ...params,
4032
+ }),
4033
+
4034
+ /**
4035
+ * @description Returns the status of multiple requirements (e.g. student history) for a given user
4036
+ *
4037
+ * @tags Requirements
4038
+ * @name ListRequirements
4039
+ * @summary User requirements status
4040
+ * @request POST:/user/{userID}/requirements
4041
+ * @secure
4042
+ */
4043
+ listRequirements: (userId: string, data: StudentHistoryRequestSchema, params: RequestParams = {}) =>
4044
+ this.request<ListRequirementsData, ListRequirementsError>({
4045
+ path: `/user/${userId}/requirements`,
4046
+ method: 'POST',
4047
+ body: data,
4048
+ secure: true,
4049
+ type: ContentType.Json,
4050
+ format: 'json',
4051
+ ...params,
4052
+ }),
4053
+
4054
+ /**
4055
+ * @description Request certification process application submission approval
4056
+ *
4057
+ * @tags Application
4058
+ * @name CreateCertificationApplicationSubmit
4059
+ * @summary Submit Application Approval
4060
+ * @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
4061
+ * @secure
4062
+ */
4063
+ createCertificationApplicationSubmit: (
4064
+ userId: string,
4065
+ certProcId: string,
4066
+ applicationType: string,
4067
+ data: InputVb1Vnjw2Eg,
4068
+ params: RequestParams = {}
4069
+ ) =>
4070
+ this.request<CreateCertificationApplicationSubmitData, CreateCertificationApplicationSubmitError>({
4071
+ path: `/user/${userId}/certification/${certProcId}/application/${applicationType}/submit`,
4072
+ method: 'POST',
4073
+ body: data,
4074
+ secure: true,
4075
+ type: ContentType.Json,
4076
+ ...params,
4077
+ }),
4078
+
4079
+ /**
4080
+ * @description This route allows you to submit a pending approval.
4081
+ *
4082
+ * @tags Course
4083
+ * @name CreateCertificationCoursePendingApproval
4084
+ * @summary Submit Pending Approval
4085
+ * @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
4086
+ * @secure
4087
+ */
4088
+ createCertificationCoursePendingApproval: (
4089
+ userId: string,
4090
+ certProcId: string,
4091
+ courseId: string,
4092
+ paId: string,
4093
+ data: InputBkb7Btdukn,
4094
+ params: RequestParams = {}
4095
+ ) =>
4096
+ this.request<CreateCertificationCoursePendingApprovalData, CreateCertificationCoursePendingApprovalError>({
4097
+ path: `/user/${userId}/certification/${certProcId}/course/${courseId}/pendingApproval/${paId}`,
4098
+ method: 'POST',
4099
+ body: data,
4100
+ secure: true,
4101
+ type: ContentType.Json,
4102
+ ...params,
4103
+ }),
4104
+
4105
+ /**
4106
+ * @description This route allows you to review a pending approval.
4107
+ *
4108
+ * @tags Course
4109
+ * @name UpdateCertificationCoursePendingApproval
4110
+ * @summary Review Pending Approval
4111
+ * @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
4112
+ * @secure
4113
+ */
4114
+ updateCertificationCoursePendingApproval: (
4115
+ userId: string,
4116
+ certProcId: string,
4117
+ courseId: string,
4118
+ paId: string,
4119
+ data: InputC53Kuyqnej,
4120
+ params: RequestParams = {}
4121
+ ) =>
4122
+ this.request<UpdateCertificationCoursePendingApprovalData, UpdateCertificationCoursePendingApprovalError>({
4123
+ path: `/user/${userId}/certification/${certProcId}/course/${courseId}/pendingApproval/${paId}`,
4124
+ method: 'PUT',
4125
+ body: data,
4126
+ secure: true,
4127
+ type: ContentType.Json,
4128
+ ...params,
4129
+ }),
4130
+
4131
+ /**
4132
+ * @description Redeems a license for a user by product ID.
4133
+ *
4134
+ * @tags License
4135
+ * @name CreateCertificationCourseRedeem
4136
+ * @summary Redeem a License for a User
4137
+ * @request POST:/user/{userID}/certification/{certProcID}/course/redeem
4138
+ * @secure
4139
+ */
4140
+ createCertificationCourseRedeem: (
4141
+ userId: string,
4142
+ certProcId: string,
4143
+ data: InputBchr75Oc4N,
4144
+ params: RequestParams = {}
4145
+ ) =>
4146
+ this.request<CreateCertificationCourseRedeemData, CreateCertificationCourseRedeemError>({
4147
+ path: `/user/${userId}/certification/${certProcId}/course/redeem`,
4148
+ method: 'POST',
4149
+ body: data,
4150
+ secure: true,
4151
+ type: ContentType.Json,
4152
+ ...params,
4153
+ }),
4154
+
4155
+ /**
4156
+ * @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
4157
+ *
4158
+ * @tags Certification
4159
+ * @name CreateCertificationMoveValidate
4160
+ * @summary Validate Certification Move
4161
+ * @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
4162
+ * @secure
4163
+ */
4164
+ createCertificationMoveValidate: (
4165
+ userId: string,
4166
+ certProcId: string,
4167
+ secUserId: string,
4168
+ params: RequestParams = {}
4169
+ ) =>
4170
+ this.request<CreateCertificationMoveValidateData, CreateCertificationMoveValidateError>({
4171
+ path: `/user/${userId}/certification/${certProcId}/move/${secUserId}/validate`,
4172
+ method: 'POST',
4173
+ secure: true,
4174
+ format: 'json',
4175
+ ...params,
4176
+ }),
4177
+
4178
+ /**
4179
+ * @description This route allows you to end the course period for a certification process for a user in a specific course.
4180
+ *
4181
+ * @tags Course
4182
+ * @name CreateCertificationCourseEndCooldown
4183
+ * @summary End Course Cooldown
4184
+ * @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
4185
+ * @secure
4186
+ */
4187
+ createCertificationCourseEndCooldown: (
4188
+ userId: string,
4189
+ certProcId: string,
4190
+ courseId: string,
4191
+ data: InputAa84W6Sw3E,
4192
+ params: RequestParams = {}
4193
+ ) =>
4194
+ this.request<CreateCertificationCourseEndCooldownData, CreateCertificationCourseEndCooldownError>({
4195
+ path: `/user/${userId}/certification/${certProcId}/course/${courseId}/endCooldown`,
4196
+ method: 'POST',
4197
+ body: data,
4198
+ secure: true,
4199
+ type: ContentType.Json,
4200
+ ...params,
4201
+ }),
4202
+
4203
+ /**
4204
+ * @description This route allows you to unlock a course for a certification process for a user in a specific course.
4205
+ *
4206
+ * @tags Course
4207
+ * @name CreateCertificationCourseUnlockCourse
4208
+ * @summary Unlock Course
4209
+ * @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
4210
+ * @secure
4211
+ */
4212
+ createCertificationCourseUnlockCourse: (
4213
+ userId: string,
4214
+ certProcId: string,
4215
+ courseId: string,
4216
+ data: InputQwegrxedmt,
4217
+ params: RequestParams = {}
4218
+ ) =>
4219
+ this.request<CreateCertificationCourseUnlockCourseData, CreateCertificationCourseUnlockCourseError>({
4220
+ path: `/user/${userId}/certification/${certProcId}/course/${courseId}/unlockCourse`,
4221
+ method: 'POST',
4222
+ body: data,
4223
+ secure: true,
4224
+ type: ContentType.Json,
4225
+ ...params,
4226
+ }),
4227
+
4228
+ /**
4229
+ * @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.
4230
+ *
4231
+ * @tags User
4232
+ * @name CreateUpdateIta
4233
+ * @summary Update User ITA Number
4234
+ * @request POST:/user/{userID}/updateITA
4235
+ * @secure
4236
+ */
4237
+ createUpdateIta: (userId: string, data: InputJkgsw7Yp8E, params: RequestParams = {}) =>
4238
+ this.request<CreateUpdateItaData, CreateUpdateItaError>({
4239
+ path: `/user/${userId}/updateITA`,
4240
+ method: 'POST',
4241
+ body: data,
4242
+ secure: true,
4243
+ type: ContentType.Json,
4244
+ ...params,
4245
+ }),
4246
+
4247
+ /**
4248
+ * @description This route allows you to override the result of a course for a user in a certification process.
4249
+ *
4250
+ * @tags Course
4251
+ * @name UpdateCertificationCourseOverrideResult
4252
+ * @summary Override Course Result
4253
+ * @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
4254
+ * @secure
4255
+ */
4256
+ updateCertificationCourseOverrideResult: (
4257
+ userId: string,
4258
+ certProcId: string,
4259
+ courseId: string,
4260
+ data: InputQogzfpjg52,
4261
+ params: RequestParams = {}
4262
+ ) =>
4263
+ this.request<UpdateCertificationCourseOverrideResultData, UpdateCertificationCourseOverrideResultError>({
4264
+ path: `/user/${userId}/certification/${certProcId}/course/${courseId}/overrideResult`,
4265
+ method: 'PUT',
4266
+ body: data,
4267
+ secure: true,
4268
+ type: ContentType.Json,
4269
+ ...params,
4270
+ }),
4271
+
4272
+ /**
4273
+ * @description This route allows you to set or override the dates for a certification process for a user.
4274
+ *
4275
+ * @tags Certification
4276
+ * @name UpdateCertificationSetDates
4277
+ * @summary Set Certification Dates
4278
+ * @request PUT:/user/{userID}/certification/{certProcID}/setDates
4279
+ * @secure
4280
+ */
4281
+ updateCertificationSetDates: (
4282
+ userId: string,
4283
+ certProcId: string,
4284
+ data: Input7Kqbtz8S05,
4285
+ params: RequestParams = {}
4286
+ ) =>
4287
+ this.request<UpdateCertificationSetDatesData, UpdateCertificationSetDatesError>({
4288
+ path: `/user/${userId}/certification/${certProcId}/setDates`,
4289
+ method: 'PUT',
4290
+ body: data,
4291
+ secure: true,
4292
+ type: ContentType.Json,
4293
+ ...params,
4294
+ }),
4295
+ }
4296
+ users = {
4297
+ /**
4298
+ * @description Searches for users by their certification specifications.
4299
+ *
4300
+ * @tags Users
4301
+ * @name CreateCertification
4302
+ * @summary Search Users by Certification
4303
+ * @request POST:/users/certification/{certSpecID}
4304
+ * @secure
4305
+ */
4306
+ createCertification: (certSpecId: string, data: InputPl0F8Ijrz3K, params: RequestParams = {}) =>
4307
+ this.request<CreateCertificationResult, CreateCertificationFail>({
4308
+ path: `/users/certification/${certSpecId}`,
4309
+ method: 'POST',
4310
+ body: data,
4311
+ secure: true,
4312
+ type: ContentType.Json,
4313
+ format: 'json',
4314
+ ...params,
4315
+ }),
4316
+ }
4317
+ }