@examplary/sdk 2.12.0 → 2.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +92 -5
- package/dist/index.d.ts +92 -5
- package/dist/index.js +8 -0
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +8 -0
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -505,6 +505,30 @@ interface paths {
|
|
|
505
505
|
patch?: never;
|
|
506
506
|
trace?: never;
|
|
507
507
|
};
|
|
508
|
+
"/exams/{id}/sessions/summary": {
|
|
509
|
+
parameters: {
|
|
510
|
+
query?: never;
|
|
511
|
+
header?: never;
|
|
512
|
+
path?: never;
|
|
513
|
+
cookie?: never;
|
|
514
|
+
};
|
|
515
|
+
/**
|
|
516
|
+
* Get results summary
|
|
517
|
+
* @description Get the stored AI-generated summary of the exam's results, if one has been generated.
|
|
518
|
+
*/
|
|
519
|
+
get: operations["exams.sessions.getResultsSummary"];
|
|
520
|
+
put?: never;
|
|
521
|
+
/**
|
|
522
|
+
* Generate results summary
|
|
523
|
+
* @description Start a background task to generate an AI summary of the exam's results, highlighting what students are struggling with. Returns the stored summary directly when the results haven't changed since the last generation.
|
|
524
|
+
*/
|
|
525
|
+
post: operations["exams.sessions.generateResultsSummary"];
|
|
526
|
+
delete?: never;
|
|
527
|
+
options?: never;
|
|
528
|
+
head?: never;
|
|
529
|
+
patch?: never;
|
|
530
|
+
trace?: never;
|
|
531
|
+
};
|
|
508
532
|
"/exams/{id}/sessions/{sessionId}": {
|
|
509
533
|
parameters: {
|
|
510
534
|
query?: never;
|
|
@@ -2375,7 +2399,7 @@ interface operations {
|
|
|
2375
2399
|
type?: string;
|
|
2376
2400
|
/** @description Title for the question (stem) */
|
|
2377
2401
|
title?: string | null;
|
|
2378
|
-
/** @description Optional description for the question */
|
|
2402
|
+
/** @description Optional HTML description for the question */
|
|
2379
2403
|
description?: string | null;
|
|
2380
2404
|
/** @description Settings for the question, often specific to the question type */
|
|
2381
2405
|
settings?: {
|
|
@@ -2597,6 +2621,21 @@ interface operations {
|
|
|
2597
2621
|
metadata?: {
|
|
2598
2622
|
[key: string]: string | number | boolean | null;
|
|
2599
2623
|
};
|
|
2624
|
+
/**
|
|
2625
|
+
* Format: uri
|
|
2626
|
+
* @description URL to the README documentation for this question type
|
|
2627
|
+
*/
|
|
2628
|
+
readme?: string;
|
|
2629
|
+
/**
|
|
2630
|
+
* Format: uri
|
|
2631
|
+
* @description URL to a preview image for this question type
|
|
2632
|
+
*/
|
|
2633
|
+
previewImage?: string;
|
|
2634
|
+
/**
|
|
2635
|
+
* Format: uri
|
|
2636
|
+
* @description URL to example question data (JSON) used to preview this question type
|
|
2637
|
+
*/
|
|
2638
|
+
previewData?: string;
|
|
2600
2639
|
/** Format: uri */
|
|
2601
2640
|
stylesheet?: string;
|
|
2602
2641
|
index?: number;
|
|
@@ -3394,6 +3433,30 @@ interface operations {
|
|
|
3394
3433
|
};
|
|
3395
3434
|
responses: never;
|
|
3396
3435
|
};
|
|
3436
|
+
"exams.sessions.getResultsSummary": {
|
|
3437
|
+
parameters: {
|
|
3438
|
+
query?: never;
|
|
3439
|
+
header?: never;
|
|
3440
|
+
path: {
|
|
3441
|
+
id: string;
|
|
3442
|
+
};
|
|
3443
|
+
cookie?: never;
|
|
3444
|
+
};
|
|
3445
|
+
requestBody?: never;
|
|
3446
|
+
responses: never;
|
|
3447
|
+
};
|
|
3448
|
+
"exams.sessions.generateResultsSummary": {
|
|
3449
|
+
parameters: {
|
|
3450
|
+
query?: never;
|
|
3451
|
+
header?: never;
|
|
3452
|
+
path: {
|
|
3453
|
+
id: string;
|
|
3454
|
+
};
|
|
3455
|
+
cookie?: never;
|
|
3456
|
+
};
|
|
3457
|
+
requestBody?: never;
|
|
3458
|
+
responses: never;
|
|
3459
|
+
};
|
|
3397
3460
|
"exams.sessions.get": {
|
|
3398
3461
|
parameters: {
|
|
3399
3462
|
query?: never;
|
|
@@ -3681,7 +3744,7 @@ interface operations {
|
|
|
3681
3744
|
name?: string;
|
|
3682
3745
|
/** @description MIME type of the file, e.g. application/pdf */
|
|
3683
3746
|
type?: string;
|
|
3684
|
-
/** @description URL of the file, required if no content is specified. */
|
|
3747
|
+
/** @description URL of the file, required if no content is specified. Needs to be a HTTPS URL without basic auth or port. */
|
|
3685
3748
|
url?: string;
|
|
3686
3749
|
/** @description Content of the file as a string, as an alternative to URL. Only supported for exports from other systems (e.g. Moodle XML). */
|
|
3687
3750
|
content?: string;
|
|
@@ -3911,7 +3974,7 @@ interface operations {
|
|
|
3911
3974
|
type?: string;
|
|
3912
3975
|
/** @description Title for the question (stem) */
|
|
3913
3976
|
title?: string | null;
|
|
3914
|
-
/** @description Optional description for the question */
|
|
3977
|
+
/** @description Optional HTML description for the question */
|
|
3915
3978
|
description?: string | null;
|
|
3916
3979
|
/** @description Settings for the question, often specific to the question type */
|
|
3917
3980
|
settings?: {
|
|
@@ -6069,7 +6132,7 @@ interface operations {
|
|
|
6069
6132
|
type: string;
|
|
6070
6133
|
/** @description Title for the question (stem) */
|
|
6071
6134
|
title?: string | null;
|
|
6072
|
-
/** @description Optional description for the question */
|
|
6135
|
+
/** @description Optional HTML description for the question */
|
|
6073
6136
|
description?: string | null;
|
|
6074
6137
|
/** @description Settings for the question, often specific to the question type */
|
|
6075
6138
|
settings: {
|
|
@@ -6167,7 +6230,7 @@ interface operations {
|
|
|
6167
6230
|
type: string;
|
|
6168
6231
|
/** @description Title for the question (stem) */
|
|
6169
6232
|
title?: string | null;
|
|
6170
|
-
/** @description Optional description for the question */
|
|
6233
|
+
/** @description Optional HTML description for the question */
|
|
6171
6234
|
description?: string | null;
|
|
6172
6235
|
/** @description Settings for the question, often specific to the question type */
|
|
6173
6236
|
settings: {
|
|
@@ -6558,6 +6621,12 @@ interface _PathOverrides {
|
|
|
6558
6621
|
"exams.sessions.scanDocument": {
|
|
6559
6622
|
examId: string;
|
|
6560
6623
|
};
|
|
6624
|
+
"exams.sessions.getResultsSummary": {
|
|
6625
|
+
examId: string;
|
|
6626
|
+
};
|
|
6627
|
+
"exams.sessions.generateResultsSummary": {
|
|
6628
|
+
examId: string;
|
|
6629
|
+
};
|
|
6561
6630
|
"exams.sessions.get": {
|
|
6562
6631
|
examId: string;
|
|
6563
6632
|
sessionId: string;
|
|
@@ -7188,6 +7257,24 @@ declare class ExamsSessions {
|
|
|
7188
7257
|
* API endpoint: `POST /exams/{examId}/sessions/scan-document`
|
|
7189
7258
|
*/
|
|
7190
7259
|
scanDocument(args: Args<"exams.sessions.scanDocument">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.scanDocument">>;
|
|
7260
|
+
/**
|
|
7261
|
+
* Get results summary
|
|
7262
|
+
*
|
|
7263
|
+
* Get the stored AI-generated summary of the exam's results, if one has been generated.
|
|
7264
|
+
*
|
|
7265
|
+
* API endpoint: `GET /exams/{examId}/sessions/summary`
|
|
7266
|
+
*/
|
|
7267
|
+
getResultsSummary(examId: string, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.getResultsSummary">>;
|
|
7268
|
+
getResultsSummary(args: Args<"exams.sessions.getResultsSummary">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.getResultsSummary">>;
|
|
7269
|
+
/**
|
|
7270
|
+
* Generate results summary
|
|
7271
|
+
*
|
|
7272
|
+
* Start a background task to generate an AI summary of the exam's results, highlighting what students are struggling with. Returns the stored summary directly when the results haven't changed since the last generation.
|
|
7273
|
+
*
|
|
7274
|
+
* API endpoint: `POST /exams/{examId}/sessions/summary`
|
|
7275
|
+
*/
|
|
7276
|
+
generateResultsSummary(examId: string, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.generateResultsSummary">>;
|
|
7277
|
+
generateResultsSummary(args: Args<"exams.sessions.generateResultsSummary">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.generateResultsSummary">>;
|
|
7191
7278
|
/**
|
|
7192
7279
|
* Get exam session
|
|
7193
7280
|
*
|
package/dist/index.d.ts
CHANGED
|
@@ -505,6 +505,30 @@ interface paths {
|
|
|
505
505
|
patch?: never;
|
|
506
506
|
trace?: never;
|
|
507
507
|
};
|
|
508
|
+
"/exams/{id}/sessions/summary": {
|
|
509
|
+
parameters: {
|
|
510
|
+
query?: never;
|
|
511
|
+
header?: never;
|
|
512
|
+
path?: never;
|
|
513
|
+
cookie?: never;
|
|
514
|
+
};
|
|
515
|
+
/**
|
|
516
|
+
* Get results summary
|
|
517
|
+
* @description Get the stored AI-generated summary of the exam's results, if one has been generated.
|
|
518
|
+
*/
|
|
519
|
+
get: operations["exams.sessions.getResultsSummary"];
|
|
520
|
+
put?: never;
|
|
521
|
+
/**
|
|
522
|
+
* Generate results summary
|
|
523
|
+
* @description Start a background task to generate an AI summary of the exam's results, highlighting what students are struggling with. Returns the stored summary directly when the results haven't changed since the last generation.
|
|
524
|
+
*/
|
|
525
|
+
post: operations["exams.sessions.generateResultsSummary"];
|
|
526
|
+
delete?: never;
|
|
527
|
+
options?: never;
|
|
528
|
+
head?: never;
|
|
529
|
+
patch?: never;
|
|
530
|
+
trace?: never;
|
|
531
|
+
};
|
|
508
532
|
"/exams/{id}/sessions/{sessionId}": {
|
|
509
533
|
parameters: {
|
|
510
534
|
query?: never;
|
|
@@ -2375,7 +2399,7 @@ interface operations {
|
|
|
2375
2399
|
type?: string;
|
|
2376
2400
|
/** @description Title for the question (stem) */
|
|
2377
2401
|
title?: string | null;
|
|
2378
|
-
/** @description Optional description for the question */
|
|
2402
|
+
/** @description Optional HTML description for the question */
|
|
2379
2403
|
description?: string | null;
|
|
2380
2404
|
/** @description Settings for the question, often specific to the question type */
|
|
2381
2405
|
settings?: {
|
|
@@ -2597,6 +2621,21 @@ interface operations {
|
|
|
2597
2621
|
metadata?: {
|
|
2598
2622
|
[key: string]: string | number | boolean | null;
|
|
2599
2623
|
};
|
|
2624
|
+
/**
|
|
2625
|
+
* Format: uri
|
|
2626
|
+
* @description URL to the README documentation for this question type
|
|
2627
|
+
*/
|
|
2628
|
+
readme?: string;
|
|
2629
|
+
/**
|
|
2630
|
+
* Format: uri
|
|
2631
|
+
* @description URL to a preview image for this question type
|
|
2632
|
+
*/
|
|
2633
|
+
previewImage?: string;
|
|
2634
|
+
/**
|
|
2635
|
+
* Format: uri
|
|
2636
|
+
* @description URL to example question data (JSON) used to preview this question type
|
|
2637
|
+
*/
|
|
2638
|
+
previewData?: string;
|
|
2600
2639
|
/** Format: uri */
|
|
2601
2640
|
stylesheet?: string;
|
|
2602
2641
|
index?: number;
|
|
@@ -3394,6 +3433,30 @@ interface operations {
|
|
|
3394
3433
|
};
|
|
3395
3434
|
responses: never;
|
|
3396
3435
|
};
|
|
3436
|
+
"exams.sessions.getResultsSummary": {
|
|
3437
|
+
parameters: {
|
|
3438
|
+
query?: never;
|
|
3439
|
+
header?: never;
|
|
3440
|
+
path: {
|
|
3441
|
+
id: string;
|
|
3442
|
+
};
|
|
3443
|
+
cookie?: never;
|
|
3444
|
+
};
|
|
3445
|
+
requestBody?: never;
|
|
3446
|
+
responses: never;
|
|
3447
|
+
};
|
|
3448
|
+
"exams.sessions.generateResultsSummary": {
|
|
3449
|
+
parameters: {
|
|
3450
|
+
query?: never;
|
|
3451
|
+
header?: never;
|
|
3452
|
+
path: {
|
|
3453
|
+
id: string;
|
|
3454
|
+
};
|
|
3455
|
+
cookie?: never;
|
|
3456
|
+
};
|
|
3457
|
+
requestBody?: never;
|
|
3458
|
+
responses: never;
|
|
3459
|
+
};
|
|
3397
3460
|
"exams.sessions.get": {
|
|
3398
3461
|
parameters: {
|
|
3399
3462
|
query?: never;
|
|
@@ -3681,7 +3744,7 @@ interface operations {
|
|
|
3681
3744
|
name?: string;
|
|
3682
3745
|
/** @description MIME type of the file, e.g. application/pdf */
|
|
3683
3746
|
type?: string;
|
|
3684
|
-
/** @description URL of the file, required if no content is specified. */
|
|
3747
|
+
/** @description URL of the file, required if no content is specified. Needs to be a HTTPS URL without basic auth or port. */
|
|
3685
3748
|
url?: string;
|
|
3686
3749
|
/** @description Content of the file as a string, as an alternative to URL. Only supported for exports from other systems (e.g. Moodle XML). */
|
|
3687
3750
|
content?: string;
|
|
@@ -3911,7 +3974,7 @@ interface operations {
|
|
|
3911
3974
|
type?: string;
|
|
3912
3975
|
/** @description Title for the question (stem) */
|
|
3913
3976
|
title?: string | null;
|
|
3914
|
-
/** @description Optional description for the question */
|
|
3977
|
+
/** @description Optional HTML description for the question */
|
|
3915
3978
|
description?: string | null;
|
|
3916
3979
|
/** @description Settings for the question, often specific to the question type */
|
|
3917
3980
|
settings?: {
|
|
@@ -6069,7 +6132,7 @@ interface operations {
|
|
|
6069
6132
|
type: string;
|
|
6070
6133
|
/** @description Title for the question (stem) */
|
|
6071
6134
|
title?: string | null;
|
|
6072
|
-
/** @description Optional description for the question */
|
|
6135
|
+
/** @description Optional HTML description for the question */
|
|
6073
6136
|
description?: string | null;
|
|
6074
6137
|
/** @description Settings for the question, often specific to the question type */
|
|
6075
6138
|
settings: {
|
|
@@ -6167,7 +6230,7 @@ interface operations {
|
|
|
6167
6230
|
type: string;
|
|
6168
6231
|
/** @description Title for the question (stem) */
|
|
6169
6232
|
title?: string | null;
|
|
6170
|
-
/** @description Optional description for the question */
|
|
6233
|
+
/** @description Optional HTML description for the question */
|
|
6171
6234
|
description?: string | null;
|
|
6172
6235
|
/** @description Settings for the question, often specific to the question type */
|
|
6173
6236
|
settings: {
|
|
@@ -6558,6 +6621,12 @@ interface _PathOverrides {
|
|
|
6558
6621
|
"exams.sessions.scanDocument": {
|
|
6559
6622
|
examId: string;
|
|
6560
6623
|
};
|
|
6624
|
+
"exams.sessions.getResultsSummary": {
|
|
6625
|
+
examId: string;
|
|
6626
|
+
};
|
|
6627
|
+
"exams.sessions.generateResultsSummary": {
|
|
6628
|
+
examId: string;
|
|
6629
|
+
};
|
|
6561
6630
|
"exams.sessions.get": {
|
|
6562
6631
|
examId: string;
|
|
6563
6632
|
sessionId: string;
|
|
@@ -7188,6 +7257,24 @@ declare class ExamsSessions {
|
|
|
7188
7257
|
* API endpoint: `POST /exams/{examId}/sessions/scan-document`
|
|
7189
7258
|
*/
|
|
7190
7259
|
scanDocument(args: Args<"exams.sessions.scanDocument">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.scanDocument">>;
|
|
7260
|
+
/**
|
|
7261
|
+
* Get results summary
|
|
7262
|
+
*
|
|
7263
|
+
* Get the stored AI-generated summary of the exam's results, if one has been generated.
|
|
7264
|
+
*
|
|
7265
|
+
* API endpoint: `GET /exams/{examId}/sessions/summary`
|
|
7266
|
+
*/
|
|
7267
|
+
getResultsSummary(examId: string, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.getResultsSummary">>;
|
|
7268
|
+
getResultsSummary(args: Args<"exams.sessions.getResultsSummary">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.getResultsSummary">>;
|
|
7269
|
+
/**
|
|
7270
|
+
* Generate results summary
|
|
7271
|
+
*
|
|
7272
|
+
* Start a background task to generate an AI summary of the exam's results, highlighting what students are struggling with. Returns the stored summary directly when the results haven't changed since the last generation.
|
|
7273
|
+
*
|
|
7274
|
+
* API endpoint: `POST /exams/{examId}/sessions/summary`
|
|
7275
|
+
*/
|
|
7276
|
+
generateResultsSummary(examId: string, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.generateResultsSummary">>;
|
|
7277
|
+
generateResultsSummary(args: Args<"exams.sessions.generateResultsSummary">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.generateResultsSummary">>;
|
|
7191
7278
|
/**
|
|
7192
7279
|
* Get exam session
|
|
7193
7280
|
*
|
package/dist/index.js
CHANGED
|
@@ -342,6 +342,14 @@ var ExamsSessions = class {
|
|
|
342
342
|
const args = arg;
|
|
343
343
|
return request(this.ctx, "POST", "/exams/{examId}/sessions/scan-document", ["examId"], [], true, args, options);
|
|
344
344
|
}
|
|
345
|
+
getResultsSummary(arg, options) {
|
|
346
|
+
const args = typeof arg === "string" ? { examId: arg } : arg;
|
|
347
|
+
return request(this.ctx, "GET", "/exams/{examId}/sessions/summary", ["examId"], [], false, args, options);
|
|
348
|
+
}
|
|
349
|
+
generateResultsSummary(arg, options) {
|
|
350
|
+
const args = typeof arg === "string" ? { examId: arg } : arg;
|
|
351
|
+
return request(this.ctx, "POST", "/exams/{examId}/sessions/summary", ["examId"], [], false, args, options);
|
|
352
|
+
}
|
|
345
353
|
get(arg, options) {
|
|
346
354
|
const args = arg;
|
|
347
355
|
return request(this.ctx, "GET", "/exams/{examId}/sessions/{sessionId}", ["examId", "sessionId"], [], false, args, options);
|