@easyedu/js-lsm-api 1.94.0 → 1.95.0

package/src/models/GetContentVersionSandbox.ts

@@ -1,66 +0,0 @@
-/* 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';
-/**
- * Sandbox data for this version
- * @export
- * @interface GetContentVersionSandbox
- */
-export interface GetContentVersionSandbox {
-    /**
-     * URL to launch the content in sandbox mode
-     * @type {string}
-     * @memberof GetContentVersionSandbox
-     */
-    launchUrl: string;
-}
-
-/**
- * Check if a given object implements the GetContentVersionSandbox interface.
- */
-export function instanceOfGetContentVersionSandbox(value: object): value is GetContentVersionSandbox {
-    if (!('launchUrl' in value) || value['launchUrl'] === undefined) return false;
-    return true;
-}
-
-export function GetContentVersionSandboxFromJSON(json: any): GetContentVersionSandbox {
-    return GetContentVersionSandboxFromJSONTyped(json, false);
-}
-
-export function GetContentVersionSandboxFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentVersionSandbox {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'launchUrl': json['launch_url'],
-    };
-}
-
-export function GetContentVersionSandboxToJSON(json: any): GetContentVersionSandbox {
-    return GetContentVersionSandboxToJSONTyped(json, false);
-}
-
-export function GetContentVersionSandboxToJSONTyped(value?: GetContentVersionSandbox | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'launch_url': value['launchUrl'],
-    };
-}
-

package/src/models/GetContentVersionScormData.ts

@@ -1,66 +0,0 @@
-/* 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';
-/**
- * SCORM-specific data (only present for SCORM content type)
- * @export
- * @interface GetContentVersionScormData
- */
-export interface GetContentVersionScormData {
-    /**
-     * The external_id (UUID) of the scorm_content record
-     * @type {string}
-     * @memberof GetContentVersionScormData
-     */
-    scormPackageId: string;
-}
-
-/**
- * Check if a given object implements the GetContentVersionScormData interface.
- */
-export function instanceOfGetContentVersionScormData(value: object): value is GetContentVersionScormData {
-    if (!('scormPackageId' in value) || value['scormPackageId'] === undefined) return false;
-    return true;
-}
-
-export function GetContentVersionScormDataFromJSON(json: any): GetContentVersionScormData {
-    return GetContentVersionScormDataFromJSONTyped(json, false);
-}
-
-export function GetContentVersionScormDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentVersionScormData {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'scormPackageId': json['scorm_package_id'],
-    };
-}
-
-export function GetContentVersionScormDataToJSON(json: any): GetContentVersionScormData {
-    return GetContentVersionScormDataToJSONTyped(json, false);
-}
-
-export function GetContentVersionScormDataToJSONTyped(value?: GetContentVersionScormData | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'scorm_package_id': value['scormPackageId'],
-    };
-}
-

package/src/models/GetCourseReportingBasic.ts

@@ -1,84 +0,0 @@
-/* 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 GetCourseReportingBasic
- */
-export interface GetCourseReportingBasic {
-    /**
-     * Total number of students enrolled in the course
-     * @type {number}
-     * @memberof GetCourseReportingBasic
-     */
-    totalStudents: number;
-    /**
-     * Number of students with enrollment status of Enrolled
-     * @type {number}
-     * @memberof GetCourseReportingBasic
-     */
-    activeStudents: number;
-    /**
-     * Percentage of students who have completed the course
-     * @type {number}
-     * @memberof GetCourseReportingBasic
-     */
-    completionRatePercentage: number;
-}
-
-/**
- * Check if a given object implements the GetCourseReportingBasic interface.
- */
-export function instanceOfGetCourseReportingBasic(value: object): value is GetCourseReportingBasic {
-    if (!('totalStudents' in value) || value['totalStudents'] === undefined) return false;
-    if (!('activeStudents' in value) || value['activeStudents'] === undefined) return false;
-    if (!('completionRatePercentage' in value) || value['completionRatePercentage'] === undefined) return false;
-    return true;
-}
-
-export function GetCourseReportingBasicFromJSON(json: any): GetCourseReportingBasic {
-    return GetCourseReportingBasicFromJSONTyped(json, false);
-}
-
-export function GetCourseReportingBasicFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseReportingBasic {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'totalStudents': json['total_students'],
-        'activeStudents': json['active_students'],
-        'completionRatePercentage': json['completion_rate_percentage'],
-    };
-}
-
-export function GetCourseReportingBasicToJSON(json: any): GetCourseReportingBasic {
-    return GetCourseReportingBasicToJSONTyped(json, false);
-}
-
-export function GetCourseReportingBasicToJSONTyped(value?: GetCourseReportingBasic | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'total_students': value['totalStudents'],
-        'active_students': value['activeStudents'],
-        'completion_rate_percentage': value['completionRatePercentage'],
-    };
-}
-

