@examplary/sdk 2.10.0 → 2.11.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 (5) hide show
  1. package/dist/index.d.mts +11 -3
  2. package/dist/index.d.ts +11 -3
  3. package/dist/index.js.map +1 -1
  4. package/dist/index.mjs.map +1 -1
  5. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -543,7 +543,7 @@ interface paths {
543
543
  get?: never;
544
544
  /**
545
545
  * Assign session to user
546
- * @description Connect an anonymous exam session to an existing user account. Only allowed when the session is not connected to a user yet.
546
+ * @description Connect an anonymous exam session to a student account, by user ID or email address (inviting a new student if needed). Optionally notifies the student that their results are available for review. Only allowed when the session is not connected to a user yet.
547
547
  */
548
548
  put: operations["exams.sessions.assignUser"];
549
549
  post?: never;
@@ -3330,7 +3330,7 @@ interface operations {
3330
3330
  requestBody?: {
3331
3331
  content: {
3332
3332
  "application/json": {
3333
- sendNotifications?: boolean;
3333
+ sendNotification?: boolean;
3334
3334
  };
3335
3335
  };
3336
3336
  };
@@ -3453,6 +3453,14 @@ interface operations {
3453
3453
  content: {
3454
3454
  "application/json": {
3455
3455
  user: string;
3456
+ sendNotification?: boolean;
3457
+ } | {
3458
+ /**
3459
+ * Format: email
3460
+ * @description The email of the student to link. Creates a new student account if no user with this email exists yet.
3461
+ */
3462
+ email: string;
3463
+ sendNotification?: boolean;
3456
3464
  };
3457
3465
  };
3458
3466
  };
@@ -7207,7 +7215,7 @@ declare class ExamsSessions {
7207
7215
  /**
7208
7216
  * Assign session to user
7209
7217
  *
7210
- * Connect an anonymous exam session to an existing user account. Only allowed when the session is not connected to a user yet.
7218
+ * Connect an anonymous exam session to a student account, by user ID or email address (inviting a new student if needed). Optionally notifies the student that their results are available for review. Only allowed when the session is not connected to a user yet.
7211
7219
  *
7212
7220
  * API endpoint: `PUT /exams/{examId}/sessions/{sessionId}/user`
7213
7221
  */
package/dist/index.d.ts CHANGED
@@ -543,7 +543,7 @@ interface paths {
543
543
  get?: never;
544
544
  /**
545
545
  * Assign session to user
546
- * @description Connect an anonymous exam session to an existing user account. Only allowed when the session is not connected to a user yet.
546
+ * @description Connect an anonymous exam session to a student account, by user ID or email address (inviting a new student if needed). Optionally notifies the student that their results are available for review. Only allowed when the session is not connected to a user yet.
547
547
  */
548
548
  put: operations["exams.sessions.assignUser"];
549
549
  post?: never;
@@ -3330,7 +3330,7 @@ interface operations {
3330
3330
  requestBody?: {
3331
3331
  content: {
3332
3332
  "application/json": {
3333
- sendNotifications?: boolean;
3333
+ sendNotification?: boolean;
3334
3334
  };
3335
3335
  };
3336
3336
  };
@@ -3453,6 +3453,14 @@ interface operations {
3453
3453
  content: {
3454
3454
  "application/json": {
3455
3455
  user: string;
3456
+ sendNotification?: boolean;
3457
+ } | {
3458
+ /**
3459
+ * Format: email
3460
+ * @description The email of the student to link. Creates a new student account if no user with this email exists yet.
3461
+ */
3462
+ email: string;
3463
+ sendNotification?: boolean;
3456
3464
  };
3457
3465
  };
3458
3466
  };
@@ -7207,7 +7215,7 @@ declare class ExamsSessions {
7207
7215
  /**
7208
7216
  * Assign session to user
7209
7217
  *
7210
- * Connect an anonymous exam session to an existing user account. Only allowed when the session is not connected to a user yet.
7218
+ * Connect an anonymous exam session to a student account, by user ID or email address (inviting a new student if needed). Optionally notifies the student that their results are available for review. Only allowed when the session is not connected to a user yet.
7211
7219
  *
7212
7220
  * API endpoint: `PUT /exams/{examId}/sessions/{sessionId}/user`
7213
7221
  */