@easyedu/js-lsm-api 1.82.0 → 1.84.0

package/src/models/GetCourseVersionItemLaunch.ts

@@ -0,0 +1,185 @@
+/* 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 { RichTextDocument } from './RichTextDocument';
+import {
+    RichTextDocumentFromJSON,
+    RichTextDocumentFromJSONTyped,
+    RichTextDocumentToJSON,
+    RichTextDocumentToJSONTyped,
+} from './RichTextDocument';
+import type { ResourceType } from './ResourceType';
+import {
+    ResourceTypeFromJSON,
+    ResourceTypeFromJSONTyped,
+    ResourceTypeToJSON,
+    ResourceTypeToJSONTyped,
+} from './ResourceType';
+import type { ContentLaunchMode } from './ContentLaunchMode';
+import {
+    ContentLaunchModeFromJSON,
+    ContentLaunchModeFromJSONTyped,
+    ContentLaunchModeToJSON,
+    ContentLaunchModeToJSONTyped,
+} from './ContentLaunchMode';
+
+/**
+ * 
+ * @export
+ * @interface GetCourseVersionItemLaunch
+ */
+export interface GetCourseVersionItemLaunch {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    courseVersionId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    itemId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    contentLibraryItemId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    contentLibraryVersionId: string;
+    /**
+     * 
+     * @type {ResourceType}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    resourceType: ResourceType;
+    /**
+     * 
+     * @type {ContentLaunchMode}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    launchMode: ContentLaunchMode;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    maxAttempts: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    url?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    filename?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    mimeType?: string | null;
+    /**
+     * 
+     * @type {RichTextDocument}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    richText?: RichTextDocument | null;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    metadata: { [key: string]: any; };
+}
+
+
+
+/**
+ * Check if a given object implements the GetCourseVersionItemLaunch interface.
+ */
+export function instanceOfGetCourseVersionItemLaunch(value: object): value is GetCourseVersionItemLaunch {
+    if (!('courseVersionId' in value) || value['courseVersionId'] === undefined) return false;
+    if (!('itemId' in value) || value['itemId'] === undefined) return false;
+    if (!('contentLibraryItemId' in value) || value['contentLibraryItemId'] === undefined) return false;
+    if (!('contentLibraryVersionId' in value) || value['contentLibraryVersionId'] === undefined) return false;
+    if (!('resourceType' in value) || value['resourceType'] === undefined) return false;
+    if (!('launchMode' in value) || value['launchMode'] === undefined) return false;
+    if (!('maxAttempts' in value) || value['maxAttempts'] === undefined) return false;
+    if (!('metadata' in value) || value['metadata'] === undefined) return false;
+    return true;
+}
+
+export function GetCourseVersionItemLaunchFromJSON(json: any): GetCourseVersionItemLaunch {
+    return GetCourseVersionItemLaunchFromJSONTyped(json, false);
+}
+
+export function GetCourseVersionItemLaunchFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionItemLaunch {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'courseVersionId': json['course_version_id'],
+        'itemId': json['item_id'],
+        'contentLibraryItemId': json['content_library_item_id'],
+        'contentLibraryVersionId': json['content_library_version_id'],
+        'resourceType': ResourceTypeFromJSON(json['resource_type']),
+        'launchMode': ContentLaunchModeFromJSON(json['launch_mode']),
+        'maxAttempts': json['max_attempts'],
+        'url': json['url'] == null ? undefined : json['url'],
+        'filename': json['filename'] == null ? undefined : json['filename'],
+        'mimeType': json['mime_type'] == null ? undefined : json['mime_type'],
+        'richText': json['rich_text'] == null ? undefined : RichTextDocumentFromJSON(json['rich_text']),
+        'metadata': json['metadata'],
+    };
+}
+
+export function GetCourseVersionItemLaunchToJSON(json: any): GetCourseVersionItemLaunch {
+    return GetCourseVersionItemLaunchToJSONTyped(json, false);
+}
+
+export function GetCourseVersionItemLaunchToJSONTyped(value?: GetCourseVersionItemLaunch | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'course_version_id': value['courseVersionId'],
+        'item_id': value['itemId'],
+        'content_library_item_id': value['contentLibraryItemId'],
+        'content_library_version_id': value['contentLibraryVersionId'],
+        'resource_type': ResourceTypeToJSON(value['resourceType']),
+        'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
+        'max_attempts': value['maxAttempts'],
+        'url': value['url'],
+        'filename': value['filename'],
+        'mime_type': value['mimeType'],
+        'rich_text': RichTextDocumentToJSON(value['richText']),
+        'metadata': value['metadata'],
+    };
+}
+