package/src/models/GetCourseStudentReporting.ts

@@ -1,122 +0,0 @@
-/* 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 { GetCourseStudentReportingEngagement } from './GetCourseStudentReportingEngagement';
-import {
-    GetCourseStudentReportingEngagementFromJSON,
-    GetCourseStudentReportingEngagementFromJSONTyped,
-    GetCourseStudentReportingEngagementToJSON,
-    GetCourseStudentReportingEngagementToJSONTyped,
-} from './GetCourseStudentReportingEngagement';
-import type { GetCourseStudentReportingModulesInner } from './GetCourseStudentReportingModulesInner';
-import {
-    GetCourseStudentReportingModulesInnerFromJSON,
-    GetCourseStudentReportingModulesInnerFromJSONTyped,
-    GetCourseStudentReportingModulesInnerToJSON,
-    GetCourseStudentReportingModulesInnerToJSONTyped,
-} from './GetCourseStudentReportingModulesInner';
-import type { GetCourseStudentReportingCourseInfo } from './GetCourseStudentReportingCourseInfo';
-import {
-    GetCourseStudentReportingCourseInfoFromJSON,
-    GetCourseStudentReportingCourseInfoFromJSONTyped,
-    GetCourseStudentReportingCourseInfoToJSON,
-    GetCourseStudentReportingCourseInfoToJSONTyped,
-} from './GetCourseStudentReportingCourseInfo';
-import type { GetCourseStudentReportingPerformance } from './GetCourseStudentReportingPerformance';
-import {
-    GetCourseStudentReportingPerformanceFromJSON,
-    GetCourseStudentReportingPerformanceFromJSONTyped,
-    GetCourseStudentReportingPerformanceToJSON,
-    GetCourseStudentReportingPerformanceToJSONTyped,
-} from './GetCourseStudentReportingPerformance';
-
-/**
- * 
- * @export
- * @interface GetCourseStudentReporting
- */
-export interface GetCourseStudentReporting {
-    /**
-     * 
-     * @type {GetCourseStudentReportingCourseInfo}
-     * @memberof GetCourseStudentReporting
-     */
-    courseInfo: GetCourseStudentReportingCourseInfo;
-    /**
-     * 
-     * @type {GetCourseStudentReportingEngagement}
-     * @memberof GetCourseStudentReporting
-     */
-    engagement: GetCourseStudentReportingEngagement;
-    /**
-     * 
-     * @type {GetCourseStudentReportingPerformance}
-     * @memberof GetCourseStudentReporting
-     */
-    performance: GetCourseStudentReportingPerformance;
-    /**
-     * Module-level progress for the student within this course.
-     * @type {Array<GetCourseStudentReportingModulesInner>}
-     * @memberof GetCourseStudentReporting
-     */
-    modules: Array<GetCourseStudentReportingModulesInner>;
-}
-
-/**
- * Check if a given object implements the GetCourseStudentReporting interface.
- */
-export function instanceOfGetCourseStudentReporting(value: object): value is GetCourseStudentReporting {
-    if (!('courseInfo' in value) || value['courseInfo'] === undefined) return false;
-    if (!('engagement' in value) || value['engagement'] === undefined) return false;
-    if (!('performance' in value) || value['performance'] === undefined) return false;
-    if (!('modules' in value) || value['modules'] === undefined) return false;
-    return true;
-}
-
-export function GetCourseStudentReportingFromJSON(json: any): GetCourseStudentReporting {
-    return GetCourseStudentReportingFromJSONTyped(json, false);
-}
-
-export function GetCourseStudentReportingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseStudentReporting {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'courseInfo': GetCourseStudentReportingCourseInfoFromJSON(json['course_info']),
-        'engagement': GetCourseStudentReportingEngagementFromJSON(json['engagement']),
-        'performance': GetCourseStudentReportingPerformanceFromJSON(json['performance']),
-        'modules': ((json['modules'] as Array<any>).map(GetCourseStudentReportingModulesInnerFromJSON)),
-    };
-}
-
-export function GetCourseStudentReportingToJSON(json: any): GetCourseStudentReporting {
-    return GetCourseStudentReportingToJSONTyped(json, false);
-}
-
-export function GetCourseStudentReportingToJSONTyped(value?: GetCourseStudentReporting | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'course_info': GetCourseStudentReportingCourseInfoToJSON(value['courseInfo']),
-        'engagement': GetCourseStudentReportingEngagementToJSON(value['engagement']),
-        'performance': GetCourseStudentReportingPerformanceToJSON(value['performance']),
-        'modules': ((value['modules'] as Array<any>).map(GetCourseStudentReportingModulesInnerToJSON)),
-    };
-}
-

