@easyedu/js-lsm-api 1.35.0 → 1.37.0

package/docs/PostCourseExport.md

@@ -1,13 +1,14 @@
 
 # PostCourseExport
 
-Request to create a new SCORM export for a course
+Request to create a new export for a course
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`scormVersion` | string
+`exportType` | string
+`moduleIds` | Array<string>
 
 ## Example
 
@@ -16,7 +17,8 @@ import type { PostCourseExport } from '@easyedu/js-lsm-api'
 
 // TODO: Update the object below with actual values
 const example = {
-  "scormVersion": null,
+  "exportType": null,
+  "moduleIds": null,
 } satisfies PostCourseExport
 
 console.log(example)

package/docs/PostQuizAttemptSubmitFinalAnswersInnerAnswer.md

@@ -11,6 +11,7 @@ Name | Type
 `answerChoiceId` | string
 `answerChoiceIds` | Array<string>
 `textAnswer` | string
+`pairs` | [Array<Matching1PairsInner>](Matching1PairsInner.md)
 
 ## Example
 
@@ -23,6 +24,7 @@ const example = {
   "answerChoiceId": null,
   "answerChoiceIds": null,
   "textAnswer": null,
+  "pairs": null,
 } satisfies PostQuizAttemptSubmitFinalAnswersInnerAnswer
 
 console.log(example)

package/docs/PutQuizAnswerAnswer.md

@@ -11,6 +11,7 @@ Name | Type
 `answerChoiceId` | string
 `answerChoiceIds` | Array<string>
 `textAnswer` | string
+`pairs` | [Array<MatchingPairsInner>](MatchingPairsInner.md)
 
 ## Example
 
@@ -23,6 +24,7 @@ const example = {
   "answerChoiceId": null,
   "answerChoiceIds": null,
   "textAnswer": null,
+  "pairs": null,
 } satisfies PutQuizAnswerAnswer
 
 console.log(example)

package/docs/PutQuizAnswerGrade.md

@@ -0,0 +1,36 @@
+
+# PutQuizAnswerGrade
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pointsEarned` | number
+`feedback` | string
+
+## Example
+
+```typescript
+import type { PutQuizAnswerGrade } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pointsEarned": null,
+  "feedback": null,
+} satisfies PutQuizAnswerGrade
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PutQuizAnswerGrade
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/QuizApi.md

