@easyedu/js-lsm-api 1.34.0 → 1.36.0

package/dist/models/ShortAnswer1.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface ShortAnswer1
+ */
+export interface ShortAnswer1 {
+    /**
+     *
+     * @type {ShortAnswer1TypeEnum}
+     * @memberof ShortAnswer1
+     */
+    type: ShortAnswer1TypeEnum;
+    /**
+     * Short text answer
+     * @type {string}
+     * @memberof ShortAnswer1
+     */
+    textAnswer: string;
+}
+/**
+ * @export
+ */
+export declare const ShortAnswer1TypeEnum: {
+    readonly ShortAnswer: "short_answer";
+};
+export type ShortAnswer1TypeEnum = typeof ShortAnswer1TypeEnum[keyof typeof ShortAnswer1TypeEnum];
+/**
+ * Check if a given object implements the ShortAnswer1 interface.
+ */
+export declare function instanceOfShortAnswer1(value: object): value is ShortAnswer1;
+export declare function ShortAnswer1FromJSON(json: any): ShortAnswer1;
+export declare function ShortAnswer1FromJSONTyped(json: any, ignoreDiscriminator: boolean): ShortAnswer1;
+export declare function ShortAnswer1ToJSON(json: any): ShortAnswer1;
+export declare function ShortAnswer1ToJSONTyped(value?: ShortAnswer1 | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ShortAnswer1.js

@@ -0,0 +1,61 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShortAnswer1TypeEnum = void 0;
+exports.instanceOfShortAnswer1 = instanceOfShortAnswer1;
+exports.ShortAnswer1FromJSON = ShortAnswer1FromJSON;
+exports.ShortAnswer1FromJSONTyped = ShortAnswer1FromJSONTyped;
+exports.ShortAnswer1ToJSON = ShortAnswer1ToJSON;
+exports.ShortAnswer1ToJSONTyped = ShortAnswer1ToJSONTyped;
+/**
+ * @export
+ */
+exports.ShortAnswer1TypeEnum = {
+    ShortAnswer: 'short_answer'
+};
+/**
+ * Check if a given object implements the ShortAnswer1 interface.
+ */
+function instanceOfShortAnswer1(value) {
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('textAnswer' in value) || value['textAnswer'] === undefined)
+        return false;
+    return true;
+}
+function ShortAnswer1FromJSON(json) {
+    return ShortAnswer1FromJSONTyped(json, false);
+}
+function ShortAnswer1FromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'type': json['type'],
+        'textAnswer': json['text_answer'],
+    };
+}
+function ShortAnswer1ToJSON(json) {
+    return ShortAnswer1ToJSONTyped(json, false);
+}
+function ShortAnswer1ToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'type': value['type'],
+        'text_answer': value['textAnswer'],
+    };
+}

package/dist/models/index.d.ts

@@ -1,6 +1,8 @@
 export * from './CriteriaBasedSelection';
 export * from './CriteriaBasedSelectionCriteria';
 export * from './CriteriaBasedSelectionDistribution';
+export * from './Essay';
+export * from './Essay1';
 export * from './FillInBlank';
 export * from './FillInBlank1';
 export * from './GetContent';
@@ -128,6 +130,10 @@ export * from './LoginResAuthData';
 export * from './LoginResUserData';
 export * from './LoginResUserDataSelectedPortal';
 export * from './ManualSelection';
+export * from './Matching';
+export * from './Matching1';
+export * from './Matching1PairsInner';
+export * from './MatchingPairsInner';
 export * from './MediaContent';
 export * from './MultipleAnswer';
 export * from './MultipleAnswer1';
@@ -180,6 +186,7 @@ export * from './PutQuestionAnswerChoicesInner';
 export * from './PutQuiz';
 export * from './PutQuizAnswer';
 export * from './PutQuizAnswerAnswer';
+export * from './PutQuizAnswerGrade';
 export * from './PutQuizSettings';
 export * from './PutRole';
 export * from './PutRolePermissions';
@@ -197,4 +204,6 @@ export * from './ScormSessionDataStatus';
 export * from './ScormSessionDataTime';
 export * from './ScormSetValueRequest';
 export * from './ScormSetValueResponse';
+export * from './ShortAnswer';
+export * from './ShortAnswer1';
 export * from './SingleAnswer';

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)
+
+