@easyedu/js-lsm-api 1.80.0 → 1.81.0

package/docs/RichTextDocument.md

@@ -0,0 +1,40 @@
+
+# RichTextDocument
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`format` | string
+`document` | { [key: string]: any; }
+`plainText` | string
+`assets` | [Array<RichTextAsset>](RichTextAsset.md)
+
+## Example
+
+```typescript
+import type { RichTextDocument } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "format": null,
+  "document": null,
+  "plainText": null,
+  "assets": null,
+} satisfies RichTextDocument
+
+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 RichTextDocument
+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/RichTextInput.md

@@ -0,0 +1,36 @@
+
+# RichTextInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`format` | string
+`document` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { RichTextInput } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "format": null,
+  "document": null,
+} satisfies RichTextInput
+
+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 RichTextInput
+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.80.0",
+  "version": "1.81.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/RichTextApi.ts

@@ -0,0 +1,201 @@
+/* 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 * as runtime from '../runtime';
+import {
+    type GetRichTextAssetUpload,
+    GetRichTextAssetUploadFromJSON,
+    GetRichTextAssetUploadToJSON,
+} from '../models/GetRichTextAssetUpload';
+import {
+    type PostRichTextAssetComplete,
+    PostRichTextAssetCompleteFromJSON,
+    PostRichTextAssetCompleteToJSON,
+} from '../models/PostRichTextAssetComplete';
+import {
+    type PostRichTextAssetUpload,
+    PostRichTextAssetUploadFromJSON,
+    PostRichTextAssetUploadToJSON,
+} from '../models/PostRichTextAssetUpload';
+import {
+    type RichTextAsset,
+    RichTextAssetFromJSON,
+    RichTextAssetToJSON,
+} from '../models/RichTextAsset';
+
+export interface GetRichTextAssetRequest {
+    assetId: string;
+}
+
+export interface PostRichTextAssetCompleteRequest {
+    assetId: string;
+    postRichTextAssetComplete: PostRichTextAssetComplete;
+}
+
+export interface PostRichTextAssetUploadRequest {
+    postRichTextAssetUpload: PostRichTextAssetUpload;
+}
+
+/**
+ * 
+ */
+export class RichTextApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for getRichTextAsset without sending the request
+     */
+    async getRichTextAssetRequestOpts(requestParameters: GetRichTextAssetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['assetId'] == null) {
+            throw new runtime.RequiredError(
+                'assetId',
+                'Required parameter "assetId" was null or undefined when calling getRichTextAsset().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/rich-text/assets/{assetId}`;
+        urlPath = urlPath.replace('{assetId}', encodeURIComponent(String(requestParameters['assetId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Redirect to a signed rich text asset URL
+     */
+    async getRichTextAssetRaw(requestParameters: GetRichTextAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.getRichTextAssetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Redirect to a signed rich text asset URL
+     */
+    async getRichTextAsset(requestParameters: GetRichTextAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getRichTextAssetRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for postRichTextAssetComplete without sending the request
+     */
+    async postRichTextAssetCompleteRequestOpts(requestParameters: PostRichTextAssetCompleteRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['assetId'] == null) {
+            throw new runtime.RequiredError(
+                'assetId',
+                'Required parameter "assetId" was null or undefined when calling postRichTextAssetComplete().'
+            );
+        }
+
+        if (requestParameters['postRichTextAssetComplete'] == null) {
+            throw new runtime.RequiredError(
+                'postRichTextAssetComplete',
+                'Required parameter "postRichTextAssetComplete" was null or undefined when calling postRichTextAssetComplete().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/rich-text/assets/{assetId}/complete`;
+        urlPath = urlPath.replace('{assetId}', encodeURIComponent(String(requestParameters['assetId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostRichTextAssetCompleteToJSON(requestParameters['postRichTextAssetComplete']),
+        };
+    }
+
+    /**
+     * Complete a pending rich text asset upload
+     */
+    async postRichTextAssetCompleteRaw(requestParameters: PostRichTextAssetCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RichTextAsset>> {
+        const requestOptions = await this.postRichTextAssetCompleteRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RichTextAssetFromJSON(jsonValue));
+    }
+
+    /**
+     * Complete a pending rich text asset upload
+     */
+    async postRichTextAssetComplete(requestParameters: PostRichTextAssetCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RichTextAsset> {
+        const response = await this.postRichTextAssetCompleteRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postRichTextAssetUpload without sending the request
+     */
+    async postRichTextAssetUploadRequestOpts(requestParameters: PostRichTextAssetUploadRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['postRichTextAssetUpload'] == null) {
+            throw new runtime.RequiredError(
+                'postRichTextAssetUpload',
+                'Required parameter "postRichTextAssetUpload" was null or undefined when calling postRichTextAssetUpload().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/rich-text/assets/uploads`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostRichTextAssetUploadToJSON(requestParameters['postRichTextAssetUpload']),
+        };
+    }
+
+    /**
+     * Create a pending rich text asset upload
+     */
+    async postRichTextAssetUploadRaw(requestParameters: PostRichTextAssetUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetRichTextAssetUpload>> {
+        const requestOptions = await this.postRichTextAssetUploadRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetRichTextAssetUploadFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a pending rich text asset upload
+     */
+    async postRichTextAssetUpload(requestParameters: PostRichTextAssetUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRichTextAssetUpload> {
+        const response = await this.postRichTextAssetUploadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -15,6 +15,7 @@ export * from './PortalSublicenseApi';
 export * from './QuestionApi';
 export * from './QuizApi';
 export * from './ReportingApi';
+export * from './RichTextApi';
 export * from './RoleApi';
 export * from './SupportTicketApi';
 export * from './SystemApi';

package/src/models/GetQuestion.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { RichTextDocument } from './RichTextDocument';
+import {
+    RichTextDocumentFromJSON,
+    RichTextDocumentFromJSONTyped,
+    RichTextDocumentToJSON,
+    RichTextDocumentToJSONTyped,
+} from './RichTextDocument';
 import type { GetQuestionAnswerChoicesInner } from './GetQuestionAnswerChoicesInner';
 import {
     GetQuestionAnswerChoicesInnerFromJSON,
@@ -41,11 +48,11 @@ export interface GetQuestion {
      */
     readonly id: string;
     /**
-     * The main question text or prompt
-     * @type {string}
+     * 
+     * @type {RichTextDocument}
      * @memberof GetQuestion
      */
-    questionText: string;
+    questionText: RichTextDocument;
     /**
      * Type of question
      * @type {GetQuestionQuestionTypeEnum}
@@ -65,11 +72,11 @@ export interface GetQuestion {
      */
     correctAnswer?: string;
     /**
-     * Explanation of the correct answer
-     * @type {string}
+     * 
+     * @type {RichTextDocument}
      * @memberof GetQuestion
      */
-    explanation?: string;
+    explanation?: RichTextDocument;
     /**
      * Topic category (Fire Alarm, Fire Pump, Fire Sprinkler, etc.)
      * @type {string}
@@ -176,11 +183,11 @@ export function GetQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolean
     return {
         
         'id': json['id'],
-        'questionText': json['question_text'],
+        'questionText': RichTextDocumentFromJSON(json['question_text']),
         'questionType': json['question_type'],
         'answerChoices': json['answer_choices'] == null ? undefined : ((json['answer_choices'] as Array<any>).map(GetQuestionAnswerChoicesInnerFromJSON)),
         'correctAnswer': json['correct_answer'] == null ? undefined : json['correct_answer'],
-        'explanation': json['explanation'] == null ? undefined : json['explanation'],
+        'explanation': json['explanation'] == null ? undefined : RichTextDocumentFromJSON(json['explanation']),
         'topic': json['topic'],
         'difficultyLevel': json['difficulty_level'],
         'tags': json['tags'] == null ? undefined : json['tags'],
@@ -204,11 +211,11 @@ export function GetQuestionToJSONTyped(value?: Omit<GetQuestion, 'id'|'created_d
 
     return {
         
-        'question_text': value['questionText'],
+        'question_text': RichTextDocumentToJSON(value['questionText']),
         'question_type': value['questionType'],
         'answer_choices': value['answerChoices'] == null ? undefined : ((value['answerChoices'] as Array<any>).map(GetQuestionAnswerChoicesInnerToJSON)),
         'correct_answer': value['correctAnswer'],
-        'explanation': value['explanation'],
+        'explanation': RichTextDocumentToJSON(value['explanation']),
         'topic': value['topic'],
         'difficulty_level': value['difficultyLevel'],
         'tags': value['tags'],

package/src/models/GetQuestionAnswerChoicesInner.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { RichTextDocument } from './RichTextDocument';
+import {
+    RichTextDocumentFromJSON,
+    RichTextDocumentFromJSONTyped,
+    RichTextDocumentToJSON,
+    RichTextDocumentToJSONTyped,
+} from './RichTextDocument';
+
 /**
  * 
  * @export
@@ -27,10 +35,10 @@ export interface GetQuestionAnswerChoicesInner {
     id: string;
     /**
      * 
-     * @type {string}
+     * @type {RichTextDocument}
      * @memberof GetQuestionAnswerChoicesInner
      */
-    text: string;
+    text: RichTextDocument;
     /**
      * 
      * @type {boolean}
@@ -60,7 +68,7 @@ export function GetQuestionAnswerChoicesInnerFromJSONTyped(json: any, ignoreDisc
     return {
         
         'id': json['id'],
-        'text': json['text'],
+        'text': RichTextDocumentFromJSON(json['text']),
         'isCorrect': json['is_correct'],
     };
 }
@@ -77,7 +85,7 @@ export function GetQuestionAnswerChoicesInnerToJSONTyped(value?: GetQuestionAnsw
     return {
         
         'id': value['id'],
-        'text': value['text'],
+        'text': RichTextDocumentToJSON(value['text']),
         'is_correct': value['isCorrect'],
     };
 }

package/src/models/GetRichTextAssetUpload.ts

@@ -0,0 +1,93 @@
+/* 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 GetRichTextAssetUpload
+ */
+export interface GetRichTextAssetUpload {
+    /**
+     * Created pending asset ID
+     * @type {string}
+     * @memberof GetRichTextAssetUpload
+     */
+    assetId: string;
+    /**
+     * Presigned URL for direct upload
+     * @type {string}
+     * @memberof GetRichTextAssetUpload
+     */
+    uploadUrl: string;
+    /**
+     * Authenticated API URL that redirects to a signed asset URL once completed
+     * @type {string}
+     * @memberof GetRichTextAssetUpload
+     */
+    renderUrl: string;
+    /**
+     * Upload URL lifetime
+     * @type {number}
+     * @memberof GetRichTextAssetUpload
+     */
+    expiresInSeconds: number;
+}
+
+/**
+ * Check if a given object implements the GetRichTextAssetUpload interface.
+ */
+export function instanceOfGetRichTextAssetUpload(value: object): value is GetRichTextAssetUpload {
+    if (!('assetId' in value) || value['assetId'] === undefined) return false;
+    if (!('uploadUrl' in value) || value['uploadUrl'] === undefined) return false;
+    if (!('renderUrl' in value) || value['renderUrl'] === undefined) return false;
+    if (!('expiresInSeconds' in value) || value['expiresInSeconds'] === undefined) return false;
+    return true;
+}
+
+export function GetRichTextAssetUploadFromJSON(json: any): GetRichTextAssetUpload {
+    return GetRichTextAssetUploadFromJSONTyped(json, false);
+}
+
+export function GetRichTextAssetUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetRichTextAssetUpload {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'assetId': json['asset_id'],
+        'uploadUrl': json['upload_url'],
+        'renderUrl': json['render_url'],
+        'expiresInSeconds': json['expires_in_seconds'],
+    };
+}
+
+export function GetRichTextAssetUploadToJSON(json: any): GetRichTextAssetUpload {
+    return GetRichTextAssetUploadToJSONTyped(json, false);
+}
+
+export function GetRichTextAssetUploadToJSONTyped(value?: GetRichTextAssetUpload | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'asset_id': value['assetId'],
+        'upload_url': value['uploadUrl'],
+        'render_url': value['renderUrl'],
+        'expires_in_seconds': value['expiresInSeconds'],
+    };
+}
+

package/src/models/PostQuestion.ts

@@ -20,6 +20,13 @@ import {
     PostQuestionAnswerChoicesInnerToJSON,
     PostQuestionAnswerChoicesInnerToJSONTyped,
 } from './PostQuestionAnswerChoicesInner';
+import type { RichTextInput } from './RichTextInput';
+import {
+    RichTextInputFromJSON,
+    RichTextInputFromJSONTyped,
+    RichTextInputToJSON,
+    RichTextInputToJSONTyped,
+} from './RichTextInput';
 
 /**
  * 
@@ -28,11 +35,11 @@ import {
  */
 export interface PostQuestion {
     /**
-     * The main question text or prompt
-     * @type {string}
+     * 
+     * @type {RichTextInput}
      * @memberof PostQuestion
      */
-    questionText: string;
+    questionText: RichTextInput;
     /**
      * Type of question
      * @type {PostQuestionQuestionTypeEnum}
@@ -52,11 +59,11 @@ export interface PostQuestion {
      */
     correctAnswer?: string;
     /**
-     * Explanation of the correct answer
-     * @type {string}
+     * 
+     * @type {RichTextInput}
      * @memberof PostQuestion
      */
-    explanation?: string;
+    explanation?: RichTextInput;
     /**
      * Topic category (Fire Alarm, Fire Pump, Fire Sprinkler, etc.)
      * @type {string}
@@ -129,11 +136,11 @@ export function PostQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolea
     }
     return {
         
-        'questionText': json['question_text'],
+        'questionText': RichTextInputFromJSON(json['question_text']),
         'questionType': json['question_type'],
         'answerChoices': json['answer_choices'] == null ? undefined : ((json['answer_choices'] as Array<any>).map(PostQuestionAnswerChoicesInnerFromJSON)),
         'correctAnswer': json['correct_answer'] == null ? undefined : json['correct_answer'],
-        'explanation': json['explanation'] == null ? undefined : json['explanation'],
+        'explanation': json['explanation'] == null ? undefined : RichTextInputFromJSON(json['explanation']),
         'topic': json['topic'],
         'difficultyLevel': json['difficulty_level'],
         'tags': json['tags'] == null ? undefined : json['tags'],
@@ -152,11 +159,11 @@ export function PostQuestionToJSONTyped(value?: PostQuestion | null, ignoreDiscr
 
     return {
         
-        'question_text': value['questionText'],
+        'question_text': RichTextInputToJSON(value['questionText']),
         'question_type': value['questionType'],
         'answer_choices': value['answerChoices'] == null ? undefined : ((value['answerChoices'] as Array<any>).map(PostQuestionAnswerChoicesInnerToJSON)),
         'correct_answer': value['correctAnswer'],
-        'explanation': value['explanation'],
+        'explanation': RichTextInputToJSON(value['explanation']),
         'topic': value['topic'],
         'difficulty_level': value['difficultyLevel'],
         'tags': value['tags'],

package/src/models/PostQuestionAnswerChoicesInner.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { RichTextInput } from './RichTextInput';
+import {
+    RichTextInputFromJSON,
+    RichTextInputFromJSONTyped,
+    RichTextInputToJSON,
+    RichTextInputToJSONTyped,
+} from './RichTextInput';
+
 /**
  * 
  * @export
@@ -21,10 +29,10 @@ import { mapValues } from '../runtime';
 export interface PostQuestionAnswerChoicesInner {
     /**
      * 
-     * @type {string}
+     * @type {RichTextInput}
      * @memberof PostQuestionAnswerChoicesInner
      */
-    text: string;
+    text: RichTextInput;
     /**
      * 
      * @type {boolean}
@@ -52,7 +60,7 @@ export function PostQuestionAnswerChoicesInnerFromJSONTyped(json: any, ignoreDis
     }
     return {
         
-        'text': json['text'],
+        'text': RichTextInputFromJSON(json['text']),
         'isCorrect': json['is_correct'],
     };
 }
@@ -68,7 +76,7 @@ export function PostQuestionAnswerChoicesInnerToJSONTyped(value?: PostQuestionAn
 
     return {
         
-        'text': value['text'],
+        'text': RichTextInputToJSON(value['text']),
         'is_correct': value['isCorrect'],
     };
 }