package/src/models/GetCourseStudentReportingCourseInfo.ts

@@ -1,66 +0,0 @@
-/* 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 GetCourseStudentReportingCourseInfo
- */
-export interface GetCourseStudentReportingCourseInfo {
-    /**
-     * Total number of modules in the course
-     * @type {number}
-     * @memberof GetCourseStudentReportingCourseInfo
-     */
-    moduleCount: number;
-}
-
-/**
- * Check if a given object implements the GetCourseStudentReportingCourseInfo interface.
- */
-export function instanceOfGetCourseStudentReportingCourseInfo(value: object): value is GetCourseStudentReportingCourseInfo {
-    if (!('moduleCount' in value) || value['moduleCount'] === undefined) return false;
-    return true;
-}
-
-export function GetCourseStudentReportingCourseInfoFromJSON(json: any): GetCourseStudentReportingCourseInfo {
-    return GetCourseStudentReportingCourseInfoFromJSONTyped(json, false);
-}
-
-export function GetCourseStudentReportingCourseInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseStudentReportingCourseInfo {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'moduleCount': json['module_count'],
-    };
-}
-
-export function GetCourseStudentReportingCourseInfoToJSON(json: any): GetCourseStudentReportingCourseInfo {
-    return GetCourseStudentReportingCourseInfoToJSONTyped(json, false);
-}
-
-export function GetCourseStudentReportingCourseInfoToJSONTyped(value?: GetCourseStudentReportingCourseInfo | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'module_count': value['moduleCount'],
-    };
-}
-

package/src/models/GetCourseStudentReportingEngagement.ts

@@ -1,75 +0,0 @@
-/* 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 GetCourseStudentReportingEngagement
- */
-export interface GetCourseStudentReportingEngagement {
-    /**
-     * Average time spent on the course in hours
-     * @type {number}
-     * @memberof GetCourseStudentReportingEngagement
-     */
-    avgTimeSpentHours: number | null;
-    /**
-     * Number of modules completed by the student
-     * @type {number}
-     * @memberof GetCourseStudentReportingEngagement
-     */
-    modulesCompletedCount: number;
-}
-
-/**
- * Check if a given object implements the GetCourseStudentReportingEngagement interface.
- */
-export function instanceOfGetCourseStudentReportingEngagement(value: object): value is GetCourseStudentReportingEngagement {
-    if (!('avgTimeSpentHours' in value) || value['avgTimeSpentHours'] === undefined) return false;
-    if (!('modulesCompletedCount' in value) || value['modulesCompletedCount'] === undefined) return false;
-    return true;
-}
-
-export function GetCourseStudentReportingEngagementFromJSON(json: any): GetCourseStudentReportingEngagement {
-    return GetCourseStudentReportingEngagementFromJSONTyped(json, false);
-}
-
-export function GetCourseStudentReportingEngagementFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseStudentReportingEngagement {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'avgTimeSpentHours': json['avg_time_spent_hours'],
-        'modulesCompletedCount': json['modules_completed_count'],
-    };
-}
-
-export function GetCourseStudentReportingEngagementToJSON(json: any): GetCourseStudentReportingEngagement {
-    return GetCourseStudentReportingEngagementToJSONTyped(json, false);
-}
-
-export function GetCourseStudentReportingEngagementToJSONTyped(value?: GetCourseStudentReportingEngagement | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'avg_time_spent_hours': value['avgTimeSpentHours'],
-        'modules_completed_count': value['modulesCompletedCount'],
-    };
-}
-

package/src/models/GetCourseStudentReportingModulesInner.ts