package/src/models/GetCourseVersionItemSession.ts

@@ -0,0 +1,216 @@
+/* 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 { ResourceType } from './ResourceType';
+import {
+    ResourceTypeFromJSON,
+    ResourceTypeFromJSONTyped,
+    ResourceTypeToJSON,
+    ResourceTypeToJSONTyped,
+} from './ResourceType';
+import type { ContentLaunchMode } from './ContentLaunchMode';
+import {
+    ContentLaunchModeFromJSON,
+    ContentLaunchModeFromJSONTyped,
+    ContentLaunchModeToJSON,
+    ContentLaunchModeToJSONTyped,
+} from './ContentLaunchMode';
+
+/**
+ * A learner resource attempt pinned to an immutable course and Content Library version.
+ * @export
+ * @interface GetCourseVersionItemSession
+ */
+export interface GetCourseVersionItemSession {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    courseVersionId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    itemId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    contentLibraryItemId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    contentLibraryVersionId: string;
+    /**
+     * 
+     * @type {ResourceType}
+     * @memberof GetCourseVersionItemSession
+     */
+    resourceType: ResourceType;
+    /**
+     * 
+     * @type {ContentLaunchMode}
+     * @memberof GetCourseVersionItemSession
+     */
+    launchMode: ContentLaunchMode;
+    /**
+     * Session-aware player URL, direct asset URL, or external link.
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    launchUrl: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    attemptNumber: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetCourseVersionItemSession
+     */
+    isCurrent: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    completionStatus: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    gradeStatus: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    scoreRaw?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    updatedAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    completedAt?: number | null;
+}
+
+
+
+/**
+ * Check if a given object implements the GetCourseVersionItemSession interface.
+ */
+export function instanceOfGetCourseVersionItemSession(value: object): value is GetCourseVersionItemSession {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('courseVersionId' in value) || value['courseVersionId'] === undefined) return false;
+    if (!('itemId' in value) || value['itemId'] === undefined) return false;
+    if (!('contentLibraryItemId' in value) || value['contentLibraryItemId'] === undefined) return false;
+    if (!('contentLibraryVersionId' in value) || value['contentLibraryVersionId'] === undefined) return false;
+    if (!('resourceType' in value) || value['resourceType'] === undefined) return false;
+    if (!('launchMode' in value) || value['launchMode'] === undefined) return false;
+    if (!('launchUrl' in value) || value['launchUrl'] === undefined) return false;
+    if (!('attemptNumber' in value) || value['attemptNumber'] === undefined) return false;
+    if (!('isCurrent' in value) || value['isCurrent'] === undefined) return false;
+    if (!('completionStatus' in value) || value['completionStatus'] === undefined) return false;
+    if (!('gradeStatus' in value) || value['gradeStatus'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function GetCourseVersionItemSessionFromJSON(json: any): GetCourseVersionItemSession {
+    return GetCourseVersionItemSessionFromJSONTyped(json, false);
+}
+
+export function GetCourseVersionItemSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionItemSession {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'courseVersionId': json['course_version_id'],
+        'itemId': json['item_id'],
+        'contentLibraryItemId': json['content_library_item_id'],
+        'contentLibraryVersionId': json['content_library_version_id'],
+        'resourceType': ResourceTypeFromJSON(json['resource_type']),
+        'launchMode': ContentLaunchModeFromJSON(json['launch_mode']),
+        'launchUrl': json['launch_url'],
+        'attemptNumber': json['attempt_number'],
+        'isCurrent': json['is_current'],
+        'completionStatus': json['completion_status'],
+        'gradeStatus': json['grade_status'],
+        'scoreRaw': json['score_raw'] == null ? undefined : json['score_raw'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'completedAt': json['completed_at'] == null ? undefined : json['completed_at'],
+    };
+}
+
+export function GetCourseVersionItemSessionToJSON(json: any): GetCourseVersionItemSession {
+    return GetCourseVersionItemSessionToJSONTyped(json, false);
+}
+
+export function GetCourseVersionItemSessionToJSONTyped(value?: GetCourseVersionItemSession | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'course_version_id': value['courseVersionId'],
+        'item_id': value['itemId'],
+        'content_library_item_id': value['contentLibraryItemId'],
+        'content_library_version_id': value['contentLibraryVersionId'],
+        'resource_type': ResourceTypeToJSON(value['resourceType']),
+        'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
+        'launch_url': value['launchUrl'],
+        'attempt_number': value['attemptNumber'],
+        'is_current': value['isCurrent'],
+        'completion_status': value['completionStatus'],
+        'grade_status': value['gradeStatus'],
+        'score_raw': value['scoreRaw'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'completed_at': value['completedAt'],
+    };
+}
+

package/src/models/GetCourseVersionList.ts

@@ -0,0 +1,74 @@
+/* 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 { GetCourseVersion } from './GetCourseVersion';
+import {
+    GetCourseVersionFromJSON,
+    GetCourseVersionFromJSONTyped,
+    GetCourseVersionToJSON,
+    GetCourseVersionToJSONTyped,
+} from './GetCourseVersion';
+
+/**
+ * 
+ * @export
+ * @interface GetCourseVersionList
+ */
+export interface GetCourseVersionList {
+    /**
+     * 
+     * @type {Array<GetCourseVersion>}
+     * @memberof GetCourseVersionList
+     */
+    items: Array<GetCourseVersion>;
+}
+
+/**
+ * Check if a given object implements the GetCourseVersionList interface.
+ */
+export function instanceOfGetCourseVersionList(value: object): value is GetCourseVersionList {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetCourseVersionListFromJSON(json: any): GetCourseVersionList {
+    return GetCourseVersionListFromJSONTyped(json, false);
+}
+
+export function GetCourseVersionListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(GetCourseVersionFromJSON)),
+    };
+}
+
+export function GetCourseVersionListToJSON(json: any): GetCourseVersionList {
+    return GetCourseVersionListToJSONTyped(json, false);
+}
+
+export function GetCourseVersionListToJSONTyped(value?: GetCourseVersionList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(GetCourseVersionToJSON)),
+    };
+}
+

