@easyedu/js-lsm-api 1.80.0 → 1.82.0

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'],
     };
 }

package/src/models/PostRichTextAssetComplete.ts

@@ -0,0 +1,82 @@
+/* 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 PostRichTextAssetComplete
+ */
+export interface PostRichTextAssetComplete {
+    /**
+     * Uploaded size confirmed by the client
+     * @type {number}
+     * @memberof PostRichTextAssetComplete
+     */
+    byteSize: number;
+    /**
+     * Image width in pixels
+     * @type {number}
+     * @memberof PostRichTextAssetComplete
+     */
+    width?: number;
+    /**
+     * Image height in pixels
+     * @type {number}
+     * @memberof PostRichTextAssetComplete
+     */
+    height?: number;
+}
+
+/**
+ * Check if a given object implements the PostRichTextAssetComplete interface.
+ */
+export function instanceOfPostRichTextAssetComplete(value: object): value is PostRichTextAssetComplete {
+    if (!('byteSize' in value) || value['byteSize'] === undefined) return false;
+    return true;
+}
+
+export function PostRichTextAssetCompleteFromJSON(json: any): PostRichTextAssetComplete {
+    return PostRichTextAssetCompleteFromJSONTyped(json, false);
+}
+
+export function PostRichTextAssetCompleteFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostRichTextAssetComplete {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'byteSize': json['byte_size'],
+        'width': json['width'] == null ? undefined : json['width'],
+        'height': json['height'] == null ? undefined : json['height'],
+    };
+}
+
+export function PostRichTextAssetCompleteToJSON(json: any): PostRichTextAssetComplete {
+    return PostRichTextAssetCompleteToJSONTyped(json, false);
+}
+
+export function PostRichTextAssetCompleteToJSONTyped(value?: PostRichTextAssetComplete | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'byte_size': value['byteSize'],
+        'width': value['width'],
+        'height': value['height'],
+    };
+}
+

package/src/models/PostRichTextAssetUpload.ts

@@ -0,0 +1,119 @@
+/* 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 PostRichTextAssetUpload
+ */
+export interface PostRichTextAssetUpload {
+    /**
+     * Original file name
+     * @type {string}
+     * @memberof PostRichTextAssetUpload
+     */
+    filename: string;
+    /**
+     * Expected MIME type
+     * @type {string}
+     * @memberof PostRichTextAssetUpload
+     */
+    mimeType: string;
+    /**
+     * Expected upload size in bytes
+     * @type {number}
+     * @memberof PostRichTextAssetUpload
+     */
+    byteSize: number;
+    /**
+     * Image width in pixels
+     * @type {number}
+     * @memberof PostRichTextAssetUpload
+     */
+    width?: number;
+    /**
+     * Image height in pixels
+     * @type {number}
+     * @memberof PostRichTextAssetUpload
+     */
+    height?: number;
+    /**
+     * Asset access policy context
+     * @type {PostRichTextAssetUploadUsageContextEnum}
+     * @memberof PostRichTextAssetUpload
+     */
+    usageContext: PostRichTextAssetUploadUsageContextEnum;
+}
+
+
+/**
+ * @export
+ */
+export const PostRichTextAssetUploadUsageContextEnum = {
+    LearningContent: 'learning_content'
+} as const;
+export type PostRichTextAssetUploadUsageContextEnum = typeof PostRichTextAssetUploadUsageContextEnum[keyof typeof PostRichTextAssetUploadUsageContextEnum];
+
+
+/**
+ * Check if a given object implements the PostRichTextAssetUpload interface.
+ */
+export function instanceOfPostRichTextAssetUpload(value: object): value is PostRichTextAssetUpload {
+    if (!('filename' in value) || value['filename'] === undefined) return false;
+    if (!('mimeType' in value) || value['mimeType'] === undefined) return false;
+    if (!('byteSize' in value) || value['byteSize'] === undefined) return false;
+    if (!('usageContext' in value) || value['usageContext'] === undefined) return false;
+    return true;
+}
+
+export function PostRichTextAssetUploadFromJSON(json: any): PostRichTextAssetUpload {
+    return PostRichTextAssetUploadFromJSONTyped(json, false);
+}
+
+export function PostRichTextAssetUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostRichTextAssetUpload {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'filename': json['filename'],
+        'mimeType': json['mime_type'],
+        'byteSize': json['byte_size'],
+        'width': json['width'] == null ? undefined : json['width'],
+        'height': json['height'] == null ? undefined : json['height'],
+        'usageContext': json['usage_context'],
+    };
+}
+
+export function PostRichTextAssetUploadToJSON(json: any): PostRichTextAssetUpload {
+    return PostRichTextAssetUploadToJSONTyped(json, false);
+}
+
+export function PostRichTextAssetUploadToJSONTyped(value?: PostRichTextAssetUpload | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'filename': value['filename'],
+        'mime_type': value['mimeType'],
+        'byte_size': value['byteSize'],
+        'width': value['width'],
+        'height': value['height'],
+        'usage_context': value['usageContext'],
+    };
+}
+

