@easyedu/js-lsm-api 1.111.0 → 1.113.0

package/docs/QuestionApi.md

@@ -7,8 +7,9 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**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 |
+| [**getQuestionVersions**](QuestionApi.md#getquestionversions) | **GET** /questions/{questionId}/versions | Get all versions of a question |
 | [**postQuestion**](QuestionApi.md#postquestion) | **POST** /questions | Create a new question |
-| [**putQuestion**](QuestionApi.md#putquestion) | **PUT** /questions/{questionId} | Update a question by ID |
+| [**putQuestion**](QuestionApi.md#putquestion) | **PUT** /questions/{questionId} | Create the next version of a question |
 
 
 
@@ -222,6 +223,72 @@ 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)
 
 
+## getQuestionVersions
+
+> Array<GetQuestion> getQuestionVersions(questionId)
+
+Get all versions of a question
+
+### Example
+
+```ts
+import {
+  Configuration,
+  QuestionApi,
+} from '@easyedu/js-lsm-api';
+import type { GetQuestionVersionsRequest } 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 GetQuestionVersionsRequest;
+
+  try {
+    const data = await api.getQuestionVersions(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
+
+[**Array<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** | Question version history, newest first |  -  |
+| **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)
+
+
 ## postQuestion
 
 > GetQuestion postQuestion(postQuestion)
@@ -292,7 +359,7 @@ No authorization required
 
 > GetQuestion putQuestion(questionId, putQuestion)
 
-Update a question by ID
+Create the next version of a question
 
 ### Example
 
@@ -354,6 +421,7 @@ No authorization required
 | **200** | update question response OK |  -  |
 | **404** | question not found |  -  |
 | **400** | update question response error |  -  |
+| **409** | supplied question is a historical or stale version |  -  |
 
 [[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/QuestionImportApi.md

@@ -0,0 +1,149 @@
+# QuestionImportApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**postQuestionImportCommit**](QuestionImportApi.md#postquestionimportcommit) | **POST** /question-imports/commit | Validate and atomically create, version, or skip approved question drafts |
+| [**postQuestionImportParse**](QuestionImportApi.md#postquestionimportparse) | **POST** /question-imports/parse | Parse a question document into stateless review drafts |
+
+
+
+## postQuestionImportCommit
+
+> PostQuestionImportCommitResponse postQuestionImportCommit(postQuestionImportCommit)
+
+Validate and atomically create, version, or skip approved question drafts
+
+### Example
+
+```ts
+import {
+  Configuration,
+  QuestionImportApi,
+} from '@easyedu/js-lsm-api';
+import type { PostQuestionImportCommitRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new QuestionImportApi();
+
+  const body = {
+    // PostQuestionImportCommit
+    postQuestionImportCommit: ...,
+  } satisfies PostQuestionImportCommitRequest;
+
+  try {
+    const data = await api.postQuestionImportCommit(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postQuestionImportCommit** | [PostQuestionImportCommit](PostQuestionImportCommit.md) |  | |
+
+### Return type
+
+[**PostQuestionImportCommitResponse**](PostQuestionImportCommitResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Approved question drafts committed |  -  |
+| **400** | Invalid draft, asset, or import token |  -  |
+| **409** | Import approval conflicts with current data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postQuestionImportParse
+
+> PostQuestionImportParseResponse postQuestionImportParse(file, sourceLabel)
+
+Parse a question document into stateless review drafts
+
+### Example
+
+```ts
+import {
+  Configuration,
+  QuestionImportApi,
+} from '@easyedu/js-lsm-api';
+import type { PostQuestionImportParseRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new QuestionImportApi();
+
+  const body = {
+    // Blob
+    file: BINARY_DATA_HERE,
+    // string | Optional source label override (optional)
+    sourceLabel: sourceLabel_example,
+  } satisfies PostQuestionImportParseRequest;
+
+  try {
+    const data = await api.postQuestionImportParse(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **file** | `Blob` |  | [Defaults to `undefined`] |
+| **sourceLabel** | `string` | Optional source label override | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PostQuestionImportParseResponse**](PostQuestionImportParseResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Document parsed into review drafts |  -  |
+| **400** | Invalid or unsupported document |  -  |
+| **413** | Document exceeds import limits |  -  |
+| **422** | No questions could be extracted |  -  |
+| **503** | Generic document interpretation is unavailable |  -  |
+
+[[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/QuestionImportCommitResult.md

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

@@ -0,0 +1,48 @@
+
+# QuestionImportDraft
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`draftId` | string
+`sourceKey` | string
+`sourceLocation` | string
+`question` | [PostQuestion](PostQuestion.md)
+`duplicate` | [QuestionImportDuplicate](QuestionImportDuplicate.md)
+`warnings` | Array<string>
+`confidence` | number
+`included` | boolean
+
+## Example
+
+```typescript
+import type { QuestionImportDraft } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "draftId": null,
+  "sourceKey": null,
+  "sourceLocation": null,
+  "question": null,
+  "duplicate": null,
+  "warnings": null,
+  "confidence": null,
+  "included": null,
+} satisfies QuestionImportDraft
+
+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 QuestionImportDraft
+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/QuestionImportDuplicate.md

@@ -0,0 +1,42 @@
+
+# QuestionImportDuplicate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | string
+`matchedQuestionId` | string
+`matchedDraftId` | string
+`matchedQuestionText` | string
+`similarity` | number
+
+## Example
+
+```typescript
+import type { QuestionImportDuplicate } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "matchedQuestionId": null,
+  "matchedDraftId": null,
+  "matchedQuestionText": null,
+  "similarity": null,
+} satisfies QuestionImportDuplicate
+
+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 QuestionImportDuplicate
+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/QuestionImportPreviewImage.md

@@ -0,0 +1,48 @@
+
+# QuestionImportPreviewImage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sourceId` | string
+`filename` | string
+`mimeType` | string
+`byteSize` | number
+`width` | number
+`height` | number
+`sha256` | string
+`dataBase64` | string
+
+## Example
+
+```typescript
+import type { QuestionImportPreviewImage } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sourceId": null,
+  "filename": null,
+  "mimeType": null,
+  "byteSize": null,
+  "width": null,
+  "height": null,
+  "sha256": null,
+  "dataBase64": null,
+} satisfies QuestionImportPreviewImage
+
+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 QuestionImportPreviewImage
+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/QuestionImportSource.md

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

@@ -0,0 +1,40 @@
+
+# QuestionImportSourceSummary
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`label` | string
+`originalFilename` | string
+`sourceKey` | string
+`importedAt` | Date
+
+## Example
+
+```typescript
+import type { QuestionImportSourceSummary } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "label": null,
+  "originalFilename": null,
+  "sourceKey": null,
+  "importedAt": null,
+} satisfies QuestionImportSourceSummary
+
+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 QuestionImportSourceSummary
+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.111.0",
+  "version": "1.113.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/QuestionApi.ts

@@ -50,6 +50,10 @@ export interface GetQuestionListRequest {
     search?: string;
 }
 
+export interface GetQuestionVersionsRequest {
+    questionId: string;
+}
+
 export interface PostQuestionRequest {
     postQuestion: PostQuestion;
 }
@@ -210,6 +214,51 @@ export class QuestionApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getQuestionVersions without sending the request
+     */
+    async getQuestionVersionsRequestOpts(requestParameters: GetQuestionVersionsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['questionId'] == null) {
+            throw new runtime.RequiredError(
+                'questionId',
+                'Required parameter "questionId" was null or undefined when calling getQuestionVersions().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/questions/{questionId}/versions`;
+        urlPath = urlPath.replace('{questionId}', encodeURIComponent(String(requestParameters['questionId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get all versions of a question
+     */
+    async getQuestionVersionsRaw(requestParameters: GetQuestionVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetQuestion>>> {
+        const requestOptions = await this.getQuestionVersionsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetQuestionFromJSON));
+    }
+
+    /**
+     * Get all versions of a question
+     */
+    async getQuestionVersions(requestParameters: GetQuestionVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetQuestion>> {
+        const response = await this.getQuestionVersionsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for postQuestion without sending the request
      */
@@ -295,7 +344,7 @@ export class QuestionApi extends runtime.BaseAPI {
     }
 
     /**
-     * Update a question by ID
+     * Create the next version of a question
      */
     async putQuestionRaw(requestParameters: PutQuestionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetQuestion>> {
         const requestOptions = await this.putQuestionRequestOpts(requestParameters);
@@ -305,7 +354,7 @@ export class QuestionApi extends runtime.BaseAPI {
     }
 
     /**
-     * Update a question by ID
+     * Create the next version of a question
      */
     async putQuestion(requestParameters: PutQuestionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetQuestion> {
         const response = await this.putQuestionRaw(requestParameters, initOverrides);