@easyedu/js-lsm-api 1.30.0 → 1.31.0

package/docs/QuestionApi.md

@@ -0,0 +1,368 @@
+# QuestionApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**deleteQuestion**](QuestionApi.md#deletequestion) | **DELETE** /questions/{questionId} | Delete a question by ID |
+| [**getQuestion**](QuestionApi.md#getquestion) | **GET** /questions/{questionId} | Get a question by ID |
+| [**getQuestionList**](QuestionApi.md#getquestionlist) | **GET** /questions | Get list of questions with filtering and pagination |
+| [**postQuestion**](QuestionApi.md#postquestion) | **POST** /questions | Create a new question |
+| [**putQuestion**](QuestionApi.md#putquestion) | **PUT** /questions/{questionId} | Update a question by ID |
+
+
+
+## deleteQuestion
+
+> deleteQuestion(questionId)
+
+Delete a question by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  QuestionApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteQuestionRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new QuestionApi();
+
+  const body = {
+    // string
+    questionId: questionId_example,
+  } satisfies DeleteQuestionRequest;
+
+  try {
+    const data = await api.deleteQuestion(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **questionId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | delete question response OK |  -  |
+| **404** | question not found |  -  |
+| **409** | question is in use by quizzes |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getQuestion
+
+> GetQuestion getQuestion(questionId)
+
+Get a question by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  QuestionApi,
+} from '@easyedu/js-lsm-api';
+import type { GetQuestionRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new QuestionApi();
+
+  const body = {
+    // string
+    questionId: questionId_example,
+  } satisfies GetQuestionRequest;
+
+  try {
+    const data = await api.getQuestion(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **questionId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetQuestion**](GetQuestion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | get question response OK |  -  |
+| **404** | question 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)
+
+
+## getQuestionList
+
+> GetQuestionList getQuestionList(page, pageSize, topic, course, questionType, difficultyLevel, tags, search)
+
+Get list of questions with filtering and pagination
+
+### Example
+
+```ts
+import {
+  Configuration,
+  QuestionApi,
+} from '@easyedu/js-lsm-api';
+import type { GetQuestionListRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new QuestionApi();
+
+  const body = {
+    // number | Page number (optional)
+    page: 56,
+    // number | Number of items per page (optional)
+    pageSize: 56,
+    // string | Filter by topic (optional)
+    topic: topic_example,
+    // string | Filter by course (optional)
+    course: course_example,
+    // 'single_answer' | 'multiple_answer' | 'fill_in_blank' | Filter by question type (optional)
+    questionType: questionType_example,
+    // 'beginner' | 'intermediate' | 'advanced' | Filter by difficulty level (optional)
+    difficultyLevel: difficultyLevel_example,
+    // Array<string> | Filter by tags (optional)
+    tags: ...,
+    // string | Search in question text (optional)
+    search: search_example,
+  } satisfies GetQuestionListRequest;
+
+  try {
+    const data = await api.getQuestionList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` | Page number | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
+| **topic** | `string` | Filter by topic | [Optional] [Defaults to `undefined`] |
+| **course** | `string` | Filter by course | [Optional] [Defaults to `undefined`] |
+| **questionType** | `single_answer`, `multiple_answer`, `fill_in_blank` | Filter by question type | [Optional] [Defaults to `undefined`] [Enum: single_answer, multiple_answer, fill_in_blank] |
+| **difficultyLevel** | `beginner`, `intermediate`, `advanced` | Filter by difficulty level | [Optional] [Defaults to `undefined`] [Enum: beginner, intermediate, advanced] |
+| **tags** | `Array<string>` | Filter by tags | [Optional] |
+| **search** | `string` | Search in question text | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**GetQuestionList**](GetQuestionList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | get question list response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postQuestion
+
+> GetQuestion postQuestion(postQuestion)
+
+Create a new question
+
+### Example
+
+```ts
+import {
+  Configuration,
+  QuestionApi,
+} from '@easyedu/js-lsm-api';
+import type { PostQuestionRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new QuestionApi();
+
+  const body = {
+    // PostQuestion | Question object to create
+    postQuestion: ...,
+  } satisfies PostQuestionRequest;
+
+  try {
+    const data = await api.postQuestion(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postQuestion** | [PostQuestion](PostQuestion.md) | Question object to create | |
+
+### Return type
+
+[**GetQuestion**](GetQuestion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | create question response OK |  -  |
+| **400** | create question response error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putQuestion
+
+> GetQuestion putQuestion(questionId, putQuestion)
+
+Update a question by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  QuestionApi,
+} from '@easyedu/js-lsm-api';
+import type { PutQuestionRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new QuestionApi();
+
+  const body = {
+    // string
+    questionId: questionId_example,
+    // PutQuestion | Question object to update
+    putQuestion: ...,
+  } satisfies PutQuestionRequest;
+
+  try {
+    const data = await api.putQuestion(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **questionId** | `string` |  | [Defaults to `undefined`] |
+| **putQuestion** | [PutQuestion](PutQuestion.md) | Question object to update | |
+
+### Return type
+
+[**GetQuestion**](GetQuestion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | update question response OK |  -  |
+| **404** | question not found |  -  |
+| **400** | update question response error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+