package/src/models/PutQuestion.ts

@@ -20,6 +20,13 @@ import {
     PutQuestionAnswerChoicesInnerToJSON,
     PutQuestionAnswerChoicesInnerToJSONTyped,
 } from './PutQuestionAnswerChoicesInner';
+import type { RichTextInput } from './RichTextInput';
+import {
+    RichTextInputFromJSON,
+    RichTextInputFromJSONTyped,
+    RichTextInputToJSON,
+    RichTextInputToJSONTyped,
+} from './RichTextInput';
 
 /**
  * 
@@ -28,11 +35,11 @@ import {
  */
 export interface PutQuestion {
     /**
-     * The main question text or prompt
-     * @type {string}
+     * 
+     * @type {RichTextInput}
      * @memberof PutQuestion
      */
-    questionText?: string;
+    questionText?: RichTextInput;
     /**
      * Type of question
      * @type {PutQuestionQuestionTypeEnum}
@@ -52,11 +59,11 @@ export interface PutQuestion {
      */
     correctAnswer?: string;
     /**
-     * Explanation of the correct answer
-     * @type {string}
+     * 
+     * @type {RichTextInput}
      * @memberof PutQuestion
      */
-    explanation?: string;
+    explanation?: RichTextInput;
     /**
      * Topic category (Fire Alarm, Fire Pump, Fire Sprinkler, etc.)
      * @type {string}
@@ -125,11 +132,11 @@ export function PutQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolean
     }
     return {
         
-        'questionText': json['question_text'] == null ? undefined : json['question_text'],
+        'questionText': json['question_text'] == null ? undefined : RichTextInputFromJSON(json['question_text']),
         'questionType': json['question_type'] == null ? undefined : json['question_type'],
         'answerChoices': json['answer_choices'] == null ? undefined : ((json['answer_choices'] as Array<any>).map(PutQuestionAnswerChoicesInnerFromJSON)),
         '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'] == null ? undefined : json['topic'],
         'difficultyLevel': json['difficulty_level'] == null ? undefined : json['difficulty_level'],
         'tags': json['tags'] == null ? undefined : json['tags'],
@@ -148,11 +155,11 @@ export function PutQuestionToJSONTyped(value?: PutQuestion | null, ignoreDiscrim
 
     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(PutQuestionAnswerChoicesInnerToJSON)),
         'correct_answer': value['correctAnswer'],
-        'explanation': value['explanation'],
+        'explanation': RichTextInputToJSON(value['explanation']),
         'topic': value['topic'],
         'difficulty_level': value['difficultyLevel'],
         'tags': value['tags'],

package/src/models/PutQuestionAnswerChoicesInner.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { RichTextInput } from './RichTextInput';
+import {
+    RichTextInputFromJSON,
+    RichTextInputFromJSONTyped,
+    RichTextInputToJSON,
+    RichTextInputToJSONTyped,
+} from './RichTextInput';
+
 /**
  * 
  * @export
@@ -27,10 +35,10 @@ export interface PutQuestionAnswerChoicesInner {
     id?: string;
     /**
      * 
-     * @type {string}
+     * @type {RichTextInput}
      * @memberof PutQuestionAnswerChoicesInner
      */
-    text: string;
+    text: RichTextInput;
     /**
      * 
      * @type {boolean}
@@ -59,7 +67,7 @@ export function PutQuestionAnswerChoicesInnerFromJSONTyped(json: any, ignoreDisc
     return {
         
         'id': json['id'] == null ? undefined : json['id'],
-        'text': json['text'],
+        'text': RichTextInputFromJSON(json['text']),
         'isCorrect': json['is_correct'],
     };
 }
@@ -76,7 +84,7 @@ export function PutQuestionAnswerChoicesInnerToJSONTyped(value?: PutQuestionAnsw
     return {
         
         'id': value['id'],
-        'text': value['text'],
+        'text': RichTextInputToJSON(value['text']),
         'is_correct': value['isCorrect'],
     };
 }