@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/Api.ts +3752 -0
- package/dist/Api.d.ts +2384 -0
- package/dist/Api.js +2145 -0
- package/dist/Api.js.map +1 -0
- package/package.json +16 -0
- package/tsconfig.json +16 -0
package/Api.ts
ADDED
|
@@ -0,0 +1,3752 @@
|
|
|
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 Input9Jxov33U7D {
|
|
21
|
+
/** @minLength 1 */
|
|
22
|
+
customerID: string
|
|
23
|
+
/** @minLength 1 */
|
|
24
|
+
name: string
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
export interface InputUse5Vle8Ta {
|
|
28
|
+
/** @minLength 1 */
|
|
29
|
+
customerID: string
|
|
30
|
+
/** @minLength 1 */
|
|
31
|
+
id: string
|
|
32
|
+
/** @minLength 1 */
|
|
33
|
+
name: string
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
export interface CityCreateSchema {
|
|
37
|
+
/**
|
|
38
|
+
* Customer ID
|
|
39
|
+
* @minLength 1
|
|
40
|
+
*/
|
|
41
|
+
customerID: string
|
|
42
|
+
/**
|
|
43
|
+
* Region ID
|
|
44
|
+
* @minLength 1
|
|
45
|
+
*/
|
|
46
|
+
regionID: string
|
|
47
|
+
/**
|
|
48
|
+
* City name
|
|
49
|
+
* @minLength 1
|
|
50
|
+
*/
|
|
51
|
+
name: string
|
|
52
|
+
/**
|
|
53
|
+
* Province code
|
|
54
|
+
* @minLength 1
|
|
55
|
+
*/
|
|
56
|
+
province: string
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export interface CityUpdateSchema {
|
|
60
|
+
/**
|
|
61
|
+
* Customer ID
|
|
62
|
+
* @minLength 1
|
|
63
|
+
*/
|
|
64
|
+
customerID: string
|
|
65
|
+
/**
|
|
66
|
+
* Region ID
|
|
67
|
+
* @minLength 1
|
|
68
|
+
*/
|
|
69
|
+
regionID: string
|
|
70
|
+
/**
|
|
71
|
+
* City ID
|
|
72
|
+
* @minLength 1
|
|
73
|
+
*/
|
|
74
|
+
id: string
|
|
75
|
+
/**
|
|
76
|
+
* City name
|
|
77
|
+
* @minLength 1
|
|
78
|
+
*/
|
|
79
|
+
name: string
|
|
80
|
+
/**
|
|
81
|
+
* Province code
|
|
82
|
+
* @minLength 1
|
|
83
|
+
*/
|
|
84
|
+
province: string
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
export interface VenueCreateSchema {
|
|
88
|
+
/**
|
|
89
|
+
* Customer ID
|
|
90
|
+
* @minLength 1
|
|
91
|
+
*/
|
|
92
|
+
customerID: string
|
|
93
|
+
/**
|
|
94
|
+
* City ID
|
|
95
|
+
* @minLength 1
|
|
96
|
+
*/
|
|
97
|
+
cityID: string
|
|
98
|
+
/**
|
|
99
|
+
* Venue name
|
|
100
|
+
* @minLength 1
|
|
101
|
+
*/
|
|
102
|
+
name: string
|
|
103
|
+
/** Venue address */
|
|
104
|
+
address: {
|
|
105
|
+
/**
|
|
106
|
+
* Street address line 1
|
|
107
|
+
* @minLength 1
|
|
108
|
+
*/
|
|
109
|
+
street1: string
|
|
110
|
+
/** Street address line 2 */
|
|
111
|
+
street2?: string | null
|
|
112
|
+
/**
|
|
113
|
+
* Postal code
|
|
114
|
+
* @minLength 1
|
|
115
|
+
*/
|
|
116
|
+
postalCode: string
|
|
117
|
+
/**
|
|
118
|
+
* Province code
|
|
119
|
+
* @minLength 1
|
|
120
|
+
*/
|
|
121
|
+
province: string
|
|
122
|
+
}
|
|
123
|
+
/** Additional comments */
|
|
124
|
+
comments?: string | null
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
export interface VenueUpdateSchema {
|
|
128
|
+
/**
|
|
129
|
+
* Customer ID
|
|
130
|
+
* @minLength 1
|
|
131
|
+
*/
|
|
132
|
+
customerID: string
|
|
133
|
+
/**
|
|
134
|
+
* City ID
|
|
135
|
+
* @minLength 1
|
|
136
|
+
*/
|
|
137
|
+
cityID: string
|
|
138
|
+
/**
|
|
139
|
+
* Venue ID
|
|
140
|
+
* @minLength 1
|
|
141
|
+
*/
|
|
142
|
+
id: string
|
|
143
|
+
/**
|
|
144
|
+
* Venue name
|
|
145
|
+
* @minLength 1
|
|
146
|
+
*/
|
|
147
|
+
name: string
|
|
148
|
+
/** Venue address */
|
|
149
|
+
address: {
|
|
150
|
+
/**
|
|
151
|
+
* Street address line 1
|
|
152
|
+
* @minLength 1
|
|
153
|
+
*/
|
|
154
|
+
street1: string
|
|
155
|
+
/** Street address line 2 */
|
|
156
|
+
street2?: string | null
|
|
157
|
+
/**
|
|
158
|
+
* Postal code
|
|
159
|
+
* @minLength 1
|
|
160
|
+
*/
|
|
161
|
+
postalCode: string
|
|
162
|
+
/**
|
|
163
|
+
* Province code
|
|
164
|
+
* @minLength 1
|
|
165
|
+
*/
|
|
166
|
+
province: string
|
|
167
|
+
}
|
|
168
|
+
/** Additional comments */
|
|
169
|
+
comments?: string | null
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
export interface InstructorCreateSchema {
|
|
173
|
+
/**
|
|
174
|
+
* User ID of the instructor
|
|
175
|
+
* @minLength 1
|
|
176
|
+
*/
|
|
177
|
+
userID: string
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
export interface InstructorUpdateSchema {
|
|
181
|
+
/** Whether the instructor is disabled */
|
|
182
|
+
disabled: boolean
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
export interface InstructorCourseUpdateSchema {
|
|
186
|
+
/** List of course IDs */
|
|
187
|
+
courseIDs: string[]
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
export interface InstructorRegionUpdateSchema {
|
|
191
|
+
/** List of region IDs */
|
|
192
|
+
regionIDs: string[]
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
export interface Input33N9Vgyjyy {
|
|
196
|
+
startTime: string | number
|
|
197
|
+
endTime: string | number
|
|
198
|
+
expandSessions?: boolean
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
export interface Input56Hzg6Xiz2 {
|
|
202
|
+
startTime: string | number
|
|
203
|
+
endTime: string | number
|
|
204
|
+
description?: string
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
export interface Input3Yilrlis7M {
|
|
208
|
+
startTime: string | number
|
|
209
|
+
endTime: string | number
|
|
210
|
+
description?: string
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
export interface InputKi6Tbrci1R {
|
|
214
|
+
/** @minLength 1 */
|
|
215
|
+
calendarColor: string
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
export interface SessionCourseTemplateCreateSchema {
|
|
219
|
+
/**
|
|
220
|
+
* Tenant ID
|
|
221
|
+
* @minLength 1
|
|
222
|
+
*/
|
|
223
|
+
tenantID: string
|
|
224
|
+
/**
|
|
225
|
+
* Course ID
|
|
226
|
+
* @minLength 1
|
|
227
|
+
*/
|
|
228
|
+
courseID: string
|
|
229
|
+
/**
|
|
230
|
+
* Template name
|
|
231
|
+
* @minLength 1
|
|
232
|
+
*/
|
|
233
|
+
name: string
|
|
234
|
+
/**
|
|
235
|
+
* Internal template name
|
|
236
|
+
* @minLength 1
|
|
237
|
+
*/
|
|
238
|
+
internalName: string
|
|
239
|
+
autoEnrolOnSession?: string | null
|
|
240
|
+
releaseType: SessionCourseTemplateCreateSchemaReleaseTypeEnum
|
|
241
|
+
productsForPurchase?: string[]
|
|
242
|
+
productPurchaseMessage?: string | null
|
|
243
|
+
disabledEmails?: (string | null)[]
|
|
244
|
+
disableLicenseEmails?: boolean
|
|
245
|
+
calendarColor?: string | null
|
|
246
|
+
capacity: number
|
|
247
|
+
reservedCapacity?: number | null
|
|
248
|
+
minCapacity?: number
|
|
249
|
+
notificationDetails: {
|
|
250
|
+
adminEmails: string[]
|
|
251
|
+
shouldNotifyEnrolmentToAdmins?: boolean
|
|
252
|
+
notifyWhenSessionFull?: boolean
|
|
253
|
+
}
|
|
254
|
+
hasMaterial: SessionCourseTemplateCreateSchemaHasMaterialEnum
|
|
255
|
+
requiresInstructor?: boolean
|
|
256
|
+
requiresAdminReview?: boolean
|
|
257
|
+
overview?: string | null
|
|
258
|
+
specialInstructions?: string | null
|
|
259
|
+
chargeDeferred?: boolean
|
|
260
|
+
checkGradeDelay?: number
|
|
261
|
+
courseMaterialProductID?: string | null
|
|
262
|
+
isEligibleForNoCost?: boolean
|
|
263
|
+
cancelationPolicyID?: string | null
|
|
264
|
+
reschedulePolicyID?: string | null
|
|
265
|
+
confirmInfoOnEnrolment?: boolean
|
|
266
|
+
bypassAgreement?: boolean
|
|
267
|
+
chargeForMaterials?: boolean
|
|
268
|
+
isReferralPercentage?: boolean
|
|
269
|
+
referralAmount?: number
|
|
270
|
+
possibleReferrals?: (string | null)[]
|
|
271
|
+
askForReferrals?: boolean
|
|
272
|
+
isPrivate: boolean
|
|
273
|
+
internalNotes?: string | null
|
|
274
|
+
instructorNotes?: string | null
|
|
275
|
+
content?: {
|
|
276
|
+
sections: {
|
|
277
|
+
order: number
|
|
278
|
+
/** @minLength 1 */
|
|
279
|
+
name: string
|
|
280
|
+
enabled: boolean
|
|
281
|
+
warning?: {
|
|
282
|
+
type?: string | null
|
|
283
|
+
/** @minLength 1 */
|
|
284
|
+
content?: string
|
|
285
|
+
}
|
|
286
|
+
/** @minLength 1 */
|
|
287
|
+
content: string
|
|
288
|
+
files?: string[] | null
|
|
289
|
+
}[]
|
|
290
|
+
}
|
|
291
|
+
type: SessionCourseTemplateCreateSchemaTypeEnum
|
|
292
|
+
duration?: number
|
|
293
|
+
venueID?: string | null
|
|
294
|
+
venueComplement?: string | null
|
|
295
|
+
considerFailures?: boolean
|
|
296
|
+
onlineAccessPeriod?: number
|
|
297
|
+
providerCourseTemplateID?: string | null | number
|
|
298
|
+
calculateScoreAsPercentage?: boolean
|
|
299
|
+
courseProviderID?: string | null
|
|
300
|
+
accessLink?: string | null
|
|
301
|
+
}
|
|
302
|
+
|
|
303
|
+
export interface SessionCourseTemplateUpdateSchema {
|
|
304
|
+
/**
|
|
305
|
+
* Template name
|
|
306
|
+
* @minLength 1
|
|
307
|
+
*/
|
|
308
|
+
name: string
|
|
309
|
+
/**
|
|
310
|
+
* Internal template name
|
|
311
|
+
* @minLength 1
|
|
312
|
+
*/
|
|
313
|
+
internalName: string
|
|
314
|
+
autoEnrolOnSession?: string | null
|
|
315
|
+
releaseType: SessionCourseTemplateUpdateSchemaReleaseTypeEnum
|
|
316
|
+
productsForPurchase?: string[]
|
|
317
|
+
productPurchaseMessage?: string | null
|
|
318
|
+
disabledEmails?: (string | null)[]
|
|
319
|
+
disableLicenseEmails?: boolean
|
|
320
|
+
calendarColor?: string | null
|
|
321
|
+
capacity: number
|
|
322
|
+
reservedCapacity?: number | null
|
|
323
|
+
minCapacity?: number
|
|
324
|
+
notificationDetails: {
|
|
325
|
+
adminEmails: string[]
|
|
326
|
+
shouldNotifyEnrolmentToAdmins?: boolean
|
|
327
|
+
notifyWhenSessionFull?: boolean
|
|
328
|
+
}
|
|
329
|
+
hasMaterial: SessionCourseTemplateUpdateSchemaHasMaterialEnum
|
|
330
|
+
requiresInstructor?: boolean
|
|
331
|
+
requiresAdminReview?: boolean
|
|
332
|
+
overview?: string | null
|
|
333
|
+
specialInstructions?: string | null
|
|
334
|
+
chargeDeferred?: boolean
|
|
335
|
+
checkGradeDelay?: number
|
|
336
|
+
courseMaterialProductID?: string | null
|
|
337
|
+
isEligibleForNoCost?: boolean
|
|
338
|
+
cancelationPolicyID?: string | null
|
|
339
|
+
reschedulePolicyID?: string | null
|
|
340
|
+
confirmInfoOnEnrolment?: boolean
|
|
341
|
+
bypassAgreement?: boolean
|
|
342
|
+
chargeForMaterials?: boolean
|
|
343
|
+
isReferralPercentage?: boolean
|
|
344
|
+
referralAmount?: number
|
|
345
|
+
possibleReferrals?: (string | null)[]
|
|
346
|
+
askForReferrals?: boolean
|
|
347
|
+
isPrivate: boolean
|
|
348
|
+
internalNotes?: string | null
|
|
349
|
+
instructorNotes?: string | null
|
|
350
|
+
content?: {
|
|
351
|
+
sections: {
|
|
352
|
+
order: number
|
|
353
|
+
/** @minLength 1 */
|
|
354
|
+
name: string
|
|
355
|
+
enabled: boolean
|
|
356
|
+
warning?: {
|
|
357
|
+
type?: string | null
|
|
358
|
+
/** @minLength 1 */
|
|
359
|
+
content?: string
|
|
360
|
+
}
|
|
361
|
+
/** @minLength 1 */
|
|
362
|
+
content: string
|
|
363
|
+
files?: string[] | null
|
|
364
|
+
}[]
|
|
365
|
+
}
|
|
366
|
+
type: SessionCourseTemplateUpdateSchemaTypeEnum
|
|
367
|
+
duration?: number
|
|
368
|
+
venueID?: string | null
|
|
369
|
+
venueComplement?: string | null
|
|
370
|
+
considerFailures?: boolean
|
|
371
|
+
onlineAccessPeriod?: number
|
|
372
|
+
providerCourseTemplateID?: string | null | number
|
|
373
|
+
calculateScoreAsPercentage?: boolean
|
|
374
|
+
courseProviderID?: string | null
|
|
375
|
+
accessLink?: string | null
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
export interface SearchSessionsByIDsSchema {
|
|
379
|
+
/** Array of session IDs to search */
|
|
380
|
+
IDs: string[]
|
|
381
|
+
}
|
|
382
|
+
|
|
383
|
+
export interface SessionCreateSchema {
|
|
384
|
+
/**
|
|
385
|
+
* Tenant ID
|
|
386
|
+
* @minLength 1
|
|
387
|
+
*/
|
|
388
|
+
tenantID: string
|
|
389
|
+
/**
|
|
390
|
+
* Course ID
|
|
391
|
+
* @minLength 1
|
|
392
|
+
*/
|
|
393
|
+
courseID: string
|
|
394
|
+
/**
|
|
395
|
+
* Template ID
|
|
396
|
+
* @minLength 1
|
|
397
|
+
*/
|
|
398
|
+
templateID: string
|
|
399
|
+
/**
|
|
400
|
+
* Session name
|
|
401
|
+
* @minLength 1
|
|
402
|
+
*/
|
|
403
|
+
name: string
|
|
404
|
+
/**
|
|
405
|
+
* Internal session name
|
|
406
|
+
* @minLength 1
|
|
407
|
+
*/
|
|
408
|
+
internalName: string
|
|
409
|
+
autoEnrolOnSession?: string | null
|
|
410
|
+
releaseType: SessionCreateSchemaReleaseTypeEnum
|
|
411
|
+
capacity: number
|
|
412
|
+
reservedCapacity?: number | null
|
|
413
|
+
disabledEmails?: (string | null)[]
|
|
414
|
+
disableLicenseEmails?: boolean
|
|
415
|
+
minCapacity?: number
|
|
416
|
+
notificationDetails: {
|
|
417
|
+
adminEmails: string[]
|
|
418
|
+
shouldNotifyEnrolmentToAdmins?: boolean
|
|
419
|
+
notifyWhenSessionFull?: boolean
|
|
420
|
+
}
|
|
421
|
+
hasMaterial: SessionCreateSchemaHasMaterialEnum
|
|
422
|
+
requiresInstructor?: boolean
|
|
423
|
+
requiresAdminReview?: boolean
|
|
424
|
+
overview?: string | null
|
|
425
|
+
specialInstructions?: string | null
|
|
426
|
+
chargeDeferred?: boolean
|
|
427
|
+
checkGradeDelay?: number[]
|
|
428
|
+
courseMaterialProductID?: string | null
|
|
429
|
+
isEligibleForNoCost?: boolean
|
|
430
|
+
cancelationPolicyID?: string | null
|
|
431
|
+
reschedulePolicyID?: string | null
|
|
432
|
+
confirmInfoOnEnrolment?: boolean
|
|
433
|
+
bypassAgreement?: boolean
|
|
434
|
+
chargeForMaterials?: boolean
|
|
435
|
+
isReferralPercentage?: boolean
|
|
436
|
+
referralAmount?: number
|
|
437
|
+
possibleReferrals?: (string | null)[]
|
|
438
|
+
productsForPurchase?: string[]
|
|
439
|
+
productPurchaseMessage?: string | null
|
|
440
|
+
enableProductPurchase?: boolean
|
|
441
|
+
askForReferrals?: boolean
|
|
442
|
+
isPrivate: boolean
|
|
443
|
+
internalNotes?: string | null
|
|
444
|
+
instructorNotes?: string | null
|
|
445
|
+
content?: {
|
|
446
|
+
sections: {
|
|
447
|
+
order: number
|
|
448
|
+
/** @minLength 1 */
|
|
449
|
+
name: string
|
|
450
|
+
enabled: boolean
|
|
451
|
+
warning?: {
|
|
452
|
+
type?: string | null
|
|
453
|
+
/** @minLength 1 */
|
|
454
|
+
content?: string
|
|
455
|
+
}
|
|
456
|
+
/** @minLength 1 */
|
|
457
|
+
content: string
|
|
458
|
+
files?: string[] | null
|
|
459
|
+
}[]
|
|
460
|
+
}
|
|
461
|
+
type: SessionCreateSchemaTypeEnum
|
|
462
|
+
duration?: number
|
|
463
|
+
venueID?: string | null
|
|
464
|
+
venueComplement?: string | null
|
|
465
|
+
considerFailures?: boolean
|
|
466
|
+
onlineAccessPeriod?: number
|
|
467
|
+
providerCourseTemplateID?: string | null | number
|
|
468
|
+
calculateScoreAsPercentage?: boolean
|
|
469
|
+
courseProviderID?: string | null
|
|
470
|
+
accessLink?: string | null
|
|
471
|
+
launchSchedule?:
|
|
472
|
+
| {
|
|
473
|
+
dayOfWeek: number
|
|
474
|
+
/** @minLength 1 */
|
|
475
|
+
startTime: string
|
|
476
|
+
/** @minLength 1 */
|
|
477
|
+
endTime: string
|
|
478
|
+
}[]
|
|
479
|
+
| null
|
|
480
|
+
allowEnrolmentUntil?: number | null
|
|
481
|
+
calendarColor?: string | null
|
|
482
|
+
isMaterialSent?: boolean
|
|
483
|
+
materialShippingInfo?: any
|
|
484
|
+
isCourseMaterialShipped?: boolean
|
|
485
|
+
lockReason?: string | null
|
|
486
|
+
dbEntity?: string | null
|
|
487
|
+
startDate: (string | number)[]
|
|
488
|
+
endDate: (string | number)[]
|
|
489
|
+
onlineCourseLabel?: string[] | null
|
|
490
|
+
onlineCourseID?: string[] | null
|
|
491
|
+
onlineGradeID?: any[]
|
|
492
|
+
onlineQuizID?: any[]
|
|
493
|
+
onlineScoreGradeID?: string[] | null
|
|
494
|
+
enrolmentCount?: number
|
|
495
|
+
enrolmentReservedCount?: number
|
|
496
|
+
charges?: any
|
|
497
|
+
}
|
|
498
|
+
|
|
499
|
+
export interface SessionUpdateSchema {
|
|
500
|
+
/**
|
|
501
|
+
* Session name
|
|
502
|
+
* @minLength 1
|
|
503
|
+
*/
|
|
504
|
+
name: string
|
|
505
|
+
/**
|
|
506
|
+
* Internal session name
|
|
507
|
+
* @minLength 1
|
|
508
|
+
*/
|
|
509
|
+
internalName: string
|
|
510
|
+
autoEnrolOnSession?: string | null
|
|
511
|
+
releaseType: SessionUpdateSchemaReleaseTypeEnum
|
|
512
|
+
capacity: number
|
|
513
|
+
reservedCapacity?: number | null
|
|
514
|
+
disabledEmails?: (string | null)[]
|
|
515
|
+
disableLicenseEmails?: boolean
|
|
516
|
+
minCapacity?: number
|
|
517
|
+
notificationDetails: {
|
|
518
|
+
adminEmails: string[]
|
|
519
|
+
shouldNotifyEnrolmentToAdmins?: boolean
|
|
520
|
+
notifyWhenSessionFull?: boolean
|
|
521
|
+
}
|
|
522
|
+
stateBeforeLock?: string | null
|
|
523
|
+
hasMaterial: SessionUpdateSchemaHasMaterialEnum
|
|
524
|
+
requiresInstructor?: boolean
|
|
525
|
+
requiresAdminReview?: boolean
|
|
526
|
+
overview?: string | null
|
|
527
|
+
specialInstructions?: string | null
|
|
528
|
+
chargeDeferred?: boolean
|
|
529
|
+
courseMaterialProductID?: string | null
|
|
530
|
+
isEligibleForNoCost?: boolean
|
|
531
|
+
cancelationPolicyID?: string | null
|
|
532
|
+
reschedulePolicyID?: string | null
|
|
533
|
+
confirmInfoOnEnrolment?: boolean
|
|
534
|
+
bypassAgreement?: boolean
|
|
535
|
+
chargeForMaterials?: boolean
|
|
536
|
+
checkGradeDelay?: number[]
|
|
537
|
+
isReferralPercentage?: boolean
|
|
538
|
+
referralAmount?: number
|
|
539
|
+
possibleReferrals?: (string | null)[]
|
|
540
|
+
productsForPurchase?: string[]
|
|
541
|
+
productPurchaseMessage?: string | null
|
|
542
|
+
enableProductPurchase?: boolean
|
|
543
|
+
askForReferrals?: boolean
|
|
544
|
+
isPrivate: boolean
|
|
545
|
+
internalNotes?: string | null
|
|
546
|
+
instructorNotes?: string | null
|
|
547
|
+
content?: {
|
|
548
|
+
sections: {
|
|
549
|
+
order: number
|
|
550
|
+
/** @minLength 1 */
|
|
551
|
+
name: string
|
|
552
|
+
enabled: boolean
|
|
553
|
+
warning?: {
|
|
554
|
+
type?: string | null
|
|
555
|
+
/** @minLength 1 */
|
|
556
|
+
content?: string
|
|
557
|
+
}
|
|
558
|
+
/** @minLength 1 */
|
|
559
|
+
content: string
|
|
560
|
+
files?: string[] | null
|
|
561
|
+
}[]
|
|
562
|
+
}
|
|
563
|
+
type: SessionUpdateSchemaTypeEnum
|
|
564
|
+
duration?: number
|
|
565
|
+
venueID?: string | null
|
|
566
|
+
venueComplement?: string | null
|
|
567
|
+
considerFailures?: boolean
|
|
568
|
+
onlineAccessPeriod?: number
|
|
569
|
+
providerCourseTemplateID?: string | null | number
|
|
570
|
+
calculateScoreAsPercentage?: boolean
|
|
571
|
+
courseProviderID?: string | null
|
|
572
|
+
accessLink?: string | null
|
|
573
|
+
launchSchedule?:
|
|
574
|
+
| {
|
|
575
|
+
dayOfWeek: number
|
|
576
|
+
/** @minLength 1 */
|
|
577
|
+
startTime: string
|
|
578
|
+
/** @minLength 1 */
|
|
579
|
+
endTime: string
|
|
580
|
+
}[]
|
|
581
|
+
| null
|
|
582
|
+
allowEnrolmentUntil?: number | null
|
|
583
|
+
calendarColor?: string | null
|
|
584
|
+
isMaterialSent?: boolean
|
|
585
|
+
materialShippingInfo?: any
|
|
586
|
+
isCourseMaterialShipped?: boolean
|
|
587
|
+
lockReason?: string | null
|
|
588
|
+
documents?: {
|
|
589
|
+
fileName: string
|
|
590
|
+
fileID: string
|
|
591
|
+
}[]
|
|
592
|
+
dbEntity?: string | null
|
|
593
|
+
startDate: (string | number)[]
|
|
594
|
+
endDate: (string | number)[]
|
|
595
|
+
onlineCourseLabel?: string[] | null
|
|
596
|
+
onlineCourseID?: string[] | null
|
|
597
|
+
onlineGradeID?: any[]
|
|
598
|
+
onlineQuizID?: any[]
|
|
599
|
+
onlineScoreGradeID?: string[] | null
|
|
600
|
+
enrolmentCount?: number
|
|
601
|
+
enrolmentReservedCount?: number
|
|
602
|
+
charges?: any
|
|
603
|
+
}
|
|
604
|
+
|
|
605
|
+
export interface SessionPublishSchema {
|
|
606
|
+
/** Whether to publish the session */
|
|
607
|
+
published: boolean
|
|
608
|
+
}
|
|
609
|
+
|
|
610
|
+
export interface SessionShipStatusSchema {
|
|
611
|
+
/** Whether material has been shipped */
|
|
612
|
+
materialShipped: boolean
|
|
613
|
+
}
|
|
614
|
+
|
|
615
|
+
export interface SessionDuplicateSchema {
|
|
616
|
+
/** Array of timestamps for new sessions */
|
|
617
|
+
newSessionDates: number[]
|
|
618
|
+
}
|
|
619
|
+
|
|
620
|
+
export interface InputQ59Gbvuj7G {
|
|
621
|
+
attendanceStatus: InputQ59Gbvuj7GAttendanceStatusEnum
|
|
622
|
+
additionalNotes?: string | null
|
|
623
|
+
}
|
|
624
|
+
|
|
625
|
+
export interface Input5S9Qlxsfdw {
|
|
626
|
+
attendanceStatus: Input5S9QlxsfdwAttendanceStatusEnum
|
|
627
|
+
additionalNotes?: string | null
|
|
628
|
+
}
|
|
629
|
+
|
|
630
|
+
export interface InputKdcf6Vev2F {
|
|
631
|
+
/** @minLength 1 */
|
|
632
|
+
ticketID: string
|
|
633
|
+
/** @minLength 1 */
|
|
634
|
+
externalID: string
|
|
635
|
+
invitationCode?: string | null
|
|
636
|
+
isReservedSeat?: boolean
|
|
637
|
+
[key: string]: any
|
|
638
|
+
}
|
|
639
|
+
|
|
640
|
+
export interface InputPcoc6Mas3J {
|
|
641
|
+
materialShippingInfo?: Record<string, any>
|
|
642
|
+
[key: string]: any
|
|
643
|
+
}
|
|
644
|
+
|
|
645
|
+
export interface Input56A08Qop2C {
|
|
646
|
+
amount: number
|
|
647
|
+
chargeResult: Input56A08Qop2CChargeResultEnum
|
|
648
|
+
description?: string | null
|
|
649
|
+
/** @minLength 1 */
|
|
650
|
+
paymentProvider: string
|
|
651
|
+
providerTransactionID?: string | null
|
|
652
|
+
timestamp: number
|
|
653
|
+
}
|
|
654
|
+
|
|
655
|
+
export interface InputHuw5M2U5Gx {
|
|
656
|
+
resultStatus: InputHuw5M2U5GxResultStatusEnum
|
|
657
|
+
resultNotes?: string | null
|
|
658
|
+
resultGrade?: number
|
|
659
|
+
retainAcessToCourse?: boolean
|
|
660
|
+
resultOverrideDate?: number
|
|
661
|
+
isManuallyPublished?: boolean
|
|
662
|
+
orgID?: string | null
|
|
663
|
+
employerName?: string | null
|
|
664
|
+
}
|
|
665
|
+
|
|
666
|
+
export interface InputXxwuna2Nn {
|
|
667
|
+
resultStatus: InputXxwuna2NnResultStatusEnum
|
|
668
|
+
resultNotes?: string | null
|
|
669
|
+
resultGrade?: number
|
|
670
|
+
retainAcessToCourse?: boolean
|
|
671
|
+
resultOverrideDate?: number
|
|
672
|
+
isManuallyPublished?: boolean
|
|
673
|
+
orgID?: string | null
|
|
674
|
+
employerName?: string | null
|
|
675
|
+
}
|
|
676
|
+
|
|
677
|
+
export interface SessionInstructorSchema {
|
|
678
|
+
/** Instructor type */
|
|
679
|
+
instructorType: SessionInstructorSchemaInstructorTypeEnum
|
|
680
|
+
}
|
|
681
|
+
|
|
682
|
+
export interface SessionsInstructorSetSchema {
|
|
683
|
+
/** Array of session IDs */
|
|
684
|
+
sessions: string[]
|
|
685
|
+
/** Instructor type */
|
|
686
|
+
instructorType: SessionsInstructorSetSchemaInstructorTypeEnum
|
|
687
|
+
}
|
|
688
|
+
|
|
689
|
+
export interface InputW0Gt14Iief {
|
|
690
|
+
activationCode?: string | null
|
|
691
|
+
/** @minLength 1 */
|
|
692
|
+
email: string
|
|
693
|
+
userID?: string | null
|
|
694
|
+
isReservedSeat?: boolean
|
|
695
|
+
maxUsage: number
|
|
696
|
+
}
|
|
697
|
+
|
|
698
|
+
export interface InputF61Tonm0Be {
|
|
699
|
+
useCount?: any
|
|
700
|
+
maxUsage: number
|
|
701
|
+
}
|
|
702
|
+
|
|
703
|
+
export interface SessionDocumentSchema {
|
|
704
|
+
/**
|
|
705
|
+
* File ID
|
|
706
|
+
* @minLength 1
|
|
707
|
+
*/
|
|
708
|
+
fileID: string
|
|
709
|
+
/**
|
|
710
|
+
* File name
|
|
711
|
+
* @minLength 1
|
|
712
|
+
*/
|
|
713
|
+
fileName: string
|
|
714
|
+
}
|
|
715
|
+
|
|
716
|
+
export interface SessionBatchUpdateSchema {
|
|
717
|
+
students: {
|
|
718
|
+
/**
|
|
719
|
+
* User ID
|
|
720
|
+
* @minLength 1
|
|
721
|
+
*/
|
|
722
|
+
userID: string
|
|
723
|
+
/**
|
|
724
|
+
* External ID
|
|
725
|
+
* @minLength 1
|
|
726
|
+
*/
|
|
727
|
+
externalID: string
|
|
728
|
+
/** Attendance data */
|
|
729
|
+
attendance?: {
|
|
730
|
+
attendanceStatus: SessionBatchUpdateSchemaAttendanceStatusEnum
|
|
731
|
+
additionalNotes?: string | null
|
|
732
|
+
}
|
|
733
|
+
/** Result data */
|
|
734
|
+
result?: {
|
|
735
|
+
resultStatus: SessionBatchUpdateSchemaResultStatusEnum
|
|
736
|
+
resultNotes?: string | null
|
|
737
|
+
resultGrade?: number
|
|
738
|
+
}
|
|
739
|
+
}[]
|
|
740
|
+
}
|
|
741
|
+
|
|
742
|
+
export interface EnrolmentsPerPeriodReportSchema {
|
|
743
|
+
filters: {
|
|
744
|
+
/** Start timestamp */
|
|
745
|
+
from: number
|
|
746
|
+
/** End timestamp */
|
|
747
|
+
to: number
|
|
748
|
+
/** Optional course filter */
|
|
749
|
+
courseID?: string | null
|
|
750
|
+
}
|
|
751
|
+
}
|
|
752
|
+
|
|
753
|
+
export interface SessionResultReportSchema {
|
|
754
|
+
filters: {
|
|
755
|
+
/**
|
|
756
|
+
* Course ID
|
|
757
|
+
* @minLength 1
|
|
758
|
+
*/
|
|
759
|
+
courseID: string
|
|
760
|
+
/**
|
|
761
|
+
* Start date
|
|
762
|
+
* @minLength 1
|
|
763
|
+
*/
|
|
764
|
+
from: string
|
|
765
|
+
/**
|
|
766
|
+
* End date
|
|
767
|
+
* @minLength 1
|
|
768
|
+
*/
|
|
769
|
+
to: string
|
|
770
|
+
/** Optional instructor filter */
|
|
771
|
+
instructorID?: string | null
|
|
772
|
+
}
|
|
773
|
+
}
|
|
774
|
+
|
|
775
|
+
export interface SessionResultsReportSchema {
|
|
776
|
+
filters: {
|
|
777
|
+
/**
|
|
778
|
+
* Start date
|
|
779
|
+
* @minLength 1
|
|
780
|
+
*/
|
|
781
|
+
dateFrom: string
|
|
782
|
+
/**
|
|
783
|
+
* End date
|
|
784
|
+
* @minLength 1
|
|
785
|
+
*/
|
|
786
|
+
dateTo: string
|
|
787
|
+
/** Optional course IDs filter */
|
|
788
|
+
courseIDs?: any
|
|
789
|
+
/** Optional pagination from */
|
|
790
|
+
from?: any
|
|
791
|
+
}
|
|
792
|
+
}
|
|
793
|
+
|
|
794
|
+
export interface SessionListReportSchema {
|
|
795
|
+
filters: {
|
|
796
|
+
/**
|
|
797
|
+
* Start date
|
|
798
|
+
* @minLength 1
|
|
799
|
+
*/
|
|
800
|
+
from: string
|
|
801
|
+
/**
|
|
802
|
+
* End date
|
|
803
|
+
* @minLength 1
|
|
804
|
+
*/
|
|
805
|
+
to: string
|
|
806
|
+
/** Optional course filter */
|
|
807
|
+
courseID?: string | null
|
|
808
|
+
/** Optional instructor filter */
|
|
809
|
+
instructorID?: string | null
|
|
810
|
+
/** Optional state filter */
|
|
811
|
+
state?: string | null
|
|
812
|
+
}
|
|
813
|
+
}
|
|
814
|
+
|
|
815
|
+
export enum SessionCourseTemplateCreateSchemaReleaseTypeEnum {
|
|
816
|
+
NONE = 'NONE',
|
|
817
|
+
AUTO = 'AUTO',
|
|
818
|
+
MANUAL = 'MANUAL',
|
|
819
|
+
SCHEDULE = 'SCHEDULE',
|
|
820
|
+
}
|
|
821
|
+
|
|
822
|
+
export enum SessionCourseTemplateCreateSchemaHasMaterialEnum {
|
|
823
|
+
NONE = 'NONE',
|
|
824
|
+
INDIVIDUAL = 'INDIVIDUAL',
|
|
825
|
+
ALL = 'ALL',
|
|
826
|
+
}
|
|
827
|
+
|
|
828
|
+
export enum SessionCourseTemplateCreateSchemaTypeEnum {
|
|
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
|
+
|
|
837
|
+
export enum SessionCourseTemplateUpdateSchemaReleaseTypeEnum {
|
|
838
|
+
NONE = 'NONE',
|
|
839
|
+
AUTO = 'AUTO',
|
|
840
|
+
MANUAL = 'MANUAL',
|
|
841
|
+
SCHEDULE = 'SCHEDULE',
|
|
842
|
+
}
|
|
843
|
+
|
|
844
|
+
export enum SessionCourseTemplateUpdateSchemaHasMaterialEnum {
|
|
845
|
+
NONE = 'NONE',
|
|
846
|
+
INDIVIDUAL = 'INDIVIDUAL',
|
|
847
|
+
ALL = 'ALL',
|
|
848
|
+
}
|
|
849
|
+
|
|
850
|
+
export enum SessionCourseTemplateUpdateSchemaTypeEnum {
|
|
851
|
+
SCHEDULED_PRESENTIAL = 'SCHEDULED_PRESENTIAL',
|
|
852
|
+
SCHEDULED_ONLINE_EXT = 'SCHEDULED_ONLINE_EXT',
|
|
853
|
+
SCHEDULED_VILT = 'SCHEDULED_VILT',
|
|
854
|
+
SCHEDULED_WEBINAR = 'SCHEDULED_WEBINAR',
|
|
855
|
+
ONLINE_EXT = 'ONLINE_EXT',
|
|
856
|
+
ONLINE = 'ONLINE',
|
|
857
|
+
}
|
|
858
|
+
|
|
859
|
+
export enum SessionCreateSchemaReleaseTypeEnum {
|
|
860
|
+
NONE = 'NONE',
|
|
861
|
+
AUTO = 'AUTO',
|
|
862
|
+
MANUAL = 'MANUAL',
|
|
863
|
+
SCHEDULE = 'SCHEDULE',
|
|
864
|
+
}
|
|
865
|
+
|
|
866
|
+
export enum SessionCreateSchemaHasMaterialEnum {
|
|
867
|
+
NONE = 'NONE',
|
|
868
|
+
INDIVIDUAL = 'INDIVIDUAL',
|
|
869
|
+
ALL = 'ALL',
|
|
870
|
+
}
|
|
871
|
+
|
|
872
|
+
export enum SessionCreateSchemaTypeEnum {
|
|
873
|
+
SCHEDULED_PRESENTIAL = 'SCHEDULED_PRESENTIAL',
|
|
874
|
+
SCHEDULED_ONLINE_EXT = 'SCHEDULED_ONLINE_EXT',
|
|
875
|
+
SCHEDULED_VILT = 'SCHEDULED_VILT',
|
|
876
|
+
SCHEDULED_WEBINAR = 'SCHEDULED_WEBINAR',
|
|
877
|
+
ONLINE_EXT = 'ONLINE_EXT',
|
|
878
|
+
ONLINE = 'ONLINE',
|
|
879
|
+
}
|
|
880
|
+
|
|
881
|
+
export enum SessionUpdateSchemaReleaseTypeEnum {
|
|
882
|
+
NONE = 'NONE',
|
|
883
|
+
AUTO = 'AUTO',
|
|
884
|
+
MANUAL = 'MANUAL',
|
|
885
|
+
SCHEDULE = 'SCHEDULE',
|
|
886
|
+
}
|
|
887
|
+
|
|
888
|
+
export enum SessionUpdateSchemaHasMaterialEnum {
|
|
889
|
+
NONE = 'NONE',
|
|
890
|
+
INDIVIDUAL = 'INDIVIDUAL',
|
|
891
|
+
ALL = 'ALL',
|
|
892
|
+
}
|
|
893
|
+
|
|
894
|
+
export enum SessionUpdateSchemaTypeEnum {
|
|
895
|
+
SCHEDULED_PRESENTIAL = 'SCHEDULED_PRESENTIAL',
|
|
896
|
+
SCHEDULED_ONLINE_EXT = 'SCHEDULED_ONLINE_EXT',
|
|
897
|
+
SCHEDULED_VILT = 'SCHEDULED_VILT',
|
|
898
|
+
SCHEDULED_WEBINAR = 'SCHEDULED_WEBINAR',
|
|
899
|
+
ONLINE_EXT = 'ONLINE_EXT',
|
|
900
|
+
ONLINE = 'ONLINE',
|
|
901
|
+
}
|
|
902
|
+
|
|
903
|
+
export enum InputQ59Gbvuj7GAttendanceStatusEnum {
|
|
904
|
+
INCOMPLETE = 'INCOMPLETE',
|
|
905
|
+
NO_SHOW = 'NO_SHOW',
|
|
906
|
+
ATTENDED = 'ATTENDED',
|
|
907
|
+
}
|
|
908
|
+
|
|
909
|
+
export enum Input5S9QlxsfdwAttendanceStatusEnum {
|
|
910
|
+
INCOMPLETE = 'INCOMPLETE',
|
|
911
|
+
NO_SHOW = 'NO_SHOW',
|
|
912
|
+
ATTENDED = 'ATTENDED',
|
|
913
|
+
}
|
|
914
|
+
|
|
915
|
+
export enum Input56A08Qop2CChargeResultEnum {
|
|
916
|
+
SUCCESS = 'SUCCESS',
|
|
917
|
+
FAIL = 'FAIL',
|
|
918
|
+
}
|
|
919
|
+
|
|
920
|
+
export enum InputHuw5M2U5GxResultStatusEnum {
|
|
921
|
+
INCOMPLETE = 'INCOMPLETE',
|
|
922
|
+
FAIL = 'FAIL',
|
|
923
|
+
PASS = 'PASS',
|
|
924
|
+
}
|
|
925
|
+
|
|
926
|
+
export enum InputXxwuna2NnResultStatusEnum {
|
|
927
|
+
INCOMPLETE = 'INCOMPLETE',
|
|
928
|
+
FAIL = 'FAIL',
|
|
929
|
+
PASS = 'PASS',
|
|
930
|
+
}
|
|
931
|
+
|
|
932
|
+
/** Instructor type */
|
|
933
|
+
export enum SessionInstructorSchemaInstructorTypeEnum {
|
|
934
|
+
PRIMARY = 'PRIMARY',
|
|
935
|
+
SECONDARY = 'SECONDARY',
|
|
936
|
+
}
|
|
937
|
+
|
|
938
|
+
/** Instructor type */
|
|
939
|
+
export enum SessionsInstructorSetSchemaInstructorTypeEnum {
|
|
940
|
+
PRIMARY = 'PRIMARY',
|
|
941
|
+
SECONDARY = 'SECONDARY',
|
|
942
|
+
}
|
|
943
|
+
|
|
944
|
+
export enum SessionBatchUpdateSchemaAttendanceStatusEnum {
|
|
945
|
+
INCOMPLETE = 'INCOMPLETE',
|
|
946
|
+
NO_SHOW = 'NO_SHOW',
|
|
947
|
+
ATTENDED = 'ATTENDED',
|
|
948
|
+
}
|
|
949
|
+
|
|
950
|
+
export enum SessionBatchUpdateSchemaResultStatusEnum {
|
|
951
|
+
INCOMPLETE = 'INCOMPLETE',
|
|
952
|
+
FAIL = 'FAIL',
|
|
953
|
+
PASS = 'PASS',
|
|
954
|
+
}
|
|
955
|
+
|
|
956
|
+
export type GetRegionData = any
|
|
957
|
+
|
|
958
|
+
export type GetRegionError = ErrorResponse
|
|
959
|
+
|
|
960
|
+
export type CreateRegionData = any
|
|
961
|
+
|
|
962
|
+
export type CreateRegionError = ErrorResponse
|
|
963
|
+
|
|
964
|
+
export type UpdateRegionData = any
|
|
965
|
+
|
|
966
|
+
export type UpdateRegionError = ErrorResponse
|
|
967
|
+
|
|
968
|
+
export type DeleteRegionData = any
|
|
969
|
+
|
|
970
|
+
export type DeleteRegionError = ErrorResponse
|
|
971
|
+
|
|
972
|
+
export type ListRegionsData = any
|
|
973
|
+
|
|
974
|
+
export type ListRegionsError = ErrorResponse
|
|
975
|
+
|
|
976
|
+
export type GetCityData = any
|
|
977
|
+
|
|
978
|
+
export type GetCityError = ErrorResponse
|
|
979
|
+
|
|
980
|
+
export type CreateCityData = any
|
|
981
|
+
|
|
982
|
+
export type CreateCityError = ErrorResponse
|
|
983
|
+
|
|
984
|
+
export type UpdateCityData = any
|
|
985
|
+
|
|
986
|
+
export type UpdateCityError = ErrorResponse
|
|
987
|
+
|
|
988
|
+
export type DeleteCityData = any
|
|
989
|
+
|
|
990
|
+
export type DeleteCityError = ErrorResponse
|
|
991
|
+
|
|
992
|
+
export type ListCitiesData = any
|
|
993
|
+
|
|
994
|
+
export type ListCitiesError = ErrorResponse
|
|
995
|
+
|
|
996
|
+
export type GetVenueData = any
|
|
997
|
+
|
|
998
|
+
export type GetVenueError = ErrorResponse
|
|
999
|
+
|
|
1000
|
+
export type CreateVenueData = any
|
|
1001
|
+
|
|
1002
|
+
export type CreateVenueError = ErrorResponse
|
|
1003
|
+
|
|
1004
|
+
export type UpdateVenueData = any
|
|
1005
|
+
|
|
1006
|
+
export type UpdateVenueError = ErrorResponse
|
|
1007
|
+
|
|
1008
|
+
export type DeleteVenueData = any
|
|
1009
|
+
|
|
1010
|
+
export type DeleteVenueError = ErrorResponse
|
|
1011
|
+
|
|
1012
|
+
export type ListVenuesData = any
|
|
1013
|
+
|
|
1014
|
+
export type ListVenuesError = ErrorResponse
|
|
1015
|
+
|
|
1016
|
+
export type GetInstructorData = any
|
|
1017
|
+
|
|
1018
|
+
export type GetInstructorError = ErrorResponse
|
|
1019
|
+
|
|
1020
|
+
export type CreateInstructorData = any
|
|
1021
|
+
|
|
1022
|
+
export type CreateInstructorError = ErrorResponse
|
|
1023
|
+
|
|
1024
|
+
export type UpdateInstructorData = any
|
|
1025
|
+
|
|
1026
|
+
export type UpdateInstructorError = ErrorResponse
|
|
1027
|
+
|
|
1028
|
+
export type DeleteInstructorData = any
|
|
1029
|
+
|
|
1030
|
+
export type DeleteInstructorError = ErrorResponse
|
|
1031
|
+
|
|
1032
|
+
export type ListInstructorsData = any
|
|
1033
|
+
|
|
1034
|
+
export type ListInstructorsError = ErrorResponse
|
|
1035
|
+
|
|
1036
|
+
export type GetCourseData = any
|
|
1037
|
+
|
|
1038
|
+
export type GetCourseError = ErrorResponse
|
|
1039
|
+
|
|
1040
|
+
export type CreateCourseData = any
|
|
1041
|
+
|
|
1042
|
+
export type CreateCourseError = ErrorResponse
|
|
1043
|
+
|
|
1044
|
+
export type GetRegionResult = any
|
|
1045
|
+
|
|
1046
|
+
export type GetRegionFail = ErrorResponse
|
|
1047
|
+
|
|
1048
|
+
export type CreateRegionResult = any
|
|
1049
|
+
|
|
1050
|
+
export type CreateRegionFail = ErrorResponse
|
|
1051
|
+
|
|
1052
|
+
export type ListEventsData = any
|
|
1053
|
+
|
|
1054
|
+
export type ListEventsError = ErrorResponse
|
|
1055
|
+
|
|
1056
|
+
export type GetAvailabilityEventData = any
|
|
1057
|
+
|
|
1058
|
+
export type GetAvailabilityEventError = ErrorResponse
|
|
1059
|
+
|
|
1060
|
+
export type CreateAvailabilityEventData = any
|
|
1061
|
+
|
|
1062
|
+
export type CreateAvailabilityEventError = ErrorResponse
|
|
1063
|
+
|
|
1064
|
+
export type UpdateAvailabilityEventData = any
|
|
1065
|
+
|
|
1066
|
+
export type UpdateAvailabilityEventError = ErrorResponse
|
|
1067
|
+
|
|
1068
|
+
export type DeleteAvailabilityEventData = any
|
|
1069
|
+
|
|
1070
|
+
export type DeleteAvailabilityEventError = ErrorResponse
|
|
1071
|
+
|
|
1072
|
+
export type GetCalendarSyncData = any
|
|
1073
|
+
|
|
1074
|
+
export type GetCalendarSyncError = ErrorResponse
|
|
1075
|
+
|
|
1076
|
+
export type CreateCalendarSyncData = any
|
|
1077
|
+
|
|
1078
|
+
export type CreateCalendarSyncError = ErrorResponse
|
|
1079
|
+
|
|
1080
|
+
export type UpdateCalendarSyncData = any
|
|
1081
|
+
|
|
1082
|
+
export type UpdateCalendarSyncError = ErrorResponse
|
|
1083
|
+
|
|
1084
|
+
export type DeleteCalendarSyncData = any
|
|
1085
|
+
|
|
1086
|
+
export type DeleteCalendarSyncError = ErrorResponse
|
|
1087
|
+
|
|
1088
|
+
export type GetCalendarSyncsData = any
|
|
1089
|
+
|
|
1090
|
+
export type GetCalendarSyncsError = ErrorResponse
|
|
1091
|
+
|
|
1092
|
+
export type GetCalendarData = any
|
|
1093
|
+
|
|
1094
|
+
export type GetCalendarError = ErrorResponse
|
|
1095
|
+
|
|
1096
|
+
export type UpdateCalendarData = any
|
|
1097
|
+
|
|
1098
|
+
export type UpdateCalendarError = ErrorResponse
|
|
1099
|
+
|
|
1100
|
+
export type GetCalendarSyncResult = any
|
|
1101
|
+
|
|
1102
|
+
export type GetCalendarSyncFail = ErrorResponse
|
|
1103
|
+
|
|
1104
|
+
export type CreateCalendarSyncResult = any
|
|
1105
|
+
|
|
1106
|
+
export type CreateCalendarSyncFail = ErrorResponse
|
|
1107
|
+
|
|
1108
|
+
export type UpdateCalendarSyncResult = any
|
|
1109
|
+
|
|
1110
|
+
export type UpdateCalendarSyncFail = ErrorResponse
|
|
1111
|
+
|
|
1112
|
+
export type DeleteCalendarSyncResult = any
|
|
1113
|
+
|
|
1114
|
+
export type DeleteCalendarSyncFail = ErrorResponse
|
|
1115
|
+
|
|
1116
|
+
export type ListCalendarSyncsData = any
|
|
1117
|
+
|
|
1118
|
+
export type ListCalendarSyncsError = ErrorResponse
|
|
1119
|
+
|
|
1120
|
+
export type GetStudentTicketData = any
|
|
1121
|
+
|
|
1122
|
+
export type GetStudentTicketError = ErrorResponse
|
|
1123
|
+
|
|
1124
|
+
export type CreateStudentTicketData = any
|
|
1125
|
+
|
|
1126
|
+
export type CreateStudentTicketError = ErrorResponse
|
|
1127
|
+
|
|
1128
|
+
export type DeleteStudentTicketData = any
|
|
1129
|
+
|
|
1130
|
+
export type DeleteStudentTicketError = ErrorResponse
|
|
1131
|
+
|
|
1132
|
+
export type GetTemplateData = any
|
|
1133
|
+
|
|
1134
|
+
export type GetTemplateError = ErrorResponse
|
|
1135
|
+
|
|
1136
|
+
export type CreateTemplateData = any
|
|
1137
|
+
|
|
1138
|
+
export type CreateTemplateError = ErrorResponse
|
|
1139
|
+
|
|
1140
|
+
export type UpdateTemplateData = any
|
|
1141
|
+
|
|
1142
|
+
export type UpdateTemplateError = ErrorResponse
|
|
1143
|
+
|
|
1144
|
+
export type DeleteTemplateData = any
|
|
1145
|
+
|
|
1146
|
+
export type DeleteTemplateError = ErrorResponse
|
|
1147
|
+
|
|
1148
|
+
export type ListTemplatesData = any
|
|
1149
|
+
|
|
1150
|
+
export type ListTemplatesError = ErrorResponse
|
|
1151
|
+
|
|
1152
|
+
export type ListCoursesData = any
|
|
1153
|
+
|
|
1154
|
+
export type ListCoursesError = ErrorResponse
|
|
1155
|
+
|
|
1156
|
+
export type ListLocationsData = any
|
|
1157
|
+
|
|
1158
|
+
export type ListLocationsError = ErrorResponse
|
|
1159
|
+
|
|
1160
|
+
export type ListSessionsIdsData = any
|
|
1161
|
+
|
|
1162
|
+
export type ListSessionsIdsError = ErrorResponse
|
|
1163
|
+
|
|
1164
|
+
export type GetSessionData = any
|
|
1165
|
+
|
|
1166
|
+
export type GetSessionError = ErrorResponse
|
|
1167
|
+
|
|
1168
|
+
export type CreateSessionData = any
|
|
1169
|
+
|
|
1170
|
+
export type CreateSessionError = ErrorResponse
|
|
1171
|
+
|
|
1172
|
+
export type UpdateSessionData = any
|
|
1173
|
+
|
|
1174
|
+
export type UpdateSessionError = ErrorResponse
|
|
1175
|
+
|
|
1176
|
+
export type DeleteSessionData = any
|
|
1177
|
+
|
|
1178
|
+
export type DeleteSessionError = ErrorResponse
|
|
1179
|
+
|
|
1180
|
+
export type CreateNextData = any
|
|
1181
|
+
|
|
1182
|
+
export type CreateNextError = ErrorResponse
|
|
1183
|
+
|
|
1184
|
+
export type CreateCancelData = any
|
|
1185
|
+
|
|
1186
|
+
export type CreateCancelError = ErrorResponse
|
|
1187
|
+
|
|
1188
|
+
export type CreateLockData = any
|
|
1189
|
+
|
|
1190
|
+
export type CreateLockError = ErrorResponse
|
|
1191
|
+
|
|
1192
|
+
export type CreateUnlockData = any
|
|
1193
|
+
|
|
1194
|
+
export type CreateUnlockError = ErrorResponse
|
|
1195
|
+
|
|
1196
|
+
export type CreatePublishData = any
|
|
1197
|
+
|
|
1198
|
+
export type CreatePublishError = ErrorResponse
|
|
1199
|
+
|
|
1200
|
+
export type CreateReleaseData = any
|
|
1201
|
+
|
|
1202
|
+
export type CreateReleaseError = ErrorResponse
|
|
1203
|
+
|
|
1204
|
+
export type CreateRefreshShippingData = any
|
|
1205
|
+
|
|
1206
|
+
export type CreateRefreshShippingError = ErrorResponse
|
|
1207
|
+
|
|
1208
|
+
export type CreateCourseMaterialData = any
|
|
1209
|
+
|
|
1210
|
+
export type CreateCourseMaterialError = ErrorResponse
|
|
1211
|
+
|
|
1212
|
+
export type CreateDuplicateData = any
|
|
1213
|
+
|
|
1214
|
+
export type CreateDuplicateError = ErrorResponse
|
|
1215
|
+
|
|
1216
|
+
export type CreateMoveStudentData = any
|
|
1217
|
+
|
|
1218
|
+
export type CreateMoveStudentError = ErrorResponse
|
|
1219
|
+
|
|
1220
|
+
export type GetAttendancesData = any
|
|
1221
|
+
|
|
1222
|
+
export type GetAttendancesError = ErrorResponse
|
|
1223
|
+
|
|
1224
|
+
export type GetEnrolmentsData = any
|
|
1225
|
+
|
|
1226
|
+
export type GetEnrolmentsError = ErrorResponse
|
|
1227
|
+
|
|
1228
|
+
export type GetResultsData = any
|
|
1229
|
+
|
|
1230
|
+
export type GetResultsError = ErrorResponse
|
|
1231
|
+
|
|
1232
|
+
export type GetInvitationsData = any
|
|
1233
|
+
|
|
1234
|
+
export type GetInvitationsError = ErrorResponse
|
|
1235
|
+
|
|
1236
|
+
export type GetChargesData = any
|
|
1237
|
+
|
|
1238
|
+
export type GetChargesError = ErrorResponse
|
|
1239
|
+
|
|
1240
|
+
export type GetAttendanceData = any
|
|
1241
|
+
|
|
1242
|
+
export type GetAttendanceError = ErrorResponse
|
|
1243
|
+
|
|
1244
|
+
export type CreateAttendanceData = any
|
|
1245
|
+
|
|
1246
|
+
export type CreateAttendanceError = ErrorResponse
|
|
1247
|
+
|
|
1248
|
+
export type UpdateAttendanceData = any
|
|
1249
|
+
|
|
1250
|
+
export type UpdateAttendanceError = ErrorResponse
|
|
1251
|
+
|
|
1252
|
+
export type DeleteAttendanceData = any
|
|
1253
|
+
|
|
1254
|
+
export type DeleteAttendanceError = ErrorResponse
|
|
1255
|
+
|
|
1256
|
+
export type GetEnrolmentData = any
|
|
1257
|
+
|
|
1258
|
+
export type GetEnrolmentError = ErrorResponse
|
|
1259
|
+
|
|
1260
|
+
export type CreateEnrolmentData = any
|
|
1261
|
+
|
|
1262
|
+
export type CreateEnrolmentError = ErrorResponse
|
|
1263
|
+
|
|
1264
|
+
export type UpdateEnrolmentData = any
|
|
1265
|
+
|
|
1266
|
+
export type UpdateEnrolmentError = ErrorResponse
|
|
1267
|
+
|
|
1268
|
+
export type DeleteEnrolmentData = any
|
|
1269
|
+
|
|
1270
|
+
export type DeleteEnrolmentError = ErrorResponse
|
|
1271
|
+
|
|
1272
|
+
export type GetEnrolment2Data = any
|
|
1273
|
+
|
|
1274
|
+
export type GetEnrolment2Error = ErrorResponse
|
|
1275
|
+
|
|
1276
|
+
export type CreateEnrolmentReleaseData = any
|
|
1277
|
+
|
|
1278
|
+
export type CreateEnrolmentReleaseError = ErrorResponse
|
|
1279
|
+
|
|
1280
|
+
export type CreateEnrolmentCancelData = any
|
|
1281
|
+
|
|
1282
|
+
export type CreateEnrolmentCancelError = ErrorResponse
|
|
1283
|
+
|
|
1284
|
+
export type CreateEnrolmentLaunchData = any
|
|
1285
|
+
|
|
1286
|
+
export type CreateEnrolmentLaunchError = ErrorResponse
|
|
1287
|
+
|
|
1288
|
+
export type CreateEnrolmentCheckResultData = any
|
|
1289
|
+
|
|
1290
|
+
export type CreateEnrolmentCheckResultError = ErrorResponse
|
|
1291
|
+
|
|
1292
|
+
export type CreateEnrolmentChargeData = any
|
|
1293
|
+
|
|
1294
|
+
export type CreateEnrolmentChargeError = ErrorResponse
|
|
1295
|
+
|
|
1296
|
+
export type GetResultData = any
|
|
1297
|
+
|
|
1298
|
+
export type GetResultError = ErrorResponse
|
|
1299
|
+
|
|
1300
|
+
export type CreateResultData = any
|
|
1301
|
+
|
|
1302
|
+
export type CreateResultError = ErrorResponse
|
|
1303
|
+
|
|
1304
|
+
export type UpdateResultData = any
|
|
1305
|
+
|
|
1306
|
+
export type UpdateResultError = ErrorResponse
|
|
1307
|
+
|
|
1308
|
+
export type DeleteResultData = any
|
|
1309
|
+
|
|
1310
|
+
export type DeleteResultError = ErrorResponse
|
|
1311
|
+
|
|
1312
|
+
export type CreateResultPublishData = any
|
|
1313
|
+
|
|
1314
|
+
export type CreateResultPublishError = ErrorResponse
|
|
1315
|
+
|
|
1316
|
+
export type GetInstructorResult = any
|
|
1317
|
+
|
|
1318
|
+
export type GetInstructorFail = ErrorResponse
|
|
1319
|
+
|
|
1320
|
+
export type CreateInstructorResult = any
|
|
1321
|
+
|
|
1322
|
+
export type CreateInstructorFail = ErrorResponse
|
|
1323
|
+
|
|
1324
|
+
export type UpdateInstructorResult = any
|
|
1325
|
+
|
|
1326
|
+
export type UpdateInstructorFail = ErrorResponse
|
|
1327
|
+
|
|
1328
|
+
export type DeleteInstructorResult = any
|
|
1329
|
+
|
|
1330
|
+
export type DeleteInstructorFail = ErrorResponse
|
|
1331
|
+
|
|
1332
|
+
export type CreateInstructorOutput = any
|
|
1333
|
+
|
|
1334
|
+
export type CreateInstructorFails = ErrorResponse
|
|
1335
|
+
|
|
1336
|
+
export type GetInvitationData = any
|
|
1337
|
+
|
|
1338
|
+
export type GetInvitationError = ErrorResponse
|
|
1339
|
+
|
|
1340
|
+
export type CreateInvitationData = any
|
|
1341
|
+
|
|
1342
|
+
export type CreateInvitationError = ErrorResponse
|
|
1343
|
+
|
|
1344
|
+
export type UpdateInvitationData = any
|
|
1345
|
+
|
|
1346
|
+
export type UpdateInvitationError = ErrorResponse
|
|
1347
|
+
|
|
1348
|
+
export type DeleteInvitationData = any
|
|
1349
|
+
|
|
1350
|
+
export type DeleteInvitationError = ErrorResponse
|
|
1351
|
+
|
|
1352
|
+
export type GetInvitationValidateData = any
|
|
1353
|
+
|
|
1354
|
+
export type GetInvitationValidateError = ErrorResponse
|
|
1355
|
+
|
|
1356
|
+
export type GetChargeData = any
|
|
1357
|
+
|
|
1358
|
+
export type GetChargeError = ErrorResponse
|
|
1359
|
+
|
|
1360
|
+
export type GetDocumentFileSignData = any
|
|
1361
|
+
|
|
1362
|
+
export type GetDocumentFileSignError = ErrorResponse
|
|
1363
|
+
|
|
1364
|
+
export type CreateDocumentFileSignData = any
|
|
1365
|
+
|
|
1366
|
+
export type CreateDocumentFileSignError = ErrorResponse
|
|
1367
|
+
|
|
1368
|
+
export type DeleteDocumentFileSignData = any
|
|
1369
|
+
|
|
1370
|
+
export type DeleteDocumentFileSignError = ErrorResponse
|
|
1371
|
+
|
|
1372
|
+
export type CreateDocumentData = any
|
|
1373
|
+
|
|
1374
|
+
export type CreateDocumentError = ErrorResponse
|
|
1375
|
+
|
|
1376
|
+
export type DeleteDocumentData = any
|
|
1377
|
+
|
|
1378
|
+
export type DeleteDocumentError = ErrorResponse
|
|
1379
|
+
|
|
1380
|
+
export type CreateAttendancesResultsBatchUpsertData = any
|
|
1381
|
+
|
|
1382
|
+
export type CreateAttendancesResultsBatchUpsertError = ErrorResponse
|
|
1383
|
+
|
|
1384
|
+
export type GetUserDataData = any
|
|
1385
|
+
|
|
1386
|
+
export type GetUserDataError = ErrorResponse
|
|
1387
|
+
|
|
1388
|
+
export type ListEventsResult = any
|
|
1389
|
+
|
|
1390
|
+
export type ListEventsFail = ErrorResponse
|
|
1391
|
+
|
|
1392
|
+
export type ListEvents2Data = any
|
|
1393
|
+
|
|
1394
|
+
export type ListEvents2Error = ErrorResponse
|
|
1395
|
+
|
|
1396
|
+
export type ListSessionEventsData = any
|
|
1397
|
+
|
|
1398
|
+
export type ListSessionEventsError = ErrorResponse
|
|
1399
|
+
|
|
1400
|
+
export type CreateEnrolmentsPerPeriodData = any
|
|
1401
|
+
|
|
1402
|
+
export type CreateEnrolmentsPerPeriodError = ErrorResponse
|
|
1403
|
+
|
|
1404
|
+
export type ListSessionResultsAnalysisData = any
|
|
1405
|
+
|
|
1406
|
+
export type ListSessionResultsAnalysisError = ErrorResponse
|
|
1407
|
+
|
|
1408
|
+
export type CreateSessionResultsPreviewData = any
|
|
1409
|
+
|
|
1410
|
+
export type CreateSessionResultsPreviewError = ErrorResponse
|
|
1411
|
+
|
|
1412
|
+
export type ListSessionResultsData = any
|
|
1413
|
+
|
|
1414
|
+
export type ListSessionResultsError = ErrorResponse
|
|
1415
|
+
|
|
1416
|
+
export type CreateSessionListData = any
|
|
1417
|
+
|
|
1418
|
+
export type CreateSessionListError = ErrorResponse
|
|
1419
|
+
|
|
1420
|
+
export type ListSessionChargesData = any
|
|
1421
|
+
|
|
1422
|
+
export type ListSessionChargesError = ErrorResponse
|
|
1423
|
+
|
|
1424
|
+
export type CreateSessionShippingManifestData = any
|
|
1425
|
+
|
|
1426
|
+
export type CreateSessionShippingManifestError = ErrorResponse
|
|
1427
|
+
|
|
1428
|
+
import type { AxiosInstance, AxiosRequestConfig, HeadersDefaults, ResponseType } from 'axios'
|
|
1429
|
+
import axios from 'axios'
|
|
1430
|
+
|
|
1431
|
+
export type QueryParamsType = Record<string | number, any>
|
|
1432
|
+
|
|
1433
|
+
export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
|
|
1434
|
+
/** set parameter to `true` for call `securityWorker` for this request */
|
|
1435
|
+
secure?: boolean
|
|
1436
|
+
/** request path */
|
|
1437
|
+
path: string
|
|
1438
|
+
/** content type of request body */
|
|
1439
|
+
type?: ContentType
|
|
1440
|
+
/** query params */
|
|
1441
|
+
query?: QueryParamsType
|
|
1442
|
+
/** format of response (i.e. response.json() -> format: "json") */
|
|
1443
|
+
format?: ResponseType
|
|
1444
|
+
/** request body */
|
|
1445
|
+
body?: unknown
|
|
1446
|
+
}
|
|
1447
|
+
|
|
1448
|
+
export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>
|
|
1449
|
+
|
|
1450
|
+
export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, 'data' | 'cancelToken'> {
|
|
1451
|
+
securityWorker?: (
|
|
1452
|
+
securityData: SecurityDataType | null
|
|
1453
|
+
) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void
|
|
1454
|
+
secure?: boolean
|
|
1455
|
+
format?: ResponseType
|
|
1456
|
+
}
|
|
1457
|
+
|
|
1458
|
+
export enum ContentType {
|
|
1459
|
+
Json = 'application/json',
|
|
1460
|
+
FormData = 'multipart/form-data',
|
|
1461
|
+
UrlEncoded = 'application/x-www-form-urlencoded',
|
|
1462
|
+
Text = 'text/plain',
|
|
1463
|
+
}
|
|
1464
|
+
|
|
1465
|
+
export class HttpClient<SecurityDataType = unknown> {
|
|
1466
|
+
public instance: AxiosInstance
|
|
1467
|
+
private securityData: SecurityDataType | null = null
|
|
1468
|
+
private securityWorker?: ApiConfig<SecurityDataType>['securityWorker']
|
|
1469
|
+
private secure?: boolean
|
|
1470
|
+
private format?: ResponseType
|
|
1471
|
+
|
|
1472
|
+
constructor({ securityWorker, secure, format, ...axiosConfig }: ApiConfig<SecurityDataType> = {}) {
|
|
1473
|
+
this.instance = axios.create({ ...axiosConfig, baseURL: axiosConfig.baseURL || 'http://localhost:8080' })
|
|
1474
|
+
this.secure = secure
|
|
1475
|
+
this.format = format
|
|
1476
|
+
this.securityWorker = securityWorker
|
|
1477
|
+
}
|
|
1478
|
+
|
|
1479
|
+
public setSecurityData = (data: SecurityDataType | null) => {
|
|
1480
|
+
this.securityData = data
|
|
1481
|
+
}
|
|
1482
|
+
|
|
1483
|
+
protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig {
|
|
1484
|
+
const method = params1.method || (params2 && params2.method)
|
|
1485
|
+
|
|
1486
|
+
return {
|
|
1487
|
+
...this.instance.defaults,
|
|
1488
|
+
...params1,
|
|
1489
|
+
...(params2 || {}),
|
|
1490
|
+
headers: {
|
|
1491
|
+
...((method && this.instance.defaults.headers[method.toLowerCase() as keyof HeadersDefaults]) || {}),
|
|
1492
|
+
...(params1.headers || {}),
|
|
1493
|
+
...((params2 && params2.headers) || {}),
|
|
1494
|
+
},
|
|
1495
|
+
}
|
|
1496
|
+
}
|
|
1497
|
+
|
|
1498
|
+
protected stringifyFormItem(formItem: unknown) {
|
|
1499
|
+
if (typeof formItem === 'object' && formItem !== null) {
|
|
1500
|
+
return JSON.stringify(formItem)
|
|
1501
|
+
} else {
|
|
1502
|
+
return `${formItem}`
|
|
1503
|
+
}
|
|
1504
|
+
}
|
|
1505
|
+
|
|
1506
|
+
protected createFormData(input: Record<string, unknown>): FormData {
|
|
1507
|
+
if (input instanceof FormData) {
|
|
1508
|
+
return input
|
|
1509
|
+
}
|
|
1510
|
+
return Object.keys(input || {}).reduce((formData, key) => {
|
|
1511
|
+
const property = input[key]
|
|
1512
|
+
const propertyContent: any[] = property instanceof Array ? property : [property]
|
|
1513
|
+
|
|
1514
|
+
for (const formItem of propertyContent) {
|
|
1515
|
+
const isFileType = formItem instanceof Blob || formItem instanceof File
|
|
1516
|
+
formData.append(key, isFileType ? formItem : this.stringifyFormItem(formItem))
|
|
1517
|
+
}
|
|
1518
|
+
|
|
1519
|
+
return formData
|
|
1520
|
+
}, new FormData())
|
|
1521
|
+
}
|
|
1522
|
+
|
|
1523
|
+
public request = async <T = any, _E = any>({
|
|
1524
|
+
secure,
|
|
1525
|
+
path,
|
|
1526
|
+
type,
|
|
1527
|
+
query,
|
|
1528
|
+
format,
|
|
1529
|
+
body,
|
|
1530
|
+
...params
|
|
1531
|
+
}: FullRequestParams): Promise<T> => {
|
|
1532
|
+
const secureParams =
|
|
1533
|
+
((typeof secure === 'boolean' ? secure : this.secure) &&
|
|
1534
|
+
this.securityWorker &&
|
|
1535
|
+
(await this.securityWorker(this.securityData))) ||
|
|
1536
|
+
{}
|
|
1537
|
+
const requestParams = this.mergeRequestParams(params, secureParams)
|
|
1538
|
+
const responseFormat = format || this.format || undefined
|
|
1539
|
+
|
|
1540
|
+
if (type === ContentType.FormData && body && body !== null && typeof body === 'object') {
|
|
1541
|
+
body = this.createFormData(body as Record<string, unknown>)
|
|
1542
|
+
}
|
|
1543
|
+
|
|
1544
|
+
if (type === ContentType.Text && body && body !== null && typeof body !== 'string') {
|
|
1545
|
+
body = JSON.stringify(body)
|
|
1546
|
+
}
|
|
1547
|
+
|
|
1548
|
+
return this.instance
|
|
1549
|
+
.request({
|
|
1550
|
+
...requestParams,
|
|
1551
|
+
headers: {
|
|
1552
|
+
...(requestParams.headers || {}),
|
|
1553
|
+
...(type ? { 'Content-Type': type } : {}),
|
|
1554
|
+
},
|
|
1555
|
+
params: query,
|
|
1556
|
+
responseType: responseFormat,
|
|
1557
|
+
data: body,
|
|
1558
|
+
url: path,
|
|
1559
|
+
})
|
|
1560
|
+
.then(response => response.data)
|
|
1561
|
+
}
|
|
1562
|
+
}
|
|
1563
|
+
|
|
1564
|
+
/**
|
|
1565
|
+
* @title Classroom Module API
|
|
1566
|
+
* @version 2.0.0
|
|
1567
|
+
* @baseUrl http://localhost:8080
|
|
1568
|
+
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
1569
|
+
*/
|
|
1570
|
+
export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
|
|
1571
|
+
region = {
|
|
1572
|
+
/**
|
|
1573
|
+
* @description Retrieve a region by ID
|
|
1574
|
+
*
|
|
1575
|
+
* @tags Region
|
|
1576
|
+
* @name GetRegion
|
|
1577
|
+
* @summary Get Region
|
|
1578
|
+
* @request GET:/region/{regionID}
|
|
1579
|
+
* @secure
|
|
1580
|
+
*/
|
|
1581
|
+
getRegion: (regionId: string, params: RequestParams = {}) =>
|
|
1582
|
+
this.request<GetRegionData, GetRegionError>({
|
|
1583
|
+
path: `/region/${regionId}`,
|
|
1584
|
+
method: 'GET',
|
|
1585
|
+
secure: true,
|
|
1586
|
+
...params,
|
|
1587
|
+
}),
|
|
1588
|
+
|
|
1589
|
+
/**
|
|
1590
|
+
* @description Create a new region
|
|
1591
|
+
*
|
|
1592
|
+
* @tags Region
|
|
1593
|
+
* @name CreateRegion
|
|
1594
|
+
* @summary Create Region
|
|
1595
|
+
* @request POST:/region/{regionID}
|
|
1596
|
+
* @secure
|
|
1597
|
+
*/
|
|
1598
|
+
createRegion: (regionId: string, data: Input9Jxov33U7D, params: RequestParams = {}) =>
|
|
1599
|
+
this.request<CreateRegionData, CreateRegionError>({
|
|
1600
|
+
path: `/region/${regionId}`,
|
|
1601
|
+
method: 'POST',
|
|
1602
|
+
body: data,
|
|
1603
|
+
secure: true,
|
|
1604
|
+
type: ContentType.Json,
|
|
1605
|
+
...params,
|
|
1606
|
+
}),
|
|
1607
|
+
|
|
1608
|
+
/**
|
|
1609
|
+
* @description Update an existing region
|
|
1610
|
+
*
|
|
1611
|
+
* @tags Region
|
|
1612
|
+
* @name UpdateRegion
|
|
1613
|
+
* @summary Update Region
|
|
1614
|
+
* @request PUT:/region/{regionID}
|
|
1615
|
+
* @secure
|
|
1616
|
+
*/
|
|
1617
|
+
updateRegion: (regionId: string, data: InputUse5Vle8Ta, params: RequestParams = {}) =>
|
|
1618
|
+
this.request<UpdateRegionData, UpdateRegionError>({
|
|
1619
|
+
path: `/region/${regionId}`,
|
|
1620
|
+
method: 'PUT',
|
|
1621
|
+
body: data,
|
|
1622
|
+
secure: true,
|
|
1623
|
+
type: ContentType.Json,
|
|
1624
|
+
...params,
|
|
1625
|
+
}),
|
|
1626
|
+
|
|
1627
|
+
/**
|
|
1628
|
+
* @description Delete a region by ID
|
|
1629
|
+
*
|
|
1630
|
+
* @tags Region
|
|
1631
|
+
* @name DeleteRegion
|
|
1632
|
+
* @summary Delete Region
|
|
1633
|
+
* @request DELETE:/region/{regionID}
|
|
1634
|
+
* @secure
|
|
1635
|
+
*/
|
|
1636
|
+
deleteRegion: (regionId: string, params: RequestParams = {}) =>
|
|
1637
|
+
this.request<DeleteRegionData, DeleteRegionError>({
|
|
1638
|
+
path: `/region/${regionId}`,
|
|
1639
|
+
method: 'DELETE',
|
|
1640
|
+
secure: true,
|
|
1641
|
+
...params,
|
|
1642
|
+
}),
|
|
1643
|
+
}
|
|
1644
|
+
regions = {
|
|
1645
|
+
/**
|
|
1646
|
+
* @description Retrieve all regions for the current customer
|
|
1647
|
+
*
|
|
1648
|
+
* @tags Region
|
|
1649
|
+
* @name ListRegions
|
|
1650
|
+
* @summary Get All Regions
|
|
1651
|
+
* @request GET:/regions
|
|
1652
|
+
* @secure
|
|
1653
|
+
*/
|
|
1654
|
+
listRegions: (params: RequestParams = {}) =>
|
|
1655
|
+
this.request<ListRegionsData, ListRegionsError>({
|
|
1656
|
+
path: `/regions`,
|
|
1657
|
+
method: 'GET',
|
|
1658
|
+
secure: true,
|
|
1659
|
+
...params,
|
|
1660
|
+
}),
|
|
1661
|
+
}
|
|
1662
|
+
city = {
|
|
1663
|
+
/**
|
|
1664
|
+
* @description Retrieve a city by ID
|
|
1665
|
+
*
|
|
1666
|
+
* @tags City
|
|
1667
|
+
* @name GetCity
|
|
1668
|
+
* @summary Get City
|
|
1669
|
+
* @request GET:/city/{cityID}
|
|
1670
|
+
* @secure
|
|
1671
|
+
*/
|
|
1672
|
+
getCity: (cityId: string, params: RequestParams = {}) =>
|
|
1673
|
+
this.request<GetCityData, GetCityError>({
|
|
1674
|
+
path: `/city/${cityId}`,
|
|
1675
|
+
method: 'GET',
|
|
1676
|
+
secure: true,
|
|
1677
|
+
...params,
|
|
1678
|
+
}),
|
|
1679
|
+
|
|
1680
|
+
/**
|
|
1681
|
+
* @description Create a new city
|
|
1682
|
+
*
|
|
1683
|
+
* @tags City
|
|
1684
|
+
* @name CreateCity
|
|
1685
|
+
* @summary Create City
|
|
1686
|
+
* @request POST:/city/{cityID}
|
|
1687
|
+
* @secure
|
|
1688
|
+
*/
|
|
1689
|
+
createCity: (cityId: string, data: CityCreateSchema, params: RequestParams = {}) =>
|
|
1690
|
+
this.request<CreateCityData, CreateCityError>({
|
|
1691
|
+
path: `/city/${cityId}`,
|
|
1692
|
+
method: 'POST',
|
|
1693
|
+
body: data,
|
|
1694
|
+
secure: true,
|
|
1695
|
+
type: ContentType.Json,
|
|
1696
|
+
...params,
|
|
1697
|
+
}),
|
|
1698
|
+
|
|
1699
|
+
/**
|
|
1700
|
+
* @description Update an existing city
|
|
1701
|
+
*
|
|
1702
|
+
* @tags City
|
|
1703
|
+
* @name UpdateCity
|
|
1704
|
+
* @summary Update City
|
|
1705
|
+
* @request PUT:/city/{cityID}
|
|
1706
|
+
* @secure
|
|
1707
|
+
*/
|
|
1708
|
+
updateCity: (cityId: string, data: CityUpdateSchema, params: RequestParams = {}) =>
|
|
1709
|
+
this.request<UpdateCityData, UpdateCityError>({
|
|
1710
|
+
path: `/city/${cityId}`,
|
|
1711
|
+
method: 'PUT',
|
|
1712
|
+
body: data,
|
|
1713
|
+
secure: true,
|
|
1714
|
+
type: ContentType.Json,
|
|
1715
|
+
...params,
|
|
1716
|
+
}),
|
|
1717
|
+
|
|
1718
|
+
/**
|
|
1719
|
+
* @description Delete a city by ID
|
|
1720
|
+
*
|
|
1721
|
+
* @tags City
|
|
1722
|
+
* @name DeleteCity
|
|
1723
|
+
* @summary Delete City
|
|
1724
|
+
* @request DELETE:/city/{cityID}
|
|
1725
|
+
* @secure
|
|
1726
|
+
*/
|
|
1727
|
+
deleteCity: (cityId: string, params: RequestParams = {}) =>
|
|
1728
|
+
this.request<DeleteCityData, DeleteCityError>({
|
|
1729
|
+
path: `/city/${cityId}`,
|
|
1730
|
+
method: 'DELETE',
|
|
1731
|
+
secure: true,
|
|
1732
|
+
...params,
|
|
1733
|
+
}),
|
|
1734
|
+
}
|
|
1735
|
+
cities = {
|
|
1736
|
+
/**
|
|
1737
|
+
* @description Retrieve all cities for the current customer
|
|
1738
|
+
*
|
|
1739
|
+
* @tags City
|
|
1740
|
+
* @name ListCities
|
|
1741
|
+
* @summary Get All Cities
|
|
1742
|
+
* @request GET:/cities
|
|
1743
|
+
* @secure
|
|
1744
|
+
*/
|
|
1745
|
+
listCities: (params: RequestParams = {}) =>
|
|
1746
|
+
this.request<ListCitiesData, ListCitiesError>({
|
|
1747
|
+
path: `/cities`,
|
|
1748
|
+
method: 'GET',
|
|
1749
|
+
secure: true,
|
|
1750
|
+
...params,
|
|
1751
|
+
}),
|
|
1752
|
+
}
|
|
1753
|
+
venue = {
|
|
1754
|
+
/**
|
|
1755
|
+
* @description Retrieve a venue by ID
|
|
1756
|
+
*
|
|
1757
|
+
* @tags Venue
|
|
1758
|
+
* @name GetVenue
|
|
1759
|
+
* @summary Get Venue
|
|
1760
|
+
* @request GET:/venue/{venueID}
|
|
1761
|
+
* @secure
|
|
1762
|
+
*/
|
|
1763
|
+
getVenue: (venueId: string, params: RequestParams = {}) =>
|
|
1764
|
+
this.request<GetVenueData, GetVenueError>({
|
|
1765
|
+
path: `/venue/${venueId}`,
|
|
1766
|
+
method: 'GET',
|
|
1767
|
+
secure: true,
|
|
1768
|
+
...params,
|
|
1769
|
+
}),
|
|
1770
|
+
|
|
1771
|
+
/**
|
|
1772
|
+
* @description Create a new venue
|
|
1773
|
+
*
|
|
1774
|
+
* @tags Venue
|
|
1775
|
+
* @name CreateVenue
|
|
1776
|
+
* @summary Create Venue
|
|
1777
|
+
* @request POST:/venue/{venueID}
|
|
1778
|
+
* @secure
|
|
1779
|
+
*/
|
|
1780
|
+
createVenue: (venueId: string, data: VenueCreateSchema, params: RequestParams = {}) =>
|
|
1781
|
+
this.request<CreateVenueData, CreateVenueError>({
|
|
1782
|
+
path: `/venue/${venueId}`,
|
|
1783
|
+
method: 'POST',
|
|
1784
|
+
body: data,
|
|
1785
|
+
secure: true,
|
|
1786
|
+
type: ContentType.Json,
|
|
1787
|
+
...params,
|
|
1788
|
+
}),
|
|
1789
|
+
|
|
1790
|
+
/**
|
|
1791
|
+
* @description Update an existing venue
|
|
1792
|
+
*
|
|
1793
|
+
* @tags Venue
|
|
1794
|
+
* @name UpdateVenue
|
|
1795
|
+
* @summary Update Venue
|
|
1796
|
+
* @request PUT:/venue/{venueID}
|
|
1797
|
+
* @secure
|
|
1798
|
+
*/
|
|
1799
|
+
updateVenue: (venueId: string, data: VenueUpdateSchema, params: RequestParams = {}) =>
|
|
1800
|
+
this.request<UpdateVenueData, UpdateVenueError>({
|
|
1801
|
+
path: `/venue/${venueId}`,
|
|
1802
|
+
method: 'PUT',
|
|
1803
|
+
body: data,
|
|
1804
|
+
secure: true,
|
|
1805
|
+
type: ContentType.Json,
|
|
1806
|
+
...params,
|
|
1807
|
+
}),
|
|
1808
|
+
|
|
1809
|
+
/**
|
|
1810
|
+
* @description Delete a venue by ID
|
|
1811
|
+
*
|
|
1812
|
+
* @tags Venue
|
|
1813
|
+
* @name DeleteVenue
|
|
1814
|
+
* @summary Delete Venue
|
|
1815
|
+
* @request DELETE:/venue/{venueID}
|
|
1816
|
+
* @secure
|
|
1817
|
+
*/
|
|
1818
|
+
deleteVenue: (venueId: string, params: RequestParams = {}) =>
|
|
1819
|
+
this.request<DeleteVenueData, DeleteVenueError>({
|
|
1820
|
+
path: `/venue/${venueId}`,
|
|
1821
|
+
method: 'DELETE',
|
|
1822
|
+
secure: true,
|
|
1823
|
+
...params,
|
|
1824
|
+
}),
|
|
1825
|
+
}
|
|
1826
|
+
venues = {
|
|
1827
|
+
/**
|
|
1828
|
+
* @description Retrieve all venues for the current customer
|
|
1829
|
+
*
|
|
1830
|
+
* @tags Venue
|
|
1831
|
+
* @name ListVenues
|
|
1832
|
+
* @summary Get All Venues
|
|
1833
|
+
* @request GET:/venues
|
|
1834
|
+
* @secure
|
|
1835
|
+
*/
|
|
1836
|
+
listVenues: (params: RequestParams = {}) =>
|
|
1837
|
+
this.request<ListVenuesData, ListVenuesError>({
|
|
1838
|
+
path: `/venues`,
|
|
1839
|
+
method: 'GET',
|
|
1840
|
+
secure: true,
|
|
1841
|
+
...params,
|
|
1842
|
+
}),
|
|
1843
|
+
}
|
|
1844
|
+
instructor = {
|
|
1845
|
+
/**
|
|
1846
|
+
* @description Retrieve an instructor by ID with expanded details
|
|
1847
|
+
*
|
|
1848
|
+
* @tags Instructor
|
|
1849
|
+
* @name GetInstructor
|
|
1850
|
+
* @summary Get Instructor
|
|
1851
|
+
* @request GET:/instructor/{instructorID}
|
|
1852
|
+
* @secure
|
|
1853
|
+
*/
|
|
1854
|
+
getInstructor: (instructorId: string, params: RequestParams = {}) =>
|
|
1855
|
+
this.request<GetInstructorData, GetInstructorError>({
|
|
1856
|
+
path: `/instructor/${instructorId}`,
|
|
1857
|
+
method: 'GET',
|
|
1858
|
+
secure: true,
|
|
1859
|
+
...params,
|
|
1860
|
+
}),
|
|
1861
|
+
|
|
1862
|
+
/**
|
|
1863
|
+
* @description Register a user as an instructor
|
|
1864
|
+
*
|
|
1865
|
+
* @tags Instructor
|
|
1866
|
+
* @name CreateInstructor
|
|
1867
|
+
* @summary Create Instructor
|
|
1868
|
+
* @request POST:/instructor/{instructorID}
|
|
1869
|
+
* @secure
|
|
1870
|
+
*/
|
|
1871
|
+
createInstructor: (instructorId: string, data: InstructorCreateSchema, params: RequestParams = {}) =>
|
|
1872
|
+
this.request<CreateInstructorData, CreateInstructorError>({
|
|
1873
|
+
path: `/instructor/${instructorId}`,
|
|
1874
|
+
method: 'POST',
|
|
1875
|
+
body: data,
|
|
1876
|
+
secure: true,
|
|
1877
|
+
type: ContentType.Json,
|
|
1878
|
+
...params,
|
|
1879
|
+
}),
|
|
1880
|
+
|
|
1881
|
+
/**
|
|
1882
|
+
* @description Update an instructor
|
|
1883
|
+
*
|
|
1884
|
+
* @tags Instructor
|
|
1885
|
+
* @name UpdateInstructor
|
|
1886
|
+
* @summary Update Instructor
|
|
1887
|
+
* @request PUT:/instructor/{instructorID}
|
|
1888
|
+
* @secure
|
|
1889
|
+
*/
|
|
1890
|
+
updateInstructor: (instructorId: string, data: InstructorUpdateSchema, params: RequestParams = {}) =>
|
|
1891
|
+
this.request<UpdateInstructorData, UpdateInstructorError>({
|
|
1892
|
+
path: `/instructor/${instructorId}`,
|
|
1893
|
+
method: 'PUT',
|
|
1894
|
+
body: data,
|
|
1895
|
+
secure: true,
|
|
1896
|
+
type: ContentType.Json,
|
|
1897
|
+
...params,
|
|
1898
|
+
}),
|
|
1899
|
+
|
|
1900
|
+
/**
|
|
1901
|
+
* @description Remove an instructor
|
|
1902
|
+
*
|
|
1903
|
+
* @tags Instructor
|
|
1904
|
+
* @name DeleteInstructor
|
|
1905
|
+
* @summary Delete Instructor
|
|
1906
|
+
* @request DELETE:/instructor/{instructorID}
|
|
1907
|
+
* @secure
|
|
1908
|
+
*/
|
|
1909
|
+
deleteInstructor: (instructorId: string, params: RequestParams = {}) =>
|
|
1910
|
+
this.request<DeleteInstructorData, DeleteInstructorError>({
|
|
1911
|
+
path: `/instructor/${instructorId}`,
|
|
1912
|
+
method: 'DELETE',
|
|
1913
|
+
secure: true,
|
|
1914
|
+
...params,
|
|
1915
|
+
}),
|
|
1916
|
+
|
|
1917
|
+
/**
|
|
1918
|
+
* @description Retrieve courses assigned to an instructor
|
|
1919
|
+
*
|
|
1920
|
+
* @tags Instructor
|
|
1921
|
+
* @name GetCourse
|
|
1922
|
+
* @summary Get Instructor Courses
|
|
1923
|
+
* @request GET:/instructor/{instructorID}/course
|
|
1924
|
+
* @secure
|
|
1925
|
+
*/
|
|
1926
|
+
getCourse: (instructorId: string, params: RequestParams = {}) =>
|
|
1927
|
+
this.request<GetCourseData, GetCourseError>({
|
|
1928
|
+
path: `/instructor/${instructorId}/course`,
|
|
1929
|
+
method: 'GET',
|
|
1930
|
+
secure: true,
|
|
1931
|
+
...params,
|
|
1932
|
+
}),
|
|
1933
|
+
|
|
1934
|
+
/**
|
|
1935
|
+
* @description Smart update courses assigned to an instructor
|
|
1936
|
+
*
|
|
1937
|
+
* @tags Instructor
|
|
1938
|
+
* @name CreateCourse
|
|
1939
|
+
* @summary Update Instructor Courses
|
|
1940
|
+
* @request POST:/instructor/{instructorID}/course
|
|
1941
|
+
* @secure
|
|
1942
|
+
*/
|
|
1943
|
+
createCourse: (instructorId: string, data: InstructorCourseUpdateSchema, params: RequestParams = {}) =>
|
|
1944
|
+
this.request<CreateCourseData, CreateCourseError>({
|
|
1945
|
+
path: `/instructor/${instructorId}/course`,
|
|
1946
|
+
method: 'POST',
|
|
1947
|
+
body: data,
|
|
1948
|
+
secure: true,
|
|
1949
|
+
type: ContentType.Json,
|
|
1950
|
+
...params,
|
|
1951
|
+
}),
|
|
1952
|
+
|
|
1953
|
+
/**
|
|
1954
|
+
* @description Retrieve regions assigned to an instructor
|
|
1955
|
+
*
|
|
1956
|
+
* @tags Instructor
|
|
1957
|
+
* @name GetRegion
|
|
1958
|
+
* @summary Get Instructor Regions
|
|
1959
|
+
* @request GET:/instructor/{instructorID}/region
|
|
1960
|
+
* @secure
|
|
1961
|
+
*/
|
|
1962
|
+
getRegion: (instructorId: string, params: RequestParams = {}) =>
|
|
1963
|
+
this.request<GetRegionResult, GetRegionFail>({
|
|
1964
|
+
path: `/instructor/${instructorId}/region`,
|
|
1965
|
+
method: 'GET',
|
|
1966
|
+
secure: true,
|
|
1967
|
+
...params,
|
|
1968
|
+
}),
|
|
1969
|
+
|
|
1970
|
+
/**
|
|
1971
|
+
* @description Smart update regions assigned to an instructor
|
|
1972
|
+
*
|
|
1973
|
+
* @tags Instructor
|
|
1974
|
+
* @name CreateRegion
|
|
1975
|
+
* @summary Update Instructor Regions
|
|
1976
|
+
* @request POST:/instructor/{instructorID}/region
|
|
1977
|
+
* @secure
|
|
1978
|
+
*/
|
|
1979
|
+
createRegion: (instructorId: string, data: InstructorRegionUpdateSchema, params: RequestParams = {}) =>
|
|
1980
|
+
this.request<CreateRegionResult, CreateRegionFail>({
|
|
1981
|
+
path: `/instructor/${instructorId}/region`,
|
|
1982
|
+
method: 'POST',
|
|
1983
|
+
body: data,
|
|
1984
|
+
secure: true,
|
|
1985
|
+
type: ContentType.Json,
|
|
1986
|
+
...params,
|
|
1987
|
+
}),
|
|
1988
|
+
|
|
1989
|
+
/**
|
|
1990
|
+
* @description Retrieve instructor calendar events within a time range
|
|
1991
|
+
*
|
|
1992
|
+
* @tags Instructor
|
|
1993
|
+
* @name ListEvents
|
|
1994
|
+
* @summary Get Instructor Events
|
|
1995
|
+
* @request POST:/instructor/{instructorID}/events
|
|
1996
|
+
* @secure
|
|
1997
|
+
*/
|
|
1998
|
+
listEvents: (instructorId: string, data: Input33N9Vgyjyy, params: RequestParams = {}) =>
|
|
1999
|
+
this.request<ListEventsData, ListEventsError>({
|
|
2000
|
+
path: `/instructor/${instructorId}/events`,
|
|
2001
|
+
method: 'POST',
|
|
2002
|
+
body: data,
|
|
2003
|
+
secure: true,
|
|
2004
|
+
type: ContentType.Json,
|
|
2005
|
+
...params,
|
|
2006
|
+
}),
|
|
2007
|
+
|
|
2008
|
+
/**
|
|
2009
|
+
* @description Retrieve an instructor availability event
|
|
2010
|
+
*
|
|
2011
|
+
* @tags InstructorCalendar
|
|
2012
|
+
* @name GetAvailabilityEvent
|
|
2013
|
+
* @summary Get Availability Event
|
|
2014
|
+
* @request GET:/instructor/{instructorID}/availabilityEvent/{startTime}
|
|
2015
|
+
* @secure
|
|
2016
|
+
*/
|
|
2017
|
+
getAvailabilityEvent: (instructorId: string, startTime: string, params: RequestParams = {}) =>
|
|
2018
|
+
this.request<GetAvailabilityEventData, GetAvailabilityEventError>({
|
|
2019
|
+
path: `/instructor/${instructorId}/availabilityEvent/${startTime}`,
|
|
2020
|
+
method: 'GET',
|
|
2021
|
+
secure: true,
|
|
2022
|
+
...params,
|
|
2023
|
+
}),
|
|
2024
|
+
|
|
2025
|
+
/**
|
|
2026
|
+
* @description Create an instructor availability event
|
|
2027
|
+
*
|
|
2028
|
+
* @tags InstructorCalendar
|
|
2029
|
+
* @name CreateAvailabilityEvent
|
|
2030
|
+
* @summary Create Availability Event
|
|
2031
|
+
* @request POST:/instructor/{instructorID}/availabilityEvent/{startTime}
|
|
2032
|
+
* @secure
|
|
2033
|
+
*/
|
|
2034
|
+
createAvailabilityEvent: (
|
|
2035
|
+
instructorId: string,
|
|
2036
|
+
startTime: string,
|
|
2037
|
+
data: Input56Hzg6Xiz2,
|
|
2038
|
+
params: RequestParams = {}
|
|
2039
|
+
) =>
|
|
2040
|
+
this.request<CreateAvailabilityEventData, CreateAvailabilityEventError>({
|
|
2041
|
+
path: `/instructor/${instructorId}/availabilityEvent/${startTime}`,
|
|
2042
|
+
method: 'POST',
|
|
2043
|
+
body: data,
|
|
2044
|
+
secure: true,
|
|
2045
|
+
type: ContentType.Json,
|
|
2046
|
+
...params,
|
|
2047
|
+
}),
|
|
2048
|
+
|
|
2049
|
+
/**
|
|
2050
|
+
* @description Update an instructor availability event (delete + recreate)
|
|
2051
|
+
*
|
|
2052
|
+
* @tags InstructorCalendar
|
|
2053
|
+
* @name UpdateAvailabilityEvent
|
|
2054
|
+
* @summary Update Availability Event
|
|
2055
|
+
* @request PUT:/instructor/{instructorID}/availabilityEvent/{startTime}
|
|
2056
|
+
* @secure
|
|
2057
|
+
*/
|
|
2058
|
+
updateAvailabilityEvent: (
|
|
2059
|
+
instructorId: string,
|
|
2060
|
+
startTime: string,
|
|
2061
|
+
data: Input3Yilrlis7M,
|
|
2062
|
+
params: RequestParams = {}
|
|
2063
|
+
) =>
|
|
2064
|
+
this.request<UpdateAvailabilityEventData, UpdateAvailabilityEventError>({
|
|
2065
|
+
path: `/instructor/${instructorId}/availabilityEvent/${startTime}`,
|
|
2066
|
+
method: 'PUT',
|
|
2067
|
+
body: data,
|
|
2068
|
+
secure: true,
|
|
2069
|
+
type: ContentType.Json,
|
|
2070
|
+
...params,
|
|
2071
|
+
}),
|
|
2072
|
+
|
|
2073
|
+
/**
|
|
2074
|
+
* @description Delete an instructor availability event
|
|
2075
|
+
*
|
|
2076
|
+
* @tags InstructorCalendar
|
|
2077
|
+
* @name DeleteAvailabilityEvent
|
|
2078
|
+
* @summary Delete Availability Event
|
|
2079
|
+
* @request DELETE:/instructor/{instructorID}/availabilityEvent/{startTime}
|
|
2080
|
+
* @secure
|
|
2081
|
+
*/
|
|
2082
|
+
deleteAvailabilityEvent: (instructorId: string, startTime: string, params: RequestParams = {}) =>
|
|
2083
|
+
this.request<DeleteAvailabilityEventData, DeleteAvailabilityEventError>({
|
|
2084
|
+
path: `/instructor/${instructorId}/availabilityEvent/${startTime}`,
|
|
2085
|
+
method: 'DELETE',
|
|
2086
|
+
secure: true,
|
|
2087
|
+
...params,
|
|
2088
|
+
}),
|
|
2089
|
+
|
|
2090
|
+
/**
|
|
2091
|
+
* @description Retrieve a calendar sync configuration
|
|
2092
|
+
*
|
|
2093
|
+
* @tags InstructorCalendarSync
|
|
2094
|
+
* @name GetCalendarSync
|
|
2095
|
+
* @summary Get Instructor Calendar Sync
|
|
2096
|
+
* @request GET:/instructor/{instructorID}/calendarSync/{providerID}
|
|
2097
|
+
* @secure
|
|
2098
|
+
*/
|
|
2099
|
+
getCalendarSync: (instructorId: string, providerId: string, params: RequestParams = {}) =>
|
|
2100
|
+
this.request<GetCalendarSyncData, GetCalendarSyncError>({
|
|
2101
|
+
path: `/instructor/${instructorId}/calendarSync/${providerId}`,
|
|
2102
|
+
method: 'GET',
|
|
2103
|
+
secure: true,
|
|
2104
|
+
...params,
|
|
2105
|
+
}),
|
|
2106
|
+
|
|
2107
|
+
/**
|
|
2108
|
+
* @description Create a calendar sync configuration
|
|
2109
|
+
*
|
|
2110
|
+
* @tags InstructorCalendarSync
|
|
2111
|
+
* @name CreateCalendarSync
|
|
2112
|
+
* @summary Create Instructor Calendar Sync
|
|
2113
|
+
* @request POST:/instructor/{instructorID}/calendarSync/{providerID}
|
|
2114
|
+
* @secure
|
|
2115
|
+
*/
|
|
2116
|
+
createCalendarSync: (instructorId: string, providerId: string, params: RequestParams = {}) =>
|
|
2117
|
+
this.request<CreateCalendarSyncData, CreateCalendarSyncError>({
|
|
2118
|
+
path: `/instructor/${instructorId}/calendarSync/${providerId}`,
|
|
2119
|
+
method: 'POST',
|
|
2120
|
+
secure: true,
|
|
2121
|
+
...params,
|
|
2122
|
+
}),
|
|
2123
|
+
|
|
2124
|
+
/**
|
|
2125
|
+
* @description Update a calendar sync configuration
|
|
2126
|
+
*
|
|
2127
|
+
* @tags InstructorCalendarSync
|
|
2128
|
+
* @name UpdateCalendarSync
|
|
2129
|
+
* @summary Update Instructor Calendar Sync
|
|
2130
|
+
* @request PUT:/instructor/{instructorID}/calendarSync/{providerID}
|
|
2131
|
+
* @secure
|
|
2132
|
+
*/
|
|
2133
|
+
updateCalendarSync: (instructorId: string, providerId: string, params: RequestParams = {}) =>
|
|
2134
|
+
this.request<UpdateCalendarSyncData, UpdateCalendarSyncError>({
|
|
2135
|
+
path: `/instructor/${instructorId}/calendarSync/${providerId}`,
|
|
2136
|
+
method: 'PUT',
|
|
2137
|
+
secure: true,
|
|
2138
|
+
...params,
|
|
2139
|
+
}),
|
|
2140
|
+
|
|
2141
|
+
/**
|
|
2142
|
+
* @description Delete a calendar sync configuration
|
|
2143
|
+
*
|
|
2144
|
+
* @tags InstructorCalendarSync
|
|
2145
|
+
* @name DeleteCalendarSync
|
|
2146
|
+
* @summary Delete Instructor Calendar Sync
|
|
2147
|
+
* @request DELETE:/instructor/{instructorID}/calendarSync/{providerID}
|
|
2148
|
+
* @secure
|
|
2149
|
+
*/
|
|
2150
|
+
deleteCalendarSync: (instructorId: string, providerId: string, params: RequestParams = {}) =>
|
|
2151
|
+
this.request<DeleteCalendarSyncData, DeleteCalendarSyncError>({
|
|
2152
|
+
path: `/instructor/${instructorId}/calendarSync/${providerId}`,
|
|
2153
|
+
method: 'DELETE',
|
|
2154
|
+
secure: true,
|
|
2155
|
+
...params,
|
|
2156
|
+
}),
|
|
2157
|
+
|
|
2158
|
+
/**
|
|
2159
|
+
* @description Retrieve all calendar sync configurations for an instructor
|
|
2160
|
+
*
|
|
2161
|
+
* @tags InstructorCalendarSync
|
|
2162
|
+
* @name GetCalendarSyncs
|
|
2163
|
+
* @summary Get All Instructor Calendar Syncs
|
|
2164
|
+
* @request GET:/instructor/{instructorID}/calendarSyncs
|
|
2165
|
+
* @secure
|
|
2166
|
+
*/
|
|
2167
|
+
getCalendarSyncs: (instructorId: string, params: RequestParams = {}) =>
|
|
2168
|
+
this.request<GetCalendarSyncsData, GetCalendarSyncsError>({
|
|
2169
|
+
path: `/instructor/${instructorId}/calendarSyncs`,
|
|
2170
|
+
method: 'GET',
|
|
2171
|
+
secure: true,
|
|
2172
|
+
...params,
|
|
2173
|
+
}),
|
|
2174
|
+
}
|
|
2175
|
+
instructors = {
|
|
2176
|
+
/**
|
|
2177
|
+
* @description Retrieve all instructors for the current customer
|
|
2178
|
+
*
|
|
2179
|
+
* @tags Instructor
|
|
2180
|
+
* @name ListInstructors
|
|
2181
|
+
* @summary Get All Instructors
|
|
2182
|
+
* @request GET:/instructors
|
|
2183
|
+
* @secure
|
|
2184
|
+
*/
|
|
2185
|
+
listInstructors: (params: RequestParams = {}) =>
|
|
2186
|
+
this.request<ListInstructorsData, ListInstructorsError>({
|
|
2187
|
+
path: `/instructors`,
|
|
2188
|
+
method: 'GET',
|
|
2189
|
+
secure: true,
|
|
2190
|
+
...params,
|
|
2191
|
+
}),
|
|
2192
|
+
}
|
|
2193
|
+
course = {
|
|
2194
|
+
/**
|
|
2195
|
+
* @description Retrieve course calendar configuration
|
|
2196
|
+
*
|
|
2197
|
+
* @tags CourseCalendar
|
|
2198
|
+
* @name GetCalendar
|
|
2199
|
+
* @summary Get Course Calendar
|
|
2200
|
+
* @request GET:/course/{courseID}/calendar
|
|
2201
|
+
* @secure
|
|
2202
|
+
*/
|
|
2203
|
+
getCalendar: (courseId: string, params: RequestParams = {}) =>
|
|
2204
|
+
this.request<GetCalendarData, GetCalendarError>({
|
|
2205
|
+
path: `/course/${courseId}/calendar`,
|
|
2206
|
+
method: 'GET',
|
|
2207
|
+
secure: true,
|
|
2208
|
+
...params,
|
|
2209
|
+
}),
|
|
2210
|
+
|
|
2211
|
+
/**
|
|
2212
|
+
* @description Upsert course calendar configuration
|
|
2213
|
+
*
|
|
2214
|
+
* @tags CourseCalendar
|
|
2215
|
+
* @name UpdateCalendar
|
|
2216
|
+
* @summary Update Course Calendar
|
|
2217
|
+
* @request PUT:/course/{courseID}/calendar
|
|
2218
|
+
* @secure
|
|
2219
|
+
*/
|
|
2220
|
+
updateCalendar: (courseId: string, data: InputKi6Tbrci1R, params: RequestParams = {}) =>
|
|
2221
|
+
this.request<UpdateCalendarData, UpdateCalendarError>({
|
|
2222
|
+
path: `/course/${courseId}/calendar`,
|
|
2223
|
+
method: 'PUT',
|
|
2224
|
+
body: data,
|
|
2225
|
+
secure: true,
|
|
2226
|
+
type: ContentType.Json,
|
|
2227
|
+
...params,
|
|
2228
|
+
}),
|
|
2229
|
+
|
|
2230
|
+
/**
|
|
2231
|
+
* @description Retrieve a course enrolment ticket
|
|
2232
|
+
*
|
|
2233
|
+
* @tags CourseTicket
|
|
2234
|
+
* @name GetStudentTicket
|
|
2235
|
+
* @summary Get Course Ticket
|
|
2236
|
+
* @request GET:/course/{courseID}/student/{userID}/ticket/{ticketID}
|
|
2237
|
+
* @secure
|
|
2238
|
+
*/
|
|
2239
|
+
getStudentTicket: (courseId: string, userId: string, ticketId: string, params: RequestParams = {}) =>
|
|
2240
|
+
this.request<GetStudentTicketData, GetStudentTicketError>({
|
|
2241
|
+
path: `/course/${courseId}/student/${userId}/ticket/${ticketId}`,
|
|
2242
|
+
method: 'GET',
|
|
2243
|
+
secure: true,
|
|
2244
|
+
...params,
|
|
2245
|
+
}),
|
|
2246
|
+
|
|
2247
|
+
/**
|
|
2248
|
+
* @description Generate a course enrolment ticket
|
|
2249
|
+
*
|
|
2250
|
+
* @tags CourseTicket
|
|
2251
|
+
* @name CreateStudentTicket
|
|
2252
|
+
* @summary Create Course Ticket
|
|
2253
|
+
* @request POST:/course/{courseID}/student/{userID}/ticket/{ticketID}
|
|
2254
|
+
* @secure
|
|
2255
|
+
*/
|
|
2256
|
+
createStudentTicket: (courseId: string, userId: string, ticketId: string, params: RequestParams = {}) =>
|
|
2257
|
+
this.request<CreateStudentTicketData, CreateStudentTicketError>({
|
|
2258
|
+
path: `/course/${courseId}/student/${userId}/ticket/${ticketId}`,
|
|
2259
|
+
method: 'POST',
|
|
2260
|
+
secure: true,
|
|
2261
|
+
...params,
|
|
2262
|
+
}),
|
|
2263
|
+
|
|
2264
|
+
/**
|
|
2265
|
+
* @description Delete a course enrolment ticket
|
|
2266
|
+
*
|
|
2267
|
+
* @tags CourseTicket
|
|
2268
|
+
* @name DeleteStudentTicket
|
|
2269
|
+
* @summary Delete Course Ticket
|
|
2270
|
+
* @request DELETE:/course/{courseID}/student/{userID}/ticket/{ticketID}
|
|
2271
|
+
* @secure
|
|
2272
|
+
*/
|
|
2273
|
+
deleteStudentTicket: (courseId: string, userId: string, ticketId: string, params: RequestParams = {}) =>
|
|
2274
|
+
this.request<DeleteStudentTicketData, DeleteStudentTicketError>({
|
|
2275
|
+
path: `/course/${courseId}/student/${userId}/ticket/${ticketId}`,
|
|
2276
|
+
method: 'DELETE',
|
|
2277
|
+
secure: true,
|
|
2278
|
+
...params,
|
|
2279
|
+
}),
|
|
2280
|
+
}
|
|
2281
|
+
courses = {
|
|
2282
|
+
/**
|
|
2283
|
+
* @description Retrieve a course calendar sync configuration
|
|
2284
|
+
*
|
|
2285
|
+
* @tags CourseCalendarSync
|
|
2286
|
+
* @name GetCalendarSync
|
|
2287
|
+
* @summary Get Course Calendar Sync
|
|
2288
|
+
* @request GET:/courses/calendarSync/{providerID}
|
|
2289
|
+
* @secure
|
|
2290
|
+
*/
|
|
2291
|
+
getCalendarSync: (providerId: string, params: RequestParams = {}) =>
|
|
2292
|
+
this.request<GetCalendarSyncResult, GetCalendarSyncFail>({
|
|
2293
|
+
path: `/courses/calendarSync/${providerId}`,
|
|
2294
|
+
method: 'GET',
|
|
2295
|
+
secure: true,
|
|
2296
|
+
...params,
|
|
2297
|
+
}),
|
|
2298
|
+
|
|
2299
|
+
/**
|
|
2300
|
+
* @description Create a course calendar sync
|
|
2301
|
+
*
|
|
2302
|
+
* @tags CourseCalendarSync
|
|
2303
|
+
* @name CreateCalendarSync
|
|
2304
|
+
* @summary Create Course Calendar Sync
|
|
2305
|
+
* @request POST:/courses/calendarSync/{providerID}
|
|
2306
|
+
* @secure
|
|
2307
|
+
*/
|
|
2308
|
+
createCalendarSync: (providerId: string, params: RequestParams = {}) =>
|
|
2309
|
+
this.request<CreateCalendarSyncResult, CreateCalendarSyncFail>({
|
|
2310
|
+
path: `/courses/calendarSync/${providerId}`,
|
|
2311
|
+
method: 'POST',
|
|
2312
|
+
secure: true,
|
|
2313
|
+
...params,
|
|
2314
|
+
}),
|
|
2315
|
+
|
|
2316
|
+
/**
|
|
2317
|
+
* @description Update a course calendar sync
|
|
2318
|
+
*
|
|
2319
|
+
* @tags CourseCalendarSync
|
|
2320
|
+
* @name UpdateCalendarSync
|
|
2321
|
+
* @summary Update Course Calendar Sync
|
|
2322
|
+
* @request PUT:/courses/calendarSync/{providerID}
|
|
2323
|
+
* @secure
|
|
2324
|
+
*/
|
|
2325
|
+
updateCalendarSync: (providerId: string, params: RequestParams = {}) =>
|
|
2326
|
+
this.request<UpdateCalendarSyncResult, UpdateCalendarSyncFail>({
|
|
2327
|
+
path: `/courses/calendarSync/${providerId}`,
|
|
2328
|
+
method: 'PUT',
|
|
2329
|
+
secure: true,
|
|
2330
|
+
...params,
|
|
2331
|
+
}),
|
|
2332
|
+
|
|
2333
|
+
/**
|
|
2334
|
+
* @description Delete a course calendar sync
|
|
2335
|
+
*
|
|
2336
|
+
* @tags CourseCalendarSync
|
|
2337
|
+
* @name DeleteCalendarSync
|
|
2338
|
+
* @summary Delete Course Calendar Sync
|
|
2339
|
+
* @request DELETE:/courses/calendarSync/{providerID}
|
|
2340
|
+
* @secure
|
|
2341
|
+
*/
|
|
2342
|
+
deleteCalendarSync: (providerId: string, params: RequestParams = {}) =>
|
|
2343
|
+
this.request<DeleteCalendarSyncResult, DeleteCalendarSyncFail>({
|
|
2344
|
+
path: `/courses/calendarSync/${providerId}`,
|
|
2345
|
+
method: 'DELETE',
|
|
2346
|
+
secure: true,
|
|
2347
|
+
...params,
|
|
2348
|
+
}),
|
|
2349
|
+
|
|
2350
|
+
/**
|
|
2351
|
+
* @description Retrieve all course calendar syncs for the customer
|
|
2352
|
+
*
|
|
2353
|
+
* @tags CourseCalendarSync
|
|
2354
|
+
* @name ListCalendarSyncs
|
|
2355
|
+
* @summary Get All Course Calendar Syncs
|
|
2356
|
+
* @request GET:/courses/calendarSyncs
|
|
2357
|
+
* @secure
|
|
2358
|
+
*/
|
|
2359
|
+
listCalendarSyncs: (params: RequestParams = {}) =>
|
|
2360
|
+
this.request<ListCalendarSyncsData, ListCalendarSyncsError>({
|
|
2361
|
+
path: `/courses/calendarSyncs`,
|
|
2362
|
+
method: 'GET',
|
|
2363
|
+
secure: true,
|
|
2364
|
+
...params,
|
|
2365
|
+
}),
|
|
2366
|
+
|
|
2367
|
+
/**
|
|
2368
|
+
* @description Retrieve all courses for the current tenant or customer
|
|
2369
|
+
*
|
|
2370
|
+
* @tags Course
|
|
2371
|
+
* @name ListCourses
|
|
2372
|
+
* @summary Get All Courses
|
|
2373
|
+
* @request GET:/courses
|
|
2374
|
+
* @secure
|
|
2375
|
+
*/
|
|
2376
|
+
listCourses: (params: RequestParams = {}) =>
|
|
2377
|
+
this.request<ListCoursesData, ListCoursesError>({
|
|
2378
|
+
path: `/courses`,
|
|
2379
|
+
method: 'GET',
|
|
2380
|
+
secure: true,
|
|
2381
|
+
...params,
|
|
2382
|
+
}),
|
|
2383
|
+
}
|
|
2384
|
+
template = {
|
|
2385
|
+
/**
|
|
2386
|
+
* @description Retrieve a session course template by ID
|
|
2387
|
+
*
|
|
2388
|
+
* @tags Template
|
|
2389
|
+
* @name GetTemplate
|
|
2390
|
+
* @summary Get Template
|
|
2391
|
+
* @request GET:/template/{templateID}
|
|
2392
|
+
* @secure
|
|
2393
|
+
*/
|
|
2394
|
+
getTemplate: (templateId: string, params: RequestParams = {}) =>
|
|
2395
|
+
this.request<GetTemplateData, GetTemplateError>({
|
|
2396
|
+
path: `/template/${templateId}`,
|
|
2397
|
+
method: 'GET',
|
|
2398
|
+
secure: true,
|
|
2399
|
+
...params,
|
|
2400
|
+
}),
|
|
2401
|
+
|
|
2402
|
+
/**
|
|
2403
|
+
* @description Create a new session course template
|
|
2404
|
+
*
|
|
2405
|
+
* @tags Template
|
|
2406
|
+
* @name CreateTemplate
|
|
2407
|
+
* @summary Create Template
|
|
2408
|
+
* @request POST:/template/{templateID}
|
|
2409
|
+
* @secure
|
|
2410
|
+
*/
|
|
2411
|
+
createTemplate: (templateId: string, data: SessionCourseTemplateCreateSchema, params: RequestParams = {}) =>
|
|
2412
|
+
this.request<CreateTemplateData, CreateTemplateError>({
|
|
2413
|
+
path: `/template/${templateId}`,
|
|
2414
|
+
method: 'POST',
|
|
2415
|
+
body: data,
|
|
2416
|
+
secure: true,
|
|
2417
|
+
type: ContentType.Json,
|
|
2418
|
+
...params,
|
|
2419
|
+
}),
|
|
2420
|
+
|
|
2421
|
+
/**
|
|
2422
|
+
* @description Update an existing session course template
|
|
2423
|
+
*
|
|
2424
|
+
* @tags Template
|
|
2425
|
+
* @name UpdateTemplate
|
|
2426
|
+
* @summary Update Template
|
|
2427
|
+
* @request PUT:/template/{templateID}
|
|
2428
|
+
* @secure
|
|
2429
|
+
*/
|
|
2430
|
+
updateTemplate: (templateId: string, data: SessionCourseTemplateUpdateSchema, params: RequestParams = {}) =>
|
|
2431
|
+
this.request<UpdateTemplateData, UpdateTemplateError>({
|
|
2432
|
+
path: `/template/${templateId}`,
|
|
2433
|
+
method: 'PUT',
|
|
2434
|
+
body: data,
|
|
2435
|
+
secure: true,
|
|
2436
|
+
type: ContentType.Json,
|
|
2437
|
+
...params,
|
|
2438
|
+
}),
|
|
2439
|
+
|
|
2440
|
+
/**
|
|
2441
|
+
* @description Delete a session course template
|
|
2442
|
+
*
|
|
2443
|
+
* @tags Template
|
|
2444
|
+
* @name DeleteTemplate
|
|
2445
|
+
* @summary Delete Template
|
|
2446
|
+
* @request DELETE:/template/{templateID}
|
|
2447
|
+
* @secure
|
|
2448
|
+
*/
|
|
2449
|
+
deleteTemplate: (templateId: string, params: RequestParams = {}) =>
|
|
2450
|
+
this.request<DeleteTemplateData, DeleteTemplateError>({
|
|
2451
|
+
path: `/template/${templateId}`,
|
|
2452
|
+
method: 'DELETE',
|
|
2453
|
+
secure: true,
|
|
2454
|
+
...params,
|
|
2455
|
+
}),
|
|
2456
|
+
}
|
|
2457
|
+
templates = {
|
|
2458
|
+
/**
|
|
2459
|
+
* @description Retrieve all session course templates
|
|
2460
|
+
*
|
|
2461
|
+
* @tags Template
|
|
2462
|
+
* @name ListTemplates
|
|
2463
|
+
* @summary Get All Templates
|
|
2464
|
+
* @request GET:/templates
|
|
2465
|
+
* @secure
|
|
2466
|
+
*/
|
|
2467
|
+
listTemplates: (params: RequestParams = {}) =>
|
|
2468
|
+
this.request<ListTemplatesData, ListTemplatesError>({
|
|
2469
|
+
path: `/templates`,
|
|
2470
|
+
method: 'GET',
|
|
2471
|
+
secure: true,
|
|
2472
|
+
...params,
|
|
2473
|
+
}),
|
|
2474
|
+
}
|
|
2475
|
+
locations = {
|
|
2476
|
+
/**
|
|
2477
|
+
* @description Retrieve all locations (regions, cities, venues map)
|
|
2478
|
+
*
|
|
2479
|
+
* @tags Location
|
|
2480
|
+
* @name ListLocations
|
|
2481
|
+
* @summary Get Locations
|
|
2482
|
+
* @request GET:/locations
|
|
2483
|
+
* @secure
|
|
2484
|
+
*/
|
|
2485
|
+
listLocations: (params: RequestParams = {}) =>
|
|
2486
|
+
this.request<ListLocationsData, ListLocationsError>({
|
|
2487
|
+
path: `/locations`,
|
|
2488
|
+
method: 'GET',
|
|
2489
|
+
secure: true,
|
|
2490
|
+
...params,
|
|
2491
|
+
}),
|
|
2492
|
+
}
|
|
2493
|
+
search = {
|
|
2494
|
+
/**
|
|
2495
|
+
* @description Search for sessions by an array of IDs
|
|
2496
|
+
*
|
|
2497
|
+
* @tags Search
|
|
2498
|
+
* @name ListSessionsIds
|
|
2499
|
+
* @summary Search Sessions by IDs
|
|
2500
|
+
* @request POST:/search/sessions/ids
|
|
2501
|
+
* @secure
|
|
2502
|
+
*/
|
|
2503
|
+
listSessionsIds: (data: SearchSessionsByIDsSchema, params: RequestParams = {}) =>
|
|
2504
|
+
this.request<ListSessionsIdsData, ListSessionsIdsError>({
|
|
2505
|
+
path: `/search/sessions/ids`,
|
|
2506
|
+
method: 'POST',
|
|
2507
|
+
body: data,
|
|
2508
|
+
secure: true,
|
|
2509
|
+
type: ContentType.Json,
|
|
2510
|
+
...params,
|
|
2511
|
+
}),
|
|
2512
|
+
}
|
|
2513
|
+
session = {
|
|
2514
|
+
/**
|
|
2515
|
+
* @description Retrieve a session by ID
|
|
2516
|
+
*
|
|
2517
|
+
* @tags Session
|
|
2518
|
+
* @name GetSession
|
|
2519
|
+
* @summary Get Session
|
|
2520
|
+
* @request GET:/session/{sessionID}
|
|
2521
|
+
* @secure
|
|
2522
|
+
*/
|
|
2523
|
+
getSession: (sessionId: string, params: RequestParams = {}) =>
|
|
2524
|
+
this.request<GetSessionData, GetSessionError>({
|
|
2525
|
+
path: `/session/${sessionId}`,
|
|
2526
|
+
method: 'GET',
|
|
2527
|
+
secure: true,
|
|
2528
|
+
...params,
|
|
2529
|
+
}),
|
|
2530
|
+
|
|
2531
|
+
/**
|
|
2532
|
+
* @description Create a new session
|
|
2533
|
+
*
|
|
2534
|
+
* @tags Session
|
|
2535
|
+
* @name CreateSession
|
|
2536
|
+
* @summary Create Session
|
|
2537
|
+
* @request POST:/session/{sessionID}
|
|
2538
|
+
* @secure
|
|
2539
|
+
*/
|
|
2540
|
+
createSession: (sessionId: string, data: SessionCreateSchema, params: RequestParams = {}) =>
|
|
2541
|
+
this.request<CreateSessionData, CreateSessionError>({
|
|
2542
|
+
path: `/session/${sessionId}`,
|
|
2543
|
+
method: 'POST',
|
|
2544
|
+
body: data,
|
|
2545
|
+
secure: true,
|
|
2546
|
+
type: ContentType.Json,
|
|
2547
|
+
...params,
|
|
2548
|
+
}),
|
|
2549
|
+
|
|
2550
|
+
/**
|
|
2551
|
+
* @description Update an existing session
|
|
2552
|
+
*
|
|
2553
|
+
* @tags Session
|
|
2554
|
+
* @name UpdateSession
|
|
2555
|
+
* @summary Update Session
|
|
2556
|
+
* @request PUT:/session/{sessionID}
|
|
2557
|
+
* @secure
|
|
2558
|
+
*/
|
|
2559
|
+
updateSession: (sessionId: string, data: SessionUpdateSchema, params: RequestParams = {}) =>
|
|
2560
|
+
this.request<UpdateSessionData, UpdateSessionError>({
|
|
2561
|
+
path: `/session/${sessionId}`,
|
|
2562
|
+
method: 'PUT',
|
|
2563
|
+
body: data,
|
|
2564
|
+
secure: true,
|
|
2565
|
+
type: ContentType.Json,
|
|
2566
|
+
...params,
|
|
2567
|
+
}),
|
|
2568
|
+
|
|
2569
|
+
/**
|
|
2570
|
+
* @description Delete a session
|
|
2571
|
+
*
|
|
2572
|
+
* @tags Session
|
|
2573
|
+
* @name DeleteSession
|
|
2574
|
+
* @summary Delete Session
|
|
2575
|
+
* @request DELETE:/session/{sessionID}
|
|
2576
|
+
* @secure
|
|
2577
|
+
*/
|
|
2578
|
+
deleteSession: (sessionId: string, params: RequestParams = {}) =>
|
|
2579
|
+
this.request<DeleteSessionData, DeleteSessionError>({
|
|
2580
|
+
path: `/session/${sessionId}`,
|
|
2581
|
+
method: 'DELETE',
|
|
2582
|
+
secure: true,
|
|
2583
|
+
...params,
|
|
2584
|
+
}),
|
|
2585
|
+
|
|
2586
|
+
/**
|
|
2587
|
+
* @description Transition session to next state
|
|
2588
|
+
*
|
|
2589
|
+
* @tags Session
|
|
2590
|
+
* @name CreateNext
|
|
2591
|
+
* @summary Advance Session State
|
|
2592
|
+
* @request POST:/session/{sessionID}/next
|
|
2593
|
+
* @secure
|
|
2594
|
+
*/
|
|
2595
|
+
createNext: (sessionId: string, params: RequestParams = {}) =>
|
|
2596
|
+
this.request<CreateNextData, CreateNextError>({
|
|
2597
|
+
path: `/session/${sessionId}/next`,
|
|
2598
|
+
method: 'POST',
|
|
2599
|
+
secure: true,
|
|
2600
|
+
...params,
|
|
2601
|
+
}),
|
|
2602
|
+
|
|
2603
|
+
/**
|
|
2604
|
+
* @description Cancel a session
|
|
2605
|
+
*
|
|
2606
|
+
* @tags Session
|
|
2607
|
+
* @name CreateCancel
|
|
2608
|
+
* @summary Cancel Session
|
|
2609
|
+
* @request POST:/session/{sessionID}/cancel
|
|
2610
|
+
* @secure
|
|
2611
|
+
*/
|
|
2612
|
+
createCancel: (sessionId: string, params: RequestParams = {}) =>
|
|
2613
|
+
this.request<CreateCancelData, CreateCancelError>({
|
|
2614
|
+
path: `/session/${sessionId}/cancel`,
|
|
2615
|
+
method: 'POST',
|
|
2616
|
+
secure: true,
|
|
2617
|
+
...params,
|
|
2618
|
+
}),
|
|
2619
|
+
|
|
2620
|
+
/**
|
|
2621
|
+
* @description Lock a session
|
|
2622
|
+
*
|
|
2623
|
+
* @tags Session
|
|
2624
|
+
* @name CreateLock
|
|
2625
|
+
* @summary Lock Session
|
|
2626
|
+
* @request POST:/session/{sessionID}/lock
|
|
2627
|
+
* @secure
|
|
2628
|
+
*/
|
|
2629
|
+
createLock: (sessionId: string, params: RequestParams = {}) =>
|
|
2630
|
+
this.request<CreateLockData, CreateLockError>({
|
|
2631
|
+
path: `/session/${sessionId}/lock`,
|
|
2632
|
+
method: 'POST',
|
|
2633
|
+
secure: true,
|
|
2634
|
+
...params,
|
|
2635
|
+
}),
|
|
2636
|
+
|
|
2637
|
+
/**
|
|
2638
|
+
* @description Unlock a locked session
|
|
2639
|
+
*
|
|
2640
|
+
* @tags Session
|
|
2641
|
+
* @name CreateUnlock
|
|
2642
|
+
* @summary Unlock Session
|
|
2643
|
+
* @request POST:/session/{sessionID}/unlock
|
|
2644
|
+
* @secure
|
|
2645
|
+
*/
|
|
2646
|
+
createUnlock: (sessionId: string, params: RequestParams = {}) =>
|
|
2647
|
+
this.request<CreateUnlockData, CreateUnlockError>({
|
|
2648
|
+
path: `/session/${sessionId}/unlock`,
|
|
2649
|
+
method: 'POST',
|
|
2650
|
+
secure: true,
|
|
2651
|
+
...params,
|
|
2652
|
+
}),
|
|
2653
|
+
|
|
2654
|
+
/**
|
|
2655
|
+
* @description Publish or unpublish session calendar events
|
|
2656
|
+
*
|
|
2657
|
+
* @tags Session
|
|
2658
|
+
* @name CreatePublish
|
|
2659
|
+
* @summary Publish Session
|
|
2660
|
+
* @request POST:/session/{sessionID}/publish
|
|
2661
|
+
* @secure
|
|
2662
|
+
*/
|
|
2663
|
+
createPublish: (sessionId: string, data: SessionPublishSchema, params: RequestParams = {}) =>
|
|
2664
|
+
this.request<CreatePublishData, CreatePublishError>({
|
|
2665
|
+
path: `/session/${sessionId}/publish`,
|
|
2666
|
+
method: 'POST',
|
|
2667
|
+
body: data,
|
|
2668
|
+
secure: true,
|
|
2669
|
+
type: ContentType.Json,
|
|
2670
|
+
...params,
|
|
2671
|
+
}),
|
|
2672
|
+
|
|
2673
|
+
/**
|
|
2674
|
+
* @description Release session access to students
|
|
2675
|
+
*
|
|
2676
|
+
* @tags Session
|
|
2677
|
+
* @name CreateRelease
|
|
2678
|
+
* @summary Release Session
|
|
2679
|
+
* @request POST:/session/{sessionID}/release
|
|
2680
|
+
* @secure
|
|
2681
|
+
*/
|
|
2682
|
+
createRelease: (sessionId: string, params: RequestParams = {}) =>
|
|
2683
|
+
this.request<CreateReleaseData, CreateReleaseError>({
|
|
2684
|
+
path: `/session/${sessionId}/release`,
|
|
2685
|
+
method: 'POST',
|
|
2686
|
+
secure: true,
|
|
2687
|
+
...params,
|
|
2688
|
+
}),
|
|
2689
|
+
|
|
2690
|
+
/**
|
|
2691
|
+
* @description Refresh material shipping info for session
|
|
2692
|
+
*
|
|
2693
|
+
* @tags Session
|
|
2694
|
+
* @name CreateRefreshShipping
|
|
2695
|
+
* @summary Refresh Shipping
|
|
2696
|
+
* @request POST:/session/{sessionID}/refreshShipping
|
|
2697
|
+
* @secure
|
|
2698
|
+
*/
|
|
2699
|
+
createRefreshShipping: (sessionId: string, params: RequestParams = {}) =>
|
|
2700
|
+
this.request<CreateRefreshShippingData, CreateRefreshShippingError>({
|
|
2701
|
+
path: `/session/${sessionId}/refreshShipping`,
|
|
2702
|
+
method: 'POST',
|
|
2703
|
+
secure: true,
|
|
2704
|
+
...params,
|
|
2705
|
+
}),
|
|
2706
|
+
|
|
2707
|
+
/**
|
|
2708
|
+
* @description Update material shipped status for a session
|
|
2709
|
+
*
|
|
2710
|
+
* @tags Session
|
|
2711
|
+
* @name CreateCourseMaterial
|
|
2712
|
+
* @summary Update Course Material Status
|
|
2713
|
+
* @request POST:/session/{sessionID}/courseMaterial
|
|
2714
|
+
* @secure
|
|
2715
|
+
*/
|
|
2716
|
+
createCourseMaterial: (sessionId: string, data: SessionShipStatusSchema, params: RequestParams = {}) =>
|
|
2717
|
+
this.request<CreateCourseMaterialData, CreateCourseMaterialError>({
|
|
2718
|
+
path: `/session/${sessionId}/courseMaterial`,
|
|
2719
|
+
method: 'POST',
|
|
2720
|
+
body: data,
|
|
2721
|
+
secure: true,
|
|
2722
|
+
type: ContentType.Json,
|
|
2723
|
+
...params,
|
|
2724
|
+
}),
|
|
2725
|
+
|
|
2726
|
+
/**
|
|
2727
|
+
* @description Duplicate a session to new dates
|
|
2728
|
+
*
|
|
2729
|
+
* @tags Session
|
|
2730
|
+
* @name CreateDuplicate
|
|
2731
|
+
* @summary Duplicate Session
|
|
2732
|
+
* @request POST:/session/{sessionID}/duplicate
|
|
2733
|
+
* @secure
|
|
2734
|
+
*/
|
|
2735
|
+
createDuplicate: (sessionId: string, data: SessionDuplicateSchema, params: RequestParams = {}) =>
|
|
2736
|
+
this.request<CreateDuplicateData, CreateDuplicateError>({
|
|
2737
|
+
path: `/session/${sessionId}/duplicate`,
|
|
2738
|
+
method: 'POST',
|
|
2739
|
+
body: data,
|
|
2740
|
+
secure: true,
|
|
2741
|
+
type: ContentType.Json,
|
|
2742
|
+
...params,
|
|
2743
|
+
}),
|
|
2744
|
+
|
|
2745
|
+
/**
|
|
2746
|
+
* @description Move a student between sessions of the same course
|
|
2747
|
+
*
|
|
2748
|
+
* @tags Session
|
|
2749
|
+
* @name CreateMoveStudent
|
|
2750
|
+
* @summary Move Student
|
|
2751
|
+
* @request POST:/session/{sessionID}/moveStudent/{userID}/{newSessionID}
|
|
2752
|
+
* @secure
|
|
2753
|
+
*/
|
|
2754
|
+
createMoveStudent: (sessionId: string, userId: string, newSessionId: string, params: RequestParams = {}) =>
|
|
2755
|
+
this.request<CreateMoveStudentData, CreateMoveStudentError>({
|
|
2756
|
+
path: `/session/${sessionId}/moveStudent/${userId}/${newSessionId}`,
|
|
2757
|
+
method: 'POST',
|
|
2758
|
+
secure: true,
|
|
2759
|
+
...params,
|
|
2760
|
+
}),
|
|
2761
|
+
|
|
2762
|
+
/**
|
|
2763
|
+
* @description Retrieve all attendances for a session
|
|
2764
|
+
*
|
|
2765
|
+
* @tags Session Attendance
|
|
2766
|
+
* @name GetAttendances
|
|
2767
|
+
* @summary Get Session Attendances
|
|
2768
|
+
* @request GET:/session/{sessionID}/attendances
|
|
2769
|
+
* @secure
|
|
2770
|
+
*/
|
|
2771
|
+
getAttendances: (sessionId: string, params: RequestParams = {}) =>
|
|
2772
|
+
this.request<GetAttendancesData, GetAttendancesError>({
|
|
2773
|
+
path: `/session/${sessionId}/attendances`,
|
|
2774
|
+
method: 'GET',
|
|
2775
|
+
secure: true,
|
|
2776
|
+
...params,
|
|
2777
|
+
}),
|
|
2778
|
+
|
|
2779
|
+
/**
|
|
2780
|
+
* @description Retrieve all enrolments for a session
|
|
2781
|
+
*
|
|
2782
|
+
* @tags Session Enrolment
|
|
2783
|
+
* @name GetEnrolments
|
|
2784
|
+
* @summary Get Session Enrolments
|
|
2785
|
+
* @request GET:/session/{sessionID}/enrolments
|
|
2786
|
+
* @secure
|
|
2787
|
+
*/
|
|
2788
|
+
getEnrolments: (sessionId: string, params: RequestParams = {}) =>
|
|
2789
|
+
this.request<GetEnrolmentsData, GetEnrolmentsError>({
|
|
2790
|
+
path: `/session/${sessionId}/enrolments`,
|
|
2791
|
+
method: 'GET',
|
|
2792
|
+
secure: true,
|
|
2793
|
+
...params,
|
|
2794
|
+
}),
|
|
2795
|
+
|
|
2796
|
+
/**
|
|
2797
|
+
* @description Retrieve all results for a session
|
|
2798
|
+
*
|
|
2799
|
+
* @tags Session Result
|
|
2800
|
+
* @name GetResults
|
|
2801
|
+
* @summary Get Session Results
|
|
2802
|
+
* @request GET:/session/{sessionID}/results
|
|
2803
|
+
* @secure
|
|
2804
|
+
*/
|
|
2805
|
+
getResults: (sessionId: string, params: RequestParams = {}) =>
|
|
2806
|
+
this.request<GetResultsData, GetResultsError>({
|
|
2807
|
+
path: `/session/${sessionId}/results`,
|
|
2808
|
+
method: 'GET',
|
|
2809
|
+
secure: true,
|
|
2810
|
+
...params,
|
|
2811
|
+
}),
|
|
2812
|
+
|
|
2813
|
+
/**
|
|
2814
|
+
* @description Retrieve all enrolment invitations for a session
|
|
2815
|
+
*
|
|
2816
|
+
* @tags Session Invitation
|
|
2817
|
+
* @name GetInvitations
|
|
2818
|
+
* @summary Get Session Invitations
|
|
2819
|
+
* @request GET:/session/{sessionID}/invitations
|
|
2820
|
+
* @secure
|
|
2821
|
+
*/
|
|
2822
|
+
getInvitations: (sessionId: string, params: RequestParams = {}) =>
|
|
2823
|
+
this.request<GetInvitationsData, GetInvitationsError>({
|
|
2824
|
+
path: `/session/${sessionId}/invitations`,
|
|
2825
|
+
method: 'GET',
|
|
2826
|
+
secure: true,
|
|
2827
|
+
...params,
|
|
2828
|
+
}),
|
|
2829
|
+
|
|
2830
|
+
/**
|
|
2831
|
+
* @description Retrieve financial charges for a user in a session
|
|
2832
|
+
*
|
|
2833
|
+
* @tags Session Financial Charge
|
|
2834
|
+
* @name GetCharges
|
|
2835
|
+
* @summary Get Session Charges
|
|
2836
|
+
* @request GET:/session/{sessionID}/charges/{userID}
|
|
2837
|
+
* @secure
|
|
2838
|
+
*/
|
|
2839
|
+
getCharges: (sessionId: string, userId: string, params: RequestParams = {}) =>
|
|
2840
|
+
this.request<GetChargesData, GetChargesError>({
|
|
2841
|
+
path: `/session/${sessionId}/charges/${userId}`,
|
|
2842
|
+
method: 'GET',
|
|
2843
|
+
secure: true,
|
|
2844
|
+
...params,
|
|
2845
|
+
}),
|
|
2846
|
+
|
|
2847
|
+
/**
|
|
2848
|
+
* @description Retrieve a specific attendance record
|
|
2849
|
+
*
|
|
2850
|
+
* @tags Session Attendance
|
|
2851
|
+
* @name GetAttendance
|
|
2852
|
+
* @summary Get Session Attendance
|
|
2853
|
+
* @request GET:/session/{sessionID}/attendance/{attendanceID}/{externalID}
|
|
2854
|
+
* @secure
|
|
2855
|
+
*/
|
|
2856
|
+
getAttendance: (sessionId: string, attendanceId: string, externalId: string, params: RequestParams = {}) =>
|
|
2857
|
+
this.request<GetAttendanceData, GetAttendanceError>({
|
|
2858
|
+
path: `/session/${sessionId}/attendance/${attendanceId}/${externalId}`,
|
|
2859
|
+
method: 'GET',
|
|
2860
|
+
secure: true,
|
|
2861
|
+
...params,
|
|
2862
|
+
}),
|
|
2863
|
+
|
|
2864
|
+
/**
|
|
2865
|
+
* @description Create a new attendance record
|
|
2866
|
+
*
|
|
2867
|
+
* @tags Session Attendance
|
|
2868
|
+
* @name CreateAttendance
|
|
2869
|
+
* @summary Create Session Attendance
|
|
2870
|
+
* @request POST:/session/{sessionID}/attendance/{attendanceID}/{externalID}
|
|
2871
|
+
* @secure
|
|
2872
|
+
*/
|
|
2873
|
+
createAttendance: (
|
|
2874
|
+
sessionId: string,
|
|
2875
|
+
attendanceId: string,
|
|
2876
|
+
externalId: string,
|
|
2877
|
+
data: InputQ59Gbvuj7G,
|
|
2878
|
+
params: RequestParams = {}
|
|
2879
|
+
) =>
|
|
2880
|
+
this.request<CreateAttendanceData, CreateAttendanceError>({
|
|
2881
|
+
path: `/session/${sessionId}/attendance/${attendanceId}/${externalId}`,
|
|
2882
|
+
method: 'POST',
|
|
2883
|
+
body: data,
|
|
2884
|
+
secure: true,
|
|
2885
|
+
type: ContentType.Json,
|
|
2886
|
+
...params,
|
|
2887
|
+
}),
|
|
2888
|
+
|
|
2889
|
+
/**
|
|
2890
|
+
* @description Update an existing attendance record
|
|
2891
|
+
*
|
|
2892
|
+
* @tags Session Attendance
|
|
2893
|
+
* @name UpdateAttendance
|
|
2894
|
+
* @summary Update Session Attendance
|
|
2895
|
+
* @request PUT:/session/{sessionID}/attendance/{attendanceID}/{externalID}
|
|
2896
|
+
* @secure
|
|
2897
|
+
*/
|
|
2898
|
+
updateAttendance: (
|
|
2899
|
+
sessionId: string,
|
|
2900
|
+
attendanceId: string,
|
|
2901
|
+
externalId: string,
|
|
2902
|
+
data: Input5S9Qlxsfdw,
|
|
2903
|
+
params: RequestParams = {}
|
|
2904
|
+
) =>
|
|
2905
|
+
this.request<UpdateAttendanceData, UpdateAttendanceError>({
|
|
2906
|
+
path: `/session/${sessionId}/attendance/${attendanceId}/${externalId}`,
|
|
2907
|
+
method: 'PUT',
|
|
2908
|
+
body: data,
|
|
2909
|
+
secure: true,
|
|
2910
|
+
type: ContentType.Json,
|
|
2911
|
+
...params,
|
|
2912
|
+
}),
|
|
2913
|
+
|
|
2914
|
+
/**
|
|
2915
|
+
* @description Delete an attendance record
|
|
2916
|
+
*
|
|
2917
|
+
* @tags Session Attendance
|
|
2918
|
+
* @name DeleteAttendance
|
|
2919
|
+
* @summary Delete Session Attendance
|
|
2920
|
+
* @request DELETE:/session/{sessionID}/attendance/{attendanceID}/{externalID}
|
|
2921
|
+
* @secure
|
|
2922
|
+
*/
|
|
2923
|
+
deleteAttendance: (sessionId: string, attendanceId: string, externalId: string, params: RequestParams = {}) =>
|
|
2924
|
+
this.request<DeleteAttendanceData, DeleteAttendanceError>({
|
|
2925
|
+
path: `/session/${sessionId}/attendance/${attendanceId}/${externalId}`,
|
|
2926
|
+
method: 'DELETE',
|
|
2927
|
+
secure: true,
|
|
2928
|
+
...params,
|
|
2929
|
+
}),
|
|
2930
|
+
|
|
2931
|
+
/**
|
|
2932
|
+
* @description Retrieve a specific enrolment record
|
|
2933
|
+
*
|
|
2934
|
+
* @tags Session Enrolment
|
|
2935
|
+
* @name GetEnrolment
|
|
2936
|
+
* @summary Get Session Enrolment
|
|
2937
|
+
* @request GET:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}
|
|
2938
|
+
* @secure
|
|
2939
|
+
*/
|
|
2940
|
+
getEnrolment: (sessionId: string, enrolmentId: string, externalId: string, params: RequestParams = {}) =>
|
|
2941
|
+
this.request<GetEnrolmentData, GetEnrolmentError>({
|
|
2942
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}/${externalId}`,
|
|
2943
|
+
method: 'GET',
|
|
2944
|
+
secure: true,
|
|
2945
|
+
...params,
|
|
2946
|
+
}),
|
|
2947
|
+
|
|
2948
|
+
/**
|
|
2949
|
+
* @description Create a new session enrolment
|
|
2950
|
+
*
|
|
2951
|
+
* @tags Session Enrolment
|
|
2952
|
+
* @name CreateEnrolment
|
|
2953
|
+
* @summary Create Session Enrolment
|
|
2954
|
+
* @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}
|
|
2955
|
+
* @secure
|
|
2956
|
+
*/
|
|
2957
|
+
createEnrolment: (
|
|
2958
|
+
sessionId: string,
|
|
2959
|
+
enrolmentId: string,
|
|
2960
|
+
externalId: string,
|
|
2961
|
+
data: InputKdcf6Vev2F,
|
|
2962
|
+
params: RequestParams = {}
|
|
2963
|
+
) =>
|
|
2964
|
+
this.request<CreateEnrolmentData, CreateEnrolmentError>({
|
|
2965
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}/${externalId}`,
|
|
2966
|
+
method: 'POST',
|
|
2967
|
+
body: data,
|
|
2968
|
+
secure: true,
|
|
2969
|
+
type: ContentType.Json,
|
|
2970
|
+
...params,
|
|
2971
|
+
}),
|
|
2972
|
+
|
|
2973
|
+
/**
|
|
2974
|
+
* @description Update an existing session enrolment
|
|
2975
|
+
*
|
|
2976
|
+
* @tags Session Enrolment
|
|
2977
|
+
* @name UpdateEnrolment
|
|
2978
|
+
* @summary Update Session Enrolment
|
|
2979
|
+
* @request PUT:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}
|
|
2980
|
+
* @secure
|
|
2981
|
+
*/
|
|
2982
|
+
updateEnrolment: (
|
|
2983
|
+
sessionId: string,
|
|
2984
|
+
enrolmentId: string,
|
|
2985
|
+
externalId: string,
|
|
2986
|
+
data: InputPcoc6Mas3J,
|
|
2987
|
+
params: RequestParams = {}
|
|
2988
|
+
) =>
|
|
2989
|
+
this.request<UpdateEnrolmentData, UpdateEnrolmentError>({
|
|
2990
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}/${externalId}`,
|
|
2991
|
+
method: 'PUT',
|
|
2992
|
+
body: data,
|
|
2993
|
+
secure: true,
|
|
2994
|
+
type: ContentType.Json,
|
|
2995
|
+
...params,
|
|
2996
|
+
}),
|
|
2997
|
+
|
|
2998
|
+
/**
|
|
2999
|
+
* @description Delete a session enrolment
|
|
3000
|
+
*
|
|
3001
|
+
* @tags Session Enrolment
|
|
3002
|
+
* @name DeleteEnrolment
|
|
3003
|
+
* @summary Delete Session Enrolment
|
|
3004
|
+
* @request DELETE:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}
|
|
3005
|
+
* @secure
|
|
3006
|
+
*/
|
|
3007
|
+
deleteEnrolment: (sessionId: string, enrolmentId: string, externalId: string, params: RequestParams = {}) =>
|
|
3008
|
+
this.request<DeleteEnrolmentData, DeleteEnrolmentError>({
|
|
3009
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}/${externalId}`,
|
|
3010
|
+
method: 'DELETE',
|
|
3011
|
+
secure: true,
|
|
3012
|
+
...params,
|
|
3013
|
+
}),
|
|
3014
|
+
|
|
3015
|
+
/**
|
|
3016
|
+
* @description Retrieve an enrolment by session and user
|
|
3017
|
+
*
|
|
3018
|
+
* @tags Session Enrolment
|
|
3019
|
+
* @name GetEnrolment2
|
|
3020
|
+
* @summary Get Session Enrolment By User
|
|
3021
|
+
* @request GET:/session/{sessionID}/enrolment/{enrolmentID}
|
|
3022
|
+
* @originalName getEnrolment
|
|
3023
|
+
* @duplicate
|
|
3024
|
+
* @secure
|
|
3025
|
+
*/
|
|
3026
|
+
getEnrolment2: (sessionId: string, enrolmentId: string, params: RequestParams = {}) =>
|
|
3027
|
+
this.request<GetEnrolment2Data, GetEnrolment2Error>({
|
|
3028
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}`,
|
|
3029
|
+
method: 'GET',
|
|
3030
|
+
secure: true,
|
|
3031
|
+
...params,
|
|
3032
|
+
}),
|
|
3033
|
+
|
|
3034
|
+
/**
|
|
3035
|
+
* @description Release a session enrolment
|
|
3036
|
+
*
|
|
3037
|
+
* @tags Session Enrolment
|
|
3038
|
+
* @name CreateEnrolmentRelease
|
|
3039
|
+
* @summary Release Session Enrolment
|
|
3040
|
+
* @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}/release
|
|
3041
|
+
* @secure
|
|
3042
|
+
*/
|
|
3043
|
+
createEnrolmentRelease: (sessionId: string, enrolmentId: string, externalId: string, params: RequestParams = {}) =>
|
|
3044
|
+
this.request<CreateEnrolmentReleaseData, CreateEnrolmentReleaseError>({
|
|
3045
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}/${externalId}/release`,
|
|
3046
|
+
method: 'POST',
|
|
3047
|
+
secure: true,
|
|
3048
|
+
...params,
|
|
3049
|
+
}),
|
|
3050
|
+
|
|
3051
|
+
/**
|
|
3052
|
+
* @description Cancel a session enrolment
|
|
3053
|
+
*
|
|
3054
|
+
* @tags Session Enrolment
|
|
3055
|
+
* @name CreateEnrolmentCancel
|
|
3056
|
+
* @summary Cancel Session Enrolment
|
|
3057
|
+
* @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}/cancel
|
|
3058
|
+
* @secure
|
|
3059
|
+
*/
|
|
3060
|
+
createEnrolmentCancel: (sessionId: string, enrolmentId: string, externalId: string, params: RequestParams = {}) =>
|
|
3061
|
+
this.request<CreateEnrolmentCancelData, CreateEnrolmentCancelError>({
|
|
3062
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}/${externalId}/cancel`,
|
|
3063
|
+
method: 'POST',
|
|
3064
|
+
secure: true,
|
|
3065
|
+
...params,
|
|
3066
|
+
}),
|
|
3067
|
+
|
|
3068
|
+
/**
|
|
3069
|
+
* @description Generate SSO launch link for an online session enrolment
|
|
3070
|
+
*
|
|
3071
|
+
* @tags Session Enrolment
|
|
3072
|
+
* @name CreateEnrolmentLaunch
|
|
3073
|
+
* @summary Launch Session Enrolment SSO
|
|
3074
|
+
* @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}/launch
|
|
3075
|
+
* @secure
|
|
3076
|
+
*/
|
|
3077
|
+
createEnrolmentLaunch: (sessionId: string, enrolmentId: string, externalId: string, params: RequestParams = {}) =>
|
|
3078
|
+
this.request<CreateEnrolmentLaunchData, CreateEnrolmentLaunchError>({
|
|
3079
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}/${externalId}/launch`,
|
|
3080
|
+
method: 'POST',
|
|
3081
|
+
secure: true,
|
|
3082
|
+
...params,
|
|
3083
|
+
}),
|
|
3084
|
+
|
|
3085
|
+
/**
|
|
3086
|
+
* @description Check the result for an online session enrolment
|
|
3087
|
+
*
|
|
3088
|
+
* @tags Session Enrolment
|
|
3089
|
+
* @name CreateEnrolmentCheckResult
|
|
3090
|
+
* @summary Check Enrolment Result
|
|
3091
|
+
* @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}/checkResult
|
|
3092
|
+
* @secure
|
|
3093
|
+
*/
|
|
3094
|
+
createEnrolmentCheckResult: (
|
|
3095
|
+
sessionId: string,
|
|
3096
|
+
enrolmentId: string,
|
|
3097
|
+
externalId: string,
|
|
3098
|
+
params: RequestParams = {}
|
|
3099
|
+
) =>
|
|
3100
|
+
this.request<CreateEnrolmentCheckResultData, CreateEnrolmentCheckResultError>({
|
|
3101
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}/${externalId}/checkResult`,
|
|
3102
|
+
method: 'POST',
|
|
3103
|
+
secure: true,
|
|
3104
|
+
...params,
|
|
3105
|
+
}),
|
|
3106
|
+
|
|
3107
|
+
/**
|
|
3108
|
+
* @description Create a financial charge for an enrolment
|
|
3109
|
+
*
|
|
3110
|
+
* @tags Session Enrolment
|
|
3111
|
+
* @name CreateEnrolmentCharge
|
|
3112
|
+
* @summary Create Enrolment Charge
|
|
3113
|
+
* @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}/charge
|
|
3114
|
+
* @secure
|
|
3115
|
+
*/
|
|
3116
|
+
createEnrolmentCharge: (
|
|
3117
|
+
sessionId: string,
|
|
3118
|
+
enrolmentId: string,
|
|
3119
|
+
externalId: string,
|
|
3120
|
+
data: Input56A08Qop2C,
|
|
3121
|
+
params: RequestParams = {}
|
|
3122
|
+
) =>
|
|
3123
|
+
this.request<CreateEnrolmentChargeData, CreateEnrolmentChargeError>({
|
|
3124
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}/${externalId}/charge`,
|
|
3125
|
+
method: 'POST',
|
|
3126
|
+
body: data,
|
|
3127
|
+
secure: true,
|
|
3128
|
+
type: ContentType.Json,
|
|
3129
|
+
...params,
|
|
3130
|
+
}),
|
|
3131
|
+
|
|
3132
|
+
/**
|
|
3133
|
+
* @description Retrieve a specific session result
|
|
3134
|
+
*
|
|
3135
|
+
* @tags Session Result
|
|
3136
|
+
* @name GetResult
|
|
3137
|
+
* @summary Get Session Result
|
|
3138
|
+
* @request GET:/session/{sessionID}/result/{resultID}/{externalID}
|
|
3139
|
+
* @secure
|
|
3140
|
+
*/
|
|
3141
|
+
getResult: (sessionId: string, resultId: string, externalId: string, params: RequestParams = {}) =>
|
|
3142
|
+
this.request<GetResultData, GetResultError>({
|
|
3143
|
+
path: `/session/${sessionId}/result/${resultId}/${externalId}`,
|
|
3144
|
+
method: 'GET',
|
|
3145
|
+
secure: true,
|
|
3146
|
+
...params,
|
|
3147
|
+
}),
|
|
3148
|
+
|
|
3149
|
+
/**
|
|
3150
|
+
* @description Create a new session result
|
|
3151
|
+
*
|
|
3152
|
+
* @tags Session Result
|
|
3153
|
+
* @name CreateResult
|
|
3154
|
+
* @summary Create Session Result
|
|
3155
|
+
* @request POST:/session/{sessionID}/result/{resultID}/{externalID}
|
|
3156
|
+
* @secure
|
|
3157
|
+
*/
|
|
3158
|
+
createResult: (
|
|
3159
|
+
sessionId: string,
|
|
3160
|
+
resultId: string,
|
|
3161
|
+
externalId: string,
|
|
3162
|
+
data: InputHuw5M2U5Gx,
|
|
3163
|
+
params: RequestParams = {}
|
|
3164
|
+
) =>
|
|
3165
|
+
this.request<CreateResultData, CreateResultError>({
|
|
3166
|
+
path: `/session/${sessionId}/result/${resultId}/${externalId}`,
|
|
3167
|
+
method: 'POST',
|
|
3168
|
+
body: data,
|
|
3169
|
+
secure: true,
|
|
3170
|
+
type: ContentType.Json,
|
|
3171
|
+
...params,
|
|
3172
|
+
}),
|
|
3173
|
+
|
|
3174
|
+
/**
|
|
3175
|
+
* @description Update an existing session result
|
|
3176
|
+
*
|
|
3177
|
+
* @tags Session Result
|
|
3178
|
+
* @name UpdateResult
|
|
3179
|
+
* @summary Update Session Result
|
|
3180
|
+
* @request PUT:/session/{sessionID}/result/{resultID}/{externalID}
|
|
3181
|
+
* @secure
|
|
3182
|
+
*/
|
|
3183
|
+
updateResult: (
|
|
3184
|
+
sessionId: string,
|
|
3185
|
+
resultId: string,
|
|
3186
|
+
externalId: string,
|
|
3187
|
+
data: InputXxwuna2Nn,
|
|
3188
|
+
params: RequestParams = {}
|
|
3189
|
+
) =>
|
|
3190
|
+
this.request<UpdateResultData, UpdateResultError>({
|
|
3191
|
+
path: `/session/${sessionId}/result/${resultId}/${externalId}`,
|
|
3192
|
+
method: 'PUT',
|
|
3193
|
+
body: data,
|
|
3194
|
+
secure: true,
|
|
3195
|
+
type: ContentType.Json,
|
|
3196
|
+
...params,
|
|
3197
|
+
}),
|
|
3198
|
+
|
|
3199
|
+
/**
|
|
3200
|
+
* @description Delete a session result
|
|
3201
|
+
*
|
|
3202
|
+
* @tags Session Result
|
|
3203
|
+
* @name DeleteResult
|
|
3204
|
+
* @summary Delete Session Result
|
|
3205
|
+
* @request DELETE:/session/{sessionID}/result/{resultID}/{externalID}
|
|
3206
|
+
* @secure
|
|
3207
|
+
*/
|
|
3208
|
+
deleteResult: (sessionId: string, resultId: string, externalId: string, params: RequestParams = {}) =>
|
|
3209
|
+
this.request<DeleteResultData, DeleteResultError>({
|
|
3210
|
+
path: `/session/${sessionId}/result/${resultId}/${externalId}`,
|
|
3211
|
+
method: 'DELETE',
|
|
3212
|
+
secure: true,
|
|
3213
|
+
...params,
|
|
3214
|
+
}),
|
|
3215
|
+
|
|
3216
|
+
/**
|
|
3217
|
+
* @description Publish a session result
|
|
3218
|
+
*
|
|
3219
|
+
* @tags Session Result
|
|
3220
|
+
* @name CreateResultPublish
|
|
3221
|
+
* @summary Publish Session Result
|
|
3222
|
+
* @request POST:/session/{sessionID}/result/{resultID}/{externalID}/publish
|
|
3223
|
+
* @secure
|
|
3224
|
+
*/
|
|
3225
|
+
createResultPublish: (sessionId: string, resultId: string, externalId: string, params: RequestParams = {}) =>
|
|
3226
|
+
this.request<CreateResultPublishData, CreateResultPublishError>({
|
|
3227
|
+
path: `/session/${sessionId}/result/${resultId}/${externalId}/publish`,
|
|
3228
|
+
method: 'POST',
|
|
3229
|
+
secure: true,
|
|
3230
|
+
...params,
|
|
3231
|
+
}),
|
|
3232
|
+
|
|
3233
|
+
/**
|
|
3234
|
+
* @description Retrieve a session instructor assignment
|
|
3235
|
+
*
|
|
3236
|
+
* @tags Session Instructor
|
|
3237
|
+
* @name GetInstructor
|
|
3238
|
+
* @summary Get Session Instructor
|
|
3239
|
+
* @request GET:/session/{sessionID}/instructor/{instructorID}
|
|
3240
|
+
* @secure
|
|
3241
|
+
*/
|
|
3242
|
+
getInstructor: (sessionId: string, instructorId: string, params: RequestParams = {}) =>
|
|
3243
|
+
this.request<GetInstructorResult, GetInstructorFail>({
|
|
3244
|
+
path: `/session/${sessionId}/instructor/${instructorId}`,
|
|
3245
|
+
method: 'GET',
|
|
3246
|
+
secure: true,
|
|
3247
|
+
...params,
|
|
3248
|
+
}),
|
|
3249
|
+
|
|
3250
|
+
/**
|
|
3251
|
+
* @description Assign an instructor to a session
|
|
3252
|
+
*
|
|
3253
|
+
* @tags Session Instructor
|
|
3254
|
+
* @name CreateInstructor
|
|
3255
|
+
* @summary Assign Session Instructor
|
|
3256
|
+
* @request POST:/session/{sessionID}/instructor/{instructorID}
|
|
3257
|
+
* @secure
|
|
3258
|
+
*/
|
|
3259
|
+
createInstructor: (
|
|
3260
|
+
sessionId: string,
|
|
3261
|
+
instructorId: string,
|
|
3262
|
+
data: SessionInstructorSchema,
|
|
3263
|
+
params: RequestParams = {}
|
|
3264
|
+
) =>
|
|
3265
|
+
this.request<CreateInstructorResult, CreateInstructorFail>({
|
|
3266
|
+
path: `/session/${sessionId}/instructor/${instructorId}`,
|
|
3267
|
+
method: 'POST',
|
|
3268
|
+
body: data,
|
|
3269
|
+
secure: true,
|
|
3270
|
+
type: ContentType.Json,
|
|
3271
|
+
...params,
|
|
3272
|
+
}),
|
|
3273
|
+
|
|
3274
|
+
/**
|
|
3275
|
+
* @description Update a session instructor assignment
|
|
3276
|
+
*
|
|
3277
|
+
* @tags Session Instructor
|
|
3278
|
+
* @name UpdateInstructor
|
|
3279
|
+
* @summary Update Session Instructor
|
|
3280
|
+
* @request PUT:/session/{sessionID}/instructor/{instructorID}
|
|
3281
|
+
* @secure
|
|
3282
|
+
*/
|
|
3283
|
+
updateInstructor: (
|
|
3284
|
+
sessionId: string,
|
|
3285
|
+
instructorId: string,
|
|
3286
|
+
data: SessionInstructorSchema,
|
|
3287
|
+
params: RequestParams = {}
|
|
3288
|
+
) =>
|
|
3289
|
+
this.request<UpdateInstructorResult, UpdateInstructorFail>({
|
|
3290
|
+
path: `/session/${sessionId}/instructor/${instructorId}`,
|
|
3291
|
+
method: 'PUT',
|
|
3292
|
+
body: data,
|
|
3293
|
+
secure: true,
|
|
3294
|
+
type: ContentType.Json,
|
|
3295
|
+
...params,
|
|
3296
|
+
}),
|
|
3297
|
+
|
|
3298
|
+
/**
|
|
3299
|
+
* @description Remove an instructor from a session
|
|
3300
|
+
*
|
|
3301
|
+
* @tags Session Instructor
|
|
3302
|
+
* @name DeleteInstructor
|
|
3303
|
+
* @summary Unassign Session Instructor
|
|
3304
|
+
* @request DELETE:/session/{sessionID}/instructor/{instructorID}
|
|
3305
|
+
* @secure
|
|
3306
|
+
*/
|
|
3307
|
+
deleteInstructor: (sessionId: string, instructorId: string, params: RequestParams = {}) =>
|
|
3308
|
+
this.request<DeleteInstructorResult, DeleteInstructorFail>({
|
|
3309
|
+
path: `/session/${sessionId}/instructor/${instructorId}`,
|
|
3310
|
+
method: 'DELETE',
|
|
3311
|
+
secure: true,
|
|
3312
|
+
...params,
|
|
3313
|
+
}),
|
|
3314
|
+
|
|
3315
|
+
/**
|
|
3316
|
+
* @description Retrieve a session invitation
|
|
3317
|
+
*
|
|
3318
|
+
* @tags Session Invitation
|
|
3319
|
+
* @name GetInvitation
|
|
3320
|
+
* @summary Get Session Invitation
|
|
3321
|
+
* @request GET:/session/{sessionID}/invitation/{invitationID}
|
|
3322
|
+
* @secure
|
|
3323
|
+
*/
|
|
3324
|
+
getInvitation: (sessionId: string, invitationId: string, params: RequestParams = {}) =>
|
|
3325
|
+
this.request<GetInvitationData, GetInvitationError>({
|
|
3326
|
+
path: `/session/${sessionId}/invitation/${invitationId}`,
|
|
3327
|
+
method: 'GET',
|
|
3328
|
+
secure: true,
|
|
3329
|
+
...params,
|
|
3330
|
+
}),
|
|
3331
|
+
|
|
3332
|
+
/**
|
|
3333
|
+
* @description Create a new session invitation
|
|
3334
|
+
*
|
|
3335
|
+
* @tags Session Invitation
|
|
3336
|
+
* @name CreateInvitation
|
|
3337
|
+
* @summary Create Session Invitation
|
|
3338
|
+
* @request POST:/session/{sessionID}/invitation/{invitationID}
|
|
3339
|
+
* @secure
|
|
3340
|
+
*/
|
|
3341
|
+
createInvitation: (sessionId: string, invitationId: string, data: InputW0Gt14Iief, params: RequestParams = {}) =>
|
|
3342
|
+
this.request<CreateInvitationData, CreateInvitationError>({
|
|
3343
|
+
path: `/session/${sessionId}/invitation/${invitationId}`,
|
|
3344
|
+
method: 'POST',
|
|
3345
|
+
body: data,
|
|
3346
|
+
secure: true,
|
|
3347
|
+
type: ContentType.Json,
|
|
3348
|
+
...params,
|
|
3349
|
+
}),
|
|
3350
|
+
|
|
3351
|
+
/**
|
|
3352
|
+
* @description Update an existing session invitation
|
|
3353
|
+
*
|
|
3354
|
+
* @tags Session Invitation
|
|
3355
|
+
* @name UpdateInvitation
|
|
3356
|
+
* @summary Update Session Invitation
|
|
3357
|
+
* @request PUT:/session/{sessionID}/invitation/{invitationID}
|
|
3358
|
+
* @secure
|
|
3359
|
+
*/
|
|
3360
|
+
updateInvitation: (sessionId: string, invitationId: string, data: InputF61Tonm0Be, params: RequestParams = {}) =>
|
|
3361
|
+
this.request<UpdateInvitationData, UpdateInvitationError>({
|
|
3362
|
+
path: `/session/${sessionId}/invitation/${invitationId}`,
|
|
3363
|
+
method: 'PUT',
|
|
3364
|
+
body: data,
|
|
3365
|
+
secure: true,
|
|
3366
|
+
type: ContentType.Json,
|
|
3367
|
+
...params,
|
|
3368
|
+
}),
|
|
3369
|
+
|
|
3370
|
+
/**
|
|
3371
|
+
* @description Delete a session invitation
|
|
3372
|
+
*
|
|
3373
|
+
* @tags Session Invitation
|
|
3374
|
+
* @name DeleteInvitation
|
|
3375
|
+
* @summary Delete Session Invitation
|
|
3376
|
+
* @request DELETE:/session/{sessionID}/invitation/{invitationID}
|
|
3377
|
+
* @secure
|
|
3378
|
+
*/
|
|
3379
|
+
deleteInvitation: (sessionId: string, invitationId: string, params: RequestParams = {}) =>
|
|
3380
|
+
this.request<DeleteInvitationData, DeleteInvitationError>({
|
|
3381
|
+
path: `/session/${sessionId}/invitation/${invitationId}`,
|
|
3382
|
+
method: 'DELETE',
|
|
3383
|
+
secure: true,
|
|
3384
|
+
...params,
|
|
3385
|
+
}),
|
|
3386
|
+
|
|
3387
|
+
/**
|
|
3388
|
+
* @description Validate a session invitation code
|
|
3389
|
+
*
|
|
3390
|
+
* @tags Session Invitation
|
|
3391
|
+
* @name GetInvitationValidate
|
|
3392
|
+
* @summary Validate Session Invitation
|
|
3393
|
+
* @request GET:/session/invitation/validate/{invitationCode}
|
|
3394
|
+
* @secure
|
|
3395
|
+
*/
|
|
3396
|
+
getInvitationValidate: (invitationCode: string, params: RequestParams = {}) =>
|
|
3397
|
+
this.request<GetInvitationValidateData, GetInvitationValidateError>({
|
|
3398
|
+
path: `/session/invitation/validate/${invitationCode}`,
|
|
3399
|
+
method: 'GET',
|
|
3400
|
+
secure: true,
|
|
3401
|
+
...params,
|
|
3402
|
+
}),
|
|
3403
|
+
|
|
3404
|
+
/**
|
|
3405
|
+
* @description Retrieve a specific financial charge
|
|
3406
|
+
*
|
|
3407
|
+
* @tags Session Financial Charge
|
|
3408
|
+
* @name GetCharge
|
|
3409
|
+
* @summary Get Session Financial Charge
|
|
3410
|
+
* @request GET:/session/{sessionID}/charge/{userID}/{timestamp}
|
|
3411
|
+
* @secure
|
|
3412
|
+
*/
|
|
3413
|
+
getCharge: (sessionId: string, userId: string, timestamp: string, params: RequestParams = {}) =>
|
|
3414
|
+
this.request<GetChargeData, GetChargeError>({
|
|
3415
|
+
path: `/session/${sessionId}/charge/${userId}/${timestamp}`,
|
|
3416
|
+
method: 'GET',
|
|
3417
|
+
secure: true,
|
|
3418
|
+
...params,
|
|
3419
|
+
}),
|
|
3420
|
+
|
|
3421
|
+
/**
|
|
3422
|
+
* @description Get a signed URL to download a session document
|
|
3423
|
+
*
|
|
3424
|
+
* @tags Session Document
|
|
3425
|
+
* @name GetDocumentFileSign
|
|
3426
|
+
* @summary Get Session Document Signed URL
|
|
3427
|
+
* @request GET:/session/{sessionID}/document/fileSign/{fileID}
|
|
3428
|
+
* @secure
|
|
3429
|
+
*/
|
|
3430
|
+
getDocumentFileSign: (sessionId: string, fileId: string, params: RequestParams = {}) =>
|
|
3431
|
+
this.request<GetDocumentFileSignData, GetDocumentFileSignError>({
|
|
3432
|
+
path: `/session/${sessionId}/document/fileSign/${fileId}`,
|
|
3433
|
+
method: 'GET',
|
|
3434
|
+
secure: true,
|
|
3435
|
+
...params,
|
|
3436
|
+
}),
|
|
3437
|
+
|
|
3438
|
+
/**
|
|
3439
|
+
* @description Get a signed URL to upload a session document
|
|
3440
|
+
*
|
|
3441
|
+
* @tags Session Document
|
|
3442
|
+
* @name CreateDocumentFileSign
|
|
3443
|
+
* @summary Get Session Document Upload URL
|
|
3444
|
+
* @request POST:/session/{sessionID}/document/fileSign/{fileID}
|
|
3445
|
+
* @secure
|
|
3446
|
+
*/
|
|
3447
|
+
createDocumentFileSign: (sessionId: string, fileId: string, params: RequestParams = {}) =>
|
|
3448
|
+
this.request<CreateDocumentFileSignData, CreateDocumentFileSignError>({
|
|
3449
|
+
path: `/session/${sessionId}/document/fileSign/${fileId}`,
|
|
3450
|
+
method: 'POST',
|
|
3451
|
+
secure: true,
|
|
3452
|
+
...params,
|
|
3453
|
+
}),
|
|
3454
|
+
|
|
3455
|
+
/**
|
|
3456
|
+
* @description Get a signed URL to delete a session document
|
|
3457
|
+
*
|
|
3458
|
+
* @tags Session Document
|
|
3459
|
+
* @name DeleteDocumentFileSign
|
|
3460
|
+
* @summary Delete Session Document
|
|
3461
|
+
* @request DELETE:/session/{sessionID}/document/fileSign/{fileID}
|
|
3462
|
+
* @secure
|
|
3463
|
+
*/
|
|
3464
|
+
deleteDocumentFileSign: (sessionId: string, fileId: string, params: RequestParams = {}) =>
|
|
3465
|
+
this.request<DeleteDocumentFileSignData, DeleteDocumentFileSignError>({
|
|
3466
|
+
path: `/session/${sessionId}/document/fileSign/${fileId}`,
|
|
3467
|
+
method: 'DELETE',
|
|
3468
|
+
secure: true,
|
|
3469
|
+
...params,
|
|
3470
|
+
}),
|
|
3471
|
+
|
|
3472
|
+
/**
|
|
3473
|
+
* @description Add a document to a session
|
|
3474
|
+
*
|
|
3475
|
+
* @tags Session Document
|
|
3476
|
+
* @name CreateDocument
|
|
3477
|
+
* @summary Add Session Document
|
|
3478
|
+
* @request POST:/session/{sessionID}/document
|
|
3479
|
+
* @secure
|
|
3480
|
+
*/
|
|
3481
|
+
createDocument: (sessionId: string, data: SessionDocumentSchema, params: RequestParams = {}) =>
|
|
3482
|
+
this.request<CreateDocumentData, CreateDocumentError>({
|
|
3483
|
+
path: `/session/${sessionId}/document`,
|
|
3484
|
+
method: 'POST',
|
|
3485
|
+
body: data,
|
|
3486
|
+
secure: true,
|
|
3487
|
+
type: ContentType.Json,
|
|
3488
|
+
...params,
|
|
3489
|
+
}),
|
|
3490
|
+
|
|
3491
|
+
/**
|
|
3492
|
+
* @description Remove a document from a session
|
|
3493
|
+
*
|
|
3494
|
+
* @tags Session Document
|
|
3495
|
+
* @name DeleteDocument
|
|
3496
|
+
* @summary Delete Session Document
|
|
3497
|
+
* @request DELETE:/session/{sessionID}/document/{fileID}
|
|
3498
|
+
* @secure
|
|
3499
|
+
*/
|
|
3500
|
+
deleteDocument: (sessionId: string, fileId: string, params: RequestParams = {}) =>
|
|
3501
|
+
this.request<DeleteDocumentData, DeleteDocumentError>({
|
|
3502
|
+
path: `/session/${sessionId}/document/${fileId}`,
|
|
3503
|
+
method: 'DELETE',
|
|
3504
|
+
secure: true,
|
|
3505
|
+
...params,
|
|
3506
|
+
}),
|
|
3507
|
+
|
|
3508
|
+
/**
|
|
3509
|
+
* @description Batch create or update attendances and results for a session
|
|
3510
|
+
*
|
|
3511
|
+
* @tags Session Attendance, Session Result
|
|
3512
|
+
* @name CreateAttendancesResultsBatchUpsert
|
|
3513
|
+
* @summary Batch Upsert Attendances and Results
|
|
3514
|
+
* @request POST:/session/{sessionID}/attendances/results/batchUpsert
|
|
3515
|
+
* @secure
|
|
3516
|
+
*/
|
|
3517
|
+
createAttendancesResultsBatchUpsert: (
|
|
3518
|
+
sessionId: string,
|
|
3519
|
+
data: SessionBatchUpdateSchema,
|
|
3520
|
+
params: RequestParams = {}
|
|
3521
|
+
) =>
|
|
3522
|
+
this.request<CreateAttendancesResultsBatchUpsertData, CreateAttendancesResultsBatchUpsertError>({
|
|
3523
|
+
path: `/session/${sessionId}/attendances/results/batchUpsert`,
|
|
3524
|
+
method: 'POST',
|
|
3525
|
+
body: data,
|
|
3526
|
+
secure: true,
|
|
3527
|
+
type: ContentType.Json,
|
|
3528
|
+
...params,
|
|
3529
|
+
}),
|
|
3530
|
+
|
|
3531
|
+
/**
|
|
3532
|
+
* @description Retrieve user data for a session
|
|
3533
|
+
*
|
|
3534
|
+
* @tags Session
|
|
3535
|
+
* @name GetUserData
|
|
3536
|
+
* @summary Get Session User Data
|
|
3537
|
+
* @request GET:/session/{sessionID}/userData/{userID}/{externalID}
|
|
3538
|
+
* @secure
|
|
3539
|
+
*/
|
|
3540
|
+
getUserData: (sessionId: string, userId: string, externalId: string, params: RequestParams = {}) =>
|
|
3541
|
+
this.request<GetUserDataData, GetUserDataError>({
|
|
3542
|
+
path: `/session/${sessionId}/userData/${userId}/${externalId}`,
|
|
3543
|
+
method: 'GET',
|
|
3544
|
+
secure: true,
|
|
3545
|
+
...params,
|
|
3546
|
+
}),
|
|
3547
|
+
|
|
3548
|
+
/**
|
|
3549
|
+
* @description List session events within a time range
|
|
3550
|
+
*
|
|
3551
|
+
* @tags Session
|
|
3552
|
+
* @name ListEvents
|
|
3553
|
+
* @summary List Session Events
|
|
3554
|
+
* @request POST:/session/events/{startTime}/{endTime}
|
|
3555
|
+
* @secure
|
|
3556
|
+
*/
|
|
3557
|
+
listEvents: (startTime: string, endTime: string, params: RequestParams = {}) =>
|
|
3558
|
+
this.request<ListEventsResult, ListEventsFail>({
|
|
3559
|
+
path: `/session/events/${startTime}/${endTime}`,
|
|
3560
|
+
method: 'POST',
|
|
3561
|
+
secure: true,
|
|
3562
|
+
...params,
|
|
3563
|
+
}),
|
|
3564
|
+
|
|
3565
|
+
/**
|
|
3566
|
+
* @description List session events within a time range filtered by course
|
|
3567
|
+
*
|
|
3568
|
+
* @tags Session
|
|
3569
|
+
* @name ListEvents2
|
|
3570
|
+
* @summary List Session Events By Course
|
|
3571
|
+
* @request POST:/session/events/{startTime}/{endTime}/{courseID}
|
|
3572
|
+
* @originalName listEvents
|
|
3573
|
+
* @duplicate
|
|
3574
|
+
* @secure
|
|
3575
|
+
*/
|
|
3576
|
+
listEvents2: (startTime: string, endTime: string, courseId: string, params: RequestParams = {}) =>
|
|
3577
|
+
this.request<ListEvents2Data, ListEvents2Error>({
|
|
3578
|
+
path: `/session/events/${startTime}/${endTime}/${courseId}`,
|
|
3579
|
+
method: 'POST',
|
|
3580
|
+
secure: true,
|
|
3581
|
+
...params,
|
|
3582
|
+
}),
|
|
3583
|
+
}
|
|
3584
|
+
sessions = {
|
|
3585
|
+
/**
|
|
3586
|
+
* @description Assign an instructor to multiple sessions
|
|
3587
|
+
*
|
|
3588
|
+
* @tags Session Instructor
|
|
3589
|
+
* @name CreateInstructor
|
|
3590
|
+
* @summary Set Instructor On Sessions
|
|
3591
|
+
* @request POST:/sessions/instructor/{instructorID}
|
|
3592
|
+
* @secure
|
|
3593
|
+
*/
|
|
3594
|
+
createInstructor: (instructorId: string, data: SessionsInstructorSetSchema, params: RequestParams = {}) =>
|
|
3595
|
+
this.request<CreateInstructorOutput, CreateInstructorFails>({
|
|
3596
|
+
path: `/sessions/instructor/${instructorId}`,
|
|
3597
|
+
method: 'POST',
|
|
3598
|
+
body: data,
|
|
3599
|
+
secure: true,
|
|
3600
|
+
type: ContentType.Json,
|
|
3601
|
+
...params,
|
|
3602
|
+
}),
|
|
3603
|
+
}
|
|
3604
|
+
customer = {
|
|
3605
|
+
/**
|
|
3606
|
+
* @description List customer-wide session events within a time range
|
|
3607
|
+
*
|
|
3608
|
+
* @tags Session
|
|
3609
|
+
* @name ListSessionEvents
|
|
3610
|
+
* @summary List Customer Session Events
|
|
3611
|
+
* @request POST:/customer/session/events/{startTime}/{endTime}
|
|
3612
|
+
* @secure
|
|
3613
|
+
*/
|
|
3614
|
+
listSessionEvents: (startTime: string, endTime: string, params: RequestParams = {}) =>
|
|
3615
|
+
this.request<ListSessionEventsData, ListSessionEventsError>({
|
|
3616
|
+
path: `/customer/session/events/${startTime}/${endTime}`,
|
|
3617
|
+
method: 'POST',
|
|
3618
|
+
secure: true,
|
|
3619
|
+
...params,
|
|
3620
|
+
}),
|
|
3621
|
+
}
|
|
3622
|
+
reports = {
|
|
3623
|
+
/**
|
|
3624
|
+
* @description Generate enrolments per period report with optional course filter
|
|
3625
|
+
*
|
|
3626
|
+
* @tags Reports
|
|
3627
|
+
* @name CreateEnrolmentsPerPeriod
|
|
3628
|
+
* @summary Enrolments Per Period Report
|
|
3629
|
+
* @request POST:/reports/enrolmentsPerPeriod
|
|
3630
|
+
* @secure
|
|
3631
|
+
*/
|
|
3632
|
+
createEnrolmentsPerPeriod: (data: EnrolmentsPerPeriodReportSchema, params: RequestParams = {}) =>
|
|
3633
|
+
this.request<CreateEnrolmentsPerPeriodData, CreateEnrolmentsPerPeriodError>({
|
|
3634
|
+
path: `/reports/enrolmentsPerPeriod`,
|
|
3635
|
+
method: 'POST',
|
|
3636
|
+
body: data,
|
|
3637
|
+
secure: true,
|
|
3638
|
+
type: ContentType.Json,
|
|
3639
|
+
...params,
|
|
3640
|
+
}),
|
|
3641
|
+
|
|
3642
|
+
/**
|
|
3643
|
+
* @description Generate session results analysis aggregation report
|
|
3644
|
+
*
|
|
3645
|
+
* @tags Reports
|
|
3646
|
+
* @name ListSessionResultsAnalysis
|
|
3647
|
+
* @summary Session Results Analysis Report
|
|
3648
|
+
* @request POST:/reports/sessionResultsAnalysis
|
|
3649
|
+
* @secure
|
|
3650
|
+
*/
|
|
3651
|
+
listSessionResultsAnalysis: (data: SessionResultReportSchema, params: RequestParams = {}) =>
|
|
3652
|
+
this.request<ListSessionResultsAnalysisData, ListSessionResultsAnalysisError>({
|
|
3653
|
+
path: `/reports/sessionResultsAnalysis`,
|
|
3654
|
+
method: 'POST',
|
|
3655
|
+
body: data,
|
|
3656
|
+
secure: true,
|
|
3657
|
+
type: ContentType.Json,
|
|
3658
|
+
...params,
|
|
3659
|
+
}),
|
|
3660
|
+
|
|
3661
|
+
/**
|
|
3662
|
+
* @description Preview session results report without row limit
|
|
3663
|
+
*
|
|
3664
|
+
* @tags Reports
|
|
3665
|
+
* @name CreateSessionResultsPreview
|
|
3666
|
+
* @summary Session Results Preview
|
|
3667
|
+
* @request POST:/reports/sessionResults/preview
|
|
3668
|
+
* @secure
|
|
3669
|
+
*/
|
|
3670
|
+
createSessionResultsPreview: (data: SessionResultsReportSchema, params: RequestParams = {}) =>
|
|
3671
|
+
this.request<CreateSessionResultsPreviewData, CreateSessionResultsPreviewError>({
|
|
3672
|
+
path: `/reports/sessionResults/preview`,
|
|
3673
|
+
method: 'POST',
|
|
3674
|
+
body: data,
|
|
3675
|
+
secure: true,
|
|
3676
|
+
type: ContentType.Json,
|
|
3677
|
+
...params,
|
|
3678
|
+
}),
|
|
3679
|
+
|
|
3680
|
+
/**
|
|
3681
|
+
* @description Generate session results report with max rows limit
|
|
3682
|
+
*
|
|
3683
|
+
* @tags Reports
|
|
3684
|
+
* @name ListSessionResults
|
|
3685
|
+
* @summary Session Results Report
|
|
3686
|
+
* @request POST:/reports/sessionResults
|
|
3687
|
+
* @secure
|
|
3688
|
+
*/
|
|
3689
|
+
listSessionResults: (data: SessionResultsReportSchema, params: RequestParams = {}) =>
|
|
3690
|
+
this.request<ListSessionResultsData, ListSessionResultsError>({
|
|
3691
|
+
path: `/reports/sessionResults`,
|
|
3692
|
+
method: 'POST',
|
|
3693
|
+
body: data,
|
|
3694
|
+
secure: true,
|
|
3695
|
+
type: ContentType.Json,
|
|
3696
|
+
...params,
|
|
3697
|
+
}),
|
|
3698
|
+
|
|
3699
|
+
/**
|
|
3700
|
+
* @description Generate session list report
|
|
3701
|
+
*
|
|
3702
|
+
* @tags Reports
|
|
3703
|
+
* @name CreateSessionList
|
|
3704
|
+
* @summary Session List Report
|
|
3705
|
+
* @request POST:/reports/sessionList
|
|
3706
|
+
* @secure
|
|
3707
|
+
*/
|
|
3708
|
+
createSessionList: (data: SessionListReportSchema, params: RequestParams = {}) =>
|
|
3709
|
+
this.request<CreateSessionListData, CreateSessionListError>({
|
|
3710
|
+
path: `/reports/sessionList`,
|
|
3711
|
+
method: 'POST',
|
|
3712
|
+
body: data,
|
|
3713
|
+
secure: true,
|
|
3714
|
+
type: ContentType.Json,
|
|
3715
|
+
...params,
|
|
3716
|
+
}),
|
|
3717
|
+
|
|
3718
|
+
/**
|
|
3719
|
+
* @description Generate Excel charges report for a session
|
|
3720
|
+
*
|
|
3721
|
+
* @tags Reports
|
|
3722
|
+
* @name ListSessionCharges
|
|
3723
|
+
* @summary Session Charges Report
|
|
3724
|
+
* @request POST:/reports/sessionCharges/{sessionID}
|
|
3725
|
+
* @secure
|
|
3726
|
+
*/
|
|
3727
|
+
listSessionCharges: (sessionId: string, params: RequestParams = {}) =>
|
|
3728
|
+
this.request<ListSessionChargesData, ListSessionChargesError>({
|
|
3729
|
+
path: `/reports/sessionCharges/${sessionId}`,
|
|
3730
|
+
method: 'POST',
|
|
3731
|
+
secure: true,
|
|
3732
|
+
...params,
|
|
3733
|
+
}),
|
|
3734
|
+
|
|
3735
|
+
/**
|
|
3736
|
+
* @description Generate Excel shipping manifest report for a session
|
|
3737
|
+
*
|
|
3738
|
+
* @tags Reports
|
|
3739
|
+
* @name CreateSessionShippingManifest
|
|
3740
|
+
* @summary Session Shipping Manifest Report
|
|
3741
|
+
* @request POST:/reports/sessionShippingManifest/{sessionID}
|
|
3742
|
+
* @secure
|
|
3743
|
+
*/
|
|
3744
|
+
createSessionShippingManifest: (sessionId: string, params: RequestParams = {}) =>
|
|
3745
|
+
this.request<CreateSessionShippingManifestData, CreateSessionShippingManifestError>({
|
|
3746
|
+
path: `/reports/sessionShippingManifest/${sessionId}`,
|
|
3747
|
+
method: 'POST',
|
|
3748
|
+
secure: true,
|
|
3749
|
+
...params,
|
|
3750
|
+
}),
|
|
3751
|
+
}
|
|
3752
|
+
}
|