@@ -1,123 +0,0 @@
-/* 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 GetCourseStudentReportingModulesInner
- */
-export interface GetCourseStudentReportingModulesInner {
-    /**
-     * The module external ID.
-     * @type {string}
-     * @memberof GetCourseStudentReportingModulesInner
-     */
-    moduleId: string;
-    /**
-     * Module name.
-     * @type {string}
-     * @memberof GetCourseStudentReportingModulesInner
-     */
-    name: string;
-    /**
-     * Order of the module within the course.
-     * @type {number}
-     * @memberof GetCourseStudentReportingModulesInner
-     */
-    order: number;
-    /**
-     * Number of visible content items in the module.
-     * @type {number}
-     * @memberof GetCourseStudentReportingModulesInner
-     */
-    contentCount: number;
-    /**
-     * Number of visible content items completed by the student.
-     * @type {number}
-     * @memberof GetCourseStudentReportingModulesInner
-     */
-    contentCompletedCount: number;
-    /**
-     * Derived module completion status for this student.
-     * @type {GetCourseStudentReportingModulesInnerCompletionStatusEnum}
-     * @memberof GetCourseStudentReportingModulesInner
-     */
-    completionStatus: GetCourseStudentReportingModulesInnerCompletionStatusEnum;
-}
-
-
-/**
- * @export
- */
-export const GetCourseStudentReportingModulesInnerCompletionStatusEnum = {
-    NotAttempted: 'NotAttempted',
-    InProgress: 'InProgress',
-    Completed: 'Completed'
-} as const;
-export type GetCourseStudentReportingModulesInnerCompletionStatusEnum = typeof GetCourseStudentReportingModulesInnerCompletionStatusEnum[keyof typeof GetCourseStudentReportingModulesInnerCompletionStatusEnum];
-
-
-/**
- * Check if a given object implements the GetCourseStudentReportingModulesInner interface.
- */
-export function instanceOfGetCourseStudentReportingModulesInner(value: object): value is GetCourseStudentReportingModulesInner {
-    if (!('moduleId' in value) || value['moduleId'] === undefined) return false;
-    if (!('name' in value) || value['name'] === undefined) return false;
-    if (!('order' in value) || value['order'] === undefined) return false;
-    if (!('contentCount' in value) || value['contentCount'] === undefined) return false;
-    if (!('contentCompletedCount' in value) || value['contentCompletedCount'] === undefined) return false;
-    if (!('completionStatus' in value) || value['completionStatus'] === undefined) return false;
-    return true;
-}
-
-export function GetCourseStudentReportingModulesInnerFromJSON(json: any): GetCourseStudentReportingModulesInner {
-    return GetCourseStudentReportingModulesInnerFromJSONTyped(json, false);
-}
-
-export function GetCourseStudentReportingModulesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseStudentReportingModulesInner {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'moduleId': json['module_id'],
-        'name': json['name'],
-        'order': json['order'],
-        'contentCount': json['content_count'],
-        'contentCompletedCount': json['content_completed_count'],
-        'completionStatus': json['completion_status'],
-    };
-}
-
-export function GetCourseStudentReportingModulesInnerToJSON(json: any): GetCourseStudentReportingModulesInner {
-    return GetCourseStudentReportingModulesInnerToJSONTyped(json, false);
-}
-
-export function GetCourseStudentReportingModulesInnerToJSONTyped(value?: GetCourseStudentReportingModulesInner | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'module_id': value['moduleId'],
-        'name': value['name'],
-        'order': value['order'],
-        'content_count': value['contentCount'],
-        'content_completed_count': value['contentCompletedCount'],
-        'completion_status': value['completionStatus'],
-    };
-}
-

package/src/models/GetCourseStudentReportingPerformance.ts

@@ -1,66 +0,0 @@
-/* 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 GetCourseStudentReportingPerformance
- */
-export interface GetCourseStudentReportingPerformance {
-    /**
-     * Average of scored quiz and SCORM content rollups in the course, using each content item's score rollup strategy. Null when no score is available.
-     * @type {number}
-     * @memberof GetCourseStudentReportingPerformance
-     */
-    avgScorePercentage: number | null;
-}
-
-/**
- * Check if a given object implements the GetCourseStudentReportingPerformance interface.
- */
-export function instanceOfGetCourseStudentReportingPerformance(value: object): value is GetCourseStudentReportingPerformance {
-    if (!('avgScorePercentage' in value) || value['avgScorePercentage'] === undefined) return false;
-    return true;
-}
-
-export function GetCourseStudentReportingPerformanceFromJSON(json: any): GetCourseStudentReportingPerformance {
-    return GetCourseStudentReportingPerformanceFromJSONTyped(json, false);
-}
-
-export function GetCourseStudentReportingPerformanceFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseStudentReportingPerformance {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'avgScorePercentage': json['avg_score_percentage'],
-    };
-}
-
-export function GetCourseStudentReportingPerformanceToJSON(json: any): GetCourseStudentReportingPerformance {
-    return GetCourseStudentReportingPerformanceToJSONTyped(json, false);
-}
-
-export function GetCourseStudentReportingPerformanceToJSONTyped(value?: GetCourseStudentReportingPerformance | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'avg_score_percentage': value['avgScorePercentage'],
-    };
-}
-