@examplary/sdk 1.0.3 → 1.1.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.
Files changed (46) hide show
  1. package/README.md +95 -9
  2. package/dist/generated/sdk.d.ts +1702 -0
  3. package/dist/generated/sdk.js +742 -0
  4. package/dist/generated/types.d.ts +5425 -0
  5. package/dist/generated/{client/client/types.gen.js → types.js} +1 -1
  6. package/dist/src/context.d.ts +7 -0
  7. package/dist/src/context.js +22 -0
  8. package/dist/src/error.d.ts +6 -0
  9. package/dist/src/error.js +24 -0
  10. package/dist/src/index.d.ts +5 -14
  11. package/dist/src/index.js +5 -45
  12. package/dist/src/options.d.ts +6 -0
  13. package/dist/{generated/client/core/types.gen.js → src/options.js} +0 -1
  14. package/dist/src/request.d.ts +3 -0
  15. package/dist/src/request.js +46 -0
  16. package/package.json +16 -8
  17. package/dist/generated/client/client/client.gen.d.ts +0 -2
  18. package/dist/generated/client/client/client.gen.js +0 -140
  19. package/dist/generated/client/client/index.d.ts +0 -8
  20. package/dist/generated/client/client/index.js +0 -16
  21. package/dist/generated/client/client/types.gen.d.ts +0 -87
  22. package/dist/generated/client/client/utils.gen.d.ts +0 -14
  23. package/dist/generated/client/client/utils.gen.js +0 -177
  24. package/dist/generated/client/client.gen.d.ts +0 -12
  25. package/dist/generated/client/client.gen.js +0 -6
  26. package/dist/generated/client/core/auth.gen.d.ts +0 -18
  27. package/dist/generated/client/core/auth.gen.js +0 -18
  28. package/dist/generated/client/core/bodySerializer.gen.d.ts +0 -25
  29. package/dist/generated/client/core/bodySerializer.gen.js +0 -60
  30. package/dist/generated/client/core/params.gen.d.ts +0 -43
  31. package/dist/generated/client/core/params.gen.js +0 -104
  32. package/dist/generated/client/core/pathSerializer.gen.d.ts +0 -33
  33. package/dist/generated/client/core/pathSerializer.gen.js +0 -115
  34. package/dist/generated/client/core/queryKeySerializer.gen.d.ts +0 -18
  35. package/dist/generated/client/core/queryKeySerializer.gen.js +0 -98
  36. package/dist/generated/client/core/serverSentEvents.gen.d.ts +0 -71
  37. package/dist/generated/client/core/serverSentEvents.gen.js +0 -135
  38. package/dist/generated/client/core/types.gen.d.ts +0 -78
  39. package/dist/generated/client/core/utils.gen.d.ts +0 -19
  40. package/dist/generated/client/core/utils.gen.js +0 -93
  41. package/dist/generated/client/index.d.ts +0 -2
  42. package/dist/generated/client/index.js +0 -36
  43. package/dist/generated/client/sdk.gen.d.ts +0 -863
  44. package/dist/generated/client/sdk.gen.js +0 -1826
  45. package/dist/generated/client/types.gen.d.ts +0 -2417
  46. package/dist/generated/client/types.gen.js +0 -3
