@easyedu/js-lsm-api 1.80.0 → 1.82.0

package/dist/esm/models/PostRichTextAssetUpload.d.ts

@@ -0,0 +1,69 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare const PostRichTextAssetUploadUsageContextEnum: {
+    readonly LearningContent: "learning_content";
+};
+export type PostRichTextAssetUploadUsageContextEnum = typeof PostRichTextAssetUploadUsageContextEnum[keyof typeof PostRichTextAssetUploadUsageContextEnum];
+/**
+ * Check if a given object implements the PostRichTextAssetUpload interface.
+ */
+export declare function instanceOfPostRichTextAssetUpload(value: object): value is PostRichTextAssetUpload;
+export declare function PostRichTextAssetUploadFromJSON(json: any): PostRichTextAssetUpload;
+export declare function PostRichTextAssetUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostRichTextAssetUpload;
+export declare function PostRichTextAssetUploadToJSON(json: any): PostRichTextAssetUpload;
+export declare function PostRichTextAssetUploadToJSONTyped(value?: PostRichTextAssetUpload | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostRichTextAssetUpload.js

@@ -0,0 +1,65 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const PostRichTextAssetUploadUsageContextEnum = {
+    LearningContent: 'learning_content'
+};
+/**
+ * Check if a given object implements the PostRichTextAssetUpload interface.
+ */
+export function instanceOfPostRichTextAssetUpload(value) {
+    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) {
+    return PostRichTextAssetUploadFromJSONTyped(json, false);
+}
+export function PostRichTextAssetUploadFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return PostRichTextAssetUploadToJSONTyped(json, false);
+}
+export function PostRichTextAssetUploadToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/PutQuestion.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { PutQuestionAnswerChoicesInner } from './PutQuestionAnswerChoicesInner';
+import type { RichTextInput } from './RichTextInput';
 /**
  *
  * @export
@@ -17,11 +18,11 @@ import type { PutQuestionAnswerChoicesInner } from './PutQuestionAnswerChoicesIn
  */
 export interface PutQuestion {
     /**
-     * The main question text or prompt
-     * @type {string}
+     *
+     * @type {RichTextInput}
      * @memberof PutQuestion
      */
-    questionText?: string;
+    questionText?: RichTextInput;
     /**
      * Type of question
      * @type {PutQuestionQuestionTypeEnum}
@@ -41,11 +42,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}

package/dist/esm/models/PutQuestion.js

@@ -12,6 +12,7 @@
  * Do not edit the class manually.
  */
 import { PutQuestionAnswerChoicesInnerFromJSON, PutQuestionAnswerChoicesInnerToJSON, } from './PutQuestionAnswerChoicesInner';
+import { RichTextInputFromJSON, RichTextInputToJSON, } from './RichTextInput';
 /**
  * @export
  */
@@ -45,11 +46,11 @@ export function PutQuestionFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     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'].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'],
@@ -64,11 +65,11 @@ export function PutQuestionToJSONTyped(value, ignoreDiscriminator = false) {
         return value;
     }
     return {
-        'question_text': value['questionText'],
+        'question_text': RichTextInputToJSON(value['questionText']),
         'question_type': value['questionType'],
         'answer_choices': value['answerChoices'] == null ? undefined : (value['answerChoices'].map(PutQuestionAnswerChoicesInnerToJSON)),
         'correct_answer': value['correctAnswer'],
-        'explanation': value['explanation'],
+        'explanation': RichTextInputToJSON(value['explanation']),
         'topic': value['topic'],
         'difficulty_level': value['difficultyLevel'],
         'tags': value['tags'],

package/dist/esm/models/PutQuestionAnswerChoicesInner.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { RichTextInput } from './RichTextInput';
 /**
  *
  * @export
@@ -23,10 +24,10 @@ export interface PutQuestionAnswerChoicesInner {
     id?: string;
     /**
      *
-     * @type {string}
+     * @type {RichTextInput}
      * @memberof PutQuestionAnswerChoicesInner
      */
-    text: string;
+    text: RichTextInput;
     /**
      *
      * @type {boolean}

package/dist/esm/models/PutQuestionAnswerChoicesInner.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { RichTextInputFromJSON, RichTextInputToJSON, } from './RichTextInput';
 /**
  * Check if a given object implements the PutQuestionAnswerChoicesInner interface.
  */
@@ -30,7 +31,7 @@ export function PutQuestionAnswerChoicesInnerFromJSONTyped(json, ignoreDiscrimin
     }
     return {
         'id': json['id'] == null ? undefined : json['id'],
-        'text': json['text'],
+        'text': RichTextInputFromJSON(json['text']),
         'isCorrect': json['is_correct'],
     };
 }