package/src/models/GetCourseVersionModule.ts

@@ -0,0 +1,126 @@
+/* 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 { GetCourseVersionItem } from './GetCourseVersionItem';
+import {
+    GetCourseVersionItemFromJSON,
+    GetCourseVersionItemFromJSONTyped,
+    GetCourseVersionItemToJSON,
+    GetCourseVersionItemToJSONTyped,
+} from './GetCourseVersionItem';
+import type { RichTextDocument } from './RichTextDocument';
+import {
+    RichTextDocumentFromJSON,
+    RichTextDocumentFromJSONTyped,
+    RichTextDocumentToJSON,
+    RichTextDocumentToJSONTyped,
+} from './RichTextDocument';
+
+/**
+ * 
+ * @export
+ * @interface GetCourseVersionModule
+ */
+export interface GetCourseVersionModule {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionModule
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionModule
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionModule
+     */
+    description: string;
+    /**
+     * 
+     * @type {RichTextDocument}
+     * @memberof GetCourseVersionModule
+     */
+    descriptionRich: RichTextDocument;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionModule
+     */
+    displayOrder: number;
+    /**
+     * 
+     * @type {Array<GetCourseVersionItem>}
+     * @memberof GetCourseVersionModule
+     */
+    items: Array<GetCourseVersionItem>;
+}
+
+/**
+ * Check if a given object implements the GetCourseVersionModule interface.
+ */
+export function instanceOfGetCourseVersionModule(value: object): value is GetCourseVersionModule {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('descriptionRich' in value) || value['descriptionRich'] === undefined) return false;
+    if (!('displayOrder' in value) || value['displayOrder'] === undefined) return false;
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetCourseVersionModuleFromJSON(json: any): GetCourseVersionModule {
+    return GetCourseVersionModuleFromJSONTyped(json, false);
+}
+
+export function GetCourseVersionModuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionModule {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'descriptionRich': RichTextDocumentFromJSON(json['description_rich']),
+        'displayOrder': json['display_order'],
+        'items': ((json['items'] as Array<any>).map(GetCourseVersionItemFromJSON)),
+    };
+}
+
+export function GetCourseVersionModuleToJSON(json: any): GetCourseVersionModule {
+    return GetCourseVersionModuleToJSONTyped(json, false);
+}
+
+export function GetCourseVersionModuleToJSONTyped(value?: GetCourseVersionModule | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'description_rich': RichTextDocumentToJSON(value['descriptionRich']),
+        'display_order': value['displayOrder'],
+        'items': ((value['items'] as Array<any>).map(GetCourseVersionItemToJSON)),
+    };
+}
+