@@ -1,2417 +0,0 @@
1
- export type ClientOptions = {
2
- baseURL: 'https://api.examplary.ai' | 'https://api-staging.examplary.ai' | (string & {});
3
- };
4
- export type GetQuestionTypesPublicData = {
5
- body?: never;
6
- path?: never;
7
- query?: never;
8
- url: '/question-types/public';
9
- };
10
- export type DeleteQuestionTypesByIdData = {
11
- body?: never;
12
- path: {
13
- id: string;
14
- };
15
- query?: never;
16
- url: '/question-types/{id}';
17
- };
18
- export type GetQuestionTypesByIdData = {
19
- body?: never;
20
- path: {
21
- id: string;
22
- };
23
- query?: never;
24
- url: '/question-types/{id}';
25
- };
26
- export type GetQuestionTypesByIdExportQti3PciData = {
27
- body?: never;
28
- path: {
29
- id: string;
30
- };
31
- query?: never;
32
- url: '/question-types/{id}/export/qti3-pci';
33
- };
34
- export type GetQuestionTypesData = {
35
- body?: never;
36
- path?: never;
37
- query?: never;
38
- url: '/question-types';
39
- };
40
- export type PostQuestionTypesData = {
41
- /**
42
- * Schema for defining question types in the Examplary system
43
- */
44
- body?: {
45
- $schema?: string;
46
- /**
47
- * Unique identifier for the question type (e.g. 'my-org.color-picker')
48
- */
49
- id: string;
50
- /**
51
- * Display name for the question type, can be a simple string or translation object
52
- */
53
- name: string | {
54
- [key: string]: string;
55
- };
56
- /**
57
- * Description of the question type, can be a simple string or translation object
58
- */
59
- description: string | {
60
- [key: string]: string;
61
- };
62
- /**
63
- * Path to the icon for this question type
64
- */
65
- icon?: string;
66
- /**
67
- * Keyboard shortcut for quick access to this question type
68
- */
69
- shortcut?: string;
70
- /**
71
- * Options for AI question generation
72
- */
73
- generation?: {
74
- /**
75
- * Whether this question type can be automatically generated using AI (default to false)
76
- */
77
- enabled: boolean;
78
- /**
79
- * Optional instructions to guide AI in generating this question type
80
- */
81
- instructions?: string | Array<string>;
82
- };
83
- /**
84
- * Options for AI question grading
85
- */
86
- grading?: {
87
- /**
88
- * Whether this question type can be automatically graded using AI (default to false)
89
- */
90
- enabled: boolean;
91
- /**
92
- * Optional instructions to guide AI in grading this question type
93
- */
94
- instructions?: string | Array<string>;
95
- };
96
- /**
97
- * Options for AI question scanning
98
- */
99
- scanning?: {
100
- /**
101
- * Optional instructions to guide AI in converting answers for this question type when scanning documents
102
- */
103
- instructions?: string | Array<string>;
104
- };
105
- /**
106
- * Estimated time in minutes to complete this question type
107
- */
108
- timeEstimateMinutes?: number;
109
- /**
110
- * Whether this question type uses AI functionality
111
- */
112
- isAi?: boolean;
113
- /**
114
- * Background color for the question type
115
- */
116
- backgroundColor?: string;
117
- /**
118
- * Position enforcement for this question type
119
- */
120
- enforcePosition?: 'start' | 'end';
121
- /**
122
- * Enforced title for this question type
123
- */
124
- enforceTitle?: string | {
125
- [key: string]: string;
126
- };
127
- /**
128
- * Whether to hide settings for this question type
129
- */
130
- hideSettings?: boolean;
131
- /**
132
- * Whether the preview can be refreshed for this question type
133
- */
134
- isPreviewRefreshable?: boolean;
135
- /**
136
- * Whether this question type has simple scoring
137
- */
138
- hasSimpleScoring?: boolean;
139
- /**
140
- * Placeholder text for the title field
141
- */
142
- titlePlaceholder?: string | {
143
- [key: string]: string;
144
- };
145
- /**
146
- * Placeholder text for the description field
147
- */
148
- descriptionPlaceholder?: string | {
149
- [key: string]: string;
150
- };
151
- /**
152
- * Placeholder text for untitled questions
153
- */
154
- untitledPlaceholder?: string | {
155
- [key: string]: string;
156
- };
157
- /**
158
- * Paths to the components used by this question type
159
- */
160
- components?: {
161
- /**
162
- * Path to the assessment component (question content)
163
- */
164
- assessment?: string;
165
- /**
166
- * Path to the print component (for printing the question)
167
- */
168
- print?: string;
169
- /**
170
- * Path to the settings area component (for configuring question settings)
171
- */
172
- 'settings-area'?: string;
173
- /**
174
- * Path to the results component (for displaying answers)
175
- */
176
- results?: string;
177
- };
178
- /**
179
- * Configuration settings for the question type
180
- */
181
- settings?: Array<{
182
- /**
183
- * Unique identifier for the setting
184
- */
185
- id: string;
186
- /**
187
- * Display name for the setting
188
- */
189
- name: string | {
190
- [key: string]: string;
191
- };
192
- /**
193
- * Help text for the setting
194
- */
195
- helpText?: string | {
196
- [key: string]: string;
197
- };
198
- /**
199
- * Description to help AI agents auto-generate question settings
200
- */
201
- description?: string;
202
- /**
203
- * Type of the setting
204
- */
205
- type: 'enum' | 'string' | 'string-array' | 'number' | 'boolean' | 'custom' | 'scoring-criteria' | 'tags' | 'question-type';
206
- index?: number;
207
- /**
208
- * Whether the setting is hidden from the user
209
- */
210
- hidden?: boolean;
211
- /**
212
- * Default value for the setting
213
- */
214
- default?: unknown | null;
215
- /**
216
- * Whether this setting is required
217
- */
218
- required?: boolean;
219
- /**
220
- * Available options for enum type settings
221
- */
222
- options?: Array<{
223
- /**
224
- * Option value
225
- */
226
- value: string;
227
- /**
228
- * Option label
229
- */
230
- label: string | {
231
- [key: string]: string;
232
- };
233
- }>;
234
- /**
235
- * Placeholder text for the setting
236
- */
237
- placeholder?: string | {
238
- [key: string]: string;
239
- } | null;
240
- /**
241
- * Step value for number type settings
242
- */
243
- step?: number;
244
- /**
245
- * Minimum value for number type settings
246
- */
247
- min?: number;
248
- /**
249
- * Maximum value for number type settings
250
- */
251
- max?: number;
252
- }>;
253
- /**
254
- * Whether this question type is public and can be used by all users
255
- */
256
- public?: boolean;
257
- /**
258
- * Custom translations for this question type
259
- */
260
- translations?: {
261
- [key: string]: string | {
262
- [key: string]: string;
263
- };
264
- };
265
- /**
266
- * Capabilities of the question type for various operations
267
- */
268
- capabilities?: {
269
- /**
270
- * Whether this question type allows the student to scan an answer using their phone. Only supported for practice spaces.
271
- */
272
- 'answer-scanning'?: boolean;
273
- [key: string]: unknown;
274
- };
275
- /**
276
- * Export configuration for various formats
277
- */
278
- export?: {
279
- /**
280
- * QTI 3.0 mapping configuration for transforming questions to QTI format
281
- */
282
- qti3?: {
283
- interaction: {
284
- /**
285
- * The QTI interaction type to generate
286
- */
287
- type: 'AssociateInteraction' | 'ChoiceInteraction' | 'DrawingInteraction' | 'EndAttemptInteraction' | 'ExtendedTextInteraction' | 'GapMatchInteraction' | 'GraphicAssociateInteraction' | 'GraphicGapMatchInteraction' | 'GraphicOrderInteraction' | 'HotspotInteraction' | 'HottextInteraction' | 'InlineChoiceInteraction' | 'MatchInteraction' | 'MediaInteraction' | 'OrderInteraction' | 'PortableCustomInteraction' | 'PositionObjectInteraction' | 'SelectPointInteraction' | 'SliderInteraction' | 'TextEntryInteraction' | 'UploadInteraction';
288
- options?: {
289
- [key: string]: string | number | boolean | Array<unknown> | {
290
- [key: string]: unknown;
291
- };
292
- };
293
- };
294
- };
295
- };
296
- /**
297
- * Optional metadata for the question type, only used by external applications
298
- */
299
- metadata?: {
300
- [key: string]: string | number | boolean | null;
301
- };
302
- stylesheet?: string;
303
- index?: number;
304
- isDefault?: boolean;
305
- };
306
- path?: never;
307
- query?: never;
308
- url: '/question-types';
309
- };
310
- export type PostQuestionTypesByIdEnableData = {
311
- body?: never;
312
- path: {
313
- id: string;
314
- };
315
- query?: never;
316
- url: '/question-types/{id}/enable';
317
- };
318
- export type PostQuestionTypesByIdDisableData = {
319
- body?: never;
320
- path: {
321
- id: string;
322
- };
323
- query?: never;
324
- url: '/question-types/{id}/disable';
325
- };
326
- export type GetLibraryPublishersByPublisherIdItemsData = {
327
- body?: never;
328
- path: {
329
- publisherId: string;
330
- };
331
- query?: never;
332
- url: '/library/publishers/{publisherId}/items';
333
- };
334
- export type PostLibraryPublishersByPublisherIdItemsData = {
335
- body?: {
336
- /**
337
- * The type of resource being added to the library. Currently only 'exam' is supported.
338
- */
339
- resourceType: 'exam';
340
- /**
341
- * The ID of the resource being added to the library, e.g. `exam_123`.
342
- */
343
- resourceId: string;
344
- /**
345
- * A publicly visible description of the library item.
346
- */
347
- description: string;
348
- /**
349
- * The name of the library item. If not provided, the name of the original resource will be used.
350
- */
351
- name?: string | null;
352
- /**
353
- * The student level associated with the library item.
354
- */
355
- studentLevel?: string | null;
356
- /**
357
- * The subject associated with the library item.
358
- */
359
- subject?: string | null;
360
- /**
361
- * Optional tags, e.g. ['math', 'science'].
362
- */
363
- tags?: Array<string> | null;
364
- };
365
- path: {
366
- publisherId: string;
367
- };
368
- query?: never;
369
- url: '/library/publishers/{publisherId}/items';
370
- };
371
- export type GetLibraryItemsFeaturedData = {
372
- body?: never;
373
- path?: never;
374
- query?: never;
375
- url: '/library/items/featured';
376
- };
377
- export type DeleteLibraryItemsByItemIdData = {
378
- body?: never;
379
- path: {
380
- itemId: string;
381
- };
382
- query?: never;
383
- url: '/library/items/{itemId}';
384
- };
385
- export type PatchLibraryItemsByItemIdData = {
386
- body?: {
387
- /**
388
- * A publicly visible description of the library item.
389
- */
390
- description?: string;
391
- /**
392
- * The name of the library item. If not provided, the name of the original resource will be used.
393
- */
394
- name?: string | null;
395
- /**
396
- * The student level associated with the library item.
397
- */
398
- studentLevel?: string | null;
399
- /**
400
- * The subject associated with the library item.
401
- */
402
- subject?: string | null;
403
- /**
404
- * Optional tags, e.g. ['math', 'science'].
405
- */
406
- tags?: Array<string> | null;
407
- };
408
- path: {
409
- itemId: string;
410
- };
411
- query?: never;
412
- url: '/library/items/{itemId}';
413
- };
414
- export type GetLibraryPublishersFeaturedData = {
415
- body?: never;
416
- path?: never;
417
- query?: never;
418
- url: '/library/publishers/featured';
419
- };
420
- export type GetLibraryPublishersData = {
421
- body?: never;
422
- path?: never;
423
- query?: never;
424
- url: '/library/publishers';
425
- };
426
- export type PostLibraryPublishersData = {
427
- body?: {
428
- name: string;
429
- bio?: string;
430
- logoImageUrl?: string;
431
- socialLinks?: Array<{
432
- type: 'facebook' | 'instagram' | 'website' | 'tiktok' | 'youtube';
433
- href: string;
434
- }>;
435
- };
436
- path?: never;
437
- query?: never;
438
- url: '/library/publishers';
439
- };
440
- export type GetLibraryPublishersMineData = {
441
- body?: never;
442
- path?: never;
443
- query?: never;
444
- url: '/library/publishers/mine';
445
- };
446
- export type DeleteLibraryPublishersByPublisherIdData = {
447
- body?: never;
448
- path: {
449
- publisherId: string;
450
- };
451
- query?: never;
452
- url: '/library/publishers/{publisherId}';
453
- };
454
- export type PatchLibraryPublishersByPublisherIdData = {
455
- body?: {
456
- name?: string;
457
- bio?: string;
458
- logoImageUrl?: string;
459
- socialLinks?: Array<{
460
- type: 'facebook' | 'instagram' | 'website' | 'tiktok' | 'youtube';
461
- href: string;
462
- }>;
463
- };
464
- path: {
465
- publisherId: string;
466
- };
467
- query?: never;
468
- url: '/library/publishers/{publisherId}';
469
- };
470
- export type GetOauthAuthorizeData = {
471
- body?: never;
472
- path?: never;
473
- query: {
474
- response_type: 'code';
475
- client_id: string;
476
- redirect_uri: string;
477
- scope?: string;
478
- state?: string;
479
- code_challenge?: string;
480
- code_challenge_method?: 'plain' | 'S256';
481
- };
482
- url: '/oauth/authorize';
483
- };
484
- export type PostOauthTokenData = {
485
- body?: never;
486
- path?: never;
487
- query?: never;
488
- url: '/oauth/token';
489
- };
490
- export type PostEmbedSessionsData = {
491
- body?: {
492
- /**
493
- * The user ID for whom the embed session is created
494
- */
495
- actor: string;
496
- /**
497
- * UI options for the embed session
498
- */
499
- theme: {
500
- /**
501
- * CSS hex color code for primary UI elements, either #RRGGBB or #RGB
502
- */
503
- primaryColor?: string;
504
- /**
505
- * Locale code for UI language. Currently supported: 'en', 'nl' - other values accepted, but will default to English
506
- */
507
- locale?: string;
508
- };
509
- /**
510
- * Additional key-value metadata
511
- */
512
- metadata?: {
513
- [key: string]: string | number | boolean | null;
514
- };
515
- /**
516
- * Optional redirect URL after completion
517
- */
518
- returnUrl?: string;
519
- /**
520
- * Optional allowed origin for postMessage events
521
- */
522
- allowedOrigin?: string;
523
- flow: 'generate-exam';
524
- /**
525
- * Preset values for the generate-exam flow
526
- */
527
- presets: {
528
- name?: string | null;
529
- studentLevel?: string | null;
530
- taxonomyId?: string | null;
531
- sourceMaterialIds?: Array<string> | null;
532
- subject?: string | null;
533
- context?: string | null;
534
- language?: string | null;
535
- intendedDuration?: unknown | null;
536
- allowedGenerationQuestionTypes?: Array<string> | null;
537
- };
538
- } | {
539
- /**
540
- * The user ID for whom the embed session is created
541
- */
542
- actor: string;
543
- /**
544
- * UI options for the embed session
545
- */
546
- theme: {
547
- /**
548
- * CSS hex color code for primary UI elements, either #RRGGBB or #RGB
549
- */
550
- primaryColor?: string;
551
- /**
552
- * Locale code for UI language. Currently supported: 'en', 'nl' - other values accepted, but will default to English
553
- */
554
- locale?: string;
555
- };
556
- /**
557
- * Additional key-value metadata
558
- */
559
- metadata?: {
560
- [key: string]: string | number | boolean | null;
561
- };
562
- /**
563
- * Optional redirect URL after completion
564
- */
565
- returnUrl?: string;
566
- /**
567
- * Optional allowed origin for postMessage events
568
- */
569
- allowedOrigin?: string;
570
- flow: 'edit-rubric';
571
- /**
572
- * Preset values for the edit-rubric flow
573
- */
574
- presets: {
575
- rubric?: {
576
- rubricType?: 'simple' | 'analytical' | 'holistic' | 'exact-values' | null;
577
- criteria?: Array<{
578
- id: string;
579
- title?: string | null;
580
- description?: string | null;
581
- points?: number | null;
582
- minPoints?: number | null;
583
- maxPoints?: number | null;
584
- levels?: Array<{
585
- id: string;
586
- title?: string | null;
587
- description?: string | null;
588
- points?: number | null;
589
- minPoints?: number | null;
590
- maxPoints?: number | null;
591
- }> | null;
592
- }> | null;
593
- exactValuesCaseInsensitive?: boolean | null;
594
- guidance?: string | null;
595
- modelAnswer?: string | null;
596
- templateId?: string | null;
597
- } | null;
598
- showDoneButton?: boolean | null;
599
- };
600
- } | {
601
- /**
602
- * The user ID for whom the embed session is created
603
- */
604
- actor: string;
605
- /**
606
- * UI options for the embed session
607
- */
608
- theme: {
609
- /**
610
- * CSS hex color code for primary UI elements, either #RRGGBB or #RGB
611
- */
612
- primaryColor?: string;
613
- /**
614
- * Locale code for UI language. Currently supported: 'en', 'nl' - other values accepted, but will default to English
615
- */
616
- locale?: string;
617
- };
618
- /**
619
- * Additional key-value metadata
620
- */
621
- metadata?: {
622
- [key: string]: string | number | boolean | null;
623
- };
624
- /**
625
- * Optional redirect URL after completion
626
- */
627
- returnUrl?: string;
628
- /**
629
- * Optional allowed origin for postMessage events
630
- */
631
- allowedOrigin?: string;
632
- flow: 'generate-question';
633
- /**
634
- * Preset values for the generate-question flow
635
- */
636
- presets: {
637
- studentLevel?: string | null;
638
- sourceMaterialIds?: Array<string> | null;
639
- subject?: string | null;
640
- context?: string | null;
641
- language?: string | null;
642
- hideSubject?: boolean | null;
643
- hideStudentLevel?: boolean | null;
644
- questionType?: string | null;
645
- outputFormat?: 'examplary_json' | 'qti_v3p0' | 'qti_v2p1' | null;
646
- };
647
- } | {
648
- /**
649
- * The user ID for whom the embed session is created
650
- */
651
- actor: string;
652
- /**
653
- * UI options for the embed session
654
- */
655
- theme: {
656
- /**
657
- * CSS hex color code for primary UI elements, either #RRGGBB or #RGB
658
- */
659
- primaryColor?: string;
660
- /**
661
- * Locale code for UI language. Currently supported: 'en', 'nl' - other values accepted, but will default to English
662
- */
663
- locale?: string;
664
- };
665
- /**
666
- * Additional key-value metadata
667
- */
668
- metadata?: {
669
- [key: string]: string | number | boolean | null;
670
- };
671
- /**
672
- * Optional redirect URL after completion
673
- */
674
- returnUrl?: string;
675
- /**
676
- * Optional allowed origin for postMessage events
677
- */
678
- allowedOrigin?: string;
679
- flow: 'mark-answer';
680
- /**
681
- * Preset values for the mark-answer flow
682
- */
683
- presets: {
684
- examId: string;
685
- sessionId: string;
686
- questionId: string;
687
- hideScoringCriteria?: boolean | null;
688
- };
689
- };
690
- path?: never;
691
- query?: never;
692
- url: '/embed-sessions';
693
- };
694
- export type PostEmbedSessionsResponses = {
695
- 201: {
696
- id: string;
697
- status: 'pending' | 'started' | 'completed' | 'failed' | 'cancelled';
698
- embedUrl: string;
699
- flow: 'generate-exam' | 'generate-question' | 'edit-rubric' | 'mark-answer';
700
- actor: string;
701
- enabledResponseModes: Array<'return_url' | 'post_message'>;
702
- createdAt: Date;
703
- expiresAt: Date;
704
- createdBy: string;
705
- presets: unknown;
706
- outputs: {
707
- [key: string]: unknown;
708
- };
709
- theme: {
710
- /**
711
- * CSS hex color code for primary UI elements, either #RRGGBB or #RGB
712
- */
713
- primaryColor?: string;
714
- /**
715
- * Locale code for UI language. Currently supported: 'en', 'nl' - other values accepted, but will default to English
716
- */
717
- locale?: string;
718
- };
719
- metadata: {
720
- [key: string]: unknown;
721
- };
722
- };
723
- };
724
- export type PostEmbedSessionsResponse = PostEmbedSessionsResponses[keyof PostEmbedSessionsResponses];
725
- export type DeleteEmbedSessionsByIdData = {
726
- body?: never;
727
- path: {
728
- id: string;
729
- };
730
- query?: never;
731
- url: '/embed-sessions/{id}';
732
- };
733
- export type GetEmbedSessionsByIdData = {
734
- body?: never;
735
- path: {
736
- id: string;
737
- };
738
- query?: never;
739
- url: '/embed-sessions/{id}';
740
- };
741
- export type GetEmbedSessionsByIdResponses = {
742
- 200: {
743
- id: string;
744
- status: 'pending' | 'started' | 'completed' | 'failed' | 'cancelled';
745
- embedUrl: string;
746
- flow: 'generate-exam' | 'generate-question' | 'edit-rubric' | 'mark-answer';
747
- actor: string;
748
- enabledResponseModes: Array<'return_url' | 'post_message'>;
749
- createdAt: Date;
750
- expiresAt: Date;
751
- createdBy: string;
752
- presets: unknown;
753
- outputs: {
754
- [key: string]: unknown;
755
- };
756
- theme: {
757
- /**
758
- * CSS hex color code for primary UI elements, either #RRGGBB or #RGB
759
- */
760
- primaryColor?: string;
761
- /**
762
- * Locale code for UI language. Currently supported: 'en', 'nl' - other values accepted, but will default to English
763
- */
764
- locale?: string;
765
- };
766
- metadata: {
767
- [key: string]: unknown;
768
- };
769
- };
770
- };
771
- export type GetEmbedSessionsByIdResponse = GetEmbedSessionsByIdResponses[keyof GetEmbedSessionsByIdResponses];
772
- export type GetMeData = {
773
- body?: never;
774
- path?: never;
775
- query?: never;
776
- url: '/me';
777
- };
778
- export type PatchMeData = {
779
- body?: {
780
- /**
781
- * The user's name
782
- */
783
- name?: string;
784
- /**
785
- * A map of user preferences
786
- */
787
- preferences?: {
788
- [key: string]: unknown;
789
- };
790
- };
791
- path?: never;
792
- query?: never;
793
- url: '/me';
794
- };
795
- export type GetMediaUploadData = {
796
- body?: never;
797
- path?: never;
798
- query?: {
799
- /**
800
- * Original attachment filename
801
- */
802
- filename?: string;
803
- /**
804
- * Category of file, used for grouping
805
- */
806
- type?: string;
807
- /**
808
- * MIME type of the attachment
809
- */
810
- contentType?: string;
811
- };
812
- url: '/media/upload';
813
- };
814
- export type GetMediaUploadResponses = {
815
- 200: {
816
- uploadUrl?: string;
817
- publicUrl?: string;
818
- };
819
- };
820
- export type GetMediaUploadResponse = GetMediaUploadResponses[keyof GetMediaUploadResponses];
821
- export type DeleteOrgData = {
822
- body?: never;
823
- path?: never;
824
- query?: never;
825
- url: '/org';
826
- };
827
- export type GetOrgData = {
828
- body?: never;
829
- path?: never;
830
- query?: never;
831
- url: '/org';
832
- };
833
- export type PatchOrgData = {
834
- body?: {
835
- name?: string;
836
- logoImageUrl?: string;
837
- menuColor?: string | string;
838
- accentColor?: string | string;
839
- sharingBlockPublic?: boolean;
840
- };
841
- path?: never;
842
- query?: never;
843
- url: '/org';
844
- };
845
- export type GetOrgCustomDomainData = {
846
- body?: never;
847
- path?: never;
848
- query?: never;
849
- url: '/org/custom-domain';
850
- };
851
- export type PostOrgCustomDomainData = {
852
- body?: {
853
- customDomain?: string | null;
854
- };
855
- path?: never;
856
- query?: never;
857
- url: '/org/custom-domain';
858
- };
859
- export type GetOrgsData = {
860
- body?: never;
861
- path?: never;
862
- query?: never;
863
- url: '/orgs';
864
- };
865
- export type PostOrgsData = {
866
- body?: {
867
- name: string;
868
- };
869
- path?: never;
870
- query?: never;
871
- url: '/orgs';
872
- };
873
- export type GetApiKeysData = {
874
- body?: never;
875
- path?: never;
876
- query?: never;
877
- url: '/api-keys';
878
- };
879
- export type PostApiKeysResetData = {
880
- body?: never;
881
- path?: never;
882
- query?: never;
883
- url: '/api-keys/reset';
884
- };
885
- export type GetAttributesData = {
886
- body?: never;
887
- path?: never;
888
- query?: never;
889
- url: '/attributes';
890
- };
891
- export type PostAttributesData = {
892
- body?: {
893
- name: string;
894
- attributeType: 'string' | 'category' | 'studentLevel' | 'subject';
895
- options?: Array<string>;
896
- showInStudentDashboard?: boolean;
897
- showAsStudentPreference?: boolean;
898
- position?: number;
899
- appearanceColor?: string | string | null;
900
- };
901
- path?: never;
902
- query?: never;
903
- url: '/attributes';
904
- };
905
- export type PostAttributesReorderData = {
906
- body?: {
907
- order: Array<{
908
- id: string;
909
- position: number;
910
- }>;
911
- };
912
- path?: never;
913
- query?: never;
914
- url: '/attributes/reorder';
915
- };
916
- export type DeleteAttributesByIdData = {
917
- body?: never;
918
- path: {
919
- id: string;
920
- };
921
- query?: never;
922
- url: '/attributes/{id}';
923
- };
924
- export type PostAttributesByIdData = {
925
- body?: {
926
- name?: string;
927
- attributeType?: 'string' | 'category' | 'studentLevel' | 'subject';
928
- options?: Array<string>;
929
- showInStudentDashboard?: boolean;
930
- showAsStudentPreference?: boolean;
931
- position?: number;
932
- appearanceColor?: string | string | null;
933
- };
934
- path: {
935
- id: string;
936
- };
937
- query?: never;
938
- url: '/attributes/{id}';
939
- };
940
- export type GetTaxonomiesData = {
941
- body?: never;
942
- path?: never;
943
- query?: never;
944
- url: '/taxonomies';
945
- };
946
- export type PostTaxonomiesData = {
947
- body?: {
948
- name: string;
949
- description?: string;
950
- instructions?: string;
951
- levels: Array<{
952
- name?: string;
953
- instructions?: string;
954
- }>;
955
- };
956
- path?: never;
957
- query?: never;
958
- url: '/taxonomies';
959
- };
960
- export type DeleteTaxonomiesByIdData = {
961
- body?: never;
962
- path: {
963
- id: string;
964
- };
965
- query?: never;
966
- url: '/taxonomies/{id}';
967
- };
968
- export type PostTaxonomiesByIdData = {
969
- body?: {
970
- name: string;
971
- description?: string;
972
- instructions?: string;
973
- levels: Array<{
974
- name?: string;
975
- instructions?: string;
976
- }>;
977
- [key: string]: unknown;
978
- };
979
- path: {
980
- id: string;
981
- };
982
- query?: never;
983
- url: '/taxonomies/{id}';
984
- };
985
- export type GetPermissionsByResourceData = {
986
- body?: never;
987
- path: {
988
- /**
989
- * The ID of the resource to list permissions for, e.g. `exam_1234`.
990
- */
991
- resource: string;
992
- };
993
- query?: never;
994
- url: '/permissions/{resource}';
995
- };
996
- export type GetPermissionsByResourceErrors = {
997
- /**
998
- * No access to this resource.
999
- */
1000
- 403: unknown;
1001
- };
1002
- export type GetPermissionsByResourceResponses = {
1003
- /**
1004
- * List of permissions for the specified resource.
1005
- */
1006
- 200: Array<{
1007
- actor: {
1008
- id: string;
1009
- name?: string;
1010
- avatar?: string;
1011
- type: 'user' | 'group' | 'org';
1012
- orgRole?: 'owner' | 'admin' | 'teacher' | 'student' | 'member';
1013
- };
1014
- role: 'owner' | 'manager' | 'editor' | 'viewer' | 'participant';
1015
- createdAt: Date;
1016
- updatedAt: Date;
1017
- createdBy: string;
1018
- }>;
1019
- };
1020
- export type GetPermissionsByResourceResponse = GetPermissionsByResourceResponses[keyof GetPermissionsByResourceResponses];
1021
- export type PostPermissionsByResourceData = {
1022
- body?: {
1023
- /**
1024
- * The ID of the actor to assign the permission to, e.g. `user_1234`, `group_1234` or `org_1234`.
1025
- */
1026
- actor: string;
1027
- role: 'owner' | 'manager' | 'editor' | 'viewer' | 'participant';
1028
- } | {
1029
- /**
1030
- * The email of the user to add or invite.
1031
- */
1032
- email: string;
1033
- role: 'owner' | 'manager' | 'editor' | 'viewer' | 'participant';
1034
- /**
1035
- * Whether to send an invitation email if the user does not exist. Defaults to false.
1036
- */
1037
- sendInvite?: boolean;
1038
- };
1039
- path: {
1040
- /**
1041
- * The ID of the resource to assign the permission on, e.g. `exam_1234`.
1042
- */
1043
- resource: string;
1044
- };
1045
- query?: never;
1046
- url: '/permissions/{resource}';
1047
- };
1048
- export type PostPermissionsByResourceErrors = {
1049
- /**
1050
- * No access to manage this resource.
1051
- */
1052
- 403: unknown;
1053
- };
1054
- export type PostPermissionsByResourceResponses = {
1055
- /**
1056
- * The created or updated permission.
1057
- */
1058
- 201: {
1059
- actor: {
1060
- id: string;
1061
- name?: string;
1062
- avatar?: string;
1063
- type: 'user' | 'group' | 'org';
1064
- orgRole?: 'owner' | 'admin' | 'teacher' | 'student' | 'member';
1065
- };
1066
- role: 'owner' | 'manager' | 'editor' | 'viewer' | 'participant';
1067
- createdAt: Date;
1068
- updatedAt: Date;
1069
- createdBy: string;
1070
- };
1071
- };
1072
- export type PostPermissionsByResourceResponse = PostPermissionsByResourceResponses[keyof PostPermissionsByResourceResponses];
1073
- export type DeletePermissionsByResourceByActorData = {
1074
- body?: never;
1075
- path: {
1076
- resource: string;
1077
- actor: string | string | string;
1078
- };
1079
- query?: never;
1080
- url: '/permissions/{resource}/{actor}';
1081
- };
1082
- export type DeletePermissionsByResourceByActorErrors = {
1083
- /**
1084
- * No access to manage this resource.
1085
- */
1086
- 403: unknown;
1087
- };
1088
- export type DeletePermissionsByResourceByActorResponses = {
1089
- /**
1090
- * Permission successfully removed.
1091
- */
1092
- 200: unknown;
1093
- };
1094
- export type GetPermissionsByResourceByActorData = {
1095
- body?: never;
1096
- path: {
1097
- /**
1098
- * The ID of the actor to check role for, e.g. `user_abcd`.
1099
- */
1100
- actor: string | string | string;
1101
- /**
1102
- * The ID of the resource to check role for, e.g. `exam_1234`.
1103
- */
1104
- resource: string;
1105
- };
1106
- query?: never;
1107
- url: '/permissions/{resource}/{actor}';
1108
- };
1109
- export type GetPermissionsByResourceByActorErrors = {
1110
- /**
1111
- * No access to this resource.
1112
- */
1113
- 403: unknown;
1114
- /**
1115
- * The specified actor has no access to the specified resource.
1116
- */
1117
- 404: unknown;
1118
- };
1119
- export type GetPermissionsByResourceByActorResponses = {
1120
- /**
1121
- * Role of the specified actor for the specified resource.
1122
- */
1123
- 200: {
1124
- actor: {
1125
- id: string;
1126
- name?: string;
1127
- avatar?: string;
1128
- type: 'user' | 'group' | 'org';
1129
- orgRole?: 'owner' | 'admin' | 'teacher' | 'student' | 'member';
1130
- };
1131
- role: 'owner' | 'manager' | 'editor' | 'viewer' | 'participant';
1132
- createdAt: Date;
1133
- updatedAt: Date;
1134
- createdBy: string;
1135
- };
1136
- };
1137
- export type GetPermissionsByResourceByActorResponse = GetPermissionsByResourceByActorResponses[keyof GetPermissionsByResourceByActorResponses];
1138
- export type GetStudentLevelsData = {
1139
- body?: never;
1140
- path?: never;
1141
- query?: never;
1142
- url: '/student-levels';
1143
- };
1144
- export type GetUsersData = {
1145
- body?: never;
1146
- path?: never;
1147
- query?: never;
1148
- url: '/users';
1149
- };
1150
- export type PostUsersData = {
1151
- body?: {
1152
- email: string;
1153
- name?: string;
1154
- role?: 'owner' | 'admin' | 'teacher' | 'student' | 'member';
1155
- /**
1156
- * Whether to send an invitation email. Defaults to false.
1157
- */
1158
- sendInvite?: boolean;
1159
- };
1160
- path?: never;
1161
- query?: never;
1162
- url: '/users';
1163
- };
1164
- export type DeleteUsersByIdData = {
1165
- body?: never;
1166
- path: {
1167
- id: string;
1168
- };
1169
- query?: never;
1170
- url: '/users/{id}';
1171
- };
1172
- export type PatchUsersByIdData = {
1173
- body?: never;
1174
- path: {
1175
- id: string;
1176
- };
1177
- query?: never;
1178
- url: '/users/{id}';
1179
- };
1180
- export type GetExamsByIdSessionsData = {
1181
- body?: never;
1182
- path: {
1183
- id: string;
1184
- };
1185
- query?: never;
1186
- url: '/exams/{id}/sessions';
1187
- };
1188
- export type PostExamsByIdSessionsData = {
1189
- body?: {
1190
- studentName: string;
1191
- source?: 'online-assessment' | 'document-scanner' | 'answer-bot' | 'manual';
1192
- answers?: Array<{
1193
- question: string | string;
1194
- value?: string | Array<string | null> | null;
1195
- completed?: boolean | null;
1196
- context?: unknown | null;
1197
- pointsAwarded?: number | null;
1198
- pointsToEarn?: number | null;
1199
- feedback?: string | null;
1200
- scoringCriteria?: unknown | null;
1201
- savedAt?: Date;
1202
- gradedAt?: Date | null;
1203
- gradedBy?: string | null;
1204
- gradingStatus?: 'graded' | 'auto-graded' | null;
1205
- originalValue?: string | Array<string | null> | null;
1206
- editedBy?: string | null;
1207
- editedAt?: Date | null;
1208
- masteryTopicId?: string | null;
1209
- traceIds?: Array<string> | null;
1210
- }>;
1211
- };
1212
- path: {
1213
- id: string;
1214
- };
1215
- query?: never;
1216
- url: '/exams/{id}/sessions';
1217
- };
1218
- export type PostExamsByIdSessionsScanData = {
1219
- body?: never;
1220
- path: {
1221
- id: string;
1222
- };
1223
- query?: never;
1224
- url: '/exams/{id}/sessions/scan';
1225
- };
1226
- export type DeleteExamsByIdSessionsBySessionIdData = {
1227
- body?: never;
1228
- path: {
1229
- id: string;
1230
- sessionId: string;
1231
- };
1232
- query?: never;
1233
- url: '/exams/{id}/sessions/{sessionId}';
1234
- };
1235
- export type GetExamsByIdSessionsBySessionIdData = {
1236
- body?: never;
1237
- path: {
1238
- id: string;
1239
- sessionId: string;
1240
- };
1241
- query?: never;
1242
- url: '/exams/{id}/sessions/{sessionId}';
1243
- };
1244
- export type PostExamsByIdSessionsBySessionIdFeedbackData = {
1245
- body?: {
1246
- /**
1247
- * Question ID to provide feedback for
1248
- */
1249
- question: string;
1250
- /**
1251
- * Points to award for the answer
1252
- */
1253
- pointsAwarded?: number;
1254
- /**
1255
- * Optional teacher feedback for the answer
1256
- */
1257
- feedback?: string;
1258
- };
1259
- path: {
1260
- id: string;
1261
- sessionId: string;
1262
- };
1263
- query?: never;
1264
- url: '/exams/{id}/sessions/{sessionId}/feedback';
1265
- };
1266
- export type PostExamsByIdSessionsBySessionIdOverallFeedbackData = {
1267
- body?: {
1268
- /**
1269
- * Teacher feedback for the test as a whole
1270
- */
1271
- feedback?: string | null;
1272
- };
1273
- path: {
1274
- id: string;
1275
- sessionId: string;
1276
- };
1277
- query?: never;
1278
- url: '/exams/{id}/sessions/{sessionId}/overall-feedback';
1279
- };
1280
- export type PostExamsByIdSessionsBySessionIdGenerateOverallFeedbackData = {
1281
- body?: never;
1282
- path: {
1283
- id: string;
1284
- sessionId: string;
1285
- };
1286
- query?: never;
1287
- url: '/exams/{id}/sessions/{sessionId}/generate-overall-feedback';
1288
- };
1289
- export type PostExamsByIdSessionsBySessionIdSuggestionsAcceptAllData = {
1290
- body?: never;
1291
- path: {
1292
- id: string;
1293
- sessionId: string;
1294
- };
1295
- query?: never;
1296
- url: '/exams/{id}/sessions/{sessionId}/suggestions/accept-all';
1297
- };
1298
- export type PostExamsByIdSessionsBySessionIdSuggestionsByQuestionIdAcceptData = {
1299
- body?: never;
1300
- path: {
1301
- id: string;
1302
- sessionId: string;
1303
- questionId: string;
1304
- };
1305
- query?: never;
1306
- url: '/exams/{id}/sessions/{sessionId}/suggestions/{questionId}/accept';
1307
- };
1308
- export type PatchExamsByIdSessionsBySessionIdAnswersByQuestionIdData = {
1309
- body?: {
1310
- answer: {
1311
- question: string | string;
1312
- value?: string | Array<string | null> | null;
1313
- completed?: boolean | null;
1314
- context?: unknown | null;
1315
- };
1316
- /**
1317
- * Whether to automatically grade the answer after editing
1318
- */
1319
- autoGrade?: boolean;
1320
- };
1321
- path: {
1322
- id: string;
1323
- sessionId: string;
1324
- questionId: string;
1325
- };
1326
- query?: never;
1327
- url: '/exams/{id}/sessions/{sessionId}/answers/{questionId}';
1328
- };
1329
- export type PostExamsByIdQuestionsImportData = {
1330
- body?: {
1331
- /**
1332
- * File name
1333
- */
1334
- name?: string;
1335
- /**
1336
- * MIME type of the file, e.g. application/pdf
1337
- */
1338
- type?: string;
1339
- /**
1340
- * URL of the file, required if no content is specified.
1341
- */
1342
- url?: string;
1343
- /**
1344
- * Content of the file as a string, as an alternative to URL. Only supported for exports from other systems (e.g. Moodle XML).
1345
- */
1346
- content?: string;
1347
- /**
1348
- * Whether to keep existing exam settings when importing questions via AI.
1349
- */
1350
- keepExistingSettings?: boolean;
1351
- };
1352
- path: {
1353
- id: string;
1354
- };
1355
- query?: never;
1356
- url: '/exams/{id}/questions/import';
1357
- };
1358
- export type PostExamsByIdQuestionsGenerateData = {
1359
- body?: {
1360
- message: string;
1361
- questionType?: string;
1362
- };
1363
- path: {
1364
- id: string;
1365
- };
1366
- query?: never;
1367
- url: '/exams/{id}/questions/generate';
1368
- };
1369
- export type GetExamsByIdQuestionsByQuestionIdData = {
1370
- body?: never;
1371
- path: {
1372
- /**
1373
- * Exam ID, e.g. `exam_1234`.
1374
- */
1375
- id: string;
1376
- /**
1377
- * Question ID, e.g. `question_1234`, or `first` to get the first question.
1378
- */
1379
- questionId: string;
1380
- };
1381
- query?: {
1382
- /**
1383
- * The format to return the question in. `examplary_json` returns the question in the Examplary JSON format, while `qti_v3p0` and `qti_v2p1` return the question in QTI format version 3 and 2.1 respectively.
1384
- */
1385
- format?: 'examplary_json' | 'qti_v3p0' | 'qti_v2p1';
1386
- };
1387
- url: '/exams/{id}/questions/{questionId}';
1388
- };
1389
- export type PostExamsByIdQuestionsByQuestionIdGenerateData = {
1390
- body?: {
1391
- message: string;
1392
- };
1393
- path: {
1394
- id: string;
1395
- questionId: string;
1396
- };
1397
- query?: never;
1398
- url: '/exams/{id}/questions/{questionId}/generate';
1399
- };
1400
- export type PostExamsByIdExportQti3ZipData = {
1401
- body?: never;
1402
- path: {
1403
- id: string;
1404
- };
1405
- query?: never;
1406
- url: '/exams/{id}/export/qti3-zip';
1407
- };
1408
- export type PostExamsByIdExportQti3ZipResponses = {
1409
- /**
1410
- * URL to download the exported QTI ZIP package.
1411
- */
1412
- 200: {
1413
- /**
1414
- * URL to download the exported QTI ZIP package.
1415
- */
1416
- url: string;
1417
- };
1418
- };
1419
- export type PostExamsByIdExportQti3ZipResponse = PostExamsByIdExportQti3ZipResponses[keyof PostExamsByIdExportQti3ZipResponses];
1420
- export type PostExamsByIdExportQti21ZipData = {
1421
- body?: never;
1422
- path: {
1423
- id: string;
1424
- };
1425
- query?: never;
1426
- url: '/exams/{id}/export/qti21-zip';
1427
- };
1428
- export type PostExamsByIdExportQti21ZipResponses = {
1429
- /**
1430
- * URL to download the exported QTI ZIP package.
1431
- */
1432
- 200: {
1433
- /**
1434
- * URL to download the exported QTI ZIP package.
1435
- */
1436
- url: string;
1437
- };
1438
- };
1439
- export type PostExamsByIdExportQti21ZipResponse = PostExamsByIdExportQti21ZipResponses[keyof PostExamsByIdExportQti21ZipResponses];
1440
- export type GetExamsData = {
1441
- body?: never;
1442
- path?: never;
1443
- query?: {
1444
- /**
1445
- * Optional filter by folder ID, e.g. `folder_1234`.
1446
- */
1447
- folder?: string;
1448
- /**
1449
- * Optional filter by permission role.
1450
- */
1451
- role?: 'owner' | 'manager' | 'editor' | 'viewer' | 'participant';
1452
- };
1453
- url: '/exams';
1454
- };
1455
- export type PostExamsData = {
1456
- body?: {
1457
- name: string;
1458
- sourceMaterialIds?: Array<string> | null;
1459
- context?: string | null;
1460
- studentLevel?: string | null;
1461
- subject?: string | null;
1462
- language?: string | null;
1463
- taxonomyId?: string | null;
1464
- intendedDuration?: unknown | null;
1465
- allowedGenerationQuestionTypes?: Array<string> | null;
1466
- metadata?: {
1467
- [key: string]: string | number | boolean | null;
1468
- } | null;
1469
- questions?: Array<{
1470
- id?: string;
1471
- type?: string;
1472
- title?: string | null;
1473
- description?: string | null;
1474
- settings?: {
1475
- [key: string]: unknown;
1476
- };
1477
- scoring?: {
1478
- rubricType?: 'simple' | 'analytical' | 'holistic' | 'exact-values' | null;
1479
- criteria?: Array<{
1480
- id: string;
1481
- title?: string | null;
1482
- description?: string | null;
1483
- points?: number | null;
1484
- minPoints?: number | null;
1485
- maxPoints?: number | null;
1486
- levels?: Array<{
1487
- id: string;
1488
- title?: string | null;
1489
- description?: string | null;
1490
- points?: number | null;
1491
- minPoints?: number | null;
1492
- maxPoints?: number | null;
1493
- }> | null;
1494
- }> | null;
1495
- exactValuesCaseInsensitive?: boolean | null;
1496
- guidance?: string | null;
1497
- modelAnswer?: string | null;
1498
- templateId?: string | null;
1499
- } | null;
1500
- tags?: Array<string> | null;
1501
- metadata?: {
1502
- [key: string]: string | number | boolean | null;
1503
- } | null;
1504
- v?: number | null;
1505
- questionBankItemId?: string | null;
1506
- traceIds?: Array<string> | null;
1507
- scoringCriteria?: Array<{
1508
- id?: string;
1509
- description?: string | null;
1510
- points?: number | null;
1511
- }> | null;
1512
- [key: string]: unknown;
1513
- }> | null;
1514
- permissions?: Array<{
1515
- actor: string;
1516
- role: 'owner' | 'manager' | 'editor' | 'viewer' | 'participant';
1517
- }> | null;
1518
- };
1519
- path?: never;
1520
- query?: never;
1521
- url: '/exams';
1522
- };
1523
- export type PostExamsImportData = {
1524
- body?: {
1525
- name: string;
1526
- sourceMaterialIds?: Array<string>;
1527
- };
1528
- path?: never;
1529
- query?: never;
1530
- url: '/exams/import';
1531
- };
1532
- export type DeleteExamsByIdData = {
1533
- body?: never;
1534
- path: {
1535
- id: string;
1536
- };
1537
- query?: never;
1538
- url: '/exams/{id}';
1539
- };
1540
- export type GetExamsByIdData = {
1541
- body?: never;
1542
- path: {
1543
- id: string;
1544
- };
1545
- query?: never;
1546
- url: '/exams/{id}';
1547
- };
1548
- export type PostExamsByIdData = {
1549
- body?: never;
1550
- path: {
1551
- id: string;
1552
- };
1553
- query?: never;
1554
- url: '/exams/{id}';
1555
- };
1556
- export type PostExamsByIdDuplicateData = {
1557
- body?: {
1558
- name: string;
1559
- includeSessions?: boolean;
1560
- };
1561
- path: {
1562
- id: string;
1563
- };
1564
- query?: never;
1565
- url: '/exams/{id}/duplicate';
1566
- };
1567
- export type PostExamsByIdPrintData = {
1568
- body?: never;
1569
- path: {
1570
- id: string;
1571
- };
1572
- query?: never;
1573
- url: '/exams/{id}/print';
1574
- };
1575
- export type PostExamsByIdGenerateData = {
1576
- body?: never;
1577
- path: {
1578
- id: string;
1579
- };
1580
- query?: never;
1581
- url: '/exams/{id}/generate';
1582
- };
1583
- export type PostExamsByIdGenerateCancelData = {
1584
- body?: never;
1585
- path: {
1586
- id: string;
1587
- };
1588
- query?: never;
1589
- url: '/exams/{id}/generate/cancel';
1590
- };
1591
- export type GetExamsByIdContextSuggestionsData = {
1592
- body?: never;
1593
- path: {
1594
- id: string;
1595
- };
1596
- query?: never;
1597
- url: '/exams/{id}/context-suggestions';
1598
- };
1599
- export type GetPracticeSpacesData = {
1600
- body?: never;
1601
- path?: never;
1602
- query?: {
1603
- /**
1604
- * Optional filter by folder ID, e.g. `folder_1234`.
1605
- */
1606
- folder?: string;
1607
- /**
1608
- * Optional filter by permission role.
1609
- */
1610
- role?: 'owner' | 'manager' | 'editor' | 'viewer' | 'participant';
1611
- };
1612
- url: '/practice-spaces';
1613
- };
1614
- export type PostPracticeSpacesData = {
1615
- body?: {
1616
- name: string;
1617
- sourceMaterialIds?: Array<string>;
1618
- masteryTopics?: Array<{
1619
- id: string;
1620
- name: string;
1621
- }>;
1622
- settings?: {
1623
- taxonomyId?: string | null;
1624
- duration?: number | null;
1625
- intendedDuration?: unknown | null;
1626
- enforceOrder?: boolean | null;
1627
- enforceTimeLimit?: boolean | null;
1628
- requirePasscode?: boolean | null;
1629
- passcode?: string | null;
1630
- showPoints?: boolean | null;
1631
- showFeedback?: boolean | null;
1632
- showTableOfContents?: boolean | null;
1633
- context?: string | null;
1634
- studentLevel?: string | null;
1635
- subject?: string | null;
1636
- language?: string | null;
1637
- feedbackPerQuestion?: boolean | null;
1638
- feedbackOverall?: boolean | null;
1639
- feedbackAiInstructions?: string | null;
1640
- allowedGenerationQuestionTypes?: Array<string> | null;
1641
- useSafeExamBrowser?: boolean | null;
1642
- gradingScheme?: {
1643
- type: 'points' | 'percentage' | 'out-of-10' | 'custom' | 'custom:letters' | 'custom:pass-fail' | 'custom:proficiency';
1644
- ranges?: Array<{
1645
- label?: string | null;
1646
- startPercentage?: number | null;
1647
- color?: string | null;
1648
- }> | null;
1649
- } | null;
1650
- appearanceColor?: string | string | null;
1651
- appearanceIconName?: string | null;
1652
- 'safeExamBrowser.showInstallLink'?: boolean | null;
1653
- 'safeExamBrowser.allowQuit'?: boolean | null;
1654
- 'safeExamBrowser.showTime'?: boolean | null;
1655
- 'safeExamBrowser.allowWlan'?: boolean | null;
1656
- 'safeExamBrowser.allowSpellCheck'?: boolean | null;
1657
- showHints?: boolean;
1658
- allowCustomPrompt?: boolean;
1659
- showTopicProgress?: boolean;
1660
- showProficiencyBadge?: boolean;
1661
- proficiencyPercentage?: number;
1662
- proficiencyQuestionsCount?: number;
1663
- proficiencyDaysCount?: number;
1664
- [key: string]: unknown;
1665
- };
1666
- folder?: string | null;
1667
- permissions?: Array<{
1668
- actor: string;
1669
- role: 'owner' | 'manager' | 'editor' | 'viewer' | 'participant';
1670
- }> | null;
1671
- studentNotes?: string | null;
1672
- published?: 'published' | 'unpublished';
1673
- metadata?: {
1674
- [key: string]: string | number | boolean | null;
1675
- };
1676
- };
1677
- path?: never;
1678
- query?: never;
1679
- url: '/practice-spaces';
1680
- };
1681
- export type DeletePracticeSpacesByIdData = {
1682
- body?: never;
1683
- path: {
1684
- id: string;
1685
- };
1686
- query?: never;
1687
- url: '/practice-spaces/{id}';
1688
- };
1689
- export type GetPracticeSpacesByIdData = {
1690
- body?: never;
1691
- path: {
1692
- id: string;
1693
- };
1694
- query?: never;
1695
- url: '/practice-spaces/{id}';
1696
- };
1697
- export type PatchPracticeSpacesByIdData = {
1698
- body?: {
1699
- name?: string;
1700
- settings?: {
1701
- taxonomyId?: string | null;
1702
- duration?: number | null;
1703
- intendedDuration?: unknown | null;
1704
- enforceOrder?: boolean | null;
1705
- enforceTimeLimit?: boolean | null;
1706
- requirePasscode?: boolean | null;
1707
- passcode?: string | null;
1708
- showPoints?: boolean | null;
1709
- showFeedback?: boolean | null;
1710
- showTableOfContents?: boolean | null;
1711
- context?: string | null;
1712
- studentLevel?: string | null;
1713
- subject?: string | null;
1714
- language?: string | null;
1715
- feedbackPerQuestion?: boolean | null;
1716
- feedbackOverall?: boolean | null;
1717
- feedbackAiInstructions?: string | null;
1718
- allowedGenerationQuestionTypes?: Array<string> | null;
1719
- useSafeExamBrowser?: boolean | null;
1720
- gradingScheme?: {
1721
- type: 'points' | 'percentage' | 'out-of-10' | 'custom' | 'custom:letters' | 'custom:pass-fail' | 'custom:proficiency';
1722
- ranges?: Array<{
1723
- label?: string | null;
1724
- startPercentage?: number | null;
1725
- color?: string | null;
1726
- }> | null;
1727
- } | null;
1728
- appearanceColor?: string | string | null;
1729
- appearanceIconName?: string | null;
1730
- 'safeExamBrowser.showInstallLink'?: boolean | null;
1731
- 'safeExamBrowser.allowQuit'?: boolean | null;
1732
- 'safeExamBrowser.showTime'?: boolean | null;
1733
- 'safeExamBrowser.allowWlan'?: boolean | null;
1734
- 'safeExamBrowser.allowSpellCheck'?: boolean | null;
1735
- showHints?: boolean;
1736
- allowCustomPrompt?: boolean;
1737
- showTopicProgress?: boolean;
1738
- showProficiencyBadge?: boolean;
1739
- proficiencyPercentage?: number;
1740
- proficiencyQuestionsCount?: number;
1741
- proficiencyDaysCount?: number;
1742
- [key: string]: unknown;
1743
- };
1744
- folder?: string | null;
1745
- sourceMaterialIds?: Array<string>;
1746
- masteryTopics?: Array<{
1747
- id: string;
1748
- name: string;
1749
- }>;
1750
- studentNotes?: string | null;
1751
- published?: 'published' | 'unpublished';
1752
- metadata?: {
1753
- [key: string]: string | number | boolean | null;
1754
- };
1755
- };
1756
- path: {
1757
- id: string;
1758
- };
1759
- query?: never;
1760
- url: '/practice-spaces/{id}';
1761
- };
1762
- export type PostPracticeSpacesByIdDuplicateData = {
1763
- body?: {
1764
- name: string;
1765
- };
1766
- path: {
1767
- id: string;
1768
- };
1769
- query?: never;
1770
- url: '/practice-spaces/{id}/duplicate';
1771
- };
1772
- export type PostPracticeSpacesByIdGenerateTopicsData = {
1773
- body?: never;
1774
- path: {
1775
- id: string;
1776
- };
1777
- query?: never;
1778
- url: '/practice-spaces/{id}/generate-topics';
1779
- };
1780
- export type PostPracticeSpacesByIdCancelGenerateTopicsData = {
1781
- body?: never;
1782
- path: {
1783
- id: string;
1784
- };
1785
- query?: never;
1786
- url: '/practice-spaces/{id}/cancel-generate-topics';
1787
- };
1788
- export type GetPracticeSpacesByIdQuestionsPreviewData = {
1789
- body?: never;
1790
- path: {
1791
- id: string;
1792
- };
1793
- query?: never;
1794
- url: '/practice-spaces/{id}/questions-preview';
1795
- };
1796
- export type GetPracticeSpacesByIdProgressData = {
1797
- body?: never;
1798
- path: {
1799
- id: string;
1800
- };
1801
- query?: never;
1802
- url: '/practice-spaces/{id}/progress';
1803
- };
1804
- export type PostPracticeSpacesByIdProgressTopicFeedbackData = {
1805
- body?: {
1806
- topicId: string;
1807
- feedbackType: 'progress' | 'challenges';
1808
- };
1809
- path: {
1810
- id: string;
1811
- };
1812
- query?: never;
1813
- url: '/practice-spaces/{id}/progress/topic-feedback';
1814
- };
1815
- export type GetPracticeSpacesByIdStudentsData = {
1816
- body?: never;
1817
- path: {
1818
- id: string;
1819
- };
1820
- query?: never;
1821
- url: '/practice-spaces/{id}/students';
1822
- };
1823
- export type GetPracticeSpacesByIdStudentsByStudentIdData = {
1824
- body?: never;
1825
- path: {
1826
- id: string;
1827
- studentId: string;
1828
- };
1829
- query?: never;
1830
- url: '/practice-spaces/{id}/students/{studentId}';
1831
- };
1832
- export type PostPracticeSpacesByIdSessionsData = {
1833
- body?: {
1834
- prompt?: string;
1835
- };
1836
- path: {
1837
- id: string;
1838
- };
1839
- query?: never;
1840
- url: '/practice-spaces/{id}/sessions';
1841
- };
1842
- export type GetPracticeSpacesByIdSessionsMineData = {
1843
- body?: never;
1844
- path: {
1845
- id: string;
1846
- };
1847
- query?: never;
1848
- url: '/practice-spaces/{id}/sessions/mine';
1849
- };
1850
- export type GetPracticeSpacesByIdSessionsBySessionIdData = {
1851
- body?: never;
1852
- path: {
1853
- id: string;
1854
- sessionId: string;
1855
- };
1856
- query?: never;
1857
- url: '/practice-spaces/{id}/sessions/{sessionId}';
1858
- };
1859
- export type PostPracticeSpacesByIdSessionsBySessionIdAnswersByQuestionIdData = {
1860
- body?: {
1861
- question: string | string;
1862
- value?: string | Array<string | null> | null;
1863
- completed?: boolean | null;
1864
- context?: unknown | null;
1865
- };
1866
- path: {
1867
- id: string;
1868
- sessionId: string;
1869
- questionId: string;
1870
- };
1871
- query?: never;
1872
- url: '/practice-spaces/{id}/sessions/{sessionId}/answers/{questionId}';
1873
- };
1874
- export type GetSourceMaterialsData = {
1875
- body?: never;
1876
- path?: never;
1877
- query?: {
1878
- /**
1879
- * Filter by externalId
1880
- */
1881
- externalId?: string;
1882
- };
1883
- url: '/source-materials';
1884
- };
1885
- export type GetSourceMaterialsResponses = {
1886
- 200: Array<{
1887
- org: string;
1888
- id: string;
1889
- type?: string;
1890
- createdBy: string;
1891
- createdAt?: Date;
1892
- updatedAt?: Date;
1893
- deletedAt?: Date;
1894
- name?: string;
1895
- originalSource: {
1896
- url: string;
1897
- type?: string;
1898
- name?: string;
1899
- size?: number;
1900
- contentType?: string;
1901
- expires?: string;
1902
- [key: string]: unknown;
1903
- };
1904
- convertedSourceV2?: {
1905
- url: string;
1906
- type?: string;
1907
- name?: string;
1908
- size?: number;
1909
- contentType?: string;
1910
- expires?: string;
1911
- [key: string]: unknown;
1912
- };
1913
- geminiSource?: {
1914
- url: string;
1915
- type?: string;
1916
- name?: string;
1917
- size?: number;
1918
- contentType?: string;
1919
- expires?: string;
1920
- [key: string]: unknown;
1921
- };
1922
- externalId?: string;
1923
- parentSourceMaterialId?: string;
1924
- cacheName?: string;
1925
- summary?: string;
1926
- factsCount?: number;
1927
- processingStatus?: 'pending' | 'converting' | 'summarizing' | 'extracting_topics' | 'extracting_facts' | 'completed' | 'failed';
1928
- numberOfPages?: number;
1929
- chapterMarkers?: Array<{
1930
- title: string;
1931
- startPage: number;
1932
- endPage: number;
1933
- }>;
1934
- topics?: unknown;
1935
- }>;
1936
- };
1937
- export type GetSourceMaterialsResponse = GetSourceMaterialsResponses[keyof GetSourceMaterialsResponses];
1938
- export type PostSourceMaterialsData = {
1939
- body?: {
1940
- url: string;
1941
- type?: string;
1942
- name?: string;
1943
- size?: number;
1944
- contentType?: string;
1945
- expires?: string;
1946
- /**
1947
- * An optional external identifier for the source material.
1948
- */
1949
- externalId?: string;
1950
- [key: string]: unknown;
1951
- };
1952
- path?: never;
1953
- query?: never;
1954
- url: '/source-materials';
1955
- };
1956
- export type PostSourceMaterialsResponses = {
1957
- 201: {
1958
- org: string;
1959
- id: string;
1960
- type?: string;
1961
- createdBy: string;
1962
- createdAt?: Date;
1963
- updatedAt?: Date;
1964
- deletedAt?: Date;
1965
- name?: string;
1966
- originalSource: {
1967
- url: string;
1968
- type?: string;
1969
- name?: string;
1970
- size?: number;
1971
- contentType?: string;
1972
- expires?: string;
1973
- [key: string]: unknown;
1974
- };
1975
- convertedSourceV2?: {
1976
- url: string;
1977
- type?: string;
1978
- name?: string;
1979
- size?: number;
1980
- contentType?: string;
1981
- expires?: string;
1982
- [key: string]: unknown;
1983
- };
1984
- geminiSource?: {
1985
- url: string;
1986
- type?: string;
1987
- name?: string;
1988
- size?: number;
1989
- contentType?: string;
1990
- expires?: string;
1991
- [key: string]: unknown;
1992
- };
1993
- externalId?: string;
1994
- parentSourceMaterialId?: string;
1995
- cacheName?: string;
1996
- summary?: string;
1997
- factsCount?: number;
1998
- processingStatus?: 'pending' | 'converting' | 'summarizing' | 'extracting_topics' | 'extracting_facts' | 'completed' | 'failed';
1999
- numberOfPages?: number;
2000
- chapterMarkers?: Array<{
2001
- title: string;
2002
- startPage: number;
2003
- endPage: number;
2004
- }>;
2005
- topics?: unknown;
2006
- };
2007
- };
2008
- export type PostSourceMaterialsResponse = PostSourceMaterialsResponses[keyof PostSourceMaterialsResponses];
2009
- export type DeleteSourceMaterialsByIdData = {
2010
- body?: never;
2011
- path: {
2012
- id: string;
2013
- };
2014
- query?: never;
2015
- url: '/source-materials/{id}';
2016
- };
2017
- export type GetSourceMaterialsByIdData = {
2018
- body?: never;
2019
- path: {
2020
- id: string;
2021
- };
2022
- query?: never;
2023
- url: '/source-materials/{id}';
2024
- };
2025
- export type GetSourceMaterialsByIdResponses = {
2026
- 200: {
2027
- org: string;
2028
- id: string;
2029
- type?: string;
2030
- createdBy: string;
2031
- createdAt?: Date;
2032
- updatedAt?: Date;
2033
- deletedAt?: Date;
2034
- name?: string;
2035
- originalSource: {
2036
- url: string;
2037
- type?: string;
2038
- name?: string;
2039
- size?: number;
2040
- contentType?: string;
2041
- expires?: string;
2042
- [key: string]: unknown;
2043
- };
2044
- convertedSourceV2?: {
2045
- url: string;
2046
- type?: string;
2047
- name?: string;
2048
- size?: number;
2049
- contentType?: string;
2050
- expires?: string;
2051
- [key: string]: unknown;
2052
- };
2053
- geminiSource?: {
2054
- url: string;
2055
- type?: string;
2056
- name?: string;
2057
- size?: number;
2058
- contentType?: string;
2059
- expires?: string;
2060
- [key: string]: unknown;
2061
- };
2062
- externalId?: string;
2063
- parentSourceMaterialId?: string;
2064
- cacheName?: string;
2065
- summary?: string;
2066
- factsCount?: number;
2067
- processingStatus?: 'pending' | 'converting' | 'summarizing' | 'extracting_topics' | 'extracting_facts' | 'completed' | 'failed';
2068
- numberOfPages?: number;
2069
- chapterMarkers?: Array<{
2070
- title: string;
2071
- startPage: number;
2072
- endPage: number;
2073
- }>;
2074
- topics?: unknown;
2075
- };
2076
- };
2077
- export type GetSourceMaterialsByIdResponse = GetSourceMaterialsByIdResponses[keyof GetSourceMaterialsByIdResponses];
2078
- export type PatchSourceMaterialsByIdData = {
2079
- body?: {
2080
- /**
2081
- * The new name of the source material.
2082
- */
2083
- name?: string;
2084
- };
2085
- path: {
2086
- id: string;
2087
- };
2088
- query?: never;
2089
- url: '/source-materials/{id}';
2090
- };
2091
- export type PostSourceMaterialsByIdSliceData = {
2092
- body?: {
2093
- /**
2094
- * Starting page number (1-based)
2095
- */
2096
- startPage: number;
2097
- /**
2098
- * Ending page number, inclusive (1-based)
2099
- */
2100
- endPage: number;
2101
- /**
2102
- * Optional name for the new source material
2103
- */
2104
- name?: string;
2105
- };
2106
- path: {
2107
- id: string;
2108
- };
2109
- query?: never;
2110
- url: '/source-materials/{id}/slice';
2111
- };
2112
- export type PostSourceMaterialsByIdSliceResponses = {
2113
- 201: {
2114
- org: string;
2115
- id: string;
2116
- type?: string;
2117
- createdBy: string;
2118
- createdAt?: Date;
2119
- updatedAt?: Date;
2120
- deletedAt?: Date;
2121
- name?: string;
2122
- originalSource: {
2123
- url: string;
2124
- type?: string;
2125
- name?: string;
2126
- size?: number;
2127
- contentType?: string;
2128
- expires?: string;
2129
- [key: string]: unknown;
2130
- };
2131
- convertedSourceV2?: {
2132
- url: string;
2133
- type?: string;
2134
- name?: string;
2135
- size?: number;
2136
- contentType?: string;
2137
- expires?: string;
2138
- [key: string]: unknown;
2139
- };
2140
- geminiSource?: {
2141
- url: string;
2142
- type?: string;
2143
- name?: string;
2144
- size?: number;
2145
- contentType?: string;
2146
- expires?: string;
2147
- [key: string]: unknown;
2148
- };
2149
- externalId?: string;
2150
- parentSourceMaterialId?: string;
2151
- cacheName?: string;
2152
- summary?: string;
2153
- factsCount?: number;
2154
- processingStatus?: 'pending' | 'converting' | 'summarizing' | 'extracting_topics' | 'extracting_facts' | 'completed' | 'failed';
2155
- numberOfPages?: number;
2156
- chapterMarkers?: Array<{
2157
- title: string;
2158
- startPage: number;
2159
- endPage: number;
2160
- }>;
2161
- topics?: unknown;
2162
- };
2163
- };
2164
- export type PostSourceMaterialsByIdSliceResponse = PostSourceMaterialsByIdSliceResponses[keyof PostSourceMaterialsByIdSliceResponses];
2165
- export type GetFoldersData = {
2166
- body?: never;
2167
- path?: never;
2168
- query?: never;
2169
- url: '/folders';
2170
- };
2171
- export type PostFoldersData = {
2172
- body?: {
2173
- name: string;
2174
- };
2175
- path?: never;
2176
- query?: never;
2177
- url: '/folders';
2178
- };
2179
- export type DeleteFoldersByIdData = {
2180
- body?: never;
2181
- path: {
2182
- id: string;
2183
- };
2184
- query?: never;
2185
- url: '/folders/{id}';
2186
- };
2187
- export type PostFoldersByIdData = {
2188
- body?: {
2189
- name: string;
2190
- };
2191
- path: {
2192
- id: string;
2193
- };
2194
- query?: never;
2195
- url: '/folders/{id}';
2196
- };
2197
- export type GetQuestionBankData = {
2198
- body?: never;
2199
- path?: never;
2200
- query?: never;
2201
- url: '/question-bank';
2202
- };
2203
- export type PostQuestionBankData = {
2204
- body?: {
2205
- question: {
2206
- type: string;
2207
- title?: string | null;
2208
- description?: string | null;
2209
- settings: {
2210
- [key: string]: unknown;
2211
- };
2212
- scoring?: {
2213
- rubricType?: 'simple' | 'analytical' | 'holistic' | 'exact-values' | null;
2214
- criteria?: Array<{
2215
- id: string;
2216
- title?: string | null;
2217
- description?: string | null;
2218
- points?: number | null;
2219
- minPoints?: number | null;
2220
- maxPoints?: number | null;
2221
- levels?: Array<{
2222
- id: string;
2223
- title?: string | null;
2224
- description?: string | null;
2225
- points?: number | null;
2226
- minPoints?: number | null;
2227
- maxPoints?: number | null;
2228
- }> | null;
2229
- }> | null;
2230
- exactValuesCaseInsensitive?: boolean | null;
2231
- guidance?: string | null;
2232
- modelAnswer?: string | null;
2233
- templateId?: string | null;
2234
- } | null;
2235
- tags?: Array<string> | null;
2236
- metadata?: {
2237
- [key: string]: string | number | boolean | null;
2238
- } | null;
2239
- questionBankItemId?: string | null;
2240
- traceIds?: Array<string> | null;
2241
- scoringCriteria?: Array<{
2242
- id?: string;
2243
- description?: string | null;
2244
- points?: number | null;
2245
- }> | null;
2246
- [key: string]: unknown;
2247
- };
2248
- };
2249
- path?: never;
2250
- query?: never;
2251
- url: '/question-bank';
2252
- };
2253
- export type DeleteQuestionBankByIdData = {
2254
- body?: never;
2255
- path: {
2256
- id: string;
2257
- };
2258
- query?: never;
2259
- url: '/question-bank/{id}';
2260
- };
2261
- export type PatchQuestionBankByIdData = {
2262
- body?: {
2263
- question: {
2264
- type: string;
2265
- title?: string | null;
2266
- description?: string | null;
2267
- settings: {
2268
- [key: string]: unknown;
2269
- };
2270
- scoring?: {
2271
- rubricType?: 'simple' | 'analytical' | 'holistic' | 'exact-values' | null;
2272
- criteria?: Array<{
2273
- id: string;
2274
- title?: string | null;
2275
- description?: string | null;
2276
- points?: number | null;
2277
- minPoints?: number | null;
2278
- maxPoints?: number | null;
2279
- levels?: Array<{
2280
- id: string;
2281
- title?: string | null;
2282
- description?: string | null;
2283
- points?: number | null;
2284
- minPoints?: number | null;
2285
- maxPoints?: number | null;
2286
- }> | null;
2287
- }> | null;
2288
- exactValuesCaseInsensitive?: boolean | null;
2289
- guidance?: string | null;
2290
- modelAnswer?: string | null;
2291
- templateId?: string | null;
2292
- } | null;
2293
- tags?: Array<string> | null;
2294
- metadata?: {
2295
- [key: string]: string | number | boolean | null;
2296
- } | null;
2297
- questionBankItemId?: string | null;
2298
- traceIds?: Array<string> | null;
2299
- scoringCriteria?: Array<{
2300
- id?: string;
2301
- description?: string | null;
2302
- points?: number | null;
2303
- }> | null;
2304
- [key: string]: unknown;
2305
- };
2306
- };
2307
- path: {
2308
- id: string;
2309
- };
2310
- query?: never;
2311
- url: '/question-bank/{id}';
2312
- };
2313
- export type GetRubricsData = {
2314
- body?: never;
2315
- path?: never;
2316
- query?: never;
2317
- url: '/rubrics';
2318
- };
2319
- export type PostRubricsData = {
2320
- body?: {
2321
- name: string;
2322
- scoring: {
2323
- rubricType?: 'simple' | 'analytical' | 'holistic' | 'exact-values' | null;
2324
- criteria?: Array<{
2325
- id: string;
2326
- title?: string | null;
2327
- description?: string | null;
2328
- points?: number | null;
2329
- minPoints?: number | null;
2330
- maxPoints?: number | null;
2331
- levels?: Array<{
2332
- id: string;
2333
- title?: string | null;
2334
- description?: string | null;
2335
- points?: number | null;
2336
- minPoints?: number | null;
2337
- maxPoints?: number | null;
2338
- }> | null;
2339
- }> | null;
2340
- exactValuesCaseInsensitive?: boolean | null;
2341
- guidance?: string | null;
2342
- modelAnswer?: string | null;
2343
- templateId?: string | null;
2344
- };
2345
- };
2346
- path?: never;
2347
- query?: never;
2348
- url: '/rubrics';
2349
- };
2350
- export type PostRubricsGenerateData = {
2351
- body?: {
2352
- message?: string;
2353
- sourceMaterialIds?: Array<string>;
2354
- language?: string;
2355
- context?: unknown;
2356
- };
2357
- path?: never;
2358
- query?: never;
2359
- url: '/rubrics/generate';
2360
- };
2361
- export type DeleteRubricsByIdData = {
2362
- body?: never;
2363
- path: {
2364
- id: string;
2365
- };
2366
- query?: never;
2367
- url: '/rubrics/{id}';
2368
- };
2369
- export type PatchRubricsByIdData = {
2370
- body?: {
2371
- name?: string;
2372
- scoring?: {
2373
- rubricType?: 'simple' | 'analytical' | 'holistic' | 'exact-values' | null;
2374
- criteria?: Array<{
2375
- id: string;
2376
- title?: string | null;
2377
- description?: string | null;
2378
- points?: number | null;
2379
- minPoints?: number | null;
2380
- maxPoints?: number | null;
2381
- levels?: Array<{
2382
- id: string;
2383
- title?: string | null;
2384
- description?: string | null;
2385
- points?: number | null;
2386
- minPoints?: number | null;
2387
- maxPoints?: number | null;
2388
- }> | null;
2389
- }> | null;
2390
- exactValuesCaseInsensitive?: boolean | null;
2391
- guidance?: string | null;
2392
- modelAnswer?: string | null;
2393
- templateId?: string | null;
2394
- };
2395
- };
2396
- path: {
2397
- id: string;
2398
- };
2399
- query?: never;
2400
- url: '/rubrics/{id}';
2401
- };
2402
- export type DeleteJobsByIdData = {
2403
- body?: never;
2404
- path: {
2405
- id: string;
2406
- };
2407
- query?: never;
2408
- url: '/jobs/{id}';
2409
- };
2410
- export type GetJobsByIdData = {
2411
- body?: never;
2412
- path: {
2413
- id: string;
2414
- };
2415
- query?: never;
2416
- url: '/jobs/{id}';
2417
- };