@easyedu/js-lsm-api 1.80.0 → 1.81.0

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

package/src/models/RichTextAsset.ts

@@ -0,0 +1,109 @@
+/* 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 RichTextAsset
+ */
+export interface RichTextAsset {
+    /**
+     * Rich text asset external identifier
+     * @type {string}
+     * @memberof RichTextAsset
+     */
+    id: string;
+    /**
+     * Asset MIME type
+     * @type {string}
+     * @memberof RichTextAsset
+     */
+    mimeType: string;
+    /**
+     * Uploaded asset size in bytes
+     * @type {number}
+     * @memberof RichTextAsset
+     */
+    byteSize: number;
+    /**
+     * Image width in pixels
+     * @type {number}
+     * @memberof RichTextAsset
+     */
+    width?: number;
+    /**
+     * Image height in pixels
+     * @type {number}
+     * @memberof RichTextAsset
+     */
+    height?: number;
+    /**
+     * Authenticated API URL that redirects to a signed asset URL
+     * @type {string}
+     * @memberof RichTextAsset
+     */
+    renderUrl: string;
+}
+
+/**
+ * Check if a given object implements the RichTextAsset interface.
+ */
+export function instanceOfRichTextAsset(value: object): value is RichTextAsset {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('mimeType' in value) || value['mimeType'] === undefined) return false;
+    if (!('byteSize' in value) || value['byteSize'] === undefined) return false;
+    if (!('renderUrl' in value) || value['renderUrl'] === undefined) return false;
+    return true;
+}
+
+export function RichTextAssetFromJSON(json: any): RichTextAsset {
+    return RichTextAssetFromJSONTyped(json, false);
+}
+
+export function RichTextAssetFromJSONTyped(json: any, ignoreDiscriminator: boolean): RichTextAsset {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'mimeType': json['mime_type'],
+        'byteSize': json['byte_size'],
+        'width': json['width'] == null ? undefined : json['width'],
+        'height': json['height'] == null ? undefined : json['height'],
+        'renderUrl': json['render_url'],
+    };
+}
+
+export function RichTextAssetToJSON(json: any): RichTextAsset {
+    return RichTextAssetToJSONTyped(json, false);
+}
+
+export function RichTextAssetToJSONTyped(value?: RichTextAsset | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'mime_type': value['mimeType'],
+        'byte_size': value['byteSize'],
+        'width': value['width'],
+        'height': value['height'],
+        'render_url': value['renderUrl'],
+    };
+}
+

package/src/models/RichTextDocument.ts

@@ -0,0 +1,111 @@
+/* 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';
+import type { RichTextAsset } from './RichTextAsset';
+import {
+    RichTextAssetFromJSON,
+    RichTextAssetFromJSONTyped,
+    RichTextAssetToJSON,
+    RichTextAssetToJSONTyped,
+} from './RichTextAsset';
+
+/**
+ * 
+ * @export
+ * @interface RichTextDocument
+ */
+export interface RichTextDocument {
+    /**
+     * Rich text document format
+     * @type {RichTextDocumentFormatEnum}
+     * @memberof RichTextDocument
+     */
+    format: RichTextDocumentFormatEnum;
+    /**
+     * TipTap/ProseMirror JSON document
+     * @type {{ [key: string]: any; }}
+     * @memberof RichTextDocument
+     */
+    document: { [key: string]: any; };
+    /**
+     * Server-derived plain text for search and previews
+     * @type {string}
+     * @memberof RichTextDocument
+     */
+    plainText: string;
+    /**
+     * Assets referenced by the document
+     * @type {Array<RichTextAsset>}
+     * @memberof RichTextDocument
+     */
+    assets: Array<RichTextAsset>;
+}
+
+
+/**
+ * @export
+ */
+export const RichTextDocumentFormatEnum = {
+    TiptapV2: 'tiptap-v2'
+} as const;
+export type RichTextDocumentFormatEnum = typeof RichTextDocumentFormatEnum[keyof typeof RichTextDocumentFormatEnum];
+
+
+/**
+ * Check if a given object implements the RichTextDocument interface.
+ */
+export function instanceOfRichTextDocument(value: object): value is RichTextDocument {
+    if (!('format' in value) || value['format'] === undefined) return false;
+    if (!('document' in value) || value['document'] === undefined) return false;
+    if (!('plainText' in value) || value['plainText'] === undefined) return false;
+    if (!('assets' in value) || value['assets'] === undefined) return false;
+    return true;
+}
+
+export function RichTextDocumentFromJSON(json: any): RichTextDocument {
+    return RichTextDocumentFromJSONTyped(json, false);
+}
+
+export function RichTextDocumentFromJSONTyped(json: any, ignoreDiscriminator: boolean): RichTextDocument {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'format': json['format'],
+        'document': json['document'],
+        'plainText': json['plain_text'],
+        'assets': ((json['assets'] as Array<any>).map(RichTextAssetFromJSON)),
+    };
+}
+
+export function RichTextDocumentToJSON(json: any): RichTextDocument {
+    return RichTextDocumentToJSONTyped(json, false);
+}
+
+export function RichTextDocumentToJSONTyped(value?: RichTextDocument | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'format': value['format'],
+        'document': value['document'],
+        'plain_text': value['plainText'],
+        'assets': ((value['assets'] as Array<any>).map(RichTextAssetToJSON)),
+    };
+}
+