package/src/models/GetQuizAttemptQuestionsInner.ts

@@ -20,6 +20,13 @@ import {
     GetQuizAttemptQuestionsInnerCurrentAnswerToJSON,
     GetQuizAttemptQuestionsInnerCurrentAnswerToJSONTyped,
 } from './GetQuizAttemptQuestionsInnerCurrentAnswer';
+import type { RichTextDocument } from './RichTextDocument';
+import {
+    RichTextDocumentFromJSON,
+    RichTextDocumentFromJSONTyped,
+    RichTextDocumentToJSON,
+    RichTextDocumentToJSONTyped,
+} from './RichTextDocument';
 import type { GetQuizAttemptQuestionsInnerAnswerChoicesInner } from './GetQuizAttemptQuestionsInnerAnswerChoicesInner';
 import {
     GetQuizAttemptQuestionsInnerAnswerChoicesInnerFromJSON,
@@ -64,6 +71,12 @@ export interface GetQuizAttemptQuestionsInner {
      * @memberof GetQuizAttemptQuestionsInner
      */
     questionText: string;
+    /**
+     * 
+     * @type {RichTextDocument}
+     * @memberof GetQuizAttemptQuestionsInner
+     */
+    questionTextRich?: RichTextDocument;
     /**
      * Question type
      * @type {GetQuizAttemptQuestionsInnerQuestionTypeEnum}
@@ -140,6 +153,7 @@ export function GetQuizAttemptQuestionsInnerFromJSONTyped(json: any, ignoreDiscr
         'questionOrder': json['question_order'],
         'points': json['points'],
         'questionText': json['question_text'],
+        'questionTextRich': json['question_text_rich'] == null ? undefined : RichTextDocumentFromJSON(json['question_text_rich']),
         'questionType': json['question_type'],
         'answerChoices': json['answer_choices'] == null ? undefined : ((json['answer_choices'] as Array<any>).map(GetQuizAttemptQuestionsInnerAnswerChoicesInnerFromJSON)),
         'isAnswered': json['is_answered'],
@@ -164,6 +178,7 @@ export function GetQuizAttemptQuestionsInnerToJSONTyped(value?: GetQuizAttemptQu
         'question_order': value['questionOrder'],
         'points': value['points'],
         'question_text': value['questionText'],
+        'question_text_rich': RichTextDocumentToJSON(value['questionTextRich']),
         'question_type': value['questionType'],
         'answer_choices': value['answerChoices'] == null ? undefined : ((value['answerChoices'] as Array<any>).map(GetQuizAttemptQuestionsInnerAnswerChoicesInnerToJSON)),
         'is_answered': value['isAnswered'],

package/src/models/GetQuizAttemptQuestionsInnerAnswerChoicesInner.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { RichTextDocument } from './RichTextDocument';
+import {
+    RichTextDocumentFromJSON,
+    RichTextDocumentFromJSONTyped,
+    RichTextDocumentToJSON,
+    RichTextDocumentToJSONTyped,
+} from './RichTextDocument';
+
 /**
  * 
  * @export
@@ -31,6 +39,12 @@ export interface GetQuizAttemptQuestionsInnerAnswerChoicesInner {
      * @memberof GetQuizAttemptQuestionsInnerAnswerChoicesInner
      */
     text: string;
+    /**
+     * 
+     * @type {RichTextDocument}
+     * @memberof GetQuizAttemptQuestionsInnerAnswerChoicesInner
+     */
+    textRich?: RichTextDocument;
     /**
      * Display order
      * @type {number}
@@ -61,6 +75,7 @@ export function GetQuizAttemptQuestionsInnerAnswerChoicesInnerFromJSONTyped(json
         
         'id': json['id'],
         'text': json['text'],
+        'textRich': json['text_rich'] == null ? undefined : RichTextDocumentFromJSON(json['text_rich']),
         'displayOrder': json['display_order'],
     };
 }
@@ -78,6 +93,7 @@ export function GetQuizAttemptQuestionsInnerAnswerChoicesInnerToJSONTyped(value?
         
         'id': value['id'],
         'text': value['text'],
+        'text_rich': RichTextDocumentToJSON(value['textRich']),
         'display_order': value['displayOrder'],
     };
 }