@@ -23,6 +23,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getQuizManualQuestionSelectionList**](QuizApi.md#getquizmanualquestionselectionlist) | **GET** /quizzes/{quizId}/manual-question-selection | Get manually selected questions for quiz |
 | [**getQuizQuestions**](QuizApi.md#getquizquestions) | **GET** /quizzes/{quizId}/questions | Get quiz questions (paginated) |
 | [**getUserQuizAttempts**](QuizApi.md#getuserquizattempts) | **GET** /users/{userId}/quiz-attempts | Get user\'s quiz attempts across all quizzes |
+| [**gradeQuizAnswer**](QuizApi.md#gradequizanswer) | **PUT** /quiz-attempts/{attemptId}/answers/{questionId}/grade | Grade or override score for a question answer |
 | [**removeQuizQuestion**](QuizApi.md#removequizquestion) | **DELETE** /quizzes/{quizId}/questions/{questionId} | Remove question from quiz |
 | [**saveQuizAnswer**](QuizApi.md#savequizanswer) | **PUT** /quiz-attempts/{attemptId}/answers/{questionId} | Save answer for a specific question |
 | [**startQuizAttempt**](QuizApi.md#startquizattempt) | **POST** /quizzes/{quizId}/attempts | Start a new quiz attempt |
@@ -1369,6 +1370,82 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## gradeQuizAnswer
+
+> gradeQuizAnswer(attemptId, questionId, putQuizAnswerGrade)
+
+Grade or override score for a question answer
+
+Allows an instructor to grade an essay or override the score for any question type.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  QuizApi,
+} from '@easyedu/js-lsm-api';
+import type { GradeQuizAnswerRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new QuizApi();
+
+  const body = {
+    // string
+    attemptId: attemptId_example,
+    // string
+    questionId: questionId_example,
+    // PutQuizAnswerGrade
+    putQuizAnswerGrade: ...,
+  } satisfies GradeQuizAnswerRequest;
+
+  try {
+    const data = await api.gradeQuizAnswer(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **attemptId** | `string` |  | [Defaults to `undefined`] |
+| **questionId** | `string` |  | [Defaults to `undefined`] |
+| **putQuizAnswerGrade** | [PutQuizAnswerGrade](PutQuizAnswerGrade.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Answer graded successfully |  -  |
+| **400** | Invalid grade (points out of range) |  -  |
+| **403** | Not authorized to grade answers |  -  |
+| **404** | Attempt, question, or answer not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## removeQuizQuestion
 
 > removeQuizQuestion(quizId, questionId)

package/docs/ShortAnswer.md

@@ -0,0 +1,36 @@
+
+# ShortAnswer
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`textAnswer` | string
+
+## Example
+
+```typescript
+import type { ShortAnswer } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "textAnswer": null,
+} satisfies ShortAnswer
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ShortAnswer
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ShortAnswer1.md

@@ -0,0 +1,36 @@
+
+# ShortAnswer1
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`textAnswer` | string
+
+## Example
+
+```typescript
+import type { ShortAnswer1 } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "textAnswer": null,
+} satisfies ShortAnswer1
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ShortAnswer1
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.35.0",
+  "version": "1.37.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/QuizApi.ts

@@ -36,6 +36,7 @@ import type {
   PostQuizQuestions,
   PutQuiz,
   PutQuizAnswer,
+  PutQuizAnswerGrade,
 } from '../models/index';
 import {
     GetManualQuestionSelectionItemFromJSON,
@@ -80,6 +81,8 @@ import {
     PutQuizToJSON,
     PutQuizAnswerFromJSON,
     PutQuizAnswerToJSON,
+    PutQuizAnswerGradeFromJSON,
+    PutQuizAnswerGradeToJSON,
 } from '../models/index';
 
 export interface AddQuizCriteriaQuestionSelectionRequest {
@@ -183,6 +186,12 @@ export interface GetUserQuizAttemptsRequest {
     status?: GetUserQuizAttemptsStatusEnum;
 }
 
+export interface GradeQuizAnswerRequest {
+    attemptId: string;
+    questionId: string;
+    putQuizAnswerGrade: PutQuizAnswerGrade;
+}
+
 export interface RemoveQuizQuestionRequest {
     quizId: string;
     questionId: string;
@@ -1202,6 +1211,70 @@ export class QuizApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for gradeQuizAnswer without sending the request
+     */
+    async gradeQuizAnswerRequestOpts(requestParameters: GradeQuizAnswerRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['attemptId'] == null) {
+            throw new runtime.RequiredError(
+                'attemptId',
+                'Required parameter "attemptId" was null or undefined when calling gradeQuizAnswer().'
+            );
+        }
+
+        if (requestParameters['questionId'] == null) {
+            throw new runtime.RequiredError(
+                'questionId',
+                'Required parameter "questionId" was null or undefined when calling gradeQuizAnswer().'
+            );
+        }
+
+        if (requestParameters['putQuizAnswerGrade'] == null) {
+            throw new runtime.RequiredError(
+                'putQuizAnswerGrade',
+                'Required parameter "putQuizAnswerGrade" was null or undefined when calling gradeQuizAnswer().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/quiz-attempts/{attemptId}/answers/{questionId}/grade`;
+        urlPath = urlPath.replace(`{${"attemptId"}}`, encodeURIComponent(String(requestParameters['attemptId'])));
+        urlPath = urlPath.replace(`{${"questionId"}}`, encodeURIComponent(String(requestParameters['questionId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutQuizAnswerGradeToJSON(requestParameters['putQuizAnswerGrade']),
+        };
+    }
+
+    /**
+     * Allows an instructor to grade an essay or override the score for any question type.
+     * Grade or override score for a question answer
+     */
+    async gradeQuizAnswerRaw(requestParameters: GradeQuizAnswerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.gradeQuizAnswerRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Allows an instructor to grade an essay or override the score for any question type.
+     * Grade or override score for a question answer
+     */
+    async gradeQuizAnswer(requestParameters: GradeQuizAnswerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.gradeQuizAnswerRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Creates request options for removeQuizQuestion without sending the request
      */

package/src/models/CriteriaBasedSelectionCriteria.ts

@@ -68,7 +68,10 @@ export type CriteriaBasedSelectionCriteriaDifficultyLevelsEnum = typeof Criteria
 export const CriteriaBasedSelectionCriteriaQuestionTypesEnum = {
     SingleAnswer: 'single_answer',
     MultipleAnswer: 'multiple_answer',
-    FillInBlank: 'fill_in_blank'
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
 } as const;
 export type CriteriaBasedSelectionCriteriaQuestionTypesEnum = typeof CriteriaBasedSelectionCriteriaQuestionTypesEnum[keyof typeof CriteriaBasedSelectionCriteriaQuestionTypesEnum];
 

package/src/models/Essay.ts

@@ -0,0 +1,85 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface Essay
+ */
+export interface Essay {
+    /**
+     * 
+     * @type {EssayTypeEnum}
+     * @memberof Essay
+     */
+    type: EssayTypeEnum;
+    /**
+     * Essay response text
+     * @type {string}
+     * @memberof Essay
+     */
+    textAnswer: string;
+}
+
+
+/**
+ * @export
+ */
+export const EssayTypeEnum = {
+    Essay: 'essay'
+} as const;
+export type EssayTypeEnum = typeof EssayTypeEnum[keyof typeof EssayTypeEnum];
+
+
+/**
+ * Check if a given object implements the Essay interface.
+ */
+export function instanceOfEssay(value: object): value is Essay {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('textAnswer' in value) || value['textAnswer'] === undefined) return false;
+    return true;
+}
+
+export function EssayFromJSON(json: any): Essay {
+    return EssayFromJSONTyped(json, false);
+}
+
+export function EssayFromJSONTyped(json: any, ignoreDiscriminator: boolean): Essay {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': json['type'],
+        'textAnswer': json['text_answer'],
+    };
+}
+
+export function EssayToJSON(json: any): Essay {
+    return EssayToJSONTyped(json, false);
+}
+
+export function EssayToJSONTyped(value?: Essay | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': value['type'],
+        'text_answer': value['textAnswer'],
+    };
+}
+

package/src/models/Essay1.ts

@@ -0,0 +1,85 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface Essay1
+ */
+export interface Essay1 {
+    /**
+     * 
+     * @type {Essay1TypeEnum}
+     * @memberof Essay1
+     */
+    type: Essay1TypeEnum;
+    /**
+     * Essay response text
+     * @type {string}
+     * @memberof Essay1
+     */
+    textAnswer: string;
+}
+
+
+/**
+ * @export
+ */
+export const Essay1TypeEnum = {
+    Essay: 'essay'
+} as const;
+export type Essay1TypeEnum = typeof Essay1TypeEnum[keyof typeof Essay1TypeEnum];
+
+
+/**
+ * Check if a given object implements the Essay1 interface.
+ */
+export function instanceOfEssay1(value: object): value is Essay1 {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('textAnswer' in value) || value['textAnswer'] === undefined) return false;
+    return true;
+}
+
+export function Essay1FromJSON(json: any): Essay1 {
+    return Essay1FromJSONTyped(json, false);
+}
+
+export function Essay1FromJSONTyped(json: any, ignoreDiscriminator: boolean): Essay1 {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': json['type'],
+        'textAnswer': json['text_answer'],
+    };
+}
+
+export function Essay1ToJSON(json: any): Essay1 {
+    return Essay1ToJSONTyped(json, false);
+}
+
+export function Essay1ToJSONTyped(value?: Essay1 | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': value['type'],
+        'text_answer': value['textAnswer'],
+    };
+}
+

package/src/models/GetCourseExport.ts

@@ -14,7 +14,7 @@
 
 import { mapValues } from '../runtime';
 /**
- * Details of a course SCORM export
+ * Details of a course export
  * @export
  * @interface GetCourseExport
  */
@@ -32,11 +32,23 @@ export interface GetCourseExport {
      */
     courseId: string;
     /**
-     * The SCORM version to export
-     * @type {GetCourseExportScormVersionEnum}
+     * The export format type
+     * @type {GetCourseExportExportTypeEnum}
      * @memberof GetCourseExport
      */
-    scormVersion: GetCourseExportScormVersionEnum;
+    exportType: GetCourseExportExportTypeEnum;
+    /**
+     * IDs of the modules included in the export
+     * @type {Array<string>}
+     * @memberof GetCourseExport
+     */
+    moduleIds: Array<string>;
+    /**
+     * ID of the user who requested the export
+     * @type {number}
+     * @memberof GetCourseExport
+     */
+    createdBy: number;
     /**
      * Current status of the export generation
      * @type {GetCourseExportStatusEnum}
@@ -44,7 +56,7 @@ export interface GetCourseExport {
      */
     status: GetCourseExportStatusEnum;
     /**
-     * URL to download the export zip file (null if not yet completed)
+     * URL to download the export file (null if not yet completed)
      * @type {string}
      * @memberof GetCourseExport
      */
@@ -73,12 +85,12 @@ export interface GetCourseExport {
 /**
  * @export
  */
-export const GetCourseExportScormVersionEnum = {
+export const GetCourseExportExportTypeEnum = {
     Scorm12: 'SCORM_1_2',
     Scorm20043RdEdition: 'SCORM_2004_3RD_EDITION',
     Scorm20044ThEdition: 'SCORM_2004_4TH_EDITION'
 } as const;
-export type GetCourseExportScormVersionEnum = typeof GetCourseExportScormVersionEnum[keyof typeof GetCourseExportScormVersionEnum];
+export type GetCourseExportExportTypeEnum = typeof GetCourseExportExportTypeEnum[keyof typeof GetCourseExportExportTypeEnum];
 
 /**
  * @export
@@ -98,7 +110,9 @@ export type GetCourseExportStatusEnum = typeof GetCourseExportStatusEnum[keyof t
 export function instanceOfGetCourseExport(value: object): value is GetCourseExport {
     if (!('id' in value) || value['id'] === undefined) return false;
     if (!('courseId' in value) || value['courseId'] === undefined) return false;
-    if (!('scormVersion' in value) || value['scormVersion'] === undefined) return false;
+    if (!('exportType' in value) || value['exportType'] === undefined) return false;
+    if (!('moduleIds' in value) || value['moduleIds'] === undefined) return false;
+    if (!('createdBy' in value) || value['createdBy'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     return true;
@@ -116,7 +130,9 @@ export function GetCourseExportFromJSONTyped(json: any, ignoreDiscriminator: boo
         
         'id': json['id'],
         'courseId': json['course_id'],
-        'scormVersion': json['scorm_version'],
+        'exportType': json['export_type'],
+        'moduleIds': json['module_ids'],
+        'createdBy': json['created_by'],
         'status': json['status'],
         'downloadUrl': json['download_url'] == null ? undefined : json['download_url'],
         'fileSize': json['file_size'] == null ? undefined : json['file_size'],
@@ -138,7 +154,9 @@ export function GetCourseExportToJSONTyped(value?: GetCourseExport | null, ignor
         
         'id': value['id'],
         'course_id': value['courseId'],
-        'scorm_version': value['scormVersion'],
+        'export_type': value['exportType'],
+        'module_ids': value['moduleIds'],
+        'created_by': value['createdBy'],
         'status': value['status'],
         'download_url': value['downloadUrl'],
         'file_size': value['fileSize'],

package/src/models/GetQuestion.ts

@@ -40,7 +40,7 @@ export interface GetQuestion {
      */
     questionText: string;
     /**
-     * Type of question: single answer (True/False, multiple choice), multiple answer, or fill in the blank
+     * Type of question
      * @type {GetQuestionQuestionTypeEnum}
      * @memberof GetQuestion
      */
@@ -126,7 +126,10 @@ export interface GetQuestion {
 export const GetQuestionQuestionTypeEnum = {
     SingleAnswer: 'single_answer',
     MultipleAnswer: 'multiple_answer',
-    FillInBlank: 'fill_in_blank'
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
 } as const;
 export type GetQuestionQuestionTypeEnum = typeof GetQuestionQuestionTypeEnum[keyof typeof GetQuestionQuestionTypeEnum];
 

package/src/models/GetQuestionListFilters.ts

@@ -76,7 +76,10 @@ export interface GetQuestionListFilters {
 export const GetQuestionListFiltersQuestionTypeEnum = {
     SingleAnswer: 'single_answer',
     MultipleAnswer: 'multiple_answer',
-    FillInBlank: 'fill_in_blank'
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
 } as const;
 export type GetQuestionListFiltersQuestionTypeEnum = typeof GetQuestionListFiltersQuestionTypeEnum[keyof typeof GetQuestionListFiltersQuestionTypeEnum];