@easyedu/js-lsm-api 1.35.0 → 1.36.0

package/dist/models/index.js

@@ -19,6 +19,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./CriteriaBasedSelection"), exports);
 __exportStar(require("./CriteriaBasedSelectionCriteria"), exports);
 __exportStar(require("./CriteriaBasedSelectionDistribution"), exports);
+__exportStar(require("./Essay"), exports);
+__exportStar(require("./Essay1"), exports);
 __exportStar(require("./FillInBlank"), exports);
 __exportStar(require("./FillInBlank1"), exports);
 __exportStar(require("./GetContent"), exports);
@@ -146,6 +148,10 @@ __exportStar(require("./LoginResAuthData"), exports);
 __exportStar(require("./LoginResUserData"), exports);
 __exportStar(require("./LoginResUserDataSelectedPortal"), exports);
 __exportStar(require("./ManualSelection"), exports);
+__exportStar(require("./Matching"), exports);
+__exportStar(require("./Matching1"), exports);
+__exportStar(require("./Matching1PairsInner"), exports);
+__exportStar(require("./MatchingPairsInner"), exports);
 __exportStar(require("./MediaContent"), exports);
 __exportStar(require("./MultipleAnswer"), exports);
 __exportStar(require("./MultipleAnswer1"), exports);
@@ -198,6 +204,7 @@ __exportStar(require("./PutQuestionAnswerChoicesInner"), exports);
 __exportStar(require("./PutQuiz"), exports);
 __exportStar(require("./PutQuizAnswer"), exports);
 __exportStar(require("./PutQuizAnswerAnswer"), exports);
+__exportStar(require("./PutQuizAnswerGrade"), exports);
 __exportStar(require("./PutQuizSettings"), exports);
 __exportStar(require("./PutRole"), exports);
 __exportStar(require("./PutRolePermissions"), exports);
@@ -215,4 +222,6 @@ __exportStar(require("./ScormSessionDataStatus"), exports);
 __exportStar(require("./ScormSessionDataTime"), exports);
 __exportStar(require("./ScormSetValueRequest"), exports);
 __exportStar(require("./ScormSetValueResponse"), exports);
+__exportStar(require("./ShortAnswer"), exports);
+__exportStar(require("./ShortAnswer1"), exports);
 __exportStar(require("./SingleAnswer"), exports);

package/docs/Essay.md

@@ -0,0 +1,36 @@
+
+# Essay
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`textAnswer` | string
+
+## Example
+
+```typescript
+import type { Essay } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "textAnswer": null,
+} satisfies Essay
+
+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 Essay
+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/Essay1.md

@@ -0,0 +1,36 @@
+
+# Essay1
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`textAnswer` | string
+
+## Example
+
+```typescript
+import type { Essay1 } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "textAnswer": null,
+} satisfies Essay1
+
+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 Essay1
+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/Matching.md

@@ -0,0 +1,36 @@
+
+# Matching
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`pairs` | [Array<MatchingPairsInner>](MatchingPairsInner.md)
+
+## Example
+
+```typescript
+import type { Matching } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "pairs": null,
+} satisfies Matching
+
+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 Matching
+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/Matching1.md

@@ -0,0 +1,36 @@
+
+# Matching1
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`pairs` | [Array<Matching1PairsInner>](Matching1PairsInner.md)
+
+## Example
+
+```typescript
+import type { Matching1 } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "pairs": null,
+} satisfies Matching1
+
+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 Matching1
+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/Matching1PairsInner.md

@@ -0,0 +1,36 @@
+
+# Matching1PairsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`premiseId` | number
+`responseId` | number
+
+## Example
+
+```typescript
+import type { Matching1PairsInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "premiseId": null,
+  "responseId": null,
+} satisfies Matching1PairsInner
+
+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 Matching1PairsInner
+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/MatchingPairsInner.md

@@ -0,0 +1,36 @@
+
+# MatchingPairsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`premiseId` | number
+`responseId` | number
+
+## Example
+
+```typescript
+import type { MatchingPairsInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "premiseId": null,
+  "responseId": null,
+} satisfies MatchingPairsInner
+
+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 MatchingPairsInner
+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/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.36.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];