package/src/models/RichTextInput.ts

@@ -0,0 +1,85 @@
+/* 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 RichTextInput
+ */
+export interface RichTextInput {
+    /**
+     * Rich text document format
+     * @type {RichTextInputFormatEnum}
+     * @memberof RichTextInput
+     */
+    format: RichTextInputFormatEnum;
+    /**
+     * TipTap/ProseMirror JSON document
+     * @type {{ [key: string]: any; }}
+     * @memberof RichTextInput
+     */
+    document: { [key: string]: any; };
+}
+
+
+/**
+ * @export
+ */
+export const RichTextInputFormatEnum = {
+    TiptapV2: 'tiptap-v2'
+} as const;
+export type RichTextInputFormatEnum = typeof RichTextInputFormatEnum[keyof typeof RichTextInputFormatEnum];
+
+
+/**
+ * Check if a given object implements the RichTextInput interface.
+ */
+export function instanceOfRichTextInput(value: object): value is RichTextInput {
+    if (!('format' in value) || value['format'] === undefined) return false;
+    if (!('document' in value) || value['document'] === undefined) return false;
+    return true;
+}
+
+export function RichTextInputFromJSON(json: any): RichTextInput {
+    return RichTextInputFromJSONTyped(json, false);
+}
+
+export function RichTextInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): RichTextInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'format': json['format'],
+        'document': json['document'],
+    };
+}
+
+export function RichTextInputToJSON(json: any): RichTextInput {
+    return RichTextInputToJSONTyped(json, false);
+}
+
+export function RichTextInputToJSONTyped(value?: RichTextInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'format': value['format'],
+        'document': value['document'],
+    };
+}
+

package/src/models/index.ts

@@ -139,6 +139,7 @@ export * from './GetQuizResultsQuestionsInnerStudentAnswer';
 export * from './GetQuizResultsScore';
 export * from './GetQuizResultsTiming';
 export * from './GetQuizStatistics';
+export * from './GetRichTextAssetUpload';
 export * from './GetRole';
 export * from './GetScormApiLogItem';
 export * from './GetScormApiLogs';
@@ -236,6 +237,8 @@ export * from './PostQuizQuestionsQuestionsInner';
 export * from './PostQuizSettings';
 export * from './PostResetPassword';
 export * from './PostRevokeCertificate';
+export * from './PostRichTextAssetComplete';
+export * from './PostRichTextAssetUpload';
 export * from './PostRole';
 export * from './PostSendResetPassword';
 export * from './PostSignupRequest';
@@ -272,6 +275,9 @@ export * from './PutUser';
 export * from './QuizContent';
 export * from './QuizContentAssignment';
 export * from './QuizContentSettings';
+export * from './RichTextAsset';
+export * from './RichTextDocument';
+export * from './RichTextInput';
 export * from './SCORMContent';
 export * from './ScormGetValueResponse';
 export * from './ScormSessionData';