@easyedu/js-lsm-api 1.79.0 → 1.81.0

package/src/models/GetUserCourseListItemEnrollment.ts

@@ -0,0 +1,171 @@
+/* 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';
+/**
+ * Selected enrollment fields for an enrolled user's course list item.
+ * @export
+ * @interface GetUserCourseListItemEnrollment
+ */
+export interface GetUserCourseListItemEnrollment {
+    /**
+     * The external ID of the selected enrollment.
+     * @type {string}
+     * @memberof GetUserCourseListItemEnrollment
+     */
+    id: string;
+    /**
+     * 
+     * @type {GetUserCourseListItemEnrollmentStatusEnum}
+     * @memberof GetUserCourseListItemEnrollment
+     */
+    status: GetUserCourseListItemEnrollmentStatusEnum;
+    /**
+     * 
+     * @type {GetUserCourseListItemEnrollmentAccessStateEnum}
+     * @memberof GetUserCourseListItemEnrollment
+     */
+    accessState: GetUserCourseListItemEnrollmentAccessStateEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetUserCourseListItemEnrollment
+     */
+    daysUntilExpiry: number | null;
+    /**
+     * 
+     * @type {GetUserCourseListItemEnrollmentUserTypeEnum}
+     * @memberof GetUserCourseListItemEnrollment
+     */
+    userType: GetUserCourseListItemEnrollmentUserTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetUserCourseListItemEnrollment
+     */
+    enrollmentDateStart: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetUserCourseListItemEnrollment
+     */
+    enrollmentDateEnd: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetUserCourseListItemEnrollment
+     */
+    completionDate: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const GetUserCourseListItemEnrollmentStatusEnum = {
+    Enrolled: 'Enrolled',
+    InProgress: 'InProgress',
+    Completed: 'Completed',
+    Failed: 'Failed',
+    Expired: 'Expired',
+    Withdrawn: 'Withdrawn',
+    Removed: 'Removed',
+    Archived: 'Archived',
+    Suspended: 'Suspended'
+} as const;
+export type GetUserCourseListItemEnrollmentStatusEnum = typeof GetUserCourseListItemEnrollmentStatusEnum[keyof typeof GetUserCourseListItemEnrollmentStatusEnum];
+
+/**
+ * @export
+ */
+export const GetUserCourseListItemEnrollmentAccessStateEnum = {
+    Active: 'active',
+    CompletedReview: 'completed_review',
+    Expired: 'expired',
+    Suspended: 'suspended',
+    Failed: 'failed',
+    Withdrawn: 'withdrawn',
+    Removed: 'removed',
+    Archived: 'archived'
+} as const;
+export type GetUserCourseListItemEnrollmentAccessStateEnum = typeof GetUserCourseListItemEnrollmentAccessStateEnum[keyof typeof GetUserCourseListItemEnrollmentAccessStateEnum];
+
+/**
+ * @export
+ */
+export const GetUserCourseListItemEnrollmentUserTypeEnum = {
+    Student: 'Student',
+    Instructor: 'Instructor'
+} as const;
+export type GetUserCourseListItemEnrollmentUserTypeEnum = typeof GetUserCourseListItemEnrollmentUserTypeEnum[keyof typeof GetUserCourseListItemEnrollmentUserTypeEnum];
+
+
+/**
+ * Check if a given object implements the GetUserCourseListItemEnrollment interface.
+ */
+export function instanceOfGetUserCourseListItemEnrollment(value: object): value is GetUserCourseListItemEnrollment {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('accessState' in value) || value['accessState'] === undefined) return false;
+    if (!('daysUntilExpiry' in value) || value['daysUntilExpiry'] === undefined) return false;
+    if (!('userType' in value) || value['userType'] === undefined) return false;
+    if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined) return false;
+    if (!('enrollmentDateEnd' in value) || value['enrollmentDateEnd'] === undefined) return false;
+    if (!('completionDate' in value) || value['completionDate'] === undefined) return false;
+    return true;
+}
+
+export function GetUserCourseListItemEnrollmentFromJSON(json: any): GetUserCourseListItemEnrollment {
+    return GetUserCourseListItemEnrollmentFromJSONTyped(json, false);
+}
+
+export function GetUserCourseListItemEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserCourseListItemEnrollment {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'status': json['status'],
+        'accessState': json['access_state'],
+        'daysUntilExpiry': json['days_until_expiry'],
+        'userType': json['user_type'],
+        'enrollmentDateStart': json['enrollment_date_start'],
+        'enrollmentDateEnd': json['enrollment_date_end'],
+        'completionDate': json['completion_date'],
+    };
+}
+
+export function GetUserCourseListItemEnrollmentToJSON(json: any): GetUserCourseListItemEnrollment {
+    return GetUserCourseListItemEnrollmentToJSONTyped(json, false);
+}
+
+export function GetUserCourseListItemEnrollmentToJSONTyped(value?: GetUserCourseListItemEnrollment | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'status': value['status'],
+        'access_state': value['accessState'],
+        'days_until_expiry': value['daysUntilExpiry'],
+        'user_type': value['userType'],
+        'enrollment_date_start': value['enrollmentDateStart'],
+        'enrollment_date_end': value['enrollmentDateEnd'],
+        'completion_date': value['completionDate'],
+    };
+}
+

package/src/models/GetUserCourseListItemProgress.ts

@@ -0,0 +1,84 @@
+/* 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';
+/**
+ * Learner progress for an enrolled user's course list item.
+ * @export
+ * @interface GetUserCourseListItemProgress
+ */
+export interface GetUserCourseListItemProgress {
+    /**
+     * Completed visible content divided by total visible content. Null when total content count is zero.
+     * @type {number}
+     * @memberof GetUserCourseListItemProgress
+     */
+    completionPercentage: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetUserCourseListItemProgress
+     */
+    completedContentCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetUserCourseListItemProgress
+     */
+    totalContentCount: number;
+}
+
+/**
+ * Check if a given object implements the GetUserCourseListItemProgress interface.
+ */
+export function instanceOfGetUserCourseListItemProgress(value: object): value is GetUserCourseListItemProgress {
+    if (!('completionPercentage' in value) || value['completionPercentage'] === undefined) return false;
+    if (!('completedContentCount' in value) || value['completedContentCount'] === undefined) return false;
+    if (!('totalContentCount' in value) || value['totalContentCount'] === undefined) return false;
+    return true;
+}
+
+export function GetUserCourseListItemProgressFromJSON(json: any): GetUserCourseListItemProgress {
+    return GetUserCourseListItemProgressFromJSONTyped(json, false);
+}
+
+export function GetUserCourseListItemProgressFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserCourseListItemProgress {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'completionPercentage': json['completion_percentage'],
+        'completedContentCount': json['completed_content_count'],
+        'totalContentCount': json['total_content_count'],
+    };
+}
+
+export function GetUserCourseListItemProgressToJSON(json: any): GetUserCourseListItemProgress {
+    return GetUserCourseListItemProgressToJSONTyped(json, false);
+}
+
+export function GetUserCourseListItemProgressToJSONTyped(value?: GetUserCourseListItemProgress | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'completion_percentage': value['completionPercentage'],
+        'completed_content_count': value['completedContentCount'],
+        'total_content_count': value['totalContentCount'],
+    };
+}
+

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