@@ -43,7 +44,7 @@ export function PutQuestionAnswerChoicesInnerToJSONTyped(value, ignoreDiscrimina
     }
     return {
         'id': value['id'],
-        'text': value['text'],
+        'text': RichTextInputToJSON(value['text']),
         'is_correct': value['isCorrect'],
     };
 }

package/dist/esm/models/RichTextAsset.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare function instanceOfRichTextAsset(value: object): value is RichTextAsset;
+export declare function RichTextAssetFromJSON(json: any): RichTextAsset;
+export declare function RichTextAssetFromJSONTyped(json: any, ignoreDiscriminator: boolean): RichTextAsset;
+export declare function RichTextAssetToJSON(json: any): RichTextAsset;
+export declare function RichTextAssetToJSONTyped(value?: RichTextAsset | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/RichTextAsset.js

@@ -0,0 +1,59 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the RichTextAsset interface.
+ */
+export function instanceOfRichTextAsset(value) {
+    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) {
+    return RichTextAssetFromJSONTyped(json, false);
+}
+export function RichTextAssetFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return RichTextAssetToJSONTyped(json, false);
+}
+export function RichTextAssetToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/RichTextDocument.d.ts

@@ -0,0 +1,60 @@
+/**
+ * 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 type { RichTextAsset } 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 declare const RichTextDocumentFormatEnum: {
+    readonly TiptapV2: "tiptap-v2";
+};
+export type RichTextDocumentFormatEnum = typeof RichTextDocumentFormatEnum[keyof typeof RichTextDocumentFormatEnum];
+/**
+ * Check if a given object implements the RichTextDocument interface.
+ */
+export declare function instanceOfRichTextDocument(value: object): value is RichTextDocument;
+export declare function RichTextDocumentFromJSON(json: any): RichTextDocument;
+export declare function RichTextDocumentFromJSONTyped(json: any, ignoreDiscriminator: boolean): RichTextDocument;
+export declare function RichTextDocumentToJSON(json: any): RichTextDocument;
+export declare function RichTextDocumentToJSONTyped(value?: RichTextDocument | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/RichTextDocument.js

@@ -0,0 +1,62 @@
+/* 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 { RichTextAssetFromJSON, RichTextAssetToJSON, } from './RichTextAsset';
+/**
+ * @export
+ */
+export const RichTextDocumentFormatEnum = {
+    TiptapV2: 'tiptap-v2'
+};
+/**
+ * Check if a given object implements the RichTextDocument interface.
+ */
+export function instanceOfRichTextDocument(value) {
+    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) {
+    return RichTextDocumentFromJSONTyped(json, false);
+}
+export function RichTextDocumentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'format': json['format'],
+        'document': json['document'],
+        'plainText': json['plain_text'],
+        'assets': (json['assets'].map(RichTextAssetFromJSON)),
+    };
+}
+export function RichTextDocumentToJSON(json) {
+    return RichTextDocumentToJSONTyped(json, false);
+}
+export function RichTextDocumentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'format': value['format'],
+        'document': value['document'],
+        'plain_text': value['plainText'],
+        'assets': (value['assets'].map(RichTextAssetToJSON)),
+    };
+}

package/dist/esm/models/RichTextInput.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare const RichTextInputFormatEnum: {
+    readonly TiptapV2: "tiptap-v2";
+};
+export type RichTextInputFormatEnum = typeof RichTextInputFormatEnum[keyof typeof RichTextInputFormatEnum];
+/**
+ * Check if a given object implements the RichTextInput interface.
+ */
+export declare function instanceOfRichTextInput(value: object): value is RichTextInput;
+export declare function RichTextInputFromJSON(json: any): RichTextInput;
+export declare function RichTextInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): RichTextInput;
+export declare function RichTextInputToJSON(json: any): RichTextInput;
+export declare function RichTextInputToJSONTyped(value?: RichTextInput | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/RichTextInput.js

@@ -0,0 +1,53 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const RichTextInputFormatEnum = {
+    TiptapV2: 'tiptap-v2'
+};
+/**
+ * Check if a given object implements the RichTextInput interface.
+ */
+export function instanceOfRichTextInput(value) {
+    if (!('format' in value) || value['format'] === undefined)
+        return false;
+    if (!('document' in value) || value['document'] === undefined)
+        return false;
+    return true;
+}
+export function RichTextInputFromJSON(json) {
+    return RichTextInputFromJSONTyped(json, false);
+}
+export function RichTextInputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'format': json['format'],
+        'document': json['document'],
+    };
+}
+export function RichTextInputToJSON(json) {
+    return RichTextInputToJSONTyped(json, false);
+}
+export function RichTextInputToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'format': value['format'],
+        'document': value['document'],
+    };
+}

package/dist/esm/models/index.d.ts

@@ -137,6 +137,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';
@@ -234,6 +235,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';
@@ -270,6 +273,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';

package/dist/esm/models/index.js

@@ -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';