@ikonintegration/bccsa-program-api 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/Api.d.ts ADDED
@@ -0,0 +1,2384 @@
1
+ /** Default API Error response */
2
+ export interface ErrorResponse {
3
+ /** Error message */
4
+ err: string;
5
+ /** Error code */
6
+ errCode: string;
7
+ }
8
+ export interface Input9Jxov33U7D {
9
+ /** @minLength 1 */
10
+ customerID: string;
11
+ /** @minLength 1 */
12
+ name: string;
13
+ }
14
+ export interface InputUse5Vle8Ta {
15
+ /** @minLength 1 */
16
+ customerID: string;
17
+ /** @minLength 1 */
18
+ id: string;
19
+ /** @minLength 1 */
20
+ name: string;
21
+ }
22
+ export interface CityCreateSchema {
23
+ /**
24
+ * Customer ID
25
+ * @minLength 1
26
+ */
27
+ customerID: string;
28
+ /**
29
+ * Region ID
30
+ * @minLength 1
31
+ */
32
+ regionID: string;
33
+ /**
34
+ * City name
35
+ * @minLength 1
36
+ */
37
+ name: string;
38
+ /**
39
+ * Province code
40
+ * @minLength 1
41
+ */
42
+ province: string;
43
+ }
44
+ export interface CityUpdateSchema {
45
+ /**
46
+ * Customer ID
47
+ * @minLength 1
48
+ */
49
+ customerID: string;
50
+ /**
51
+ * Region ID
52
+ * @minLength 1
53
+ */
54
+ regionID: string;
55
+ /**
56
+ * City ID
57
+ * @minLength 1
58
+ */
59
+ id: string;
60
+ /**
61
+ * City name
62
+ * @minLength 1
63
+ */
64
+ name: string;
65
+ /**
66
+ * Province code
67
+ * @minLength 1
68
+ */
69
+ province: string;
70
+ }
71
+ export interface VenueCreateSchema {
72
+ /**
73
+ * Customer ID
74
+ * @minLength 1
75
+ */
76
+ customerID: string;
77
+ /**
78
+ * City ID
79
+ * @minLength 1
80
+ */
81
+ cityID: string;
82
+ /**
83
+ * Venue name
84
+ * @minLength 1
85
+ */
86
+ name: string;
87
+ /** Venue address */
88
+ address: {
89
+ /**
90
+ * Street address line 1
91
+ * @minLength 1
92
+ */
93
+ street1: string;
94
+ /** Street address line 2 */
95
+ street2?: string | null;
96
+ /**
97
+ * Postal code
98
+ * @minLength 1
99
+ */
100
+ postalCode: string;
101
+ /**
102
+ * Province code
103
+ * @minLength 1
104
+ */
105
+ province: string;
106
+ };
107
+ /** Additional comments */
108
+ comments?: string | null;
109
+ }
110
+ export interface VenueUpdateSchema {
111
+ /**
112
+ * Customer ID
113
+ * @minLength 1
114
+ */
115
+ customerID: string;
116
+ /**
117
+ * City ID
118
+ * @minLength 1
119
+ */
120
+ cityID: string;
121
+ /**
122
+ * Venue ID
123
+ * @minLength 1
124
+ */
125
+ id: string;
126
+ /**
127
+ * Venue name
128
+ * @minLength 1
129
+ */
130
+ name: string;
131
+ /** Venue address */
132
+ address: {
133
+ /**
134
+ * Street address line 1
135
+ * @minLength 1
136
+ */
137
+ street1: string;
138
+ /** Street address line 2 */
139
+ street2?: string | null;
140
+ /**
141
+ * Postal code
142
+ * @minLength 1
143
+ */
144
+ postalCode: string;
145
+ /**
146
+ * Province code
147
+ * @minLength 1
148
+ */
149
+ province: string;
150
+ };
151
+ /** Additional comments */
152
+ comments?: string | null;
153
+ }
154
+ export interface InstructorCreateSchema {
155
+ /**
156
+ * User ID of the instructor
157
+ * @minLength 1
158
+ */
159
+ userID: string;
160
+ }
161
+ export interface InstructorUpdateSchema {
162
+ /** Whether the instructor is disabled */
163
+ disabled: boolean;
164
+ }
165
+ export interface InstructorCourseUpdateSchema {
166
+ /** List of course IDs */
167
+ courseIDs: string[];
168
+ }
169
+ export interface InstructorRegionUpdateSchema {
170
+ /** List of region IDs */
171
+ regionIDs: string[];
172
+ }
173
+ export interface Input33N9Vgyjyy {
174
+ startTime: string | number;
175
+ endTime: string | number;
176
+ expandSessions?: boolean;
177
+ }
178
+ export interface Input56Hzg6Xiz2 {
179
+ startTime: string | number;
180
+ endTime: string | number;
181
+ description?: string;
182
+ }
183
+ export interface Input3Yilrlis7M {
184
+ startTime: string | number;
185
+ endTime: string | number;
186
+ description?: string;
187
+ }
188
+ export interface InputKi6Tbrci1R {
189
+ /** @minLength 1 */
190
+ calendarColor: string;
191
+ }
192
+ export interface SessionCourseTemplateCreateSchema {
193
+ /**
194
+ * Tenant ID
195
+ * @minLength 1
196
+ */
197
+ tenantID: string;
198
+ /**
199
+ * Course ID
200
+ * @minLength 1
201
+ */
202
+ courseID: string;
203
+ /**
204
+ * Template name
205
+ * @minLength 1
206
+ */
207
+ name: string;
208
+ /**
209
+ * Internal template name
210
+ * @minLength 1
211
+ */
212
+ internalName: string;
213
+ autoEnrolOnSession?: string | null;
214
+ releaseType: SessionCourseTemplateCreateSchemaReleaseTypeEnum;
215
+ productsForPurchase?: string[];
216
+ productPurchaseMessage?: string | null;
217
+ disabledEmails?: (string | null)[];
218
+ disableLicenseEmails?: boolean;
219
+ calendarColor?: string | null;
220
+ capacity: number;
221
+ reservedCapacity?: number | null;
222
+ minCapacity?: number;
223
+ notificationDetails: {
224
+ adminEmails: string[];
225
+ shouldNotifyEnrolmentToAdmins?: boolean;
226
+ notifyWhenSessionFull?: boolean;
227
+ };
228
+ hasMaterial: SessionCourseTemplateCreateSchemaHasMaterialEnum;
229
+ requiresInstructor?: boolean;
230
+ requiresAdminReview?: boolean;
231
+ overview?: string | null;
232
+ specialInstructions?: string | null;
233
+ chargeDeferred?: boolean;
234
+ checkGradeDelay?: number;
235
+ courseMaterialProductID?: string | null;
236
+ isEligibleForNoCost?: boolean;
237
+ cancelationPolicyID?: string | null;
238
+ reschedulePolicyID?: string | null;
239
+ confirmInfoOnEnrolment?: boolean;
240
+ bypassAgreement?: boolean;
241
+ chargeForMaterials?: boolean;
242
+ isReferralPercentage?: boolean;
243
+ referralAmount?: number;
244
+ possibleReferrals?: (string | null)[];
245
+ askForReferrals?: boolean;
246
+ isPrivate: boolean;
247
+ internalNotes?: string | null;
248
+ instructorNotes?: string | null;
249
+ content?: {
250
+ sections: {
251
+ order: number;
252
+ /** @minLength 1 */
253
+ name: string;
254
+ enabled: boolean;
255
+ warning?: {
256
+ type?: string | null;
257
+ /** @minLength 1 */
258
+ content?: string;
259
+ };
260
+ /** @minLength 1 */
261
+ content: string;
262
+ files?: string[] | null;
263
+ }[];
264
+ };
265
+ type: SessionCourseTemplateCreateSchemaTypeEnum;
266
+ duration?: number;
267
+ venueID?: string | null;
268
+ venueComplement?: string | null;
269
+ considerFailures?: boolean;
270
+ onlineAccessPeriod?: number;
271
+ providerCourseTemplateID?: string | null | number;
272
+ calculateScoreAsPercentage?: boolean;
273
+ courseProviderID?: string | null;
274
+ accessLink?: string | null;
275
+ }
276
+ export interface SessionCourseTemplateUpdateSchema {
277
+ /**
278
+ * Template name
279
+ * @minLength 1
280
+ */
281
+ name: string;
282
+ /**
283
+ * Internal template name
284
+ * @minLength 1
285
+ */
286
+ internalName: string;
287
+ autoEnrolOnSession?: string | null;
288
+ releaseType: SessionCourseTemplateUpdateSchemaReleaseTypeEnum;
289
+ productsForPurchase?: string[];
290
+ productPurchaseMessage?: string | null;
291
+ disabledEmails?: (string | null)[];
292
+ disableLicenseEmails?: boolean;
293
+ calendarColor?: string | null;
294
+ capacity: number;
295
+ reservedCapacity?: number | null;
296
+ minCapacity?: number;
297
+ notificationDetails: {
298
+ adminEmails: string[];
299
+ shouldNotifyEnrolmentToAdmins?: boolean;
300
+ notifyWhenSessionFull?: boolean;
301
+ };
302
+ hasMaterial: SessionCourseTemplateUpdateSchemaHasMaterialEnum;
303
+ requiresInstructor?: boolean;
304
+ requiresAdminReview?: boolean;
305
+ overview?: string | null;
306
+ specialInstructions?: string | null;
307
+ chargeDeferred?: boolean;
308
+ checkGradeDelay?: number;
309
+ courseMaterialProductID?: string | null;
310
+ isEligibleForNoCost?: boolean;
311
+ cancelationPolicyID?: string | null;
312
+ reschedulePolicyID?: string | null;
313
+ confirmInfoOnEnrolment?: boolean;
314
+ bypassAgreement?: boolean;
315
+ chargeForMaterials?: boolean;
316
+ isReferralPercentage?: boolean;
317
+ referralAmount?: number;
318
+ possibleReferrals?: (string | null)[];
319
+ askForReferrals?: boolean;
320
+ isPrivate: boolean;
321
+ internalNotes?: string | null;
322
+ instructorNotes?: string | null;
323
+ content?: {
324
+ sections: {
325
+ order: number;
326
+ /** @minLength 1 */
327
+ name: string;
328
+ enabled: boolean;
329
+ warning?: {
330
+ type?: string | null;
331
+ /** @minLength 1 */
332
+ content?: string;
333
+ };
334
+ /** @minLength 1 */
335
+ content: string;
336
+ files?: string[] | null;
337
+ }[];
338
+ };
339
+ type: SessionCourseTemplateUpdateSchemaTypeEnum;
340
+ duration?: number;
341
+ venueID?: string | null;
342
+ venueComplement?: string | null;
343
+ considerFailures?: boolean;
344
+ onlineAccessPeriod?: number;
345
+ providerCourseTemplateID?: string | null | number;
346
+ calculateScoreAsPercentage?: boolean;
347
+ courseProviderID?: string | null;
348
+ accessLink?: string | null;
349
+ }
350
+ export interface SearchSessionsByIDsSchema {
351
+ /** Array of session IDs to search */
352
+ IDs: string[];
353
+ }
354
+ export interface SessionCreateSchema {
355
+ /**
356
+ * Tenant ID
357
+ * @minLength 1
358
+ */
359
+ tenantID: string;
360
+ /**
361
+ * Course ID
362
+ * @minLength 1
363
+ */
364
+ courseID: string;
365
+ /**
366
+ * Template ID
367
+ * @minLength 1
368
+ */
369
+ templateID: string;
370
+ /**
371
+ * Session name
372
+ * @minLength 1
373
+ */
374
+ name: string;
375
+ /**
376
+ * Internal session name
377
+ * @minLength 1
378
+ */
379
+ internalName: string;
380
+ autoEnrolOnSession?: string | null;
381
+ releaseType: SessionCreateSchemaReleaseTypeEnum;
382
+ capacity: number;
383
+ reservedCapacity?: number | null;
384
+ disabledEmails?: (string | null)[];
385
+ disableLicenseEmails?: boolean;
386
+ minCapacity?: number;
387
+ notificationDetails: {
388
+ adminEmails: string[];
389
+ shouldNotifyEnrolmentToAdmins?: boolean;
390
+ notifyWhenSessionFull?: boolean;
391
+ };
392
+ hasMaterial: SessionCreateSchemaHasMaterialEnum;
393
+ requiresInstructor?: boolean;
394
+ requiresAdminReview?: boolean;
395
+ overview?: string | null;
396
+ specialInstructions?: string | null;
397
+ chargeDeferred?: boolean;
398
+ checkGradeDelay?: number[];
399
+ courseMaterialProductID?: string | null;
400
+ isEligibleForNoCost?: boolean;
401
+ cancelationPolicyID?: string | null;
402
+ reschedulePolicyID?: string | null;
403
+ confirmInfoOnEnrolment?: boolean;
404
+ bypassAgreement?: boolean;
405
+ chargeForMaterials?: boolean;
406
+ isReferralPercentage?: boolean;
407
+ referralAmount?: number;
408
+ possibleReferrals?: (string | null)[];
409
+ productsForPurchase?: string[];
410
+ productPurchaseMessage?: string | null;
411
+ enableProductPurchase?: boolean;
412
+ askForReferrals?: boolean;
413
+ isPrivate: boolean;
414
+ internalNotes?: string | null;
415
+ instructorNotes?: string | null;
416
+ content?: {
417
+ sections: {
418
+ order: number;
419
+ /** @minLength 1 */
420
+ name: string;
421
+ enabled: boolean;
422
+ warning?: {
423
+ type?: string | null;
424
+ /** @minLength 1 */
425
+ content?: string;
426
+ };
427
+ /** @minLength 1 */
428
+ content: string;
429
+ files?: string[] | null;
430
+ }[];
431
+ };
432
+ type: SessionCreateSchemaTypeEnum;
433
+ duration?: number;
434
+ venueID?: string | null;
435
+ venueComplement?: string | null;
436
+ considerFailures?: boolean;
437
+ onlineAccessPeriod?: number;
438
+ providerCourseTemplateID?: string | null | number;
439
+ calculateScoreAsPercentage?: boolean;
440
+ courseProviderID?: string | null;
441
+ accessLink?: string | null;
442
+ launchSchedule?: {
443
+ dayOfWeek: number;
444
+ /** @minLength 1 */
445
+ startTime: string;
446
+ /** @minLength 1 */
447
+ endTime: string;
448
+ }[] | null;
449
+ allowEnrolmentUntil?: number | null;
450
+ calendarColor?: string | null;
451
+ isMaterialSent?: boolean;
452
+ materialShippingInfo?: any;
453
+ isCourseMaterialShipped?: boolean;
454
+ lockReason?: string | null;
455
+ dbEntity?: string | null;
456
+ startDate: (string | number)[];
457
+ endDate: (string | number)[];
458
+ onlineCourseLabel?: string[] | null;
459
+ onlineCourseID?: string[] | null;
460
+ onlineGradeID?: any[];
461
+ onlineQuizID?: any[];
462
+ onlineScoreGradeID?: string[] | null;
463
+ enrolmentCount?: number;
464
+ enrolmentReservedCount?: number;
465
+ charges?: any;
466
+ }
467
+ export interface SessionUpdateSchema {
468
+ /**
469
+ * Session name
470
+ * @minLength 1
471
+ */
472
+ name: string;
473
+ /**
474
+ * Internal session name
475
+ * @minLength 1
476
+ */
477
+ internalName: string;
478
+ autoEnrolOnSession?: string | null;
479
+ releaseType: SessionUpdateSchemaReleaseTypeEnum;
480
+ capacity: number;
481
+ reservedCapacity?: number | null;
482
+ disabledEmails?: (string | null)[];
483
+ disableLicenseEmails?: boolean;
484
+ minCapacity?: number;
485
+ notificationDetails: {
486
+ adminEmails: string[];
487
+ shouldNotifyEnrolmentToAdmins?: boolean;
488
+ notifyWhenSessionFull?: boolean;
489
+ };
490
+ stateBeforeLock?: string | null;
491
+ hasMaterial: SessionUpdateSchemaHasMaterialEnum;
492
+ requiresInstructor?: boolean;
493
+ requiresAdminReview?: boolean;
494
+ overview?: string | null;
495
+ specialInstructions?: string | null;
496
+ chargeDeferred?: boolean;
497
+ courseMaterialProductID?: string | null;
498
+ isEligibleForNoCost?: boolean;
499
+ cancelationPolicyID?: string | null;
500
+ reschedulePolicyID?: string | null;
501
+ confirmInfoOnEnrolment?: boolean;
502
+ bypassAgreement?: boolean;
503
+ chargeForMaterials?: boolean;
504
+ checkGradeDelay?: number[];
505
+ isReferralPercentage?: boolean;
506
+ referralAmount?: number;
507
+ possibleReferrals?: (string | null)[];
508
+ productsForPurchase?: string[];
509
+ productPurchaseMessage?: string | null;
510
+ enableProductPurchase?: boolean;
511
+ askForReferrals?: boolean;
512
+ isPrivate: boolean;
513
+ internalNotes?: string | null;
514
+ instructorNotes?: string | null;
515
+ content?: {
516
+ sections: {
517
+ order: number;
518
+ /** @minLength 1 */
519
+ name: string;
520
+ enabled: boolean;
521
+ warning?: {
522
+ type?: string | null;
523
+ /** @minLength 1 */
524
+ content?: string;
525
+ };
526
+ /** @minLength 1 */
527
+ content: string;
528
+ files?: string[] | null;
529
+ }[];
530
+ };
531
+ type: SessionUpdateSchemaTypeEnum;
532
+ duration?: number;
533
+ venueID?: string | null;
534
+ venueComplement?: string | null;
535
+ considerFailures?: boolean;
536
+ onlineAccessPeriod?: number;
537
+ providerCourseTemplateID?: string | null | number;
538
+ calculateScoreAsPercentage?: boolean;
539
+ courseProviderID?: string | null;
540
+ accessLink?: string | null;
541
+ launchSchedule?: {
542
+ dayOfWeek: number;
543
+ /** @minLength 1 */
544
+ startTime: string;
545
+ /** @minLength 1 */
546
+ endTime: string;
547
+ }[] | null;
548
+ allowEnrolmentUntil?: number | null;
549
+ calendarColor?: string | null;
550
+ isMaterialSent?: boolean;
551
+ materialShippingInfo?: any;
552
+ isCourseMaterialShipped?: boolean;
553
+ lockReason?: string | null;
554
+ documents?: {
555
+ fileName: string;
556
+ fileID: string;
557
+ }[];
558
+ dbEntity?: string | null;
559
+ startDate: (string | number)[];
560
+ endDate: (string | number)[];
561
+ onlineCourseLabel?: string[] | null;
562
+ onlineCourseID?: string[] | null;
563
+ onlineGradeID?: any[];
564
+ onlineQuizID?: any[];
565
+ onlineScoreGradeID?: string[] | null;
566
+ enrolmentCount?: number;
567
+ enrolmentReservedCount?: number;
568
+ charges?: any;
569
+ }
570
+ export interface SessionPublishSchema {
571
+ /** Whether to publish the session */
572
+ published: boolean;
573
+ }
574
+ export interface SessionShipStatusSchema {
575
+ /** Whether material has been shipped */
576
+ materialShipped: boolean;
577
+ }
578
+ export interface SessionDuplicateSchema {
579
+ /** Array of timestamps for new sessions */
580
+ newSessionDates: number[];
581
+ }
582
+ export interface InputQ59Gbvuj7G {
583
+ attendanceStatus: InputQ59Gbvuj7GAttendanceStatusEnum;
584
+ additionalNotes?: string | null;
585
+ }
586
+ export interface Input5S9Qlxsfdw {
587
+ attendanceStatus: Input5S9QlxsfdwAttendanceStatusEnum;
588
+ additionalNotes?: string | null;
589
+ }
590
+ export interface InputKdcf6Vev2F {
591
+ /** @minLength 1 */
592
+ ticketID: string;
593
+ /** @minLength 1 */
594
+ externalID: string;
595
+ invitationCode?: string | null;
596
+ isReservedSeat?: boolean;
597
+ [key: string]: any;
598
+ }
599
+ export interface InputPcoc6Mas3J {
600
+ materialShippingInfo?: Record<string, any>;
601
+ [key: string]: any;
602
+ }
603
+ export interface Input56A08Qop2C {
604
+ amount: number;
605
+ chargeResult: Input56A08Qop2CChargeResultEnum;
606
+ description?: string | null;
607
+ /** @minLength 1 */
608
+ paymentProvider: string;
609
+ providerTransactionID?: string | null;
610
+ timestamp: number;
611
+ }
612
+ export interface InputHuw5M2U5Gx {
613
+ resultStatus: InputHuw5M2U5GxResultStatusEnum;
614
+ resultNotes?: string | null;
615
+ resultGrade?: number;
616
+ retainAcessToCourse?: boolean;
617
+ resultOverrideDate?: number;
618
+ isManuallyPublished?: boolean;
619
+ orgID?: string | null;
620
+ employerName?: string | null;
621
+ }
622
+ export interface InputXxwuna2Nn {
623
+ resultStatus: InputXxwuna2NnResultStatusEnum;
624
+ resultNotes?: string | null;
625
+ resultGrade?: number;
626
+ retainAcessToCourse?: boolean;
627
+ resultOverrideDate?: number;
628
+ isManuallyPublished?: boolean;
629
+ orgID?: string | null;
630
+ employerName?: string | null;
631
+ }
632
+ export interface SessionInstructorSchema {
633
+ /** Instructor type */
634
+ instructorType: SessionInstructorSchemaInstructorTypeEnum;
635
+ }
636
+ export interface SessionsInstructorSetSchema {
637
+ /** Array of session IDs */
638
+ sessions: string[];
639
+ /** Instructor type */
640
+ instructorType: SessionsInstructorSetSchemaInstructorTypeEnum;
641
+ }
642
+ export interface InputW0Gt14Iief {
643
+ activationCode?: string | null;
644
+ /** @minLength 1 */
645
+ email: string;
646
+ userID?: string | null;
647
+ isReservedSeat?: boolean;
648
+ maxUsage: number;
649
+ }
650
+ export interface InputF61Tonm0Be {
651
+ useCount?: any;
652
+ maxUsage: number;
653
+ }
654
+ export interface SessionDocumentSchema {
655
+ /**
656
+ * File ID
657
+ * @minLength 1
658
+ */
659
+ fileID: string;
660
+ /**
661
+ * File name
662
+ * @minLength 1
663
+ */
664
+ fileName: string;
665
+ }
666
+ export interface SessionBatchUpdateSchema {
667
+ students: {
668
+ /**
669
+ * User ID
670
+ * @minLength 1
671
+ */
672
+ userID: string;
673
+ /**
674
+ * External ID
675
+ * @minLength 1
676
+ */
677
+ externalID: string;
678
+ /** Attendance data */
679
+ attendance?: {
680
+ attendanceStatus: SessionBatchUpdateSchemaAttendanceStatusEnum;
681
+ additionalNotes?: string | null;
682
+ };
683
+ /** Result data */
684
+ result?: {
685
+ resultStatus: SessionBatchUpdateSchemaResultStatusEnum;
686
+ resultNotes?: string | null;
687
+ resultGrade?: number;
688
+ };
689
+ }[];
690
+ }
691
+ export interface EnrolmentsPerPeriodReportSchema {
692
+ filters: {
693
+ /** Start timestamp */
694
+ from: number;
695
+ /** End timestamp */
696
+ to: number;
697
+ /** Optional course filter */
698
+ courseID?: string | null;
699
+ };
700
+ }
701
+ export interface SessionResultReportSchema {
702
+ filters: {
703
+ /**
704
+ * Course ID
705
+ * @minLength 1
706
+ */
707
+ courseID: string;
708
+ /**
709
+ * Start date
710
+ * @minLength 1
711
+ */
712
+ from: string;
713
+ /**
714
+ * End date
715
+ * @minLength 1
716
+ */
717
+ to: string;
718
+ /** Optional instructor filter */
719
+ instructorID?: string | null;
720
+ };
721
+ }
722
+ export interface SessionResultsReportSchema {
723
+ filters: {
724
+ /**
725
+ * Start date
726
+ * @minLength 1
727
+ */
728
+ dateFrom: string;
729
+ /**
730
+ * End date
731
+ * @minLength 1
732
+ */
733
+ dateTo: string;
734
+ /** Optional course IDs filter */
735
+ courseIDs?: any;
736
+ /** Optional pagination from */
737
+ from?: any;
738
+ };
739
+ }
740
+ export interface SessionListReportSchema {
741
+ filters: {
742
+ /**
743
+ * Start date
744
+ * @minLength 1
745
+ */
746
+ from: string;
747
+ /**
748
+ * End date
749
+ * @minLength 1
750
+ */
751
+ to: string;
752
+ /** Optional course filter */
753
+ courseID?: string | null;
754
+ /** Optional instructor filter */
755
+ instructorID?: string | null;
756
+ /** Optional state filter */
757
+ state?: string | null;
758
+ };
759
+ }
760
+ export declare enum SessionCourseTemplateCreateSchemaReleaseTypeEnum {
761
+ NONE = "NONE",
762
+ AUTO = "AUTO",
763
+ MANUAL = "MANUAL",
764
+ SCHEDULE = "SCHEDULE"
765
+ }
766
+ export declare enum SessionCourseTemplateCreateSchemaHasMaterialEnum {
767
+ NONE = "NONE",
768
+ INDIVIDUAL = "INDIVIDUAL",
769
+ ALL = "ALL"
770
+ }
771
+ export declare enum SessionCourseTemplateCreateSchemaTypeEnum {
772
+ SCHEDULED_PRESENTIAL = "SCHEDULED_PRESENTIAL",
773
+ SCHEDULED_ONLINE_EXT = "SCHEDULED_ONLINE_EXT",
774
+ SCHEDULED_VILT = "SCHEDULED_VILT",
775
+ SCHEDULED_WEBINAR = "SCHEDULED_WEBINAR",
776
+ ONLINE_EXT = "ONLINE_EXT",
777
+ ONLINE = "ONLINE"
778
+ }
779
+ export declare enum SessionCourseTemplateUpdateSchemaReleaseTypeEnum {
780
+ NONE = "NONE",
781
+ AUTO = "AUTO",
782
+ MANUAL = "MANUAL",
783
+ SCHEDULE = "SCHEDULE"
784
+ }
785
+ export declare enum SessionCourseTemplateUpdateSchemaHasMaterialEnum {
786
+ NONE = "NONE",
787
+ INDIVIDUAL = "INDIVIDUAL",
788
+ ALL = "ALL"
789
+ }
790
+ export declare enum SessionCourseTemplateUpdateSchemaTypeEnum {
791
+ SCHEDULED_PRESENTIAL = "SCHEDULED_PRESENTIAL",
792
+ SCHEDULED_ONLINE_EXT = "SCHEDULED_ONLINE_EXT",
793
+ SCHEDULED_VILT = "SCHEDULED_VILT",
794
+ SCHEDULED_WEBINAR = "SCHEDULED_WEBINAR",
795
+ ONLINE_EXT = "ONLINE_EXT",
796
+ ONLINE = "ONLINE"
797
+ }
798
+ export declare enum SessionCreateSchemaReleaseTypeEnum {
799
+ NONE = "NONE",
800
+ AUTO = "AUTO",
801
+ MANUAL = "MANUAL",
802
+ SCHEDULE = "SCHEDULE"
803
+ }
804
+ export declare enum SessionCreateSchemaHasMaterialEnum {
805
+ NONE = "NONE",
806
+ INDIVIDUAL = "INDIVIDUAL",
807
+ ALL = "ALL"
808
+ }
809
+ export declare enum SessionCreateSchemaTypeEnum {
810
+ SCHEDULED_PRESENTIAL = "SCHEDULED_PRESENTIAL",
811
+ SCHEDULED_ONLINE_EXT = "SCHEDULED_ONLINE_EXT",
812
+ SCHEDULED_VILT = "SCHEDULED_VILT",
813
+ SCHEDULED_WEBINAR = "SCHEDULED_WEBINAR",
814
+ ONLINE_EXT = "ONLINE_EXT",
815
+ ONLINE = "ONLINE"
816
+ }
817
+ export declare enum SessionUpdateSchemaReleaseTypeEnum {
818
+ NONE = "NONE",
819
+ AUTO = "AUTO",
820
+ MANUAL = "MANUAL",
821
+ SCHEDULE = "SCHEDULE"
822
+ }
823
+ export declare enum SessionUpdateSchemaHasMaterialEnum {
824
+ NONE = "NONE",
825
+ INDIVIDUAL = "INDIVIDUAL",
826
+ ALL = "ALL"
827
+ }
828
+ export declare enum SessionUpdateSchemaTypeEnum {
829
+ SCHEDULED_PRESENTIAL = "SCHEDULED_PRESENTIAL",
830
+ SCHEDULED_ONLINE_EXT = "SCHEDULED_ONLINE_EXT",
831
+ SCHEDULED_VILT = "SCHEDULED_VILT",
832
+ SCHEDULED_WEBINAR = "SCHEDULED_WEBINAR",
833
+ ONLINE_EXT = "ONLINE_EXT",
834
+ ONLINE = "ONLINE"
835
+ }
836
+ export declare enum InputQ59Gbvuj7GAttendanceStatusEnum {
837
+ INCOMPLETE = "INCOMPLETE",
838
+ NO_SHOW = "NO_SHOW",
839
+ ATTENDED = "ATTENDED"
840
+ }
841
+ export declare enum Input5S9QlxsfdwAttendanceStatusEnum {
842
+ INCOMPLETE = "INCOMPLETE",
843
+ NO_SHOW = "NO_SHOW",
844
+ ATTENDED = "ATTENDED"
845
+ }
846
+ export declare enum Input56A08Qop2CChargeResultEnum {
847
+ SUCCESS = "SUCCESS",
848
+ FAIL = "FAIL"
849
+ }
850
+ export declare enum InputHuw5M2U5GxResultStatusEnum {
851
+ INCOMPLETE = "INCOMPLETE",
852
+ FAIL = "FAIL",
853
+ PASS = "PASS"
854
+ }
855
+ export declare enum InputXxwuna2NnResultStatusEnum {
856
+ INCOMPLETE = "INCOMPLETE",
857
+ FAIL = "FAIL",
858
+ PASS = "PASS"
859
+ }
860
+ /** Instructor type */
861
+ export declare enum SessionInstructorSchemaInstructorTypeEnum {
862
+ PRIMARY = "PRIMARY",
863
+ SECONDARY = "SECONDARY"
864
+ }
865
+ /** Instructor type */
866
+ export declare enum SessionsInstructorSetSchemaInstructorTypeEnum {
867
+ PRIMARY = "PRIMARY",
868
+ SECONDARY = "SECONDARY"
869
+ }
870
+ export declare enum SessionBatchUpdateSchemaAttendanceStatusEnum {
871
+ INCOMPLETE = "INCOMPLETE",
872
+ NO_SHOW = "NO_SHOW",
873
+ ATTENDED = "ATTENDED"
874
+ }
875
+ export declare enum SessionBatchUpdateSchemaResultStatusEnum {
876
+ INCOMPLETE = "INCOMPLETE",
877
+ FAIL = "FAIL",
878
+ PASS = "PASS"
879
+ }
880
+ export type GetRegionData = any;
881
+ export type GetRegionError = ErrorResponse;
882
+ export type CreateRegionData = any;
883
+ export type CreateRegionError = ErrorResponse;
884
+ export type UpdateRegionData = any;
885
+ export type UpdateRegionError = ErrorResponse;
886
+ export type DeleteRegionData = any;
887
+ export type DeleteRegionError = ErrorResponse;
888
+ export type ListRegionsData = any;
889
+ export type ListRegionsError = ErrorResponse;
890
+ export type GetCityData = any;
891
+ export type GetCityError = ErrorResponse;
892
+ export type CreateCityData = any;
893
+ export type CreateCityError = ErrorResponse;
894
+ export type UpdateCityData = any;
895
+ export type UpdateCityError = ErrorResponse;
896
+ export type DeleteCityData = any;
897
+ export type DeleteCityError = ErrorResponse;
898
+ export type ListCitiesData = any;
899
+ export type ListCitiesError = ErrorResponse;
900
+ export type GetVenueData = any;
901
+ export type GetVenueError = ErrorResponse;
902
+ export type CreateVenueData = any;
903
+ export type CreateVenueError = ErrorResponse;
904
+ export type UpdateVenueData = any;
905
+ export type UpdateVenueError = ErrorResponse;
906
+ export type DeleteVenueData = any;
907
+ export type DeleteVenueError = ErrorResponse;
908
+ export type ListVenuesData = any;
909
+ export type ListVenuesError = ErrorResponse;
910
+ export type GetInstructorData = any;
911
+ export type GetInstructorError = ErrorResponse;
912
+ export type CreateInstructorData = any;
913
+ export type CreateInstructorError = ErrorResponse;
914
+ export type UpdateInstructorData = any;
915
+ export type UpdateInstructorError = ErrorResponse;
916
+ export type DeleteInstructorData = any;
917
+ export type DeleteInstructorError = ErrorResponse;
918
+ export type ListInstructorsData = any;
919
+ export type ListInstructorsError = ErrorResponse;
920
+ export type GetCourseData = any;
921
+ export type GetCourseError = ErrorResponse;
922
+ export type CreateCourseData = any;
923
+ export type CreateCourseError = ErrorResponse;
924
+ export type GetRegionResult = any;
925
+ export type GetRegionFail = ErrorResponse;
926
+ export type CreateRegionResult = any;
927
+ export type CreateRegionFail = ErrorResponse;
928
+ export type ListEventsData = any;
929
+ export type ListEventsError = ErrorResponse;
930
+ export type GetAvailabilityEventData = any;
931
+ export type GetAvailabilityEventError = ErrorResponse;
932
+ export type CreateAvailabilityEventData = any;
933
+ export type CreateAvailabilityEventError = ErrorResponse;
934
+ export type UpdateAvailabilityEventData = any;
935
+ export type UpdateAvailabilityEventError = ErrorResponse;
936
+ export type DeleteAvailabilityEventData = any;
937
+ export type DeleteAvailabilityEventError = ErrorResponse;
938
+ export type GetCalendarSyncData = any;
939
+ export type GetCalendarSyncError = ErrorResponse;
940
+ export type CreateCalendarSyncData = any;
941
+ export type CreateCalendarSyncError = ErrorResponse;
942
+ export type UpdateCalendarSyncData = any;
943
+ export type UpdateCalendarSyncError = ErrorResponse;
944
+ export type DeleteCalendarSyncData = any;
945
+ export type DeleteCalendarSyncError = ErrorResponse;
946
+ export type GetCalendarSyncsData = any;
947
+ export type GetCalendarSyncsError = ErrorResponse;
948
+ export type GetCalendarData = any;
949
+ export type GetCalendarError = ErrorResponse;
950
+ export type UpdateCalendarData = any;
951
+ export type UpdateCalendarError = ErrorResponse;
952
+ export type GetCalendarSyncResult = any;
953
+ export type GetCalendarSyncFail = ErrorResponse;
954
+ export type CreateCalendarSyncResult = any;
955
+ export type CreateCalendarSyncFail = ErrorResponse;
956
+ export type UpdateCalendarSyncResult = any;
957
+ export type UpdateCalendarSyncFail = ErrorResponse;
958
+ export type DeleteCalendarSyncResult = any;
959
+ export type DeleteCalendarSyncFail = ErrorResponse;
960
+ export type ListCalendarSyncsData = any;
961
+ export type ListCalendarSyncsError = ErrorResponse;
962
+ export type GetStudentTicketData = any;
963
+ export type GetStudentTicketError = ErrorResponse;
964
+ export type CreateStudentTicketData = any;
965
+ export type CreateStudentTicketError = ErrorResponse;
966
+ export type DeleteStudentTicketData = any;
967
+ export type DeleteStudentTicketError = ErrorResponse;
968
+ export type GetTemplateData = any;
969
+ export type GetTemplateError = ErrorResponse;
970
+ export type CreateTemplateData = any;
971
+ export type CreateTemplateError = ErrorResponse;
972
+ export type UpdateTemplateData = any;
973
+ export type UpdateTemplateError = ErrorResponse;
974
+ export type DeleteTemplateData = any;
975
+ export type DeleteTemplateError = ErrorResponse;
976
+ export type ListTemplatesData = any;
977
+ export type ListTemplatesError = ErrorResponse;
978
+ export type ListCoursesData = any;
979
+ export type ListCoursesError = ErrorResponse;
980
+ export type ListLocationsData = any;
981
+ export type ListLocationsError = ErrorResponse;
982
+ export type ListSessionsIdsData = any;
983
+ export type ListSessionsIdsError = ErrorResponse;
984
+ export type GetSessionData = any;
985
+ export type GetSessionError = ErrorResponse;
986
+ export type CreateSessionData = any;
987
+ export type CreateSessionError = ErrorResponse;
988
+ export type UpdateSessionData = any;
989
+ export type UpdateSessionError = ErrorResponse;
990
+ export type DeleteSessionData = any;
991
+ export type DeleteSessionError = ErrorResponse;
992
+ export type CreateNextData = any;
993
+ export type CreateNextError = ErrorResponse;
994
+ export type CreateCancelData = any;
995
+ export type CreateCancelError = ErrorResponse;
996
+ export type CreateLockData = any;
997
+ export type CreateLockError = ErrorResponse;
998
+ export type CreateUnlockData = any;
999
+ export type CreateUnlockError = ErrorResponse;
1000
+ export type CreatePublishData = any;
1001
+ export type CreatePublishError = ErrorResponse;
1002
+ export type CreateReleaseData = any;
1003
+ export type CreateReleaseError = ErrorResponse;
1004
+ export type CreateRefreshShippingData = any;
1005
+ export type CreateRefreshShippingError = ErrorResponse;
1006
+ export type CreateCourseMaterialData = any;
1007
+ export type CreateCourseMaterialError = ErrorResponse;
1008
+ export type CreateDuplicateData = any;
1009
+ export type CreateDuplicateError = ErrorResponse;
1010
+ export type CreateMoveStudentData = any;
1011
+ export type CreateMoveStudentError = ErrorResponse;
1012
+ export type GetAttendancesData = any;
1013
+ export type GetAttendancesError = ErrorResponse;
1014
+ export type GetEnrolmentsData = any;
1015
+ export type GetEnrolmentsError = ErrorResponse;
1016
+ export type GetResultsData = any;
1017
+ export type GetResultsError = ErrorResponse;
1018
+ export type GetInvitationsData = any;
1019
+ export type GetInvitationsError = ErrorResponse;
1020
+ export type GetChargesData = any;
1021
+ export type GetChargesError = ErrorResponse;
1022
+ export type GetAttendanceData = any;
1023
+ export type GetAttendanceError = ErrorResponse;
1024
+ export type CreateAttendanceData = any;
1025
+ export type CreateAttendanceError = ErrorResponse;
1026
+ export type UpdateAttendanceData = any;
1027
+ export type UpdateAttendanceError = ErrorResponse;
1028
+ export type DeleteAttendanceData = any;
1029
+ export type DeleteAttendanceError = ErrorResponse;
1030
+ export type GetEnrolmentData = any;
1031
+ export type GetEnrolmentError = ErrorResponse;
1032
+ export type CreateEnrolmentData = any;
1033
+ export type CreateEnrolmentError = ErrorResponse;
1034
+ export type UpdateEnrolmentData = any;
1035
+ export type UpdateEnrolmentError = ErrorResponse;
1036
+ export type DeleteEnrolmentData = any;
1037
+ export type DeleteEnrolmentError = ErrorResponse;
1038
+ export type GetEnrolment2Data = any;
1039
+ export type GetEnrolment2Error = ErrorResponse;
1040
+ export type CreateEnrolmentReleaseData = any;
1041
+ export type CreateEnrolmentReleaseError = ErrorResponse;
1042
+ export type CreateEnrolmentCancelData = any;
1043
+ export type CreateEnrolmentCancelError = ErrorResponse;
1044
+ export type CreateEnrolmentLaunchData = any;
1045
+ export type CreateEnrolmentLaunchError = ErrorResponse;
1046
+ export type CreateEnrolmentCheckResultData = any;
1047
+ export type CreateEnrolmentCheckResultError = ErrorResponse;
1048
+ export type CreateEnrolmentChargeData = any;
1049
+ export type CreateEnrolmentChargeError = ErrorResponse;
1050
+ export type GetResultData = any;
1051
+ export type GetResultError = ErrorResponse;
1052
+ export type CreateResultData = any;
1053
+ export type CreateResultError = ErrorResponse;
1054
+ export type UpdateResultData = any;
1055
+ export type UpdateResultError = ErrorResponse;
1056
+ export type DeleteResultData = any;
1057
+ export type DeleteResultError = ErrorResponse;
1058
+ export type CreateResultPublishData = any;
1059
+ export type CreateResultPublishError = ErrorResponse;
1060
+ export type GetInstructorResult = any;
1061
+ export type GetInstructorFail = ErrorResponse;
1062
+ export type CreateInstructorResult = any;
1063
+ export type CreateInstructorFail = ErrorResponse;
1064
+ export type UpdateInstructorResult = any;
1065
+ export type UpdateInstructorFail = ErrorResponse;
1066
+ export type DeleteInstructorResult = any;
1067
+ export type DeleteInstructorFail = ErrorResponse;
1068
+ export type CreateInstructorOutput = any;
1069
+ export type CreateInstructorFails = ErrorResponse;
1070
+ export type GetInvitationData = any;
1071
+ export type GetInvitationError = ErrorResponse;
1072
+ export type CreateInvitationData = any;
1073
+ export type CreateInvitationError = ErrorResponse;
1074
+ export type UpdateInvitationData = any;
1075
+ export type UpdateInvitationError = ErrorResponse;
1076
+ export type DeleteInvitationData = any;
1077
+ export type DeleteInvitationError = ErrorResponse;
1078
+ export type GetInvitationValidateData = any;
1079
+ export type GetInvitationValidateError = ErrorResponse;
1080
+ export type GetChargeData = any;
1081
+ export type GetChargeError = ErrorResponse;
1082
+ export type GetDocumentFileSignData = any;
1083
+ export type GetDocumentFileSignError = ErrorResponse;
1084
+ export type CreateDocumentFileSignData = any;
1085
+ export type CreateDocumentFileSignError = ErrorResponse;
1086
+ export type DeleteDocumentFileSignData = any;
1087
+ export type DeleteDocumentFileSignError = ErrorResponse;
1088
+ export type CreateDocumentData = any;
1089
+ export type CreateDocumentError = ErrorResponse;
1090
+ export type DeleteDocumentData = any;
1091
+ export type DeleteDocumentError = ErrorResponse;
1092
+ export type CreateAttendancesResultsBatchUpsertData = any;
1093
+ export type CreateAttendancesResultsBatchUpsertError = ErrorResponse;
1094
+ export type GetUserDataData = any;
1095
+ export type GetUserDataError = ErrorResponse;
1096
+ export type ListEventsResult = any;
1097
+ export type ListEventsFail = ErrorResponse;
1098
+ export type ListEvents2Data = any;
1099
+ export type ListEvents2Error = ErrorResponse;
1100
+ export type ListSessionEventsData = any;
1101
+ export type ListSessionEventsError = ErrorResponse;
1102
+ export type CreateEnrolmentsPerPeriodData = any;
1103
+ export type CreateEnrolmentsPerPeriodError = ErrorResponse;
1104
+ export type ListSessionResultsAnalysisData = any;
1105
+ export type ListSessionResultsAnalysisError = ErrorResponse;
1106
+ export type CreateSessionResultsPreviewData = any;
1107
+ export type CreateSessionResultsPreviewError = ErrorResponse;
1108
+ export type ListSessionResultsData = any;
1109
+ export type ListSessionResultsError = ErrorResponse;
1110
+ export type CreateSessionListData = any;
1111
+ export type CreateSessionListError = ErrorResponse;
1112
+ export type ListSessionChargesData = any;
1113
+ export type ListSessionChargesError = ErrorResponse;
1114
+ export type CreateSessionShippingManifestData = any;
1115
+ export type CreateSessionShippingManifestError = ErrorResponse;
1116
+ import type { AxiosInstance, AxiosRequestConfig, ResponseType } from 'axios';
1117
+ export type QueryParamsType = Record<string | number, any>;
1118
+ export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
1119
+ /** set parameter to `true` for call `securityWorker` for this request */
1120
+ secure?: boolean;
1121
+ /** request path */
1122
+ path: string;
1123
+ /** content type of request body */
1124
+ type?: ContentType;
1125
+ /** query params */
1126
+ query?: QueryParamsType;
1127
+ /** format of response (i.e. response.json() -> format: "json") */
1128
+ format?: ResponseType;
1129
+ /** request body */
1130
+ body?: unknown;
1131
+ }
1132
+ export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>;
1133
+ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, 'data' | 'cancelToken'> {
1134
+ securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
1135
+ secure?: boolean;
1136
+ format?: ResponseType;
1137
+ }
1138
+ export declare enum ContentType {
1139
+ Json = "application/json",
1140
+ FormData = "multipart/form-data",
1141
+ UrlEncoded = "application/x-www-form-urlencoded",
1142
+ Text = "text/plain"
1143
+ }
1144
+ export declare class HttpClient<SecurityDataType = unknown> {
1145
+ instance: AxiosInstance;
1146
+ private securityData;
1147
+ private securityWorker?;
1148
+ private secure?;
1149
+ private format?;
1150
+ constructor({ securityWorker, secure, format, ...axiosConfig }?: ApiConfig<SecurityDataType>);
1151
+ setSecurityData: (data: SecurityDataType | null) => void;
1152
+ protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
1153
+ protected stringifyFormItem(formItem: unknown): string;
1154
+ protected createFormData(input: Record<string, unknown>): FormData;
1155
+ request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<T>;
1156
+ }
1157
+ /**
1158
+ * @title Classroom Module API
1159
+ * @version 2.0.0
1160
+ * @baseUrl http://localhost:8080
1161
+ * @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
1162
+ */
1163
+ export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
1164
+ region: {
1165
+ /**
1166
+ * @description Retrieve a region by ID
1167
+ *
1168
+ * @tags Region
1169
+ * @name GetRegion
1170
+ * @summary Get Region
1171
+ * @request GET:/region/{regionID}
1172
+ * @secure
1173
+ */
1174
+ getRegion: (regionId: string, params?: RequestParams) => Promise<any>;
1175
+ /**
1176
+ * @description Create a new region
1177
+ *
1178
+ * @tags Region
1179
+ * @name CreateRegion
1180
+ * @summary Create Region
1181
+ * @request POST:/region/{regionID}
1182
+ * @secure
1183
+ */
1184
+ createRegion: (regionId: string, data: Input9Jxov33U7D, params?: RequestParams) => Promise<any>;
1185
+ /**
1186
+ * @description Update an existing region
1187
+ *
1188
+ * @tags Region
1189
+ * @name UpdateRegion
1190
+ * @summary Update Region
1191
+ * @request PUT:/region/{regionID}
1192
+ * @secure
1193
+ */
1194
+ updateRegion: (regionId: string, data: InputUse5Vle8Ta, params?: RequestParams) => Promise<any>;
1195
+ /**
1196
+ * @description Delete a region by ID
1197
+ *
1198
+ * @tags Region
1199
+ * @name DeleteRegion
1200
+ * @summary Delete Region
1201
+ * @request DELETE:/region/{regionID}
1202
+ * @secure
1203
+ */
1204
+ deleteRegion: (regionId: string, params?: RequestParams) => Promise<any>;
1205
+ };
1206
+ regions: {
1207
+ /**
1208
+ * @description Retrieve all regions for the current customer
1209
+ *
1210
+ * @tags Region
1211
+ * @name ListRegions
1212
+ * @summary Get All Regions
1213
+ * @request GET:/regions
1214
+ * @secure
1215
+ */
1216
+ listRegions: (params?: RequestParams) => Promise<any>;
1217
+ };
1218
+ city: {
1219
+ /**
1220
+ * @description Retrieve a city by ID
1221
+ *
1222
+ * @tags City
1223
+ * @name GetCity
1224
+ * @summary Get City
1225
+ * @request GET:/city/{cityID}
1226
+ * @secure
1227
+ */
1228
+ getCity: (cityId: string, params?: RequestParams) => Promise<any>;
1229
+ /**
1230
+ * @description Create a new city
1231
+ *
1232
+ * @tags City
1233
+ * @name CreateCity
1234
+ * @summary Create City
1235
+ * @request POST:/city/{cityID}
1236
+ * @secure
1237
+ */
1238
+ createCity: (cityId: string, data: CityCreateSchema, params?: RequestParams) => Promise<any>;
1239
+ /**
1240
+ * @description Update an existing city
1241
+ *
1242
+ * @tags City
1243
+ * @name UpdateCity
1244
+ * @summary Update City
1245
+ * @request PUT:/city/{cityID}
1246
+ * @secure
1247
+ */
1248
+ updateCity: (cityId: string, data: CityUpdateSchema, params?: RequestParams) => Promise<any>;
1249
+ /**
1250
+ * @description Delete a city by ID
1251
+ *
1252
+ * @tags City
1253
+ * @name DeleteCity
1254
+ * @summary Delete City
1255
+ * @request DELETE:/city/{cityID}
1256
+ * @secure
1257
+ */
1258
+ deleteCity: (cityId: string, params?: RequestParams) => Promise<any>;
1259
+ };
1260
+ cities: {
1261
+ /**
1262
+ * @description Retrieve all cities for the current customer
1263
+ *
1264
+ * @tags City
1265
+ * @name ListCities
1266
+ * @summary Get All Cities
1267
+ * @request GET:/cities
1268
+ * @secure
1269
+ */
1270
+ listCities: (params?: RequestParams) => Promise<any>;
1271
+ };
1272
+ venue: {
1273
+ /**
1274
+ * @description Retrieve a venue by ID
1275
+ *
1276
+ * @tags Venue
1277
+ * @name GetVenue
1278
+ * @summary Get Venue
1279
+ * @request GET:/venue/{venueID}
1280
+ * @secure
1281
+ */
1282
+ getVenue: (venueId: string, params?: RequestParams) => Promise<any>;
1283
+ /**
1284
+ * @description Create a new venue
1285
+ *
1286
+ * @tags Venue
1287
+ * @name CreateVenue
1288
+ * @summary Create Venue
1289
+ * @request POST:/venue/{venueID}
1290
+ * @secure
1291
+ */
1292
+ createVenue: (venueId: string, data: VenueCreateSchema, params?: RequestParams) => Promise<any>;
1293
+ /**
1294
+ * @description Update an existing venue
1295
+ *
1296
+ * @tags Venue
1297
+ * @name UpdateVenue
1298
+ * @summary Update Venue
1299
+ * @request PUT:/venue/{venueID}
1300
+ * @secure
1301
+ */
1302
+ updateVenue: (venueId: string, data: VenueUpdateSchema, params?: RequestParams) => Promise<any>;
1303
+ /**
1304
+ * @description Delete a venue by ID
1305
+ *
1306
+ * @tags Venue
1307
+ * @name DeleteVenue
1308
+ * @summary Delete Venue
1309
+ * @request DELETE:/venue/{venueID}
1310
+ * @secure
1311
+ */
1312
+ deleteVenue: (venueId: string, params?: RequestParams) => Promise<any>;
1313
+ };
1314
+ venues: {
1315
+ /**
1316
+ * @description Retrieve all venues for the current customer
1317
+ *
1318
+ * @tags Venue
1319
+ * @name ListVenues
1320
+ * @summary Get All Venues
1321
+ * @request GET:/venues
1322
+ * @secure
1323
+ */
1324
+ listVenues: (params?: RequestParams) => Promise<any>;
1325
+ };
1326
+ instructor: {
1327
+ /**
1328
+ * @description Retrieve an instructor by ID with expanded details
1329
+ *
1330
+ * @tags Instructor
1331
+ * @name GetInstructor
1332
+ * @summary Get Instructor
1333
+ * @request GET:/instructor/{instructorID}
1334
+ * @secure
1335
+ */
1336
+ getInstructor: (instructorId: string, params?: RequestParams) => Promise<any>;
1337
+ /**
1338
+ * @description Register a user as an instructor
1339
+ *
1340
+ * @tags Instructor
1341
+ * @name CreateInstructor
1342
+ * @summary Create Instructor
1343
+ * @request POST:/instructor/{instructorID}
1344
+ * @secure
1345
+ */
1346
+ createInstructor: (instructorId: string, data: InstructorCreateSchema, params?: RequestParams) => Promise<any>;
1347
+ /**
1348
+ * @description Update an instructor
1349
+ *
1350
+ * @tags Instructor
1351
+ * @name UpdateInstructor
1352
+ * @summary Update Instructor
1353
+ * @request PUT:/instructor/{instructorID}
1354
+ * @secure
1355
+ */
1356
+ updateInstructor: (instructorId: string, data: InstructorUpdateSchema, params?: RequestParams) => Promise<any>;
1357
+ /**
1358
+ * @description Remove an instructor
1359
+ *
1360
+ * @tags Instructor
1361
+ * @name DeleteInstructor
1362
+ * @summary Delete Instructor
1363
+ * @request DELETE:/instructor/{instructorID}
1364
+ * @secure
1365
+ */
1366
+ deleteInstructor: (instructorId: string, params?: RequestParams) => Promise<any>;
1367
+ /**
1368
+ * @description Retrieve courses assigned to an instructor
1369
+ *
1370
+ * @tags Instructor
1371
+ * @name GetCourse
1372
+ * @summary Get Instructor Courses
1373
+ * @request GET:/instructor/{instructorID}/course
1374
+ * @secure
1375
+ */
1376
+ getCourse: (instructorId: string, params?: RequestParams) => Promise<any>;
1377
+ /**
1378
+ * @description Smart update courses assigned to an instructor
1379
+ *
1380
+ * @tags Instructor
1381
+ * @name CreateCourse
1382
+ * @summary Update Instructor Courses
1383
+ * @request POST:/instructor/{instructorID}/course
1384
+ * @secure
1385
+ */
1386
+ createCourse: (instructorId: string, data: InstructorCourseUpdateSchema, params?: RequestParams) => Promise<any>;
1387
+ /**
1388
+ * @description Retrieve regions assigned to an instructor
1389
+ *
1390
+ * @tags Instructor
1391
+ * @name GetRegion
1392
+ * @summary Get Instructor Regions
1393
+ * @request GET:/instructor/{instructorID}/region
1394
+ * @secure
1395
+ */
1396
+ getRegion: (instructorId: string, params?: RequestParams) => Promise<any>;
1397
+ /**
1398
+ * @description Smart update regions assigned to an instructor
1399
+ *
1400
+ * @tags Instructor
1401
+ * @name CreateRegion
1402
+ * @summary Update Instructor Regions
1403
+ * @request POST:/instructor/{instructorID}/region
1404
+ * @secure
1405
+ */
1406
+ createRegion: (instructorId: string, data: InstructorRegionUpdateSchema, params?: RequestParams) => Promise<any>;
1407
+ /**
1408
+ * @description Retrieve instructor calendar events within a time range
1409
+ *
1410
+ * @tags Instructor
1411
+ * @name ListEvents
1412
+ * @summary Get Instructor Events
1413
+ * @request POST:/instructor/{instructorID}/events
1414
+ * @secure
1415
+ */
1416
+ listEvents: (instructorId: string, data: Input33N9Vgyjyy, params?: RequestParams) => Promise<any>;
1417
+ /**
1418
+ * @description Retrieve an instructor availability event
1419
+ *
1420
+ * @tags InstructorCalendar
1421
+ * @name GetAvailabilityEvent
1422
+ * @summary Get Availability Event
1423
+ * @request GET:/instructor/{instructorID}/availabilityEvent/{startTime}
1424
+ * @secure
1425
+ */
1426
+ getAvailabilityEvent: (instructorId: string, startTime: string, params?: RequestParams) => Promise<any>;
1427
+ /**
1428
+ * @description Create an instructor availability event
1429
+ *
1430
+ * @tags InstructorCalendar
1431
+ * @name CreateAvailabilityEvent
1432
+ * @summary Create Availability Event
1433
+ * @request POST:/instructor/{instructorID}/availabilityEvent/{startTime}
1434
+ * @secure
1435
+ */
1436
+ createAvailabilityEvent: (instructorId: string, startTime: string, data: Input56Hzg6Xiz2, params?: RequestParams) => Promise<any>;
1437
+ /**
1438
+ * @description Update an instructor availability event (delete + recreate)
1439
+ *
1440
+ * @tags InstructorCalendar
1441
+ * @name UpdateAvailabilityEvent
1442
+ * @summary Update Availability Event
1443
+ * @request PUT:/instructor/{instructorID}/availabilityEvent/{startTime}
1444
+ * @secure
1445
+ */
1446
+ updateAvailabilityEvent: (instructorId: string, startTime: string, data: Input3Yilrlis7M, params?: RequestParams) => Promise<any>;
1447
+ /**
1448
+ * @description Delete an instructor availability event
1449
+ *
1450
+ * @tags InstructorCalendar
1451
+ * @name DeleteAvailabilityEvent
1452
+ * @summary Delete Availability Event
1453
+ * @request DELETE:/instructor/{instructorID}/availabilityEvent/{startTime}
1454
+ * @secure
1455
+ */
1456
+ deleteAvailabilityEvent: (instructorId: string, startTime: string, params?: RequestParams) => Promise<any>;
1457
+ /**
1458
+ * @description Retrieve a calendar sync configuration
1459
+ *
1460
+ * @tags InstructorCalendarSync
1461
+ * @name GetCalendarSync
1462
+ * @summary Get Instructor Calendar Sync
1463
+ * @request GET:/instructor/{instructorID}/calendarSync/{providerID}
1464
+ * @secure
1465
+ */
1466
+ getCalendarSync: (instructorId: string, providerId: string, params?: RequestParams) => Promise<any>;
1467
+ /**
1468
+ * @description Create a calendar sync configuration
1469
+ *
1470
+ * @tags InstructorCalendarSync
1471
+ * @name CreateCalendarSync
1472
+ * @summary Create Instructor Calendar Sync
1473
+ * @request POST:/instructor/{instructorID}/calendarSync/{providerID}
1474
+ * @secure
1475
+ */
1476
+ createCalendarSync: (instructorId: string, providerId: string, params?: RequestParams) => Promise<any>;
1477
+ /**
1478
+ * @description Update a calendar sync configuration
1479
+ *
1480
+ * @tags InstructorCalendarSync
1481
+ * @name UpdateCalendarSync
1482
+ * @summary Update Instructor Calendar Sync
1483
+ * @request PUT:/instructor/{instructorID}/calendarSync/{providerID}
1484
+ * @secure
1485
+ */
1486
+ updateCalendarSync: (instructorId: string, providerId: string, params?: RequestParams) => Promise<any>;
1487
+ /**
1488
+ * @description Delete a calendar sync configuration
1489
+ *
1490
+ * @tags InstructorCalendarSync
1491
+ * @name DeleteCalendarSync
1492
+ * @summary Delete Instructor Calendar Sync
1493
+ * @request DELETE:/instructor/{instructorID}/calendarSync/{providerID}
1494
+ * @secure
1495
+ */
1496
+ deleteCalendarSync: (instructorId: string, providerId: string, params?: RequestParams) => Promise<any>;
1497
+ /**
1498
+ * @description Retrieve all calendar sync configurations for an instructor
1499
+ *
1500
+ * @tags InstructorCalendarSync
1501
+ * @name GetCalendarSyncs
1502
+ * @summary Get All Instructor Calendar Syncs
1503
+ * @request GET:/instructor/{instructorID}/calendarSyncs
1504
+ * @secure
1505
+ */
1506
+ getCalendarSyncs: (instructorId: string, params?: RequestParams) => Promise<any>;
1507
+ };
1508
+ instructors: {
1509
+ /**
1510
+ * @description Retrieve all instructors for the current customer
1511
+ *
1512
+ * @tags Instructor
1513
+ * @name ListInstructors
1514
+ * @summary Get All Instructors
1515
+ * @request GET:/instructors
1516
+ * @secure
1517
+ */
1518
+ listInstructors: (params?: RequestParams) => Promise<any>;
1519
+ };
1520
+ course: {
1521
+ /**
1522
+ * @description Retrieve course calendar configuration
1523
+ *
1524
+ * @tags CourseCalendar
1525
+ * @name GetCalendar
1526
+ * @summary Get Course Calendar
1527
+ * @request GET:/course/{courseID}/calendar
1528
+ * @secure
1529
+ */
1530
+ getCalendar: (courseId: string, params?: RequestParams) => Promise<any>;
1531
+ /**
1532
+ * @description Upsert course calendar configuration
1533
+ *
1534
+ * @tags CourseCalendar
1535
+ * @name UpdateCalendar
1536
+ * @summary Update Course Calendar
1537
+ * @request PUT:/course/{courseID}/calendar
1538
+ * @secure
1539
+ */
1540
+ updateCalendar: (courseId: string, data: InputKi6Tbrci1R, params?: RequestParams) => Promise<any>;
1541
+ /**
1542
+ * @description Retrieve a course enrolment ticket
1543
+ *
1544
+ * @tags CourseTicket
1545
+ * @name GetStudentTicket
1546
+ * @summary Get Course Ticket
1547
+ * @request GET:/course/{courseID}/student/{userID}/ticket/{ticketID}
1548
+ * @secure
1549
+ */
1550
+ getStudentTicket: (courseId: string, userId: string, ticketId: string, params?: RequestParams) => Promise<any>;
1551
+ /**
1552
+ * @description Generate a course enrolment ticket
1553
+ *
1554
+ * @tags CourseTicket
1555
+ * @name CreateStudentTicket
1556
+ * @summary Create Course Ticket
1557
+ * @request POST:/course/{courseID}/student/{userID}/ticket/{ticketID}
1558
+ * @secure
1559
+ */
1560
+ createStudentTicket: (courseId: string, userId: string, ticketId: string, params?: RequestParams) => Promise<any>;
1561
+ /**
1562
+ * @description Delete a course enrolment ticket
1563
+ *
1564
+ * @tags CourseTicket
1565
+ * @name DeleteStudentTicket
1566
+ * @summary Delete Course Ticket
1567
+ * @request DELETE:/course/{courseID}/student/{userID}/ticket/{ticketID}
1568
+ * @secure
1569
+ */
1570
+ deleteStudentTicket: (courseId: string, userId: string, ticketId: string, params?: RequestParams) => Promise<any>;
1571
+ };
1572
+ courses: {
1573
+ /**
1574
+ * @description Retrieve a course calendar sync configuration
1575
+ *
1576
+ * @tags CourseCalendarSync
1577
+ * @name GetCalendarSync
1578
+ * @summary Get Course Calendar Sync
1579
+ * @request GET:/courses/calendarSync/{providerID}
1580
+ * @secure
1581
+ */
1582
+ getCalendarSync: (providerId: string, params?: RequestParams) => Promise<any>;
1583
+ /**
1584
+ * @description Create a course calendar sync
1585
+ *
1586
+ * @tags CourseCalendarSync
1587
+ * @name CreateCalendarSync
1588
+ * @summary Create Course Calendar Sync
1589
+ * @request POST:/courses/calendarSync/{providerID}
1590
+ * @secure
1591
+ */
1592
+ createCalendarSync: (providerId: string, params?: RequestParams) => Promise<any>;
1593
+ /**
1594
+ * @description Update a course calendar sync
1595
+ *
1596
+ * @tags CourseCalendarSync
1597
+ * @name UpdateCalendarSync
1598
+ * @summary Update Course Calendar Sync
1599
+ * @request PUT:/courses/calendarSync/{providerID}
1600
+ * @secure
1601
+ */
1602
+ updateCalendarSync: (providerId: string, params?: RequestParams) => Promise<any>;
1603
+ /**
1604
+ * @description Delete a course calendar sync
1605
+ *
1606
+ * @tags CourseCalendarSync
1607
+ * @name DeleteCalendarSync
1608
+ * @summary Delete Course Calendar Sync
1609
+ * @request DELETE:/courses/calendarSync/{providerID}
1610
+ * @secure
1611
+ */
1612
+ deleteCalendarSync: (providerId: string, params?: RequestParams) => Promise<any>;
1613
+ /**
1614
+ * @description Retrieve all course calendar syncs for the customer
1615
+ *
1616
+ * @tags CourseCalendarSync
1617
+ * @name ListCalendarSyncs
1618
+ * @summary Get All Course Calendar Syncs
1619
+ * @request GET:/courses/calendarSyncs
1620
+ * @secure
1621
+ */
1622
+ listCalendarSyncs: (params?: RequestParams) => Promise<any>;
1623
+ /**
1624
+ * @description Retrieve all courses for the current tenant or customer
1625
+ *
1626
+ * @tags Course
1627
+ * @name ListCourses
1628
+ * @summary Get All Courses
1629
+ * @request GET:/courses
1630
+ * @secure
1631
+ */
1632
+ listCourses: (params?: RequestParams) => Promise<any>;
1633
+ };
1634
+ template: {
1635
+ /**
1636
+ * @description Retrieve a session course template by ID
1637
+ *
1638
+ * @tags Template
1639
+ * @name GetTemplate
1640
+ * @summary Get Template
1641
+ * @request GET:/template/{templateID}
1642
+ * @secure
1643
+ */
1644
+ getTemplate: (templateId: string, params?: RequestParams) => Promise<any>;
1645
+ /**
1646
+ * @description Create a new session course template
1647
+ *
1648
+ * @tags Template
1649
+ * @name CreateTemplate
1650
+ * @summary Create Template
1651
+ * @request POST:/template/{templateID}
1652
+ * @secure
1653
+ */
1654
+ createTemplate: (templateId: string, data: SessionCourseTemplateCreateSchema, params?: RequestParams) => Promise<any>;
1655
+ /**
1656
+ * @description Update an existing session course template
1657
+ *
1658
+ * @tags Template
1659
+ * @name UpdateTemplate
1660
+ * @summary Update Template
1661
+ * @request PUT:/template/{templateID}
1662
+ * @secure
1663
+ */
1664
+ updateTemplate: (templateId: string, data: SessionCourseTemplateUpdateSchema, params?: RequestParams) => Promise<any>;
1665
+ /**
1666
+ * @description Delete a session course template
1667
+ *
1668
+ * @tags Template
1669
+ * @name DeleteTemplate
1670
+ * @summary Delete Template
1671
+ * @request DELETE:/template/{templateID}
1672
+ * @secure
1673
+ */
1674
+ deleteTemplate: (templateId: string, params?: RequestParams) => Promise<any>;
1675
+ };
1676
+ templates: {
1677
+ /**
1678
+ * @description Retrieve all session course templates
1679
+ *
1680
+ * @tags Template
1681
+ * @name ListTemplates
1682
+ * @summary Get All Templates
1683
+ * @request GET:/templates
1684
+ * @secure
1685
+ */
1686
+ listTemplates: (params?: RequestParams) => Promise<any>;
1687
+ };
1688
+ locations: {
1689
+ /**
1690
+ * @description Retrieve all locations (regions, cities, venues map)
1691
+ *
1692
+ * @tags Location
1693
+ * @name ListLocations
1694
+ * @summary Get Locations
1695
+ * @request GET:/locations
1696
+ * @secure
1697
+ */
1698
+ listLocations: (params?: RequestParams) => Promise<any>;
1699
+ };
1700
+ search: {
1701
+ /**
1702
+ * @description Search for sessions by an array of IDs
1703
+ *
1704
+ * @tags Search
1705
+ * @name ListSessionsIds
1706
+ * @summary Search Sessions by IDs
1707
+ * @request POST:/search/sessions/ids
1708
+ * @secure
1709
+ */
1710
+ listSessionsIds: (data: SearchSessionsByIDsSchema, params?: RequestParams) => Promise<any>;
1711
+ };
1712
+ session: {
1713
+ /**
1714
+ * @description Retrieve a session by ID
1715
+ *
1716
+ * @tags Session
1717
+ * @name GetSession
1718
+ * @summary Get Session
1719
+ * @request GET:/session/{sessionID}
1720
+ * @secure
1721
+ */
1722
+ getSession: (sessionId: string, params?: RequestParams) => Promise<any>;
1723
+ /**
1724
+ * @description Create a new session
1725
+ *
1726
+ * @tags Session
1727
+ * @name CreateSession
1728
+ * @summary Create Session
1729
+ * @request POST:/session/{sessionID}
1730
+ * @secure
1731
+ */
1732
+ createSession: (sessionId: string, data: SessionCreateSchema, params?: RequestParams) => Promise<any>;
1733
+ /**
1734
+ * @description Update an existing session
1735
+ *
1736
+ * @tags Session
1737
+ * @name UpdateSession
1738
+ * @summary Update Session
1739
+ * @request PUT:/session/{sessionID}
1740
+ * @secure
1741
+ */
1742
+ updateSession: (sessionId: string, data: SessionUpdateSchema, params?: RequestParams) => Promise<any>;
1743
+ /**
1744
+ * @description Delete a session
1745
+ *
1746
+ * @tags Session
1747
+ * @name DeleteSession
1748
+ * @summary Delete Session
1749
+ * @request DELETE:/session/{sessionID}
1750
+ * @secure
1751
+ */
1752
+ deleteSession: (sessionId: string, params?: RequestParams) => Promise<any>;
1753
+ /**
1754
+ * @description Transition session to next state
1755
+ *
1756
+ * @tags Session
1757
+ * @name CreateNext
1758
+ * @summary Advance Session State
1759
+ * @request POST:/session/{sessionID}/next
1760
+ * @secure
1761
+ */
1762
+ createNext: (sessionId: string, params?: RequestParams) => Promise<any>;
1763
+ /**
1764
+ * @description Cancel a session
1765
+ *
1766
+ * @tags Session
1767
+ * @name CreateCancel
1768
+ * @summary Cancel Session
1769
+ * @request POST:/session/{sessionID}/cancel
1770
+ * @secure
1771
+ */
1772
+ createCancel: (sessionId: string, params?: RequestParams) => Promise<any>;
1773
+ /**
1774
+ * @description Lock a session
1775
+ *
1776
+ * @tags Session
1777
+ * @name CreateLock
1778
+ * @summary Lock Session
1779
+ * @request POST:/session/{sessionID}/lock
1780
+ * @secure
1781
+ */
1782
+ createLock: (sessionId: string, params?: RequestParams) => Promise<any>;
1783
+ /**
1784
+ * @description Unlock a locked session
1785
+ *
1786
+ * @tags Session
1787
+ * @name CreateUnlock
1788
+ * @summary Unlock Session
1789
+ * @request POST:/session/{sessionID}/unlock
1790
+ * @secure
1791
+ */
1792
+ createUnlock: (sessionId: string, params?: RequestParams) => Promise<any>;
1793
+ /**
1794
+ * @description Publish or unpublish session calendar events
1795
+ *
1796
+ * @tags Session
1797
+ * @name CreatePublish
1798
+ * @summary Publish Session
1799
+ * @request POST:/session/{sessionID}/publish
1800
+ * @secure
1801
+ */
1802
+ createPublish: (sessionId: string, data: SessionPublishSchema, params?: RequestParams) => Promise<any>;
1803
+ /**
1804
+ * @description Release session access to students
1805
+ *
1806
+ * @tags Session
1807
+ * @name CreateRelease
1808
+ * @summary Release Session
1809
+ * @request POST:/session/{sessionID}/release
1810
+ * @secure
1811
+ */
1812
+ createRelease: (sessionId: string, params?: RequestParams) => Promise<any>;
1813
+ /**
1814
+ * @description Refresh material shipping info for session
1815
+ *
1816
+ * @tags Session
1817
+ * @name CreateRefreshShipping
1818
+ * @summary Refresh Shipping
1819
+ * @request POST:/session/{sessionID}/refreshShipping
1820
+ * @secure
1821
+ */
1822
+ createRefreshShipping: (sessionId: string, params?: RequestParams) => Promise<any>;
1823
+ /**
1824
+ * @description Update material shipped status for a session
1825
+ *
1826
+ * @tags Session
1827
+ * @name CreateCourseMaterial
1828
+ * @summary Update Course Material Status
1829
+ * @request POST:/session/{sessionID}/courseMaterial
1830
+ * @secure
1831
+ */
1832
+ createCourseMaterial: (sessionId: string, data: SessionShipStatusSchema, params?: RequestParams) => Promise<any>;
1833
+ /**
1834
+ * @description Duplicate a session to new dates
1835
+ *
1836
+ * @tags Session
1837
+ * @name CreateDuplicate
1838
+ * @summary Duplicate Session
1839
+ * @request POST:/session/{sessionID}/duplicate
1840
+ * @secure
1841
+ */
1842
+ createDuplicate: (sessionId: string, data: SessionDuplicateSchema, params?: RequestParams) => Promise<any>;
1843
+ /**
1844
+ * @description Move a student between sessions of the same course
1845
+ *
1846
+ * @tags Session
1847
+ * @name CreateMoveStudent
1848
+ * @summary Move Student
1849
+ * @request POST:/session/{sessionID}/moveStudent/{userID}/{newSessionID}
1850
+ * @secure
1851
+ */
1852
+ createMoveStudent: (sessionId: string, userId: string, newSessionId: string, params?: RequestParams) => Promise<any>;
1853
+ /**
1854
+ * @description Retrieve all attendances for a session
1855
+ *
1856
+ * @tags Session Attendance
1857
+ * @name GetAttendances
1858
+ * @summary Get Session Attendances
1859
+ * @request GET:/session/{sessionID}/attendances
1860
+ * @secure
1861
+ */
1862
+ getAttendances: (sessionId: string, params?: RequestParams) => Promise<any>;
1863
+ /**
1864
+ * @description Retrieve all enrolments for a session
1865
+ *
1866
+ * @tags Session Enrolment
1867
+ * @name GetEnrolments
1868
+ * @summary Get Session Enrolments
1869
+ * @request GET:/session/{sessionID}/enrolments
1870
+ * @secure
1871
+ */
1872
+ getEnrolments: (sessionId: string, params?: RequestParams) => Promise<any>;
1873
+ /**
1874
+ * @description Retrieve all results for a session
1875
+ *
1876
+ * @tags Session Result
1877
+ * @name GetResults
1878
+ * @summary Get Session Results
1879
+ * @request GET:/session/{sessionID}/results
1880
+ * @secure
1881
+ */
1882
+ getResults: (sessionId: string, params?: RequestParams) => Promise<any>;
1883
+ /**
1884
+ * @description Retrieve all enrolment invitations for a session
1885
+ *
1886
+ * @tags Session Invitation
1887
+ * @name GetInvitations
1888
+ * @summary Get Session Invitations
1889
+ * @request GET:/session/{sessionID}/invitations
1890
+ * @secure
1891
+ */
1892
+ getInvitations: (sessionId: string, params?: RequestParams) => Promise<any>;
1893
+ /**
1894
+ * @description Retrieve financial charges for a user in a session
1895
+ *
1896
+ * @tags Session Financial Charge
1897
+ * @name GetCharges
1898
+ * @summary Get Session Charges
1899
+ * @request GET:/session/{sessionID}/charges/{userID}
1900
+ * @secure
1901
+ */
1902
+ getCharges: (sessionId: string, userId: string, params?: RequestParams) => Promise<any>;
1903
+ /**
1904
+ * @description Retrieve a specific attendance record
1905
+ *
1906
+ * @tags Session Attendance
1907
+ * @name GetAttendance
1908
+ * @summary Get Session Attendance
1909
+ * @request GET:/session/{sessionID}/attendance/{attendanceID}/{externalID}
1910
+ * @secure
1911
+ */
1912
+ getAttendance: (sessionId: string, attendanceId: string, externalId: string, params?: RequestParams) => Promise<any>;
1913
+ /**
1914
+ * @description Create a new attendance record
1915
+ *
1916
+ * @tags Session Attendance
1917
+ * @name CreateAttendance
1918
+ * @summary Create Session Attendance
1919
+ * @request POST:/session/{sessionID}/attendance/{attendanceID}/{externalID}
1920
+ * @secure
1921
+ */
1922
+ createAttendance: (sessionId: string, attendanceId: string, externalId: string, data: InputQ59Gbvuj7G, params?: RequestParams) => Promise<any>;
1923
+ /**
1924
+ * @description Update an existing attendance record
1925
+ *
1926
+ * @tags Session Attendance
1927
+ * @name UpdateAttendance
1928
+ * @summary Update Session Attendance
1929
+ * @request PUT:/session/{sessionID}/attendance/{attendanceID}/{externalID}
1930
+ * @secure
1931
+ */
1932
+ updateAttendance: (sessionId: string, attendanceId: string, externalId: string, data: Input5S9Qlxsfdw, params?: RequestParams) => Promise<any>;
1933
+ /**
1934
+ * @description Delete an attendance record
1935
+ *
1936
+ * @tags Session Attendance
1937
+ * @name DeleteAttendance
1938
+ * @summary Delete Session Attendance
1939
+ * @request DELETE:/session/{sessionID}/attendance/{attendanceID}/{externalID}
1940
+ * @secure
1941
+ */
1942
+ deleteAttendance: (sessionId: string, attendanceId: string, externalId: string, params?: RequestParams) => Promise<any>;
1943
+ /**
1944
+ * @description Retrieve a specific enrolment record
1945
+ *
1946
+ * @tags Session Enrolment
1947
+ * @name GetEnrolment
1948
+ * @summary Get Session Enrolment
1949
+ * @request GET:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}
1950
+ * @secure
1951
+ */
1952
+ getEnrolment: (sessionId: string, enrolmentId: string, externalId: string, params?: RequestParams) => Promise<any>;
1953
+ /**
1954
+ * @description Create a new session enrolment
1955
+ *
1956
+ * @tags Session Enrolment
1957
+ * @name CreateEnrolment
1958
+ * @summary Create Session Enrolment
1959
+ * @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}
1960
+ * @secure
1961
+ */
1962
+ createEnrolment: (sessionId: string, enrolmentId: string, externalId: string, data: InputKdcf6Vev2F, params?: RequestParams) => Promise<any>;
1963
+ /**
1964
+ * @description Update an existing session enrolment
1965
+ *
1966
+ * @tags Session Enrolment
1967
+ * @name UpdateEnrolment
1968
+ * @summary Update Session Enrolment
1969
+ * @request PUT:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}
1970
+ * @secure
1971
+ */
1972
+ updateEnrolment: (sessionId: string, enrolmentId: string, externalId: string, data: InputPcoc6Mas3J, params?: RequestParams) => Promise<any>;
1973
+ /**
1974
+ * @description Delete a session enrolment
1975
+ *
1976
+ * @tags Session Enrolment
1977
+ * @name DeleteEnrolment
1978
+ * @summary Delete Session Enrolment
1979
+ * @request DELETE:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}
1980
+ * @secure
1981
+ */
1982
+ deleteEnrolment: (sessionId: string, enrolmentId: string, externalId: string, params?: RequestParams) => Promise<any>;
1983
+ /**
1984
+ * @description Retrieve an enrolment by session and user
1985
+ *
1986
+ * @tags Session Enrolment
1987
+ * @name GetEnrolment2
1988
+ * @summary Get Session Enrolment By User
1989
+ * @request GET:/session/{sessionID}/enrolment/{enrolmentID}
1990
+ * @originalName getEnrolment
1991
+ * @duplicate
1992
+ * @secure
1993
+ */
1994
+ getEnrolment2: (sessionId: string, enrolmentId: string, params?: RequestParams) => Promise<any>;
1995
+ /**
1996
+ * @description Release a session enrolment
1997
+ *
1998
+ * @tags Session Enrolment
1999
+ * @name CreateEnrolmentRelease
2000
+ * @summary Release Session Enrolment
2001
+ * @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}/release
2002
+ * @secure
2003
+ */
2004
+ createEnrolmentRelease: (sessionId: string, enrolmentId: string, externalId: string, params?: RequestParams) => Promise<any>;
2005
+ /**
2006
+ * @description Cancel a session enrolment
2007
+ *
2008
+ * @tags Session Enrolment
2009
+ * @name CreateEnrolmentCancel
2010
+ * @summary Cancel Session Enrolment
2011
+ * @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}/cancel
2012
+ * @secure
2013
+ */
2014
+ createEnrolmentCancel: (sessionId: string, enrolmentId: string, externalId: string, params?: RequestParams) => Promise<any>;
2015
+ /**
2016
+ * @description Generate SSO launch link for an online session enrolment
2017
+ *
2018
+ * @tags Session Enrolment
2019
+ * @name CreateEnrolmentLaunch
2020
+ * @summary Launch Session Enrolment SSO
2021
+ * @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}/launch
2022
+ * @secure
2023
+ */
2024
+ createEnrolmentLaunch: (sessionId: string, enrolmentId: string, externalId: string, params?: RequestParams) => Promise<any>;
2025
+ /**
2026
+ * @description Check the result for an online session enrolment
2027
+ *
2028
+ * @tags Session Enrolment
2029
+ * @name CreateEnrolmentCheckResult
2030
+ * @summary Check Enrolment Result
2031
+ * @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}/checkResult
2032
+ * @secure
2033
+ */
2034
+ createEnrolmentCheckResult: (sessionId: string, enrolmentId: string, externalId: string, params?: RequestParams) => Promise<any>;
2035
+ /**
2036
+ * @description Create a financial charge for an enrolment
2037
+ *
2038
+ * @tags Session Enrolment
2039
+ * @name CreateEnrolmentCharge
2040
+ * @summary Create Enrolment Charge
2041
+ * @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}/charge
2042
+ * @secure
2043
+ */
2044
+ createEnrolmentCharge: (sessionId: string, enrolmentId: string, externalId: string, data: Input56A08Qop2C, params?: RequestParams) => Promise<any>;
2045
+ /**
2046
+ * @description Retrieve a specific session result
2047
+ *
2048
+ * @tags Session Result
2049
+ * @name GetResult
2050
+ * @summary Get Session Result
2051
+ * @request GET:/session/{sessionID}/result/{resultID}/{externalID}
2052
+ * @secure
2053
+ */
2054
+ getResult: (sessionId: string, resultId: string, externalId: string, params?: RequestParams) => Promise<any>;
2055
+ /**
2056
+ * @description Create a new session result
2057
+ *
2058
+ * @tags Session Result
2059
+ * @name CreateResult
2060
+ * @summary Create Session Result
2061
+ * @request POST:/session/{sessionID}/result/{resultID}/{externalID}
2062
+ * @secure
2063
+ */
2064
+ createResult: (sessionId: string, resultId: string, externalId: string, data: InputHuw5M2U5Gx, params?: RequestParams) => Promise<any>;
2065
+ /**
2066
+ * @description Update an existing session result
2067
+ *
2068
+ * @tags Session Result
2069
+ * @name UpdateResult
2070
+ * @summary Update Session Result
2071
+ * @request PUT:/session/{sessionID}/result/{resultID}/{externalID}
2072
+ * @secure
2073
+ */
2074
+ updateResult: (sessionId: string, resultId: string, externalId: string, data: InputXxwuna2Nn, params?: RequestParams) => Promise<any>;
2075
+ /**
2076
+ * @description Delete a session result
2077
+ *
2078
+ * @tags Session Result
2079
+ * @name DeleteResult
2080
+ * @summary Delete Session Result
2081
+ * @request DELETE:/session/{sessionID}/result/{resultID}/{externalID}
2082
+ * @secure
2083
+ */
2084
+ deleteResult: (sessionId: string, resultId: string, externalId: string, params?: RequestParams) => Promise<any>;
2085
+ /**
2086
+ * @description Publish a session result
2087
+ *
2088
+ * @tags Session Result
2089
+ * @name CreateResultPublish
2090
+ * @summary Publish Session Result
2091
+ * @request POST:/session/{sessionID}/result/{resultID}/{externalID}/publish
2092
+ * @secure
2093
+ */
2094
+ createResultPublish: (sessionId: string, resultId: string, externalId: string, params?: RequestParams) => Promise<any>;
2095
+ /**
2096
+ * @description Retrieve a session instructor assignment
2097
+ *
2098
+ * @tags Session Instructor
2099
+ * @name GetInstructor
2100
+ * @summary Get Session Instructor
2101
+ * @request GET:/session/{sessionID}/instructor/{instructorID}
2102
+ * @secure
2103
+ */
2104
+ getInstructor: (sessionId: string, instructorId: string, params?: RequestParams) => Promise<any>;
2105
+ /**
2106
+ * @description Assign an instructor to a session
2107
+ *
2108
+ * @tags Session Instructor
2109
+ * @name CreateInstructor
2110
+ * @summary Assign Session Instructor
2111
+ * @request POST:/session/{sessionID}/instructor/{instructorID}
2112
+ * @secure
2113
+ */
2114
+ createInstructor: (sessionId: string, instructorId: string, data: SessionInstructorSchema, params?: RequestParams) => Promise<any>;
2115
+ /**
2116
+ * @description Update a session instructor assignment
2117
+ *
2118
+ * @tags Session Instructor
2119
+ * @name UpdateInstructor
2120
+ * @summary Update Session Instructor
2121
+ * @request PUT:/session/{sessionID}/instructor/{instructorID}
2122
+ * @secure
2123
+ */
2124
+ updateInstructor: (sessionId: string, instructorId: string, data: SessionInstructorSchema, params?: RequestParams) => Promise<any>;
2125
+ /**
2126
+ * @description Remove an instructor from a session
2127
+ *
2128
+ * @tags Session Instructor
2129
+ * @name DeleteInstructor
2130
+ * @summary Unassign Session Instructor
2131
+ * @request DELETE:/session/{sessionID}/instructor/{instructorID}
2132
+ * @secure
2133
+ */
2134
+ deleteInstructor: (sessionId: string, instructorId: string, params?: RequestParams) => Promise<any>;
2135
+ /**
2136
+ * @description Retrieve a session invitation
2137
+ *
2138
+ * @tags Session Invitation
2139
+ * @name GetInvitation
2140
+ * @summary Get Session Invitation
2141
+ * @request GET:/session/{sessionID}/invitation/{invitationID}
2142
+ * @secure
2143
+ */
2144
+ getInvitation: (sessionId: string, invitationId: string, params?: RequestParams) => Promise<any>;
2145
+ /**
2146
+ * @description Create a new session invitation
2147
+ *
2148
+ * @tags Session Invitation
2149
+ * @name CreateInvitation
2150
+ * @summary Create Session Invitation
2151
+ * @request POST:/session/{sessionID}/invitation/{invitationID}
2152
+ * @secure
2153
+ */
2154
+ createInvitation: (sessionId: string, invitationId: string, data: InputW0Gt14Iief, params?: RequestParams) => Promise<any>;
2155
+ /**
2156
+ * @description Update an existing session invitation
2157
+ *
2158
+ * @tags Session Invitation
2159
+ * @name UpdateInvitation
2160
+ * @summary Update Session Invitation
2161
+ * @request PUT:/session/{sessionID}/invitation/{invitationID}
2162
+ * @secure
2163
+ */
2164
+ updateInvitation: (sessionId: string, invitationId: string, data: InputF61Tonm0Be, params?: RequestParams) => Promise<any>;
2165
+ /**
2166
+ * @description Delete a session invitation
2167
+ *
2168
+ * @tags Session Invitation
2169
+ * @name DeleteInvitation
2170
+ * @summary Delete Session Invitation
2171
+ * @request DELETE:/session/{sessionID}/invitation/{invitationID}
2172
+ * @secure
2173
+ */
2174
+ deleteInvitation: (sessionId: string, invitationId: string, params?: RequestParams) => Promise<any>;
2175
+ /**
2176
+ * @description Validate a session invitation code
2177
+ *
2178
+ * @tags Session Invitation
2179
+ * @name GetInvitationValidate
2180
+ * @summary Validate Session Invitation
2181
+ * @request GET:/session/invitation/validate/{invitationCode}
2182
+ * @secure
2183
+ */
2184
+ getInvitationValidate: (invitationCode: string, params?: RequestParams) => Promise<any>;
2185
+ /**
2186
+ * @description Retrieve a specific financial charge
2187
+ *
2188
+ * @tags Session Financial Charge
2189
+ * @name GetCharge
2190
+ * @summary Get Session Financial Charge
2191
+ * @request GET:/session/{sessionID}/charge/{userID}/{timestamp}
2192
+ * @secure
2193
+ */
2194
+ getCharge: (sessionId: string, userId: string, timestamp: string, params?: RequestParams) => Promise<any>;
2195
+ /**
2196
+ * @description Get a signed URL to download a session document
2197
+ *
2198
+ * @tags Session Document
2199
+ * @name GetDocumentFileSign
2200
+ * @summary Get Session Document Signed URL
2201
+ * @request GET:/session/{sessionID}/document/fileSign/{fileID}
2202
+ * @secure
2203
+ */
2204
+ getDocumentFileSign: (sessionId: string, fileId: string, params?: RequestParams) => Promise<any>;
2205
+ /**
2206
+ * @description Get a signed URL to upload a session document
2207
+ *
2208
+ * @tags Session Document
2209
+ * @name CreateDocumentFileSign
2210
+ * @summary Get Session Document Upload URL
2211
+ * @request POST:/session/{sessionID}/document/fileSign/{fileID}
2212
+ * @secure
2213
+ */
2214
+ createDocumentFileSign: (sessionId: string, fileId: string, params?: RequestParams) => Promise<any>;
2215
+ /**
2216
+ * @description Get a signed URL to delete a session document
2217
+ *
2218
+ * @tags Session Document
2219
+ * @name DeleteDocumentFileSign
2220
+ * @summary Delete Session Document
2221
+ * @request DELETE:/session/{sessionID}/document/fileSign/{fileID}
2222
+ * @secure
2223
+ */
2224
+ deleteDocumentFileSign: (sessionId: string, fileId: string, params?: RequestParams) => Promise<any>;
2225
+ /**
2226
+ * @description Add a document to a session
2227
+ *
2228
+ * @tags Session Document
2229
+ * @name CreateDocument
2230
+ * @summary Add Session Document
2231
+ * @request POST:/session/{sessionID}/document
2232
+ * @secure
2233
+ */
2234
+ createDocument: (sessionId: string, data: SessionDocumentSchema, params?: RequestParams) => Promise<any>;
2235
+ /**
2236
+ * @description Remove a document from a session
2237
+ *
2238
+ * @tags Session Document
2239
+ * @name DeleteDocument
2240
+ * @summary Delete Session Document
2241
+ * @request DELETE:/session/{sessionID}/document/{fileID}
2242
+ * @secure
2243
+ */
2244
+ deleteDocument: (sessionId: string, fileId: string, params?: RequestParams) => Promise<any>;
2245
+ /**
2246
+ * @description Batch create or update attendances and results for a session
2247
+ *
2248
+ * @tags Session Attendance, Session Result
2249
+ * @name CreateAttendancesResultsBatchUpsert
2250
+ * @summary Batch Upsert Attendances and Results
2251
+ * @request POST:/session/{sessionID}/attendances/results/batchUpsert
2252
+ * @secure
2253
+ */
2254
+ createAttendancesResultsBatchUpsert: (sessionId: string, data: SessionBatchUpdateSchema, params?: RequestParams) => Promise<any>;
2255
+ /**
2256
+ * @description Retrieve user data for a session
2257
+ *
2258
+ * @tags Session
2259
+ * @name GetUserData
2260
+ * @summary Get Session User Data
2261
+ * @request GET:/session/{sessionID}/userData/{userID}/{externalID}
2262
+ * @secure
2263
+ */
2264
+ getUserData: (sessionId: string, userId: string, externalId: string, params?: RequestParams) => Promise<any>;
2265
+ /**
2266
+ * @description List session events within a time range
2267
+ *
2268
+ * @tags Session
2269
+ * @name ListEvents
2270
+ * @summary List Session Events
2271
+ * @request POST:/session/events/{startTime}/{endTime}
2272
+ * @secure
2273
+ */
2274
+ listEvents: (startTime: string, endTime: string, params?: RequestParams) => Promise<any>;
2275
+ /**
2276
+ * @description List session events within a time range filtered by course
2277
+ *
2278
+ * @tags Session
2279
+ * @name ListEvents2
2280
+ * @summary List Session Events By Course
2281
+ * @request POST:/session/events/{startTime}/{endTime}/{courseID}
2282
+ * @originalName listEvents
2283
+ * @duplicate
2284
+ * @secure
2285
+ */
2286
+ listEvents2: (startTime: string, endTime: string, courseId: string, params?: RequestParams) => Promise<any>;
2287
+ };
2288
+ sessions: {
2289
+ /**
2290
+ * @description Assign an instructor to multiple sessions
2291
+ *
2292
+ * @tags Session Instructor
2293
+ * @name CreateInstructor
2294
+ * @summary Set Instructor On Sessions
2295
+ * @request POST:/sessions/instructor/{instructorID}
2296
+ * @secure
2297
+ */
2298
+ createInstructor: (instructorId: string, data: SessionsInstructorSetSchema, params?: RequestParams) => Promise<any>;
2299
+ };
2300
+ customer: {
2301
+ /**
2302
+ * @description List customer-wide session events within a time range
2303
+ *
2304
+ * @tags Session
2305
+ * @name ListSessionEvents
2306
+ * @summary List Customer Session Events
2307
+ * @request POST:/customer/session/events/{startTime}/{endTime}
2308
+ * @secure
2309
+ */
2310
+ listSessionEvents: (startTime: string, endTime: string, params?: RequestParams) => Promise<any>;
2311
+ };
2312
+ reports: {
2313
+ /**
2314
+ * @description Generate enrolments per period report with optional course filter
2315
+ *
2316
+ * @tags Reports
2317
+ * @name CreateEnrolmentsPerPeriod
2318
+ * @summary Enrolments Per Period Report
2319
+ * @request POST:/reports/enrolmentsPerPeriod
2320
+ * @secure
2321
+ */
2322
+ createEnrolmentsPerPeriod: (data: EnrolmentsPerPeriodReportSchema, params?: RequestParams) => Promise<any>;
2323
+ /**
2324
+ * @description Generate session results analysis aggregation report
2325
+ *
2326
+ * @tags Reports
2327
+ * @name ListSessionResultsAnalysis
2328
+ * @summary Session Results Analysis Report
2329
+ * @request POST:/reports/sessionResultsAnalysis
2330
+ * @secure
2331
+ */
2332
+ listSessionResultsAnalysis: (data: SessionResultReportSchema, params?: RequestParams) => Promise<any>;
2333
+ /**
2334
+ * @description Preview session results report without row limit
2335
+ *
2336
+ * @tags Reports
2337
+ * @name CreateSessionResultsPreview
2338
+ * @summary Session Results Preview
2339
+ * @request POST:/reports/sessionResults/preview
2340
+ * @secure
2341
+ */
2342
+ createSessionResultsPreview: (data: SessionResultsReportSchema, params?: RequestParams) => Promise<any>;
2343
+ /**
2344
+ * @description Generate session results report with max rows limit
2345
+ *
2346
+ * @tags Reports
2347
+ * @name ListSessionResults
2348
+ * @summary Session Results Report
2349
+ * @request POST:/reports/sessionResults
2350
+ * @secure
2351
+ */
2352
+ listSessionResults: (data: SessionResultsReportSchema, params?: RequestParams) => Promise<any>;
2353
+ /**
2354
+ * @description Generate session list report
2355
+ *
2356
+ * @tags Reports
2357
+ * @name CreateSessionList
2358
+ * @summary Session List Report
2359
+ * @request POST:/reports/sessionList
2360
+ * @secure
2361
+ */
2362
+ createSessionList: (data: SessionListReportSchema, params?: RequestParams) => Promise<any>;
2363
+ /**
2364
+ * @description Generate Excel charges report for a session
2365
+ *
2366
+ * @tags Reports
2367
+ * @name ListSessionCharges
2368
+ * @summary Session Charges Report
2369
+ * @request POST:/reports/sessionCharges/{sessionID}
2370
+ * @secure
2371
+ */
2372
+ listSessionCharges: (sessionId: string, params?: RequestParams) => Promise<any>;
2373
+ /**
2374
+ * @description Generate Excel shipping manifest report for a session
2375
+ *
2376
+ * @tags Reports
2377
+ * @name CreateSessionShippingManifest
2378
+ * @summary Session Shipping Manifest Report
2379
+ * @request POST:/reports/sessionShippingManifest/{sessionID}
2380
+ * @secure
2381
+ */
2382
+ createSessionShippingManifest: (sessionId: string, params?: RequestParams) => Promise<any>;
2383
+ };
2384
+ }