@easyedu/js-lsm-api 1.14.0 → 1.16.0

package/src/models/GetModuleStudentReporting.ts

@@ -0,0 +1,106 @@
+/* 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 { GetModuleInstructorBasicReportingModuleInfo } from './GetModuleInstructorBasicReportingModuleInfo';
+import {
+    GetModuleInstructorBasicReportingModuleInfoFromJSON,
+    GetModuleInstructorBasicReportingModuleInfoFromJSONTyped,
+    GetModuleInstructorBasicReportingModuleInfoToJSON,
+    GetModuleInstructorBasicReportingModuleInfoToJSONTyped,
+} from './GetModuleInstructorBasicReportingModuleInfo';
+import type { GetModuleStudentReportingAccess } from './GetModuleStudentReportingAccess';
+import {
+    GetModuleStudentReportingAccessFromJSON,
+    GetModuleStudentReportingAccessFromJSONTyped,
+    GetModuleStudentReportingAccessToJSON,
+    GetModuleStudentReportingAccessToJSONTyped,
+} from './GetModuleStudentReportingAccess';
+import type { GetModuleStudentReportingProgress } from './GetModuleStudentReportingProgress';
+import {
+    GetModuleStudentReportingProgressFromJSON,
+    GetModuleStudentReportingProgressFromJSONTyped,
+    GetModuleStudentReportingProgressToJSON,
+    GetModuleStudentReportingProgressToJSONTyped,
+} from './GetModuleStudentReportingProgress';
+
+/**
+ * 
+ * @export
+ * @interface GetModuleStudentReporting
+ */
+export interface GetModuleStudentReporting {
+    /**
+     * 
+     * @type {GetModuleInstructorBasicReportingModuleInfo}
+     * @memberof GetModuleStudentReporting
+     */
+    moduleInfo: GetModuleInstructorBasicReportingModuleInfo;
+    /**
+     * 
+     * @type {GetModuleStudentReportingProgress}
+     * @memberof GetModuleStudentReporting
+     */
+    progress: GetModuleStudentReportingProgress;
+    /**
+     * 
+     * @type {GetModuleStudentReportingAccess}
+     * @memberof GetModuleStudentReporting
+     */
+    access: GetModuleStudentReportingAccess;
+}
+
+/**
+ * Check if a given object implements the GetModuleStudentReporting interface.
+ */
+export function instanceOfGetModuleStudentReporting(value: object): value is GetModuleStudentReporting {
+    if (!('moduleInfo' in value) || value['moduleInfo'] === undefined) return false;
+    if (!('progress' in value) || value['progress'] === undefined) return false;
+    if (!('access' in value) || value['access'] === undefined) return false;
+    return true;
+}
+
+export function GetModuleStudentReportingFromJSON(json: any): GetModuleStudentReporting {
+    return GetModuleStudentReportingFromJSONTyped(json, false);
+}
+
+export function GetModuleStudentReportingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetModuleStudentReporting {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'moduleInfo': GetModuleInstructorBasicReportingModuleInfoFromJSON(json['module_info']),
+        'progress': GetModuleStudentReportingProgressFromJSON(json['progress']),
+        'access': GetModuleStudentReportingAccessFromJSON(json['access']),
+    };
+}
+
+export function GetModuleStudentReportingToJSON(json: any): GetModuleStudentReporting {
+    return GetModuleStudentReportingToJSONTyped(json, false);
+}
+
+export function GetModuleStudentReportingToJSONTyped(value?: GetModuleStudentReporting | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'module_info': GetModuleInstructorBasicReportingModuleInfoToJSON(value['moduleInfo']),
+        'progress': GetModuleStudentReportingProgressToJSON(value['progress']),
+        'access': GetModuleStudentReportingAccessToJSON(value['access']),
+    };
+}
+

package/src/models/GetModuleStudentReportingAccess.ts

@@ -0,0 +1,75 @@
+/* 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 GetModuleStudentReportingAccess
+ */
+export interface GetModuleStudentReportingAccess {
+    /**
+     * Last access timestamp (epoch seconds)
+     * @type {number}
+     * @memberof GetModuleStudentReportingAccess
+     */
+    lastAccessedAt: number | null;
+    /**
+     * Total time spent on the module in hours
+     * @type {number}
+     * @memberof GetModuleStudentReportingAccess
+     */
+    totalTimeSpent: number | null;
+}
+
+/**
+ * Check if a given object implements the GetModuleStudentReportingAccess interface.
+ */
+export function instanceOfGetModuleStudentReportingAccess(value: object): value is GetModuleStudentReportingAccess {
+    if (!('lastAccessedAt' in value) || value['lastAccessedAt'] === undefined) return false;
+    if (!('totalTimeSpent' in value) || value['totalTimeSpent'] === undefined) return false;
+    return true;
+}
+
+export function GetModuleStudentReportingAccessFromJSON(json: any): GetModuleStudentReportingAccess {
+    return GetModuleStudentReportingAccessFromJSONTyped(json, false);
+}
+
+export function GetModuleStudentReportingAccessFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetModuleStudentReportingAccess {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'lastAccessedAt': json['last_accessed_at'],
+        'totalTimeSpent': json['total_time_spent'],
+    };
+}
+
+export function GetModuleStudentReportingAccessToJSON(json: any): GetModuleStudentReportingAccess {
+    return GetModuleStudentReportingAccessToJSONTyped(json, false);
+}
+
+export function GetModuleStudentReportingAccessToJSONTyped(value?: GetModuleStudentReportingAccess | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'last_accessed_at': value['lastAccessedAt'],
+        'total_time_spent': value['totalTimeSpent'],
+    };
+}
+

package/src/models/GetModuleStudentReportingProgress.ts

@@ -0,0 +1,75 @@
+/* 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 GetModuleStudentReportingProgress
+ */
+export interface GetModuleStudentReportingProgress {
+    /**
+     * Number of content items completed by the user
+     * @type {number}
+     * @memberof GetModuleStudentReportingProgress
+     */
+    contentCompletedCount: number;
+    /**
+     * Total time spent on the module in hours
+     * @type {number}
+     * @memberof GetModuleStudentReportingProgress
+     */
+    totalTimeSpent: number | null;
+}
+
+/**
+ * Check if a given object implements the GetModuleStudentReportingProgress interface.
+ */
+export function instanceOfGetModuleStudentReportingProgress(value: object): value is GetModuleStudentReportingProgress {
+    if (!('contentCompletedCount' in value) || value['contentCompletedCount'] === undefined) return false;
+    if (!('totalTimeSpent' in value) || value['totalTimeSpent'] === undefined) return false;
+    return true;
+}
+
+export function GetModuleStudentReportingProgressFromJSON(json: any): GetModuleStudentReportingProgress {
+    return GetModuleStudentReportingProgressFromJSONTyped(json, false);
+}
+
+export function GetModuleStudentReportingProgressFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetModuleStudentReportingProgress {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'contentCompletedCount': json['content_completed_count'],
+        'totalTimeSpent': json['total_time_spent'],
+    };
+}
+
+export function GetModuleStudentReportingProgressToJSON(json: any): GetModuleStudentReportingProgress {
+    return GetModuleStudentReportingProgressToJSONTyped(json, false);
+}
+
+export function GetModuleStudentReportingProgressToJSONTyped(value?: GetModuleStudentReportingProgress | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'content_completed_count': value['contentCompletedCount'],
+        'total_time_spent': value['totalTimeSpent'],
+    };
+}
+

package/src/models/GetPortalBasicReporting.ts

@@ -0,0 +1,90 @@
+/* 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 { GetPortalBasicReportingPortalInfo } from './GetPortalBasicReportingPortalInfo';
+import {
+    GetPortalBasicReportingPortalInfoFromJSON,
+    GetPortalBasicReportingPortalInfoFromJSONTyped,
+    GetPortalBasicReportingPortalInfoToJSON,
+    GetPortalBasicReportingPortalInfoToJSONTyped,
+} from './GetPortalBasicReportingPortalInfo';
+import type { GetPortalBasicReportingCertificates } from './GetPortalBasicReportingCertificates';
+import {
+    GetPortalBasicReportingCertificatesFromJSON,
+    GetPortalBasicReportingCertificatesFromJSONTyped,
+    GetPortalBasicReportingCertificatesToJSON,
+    GetPortalBasicReportingCertificatesToJSONTyped,
+} from './GetPortalBasicReportingCertificates';
+
+/**
+ * 
+ * @export
+ * @interface GetPortalBasicReporting
+ */
+export interface GetPortalBasicReporting {
+    /**
+     * 
+     * @type {GetPortalBasicReportingPortalInfo}
+     * @memberof GetPortalBasicReporting
+     */
+    portalInfo: GetPortalBasicReportingPortalInfo;
+    /**
+     * 
+     * @type {GetPortalBasicReportingCertificates}
+     * @memberof GetPortalBasicReporting
+     */
+    certificates: GetPortalBasicReportingCertificates;
+}
+
+/**
+ * Check if a given object implements the GetPortalBasicReporting interface.
+ */
+export function instanceOfGetPortalBasicReporting(value: object): value is GetPortalBasicReporting {
+    if (!('portalInfo' in value) || value['portalInfo'] === undefined) return false;
+    if (!('certificates' in value) || value['certificates'] === undefined) return false;
+    return true;
+}
+
+export function GetPortalBasicReportingFromJSON(json: any): GetPortalBasicReporting {
+    return GetPortalBasicReportingFromJSONTyped(json, false);
+}
+
+export function GetPortalBasicReportingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalBasicReporting {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'portalInfo': GetPortalBasicReportingPortalInfoFromJSON(json['portal_info']),
+        'certificates': GetPortalBasicReportingCertificatesFromJSON(json['certificates']),
+    };
+}
+
+export function GetPortalBasicReportingToJSON(json: any): GetPortalBasicReporting {
+    return GetPortalBasicReportingToJSONTyped(json, false);
+}
+
+export function GetPortalBasicReportingToJSONTyped(value?: GetPortalBasicReporting | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'portal_info': GetPortalBasicReportingPortalInfoToJSON(value['portalInfo']),
+        'certificates': GetPortalBasicReportingCertificatesToJSON(value['certificates']),
+    };
+}
+

package/src/models/GetPortalBasicReportingCertificates.ts

@@ -0,0 +1,66 @@
+/* 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 GetPortalBasicReportingCertificates
+ */
+export interface GetPortalBasicReportingCertificates {
+    /**
+     * Total number of certificates earned in the portal
+     * @type {number}
+     * @memberof GetPortalBasicReportingCertificates
+     */
+    certificatesEarnedCount: number;
+}
+
+/**
+ * Check if a given object implements the GetPortalBasicReportingCertificates interface.
+ */
+export function instanceOfGetPortalBasicReportingCertificates(value: object): value is GetPortalBasicReportingCertificates {
+    if (!('certificatesEarnedCount' in value) || value['certificatesEarnedCount'] === undefined) return false;
+    return true;
+}
+
+export function GetPortalBasicReportingCertificatesFromJSON(json: any): GetPortalBasicReportingCertificates {
+    return GetPortalBasicReportingCertificatesFromJSONTyped(json, false);
+}
+
+export function GetPortalBasicReportingCertificatesFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalBasicReportingCertificates {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'certificatesEarnedCount': json['certificates_earned_count'],
+    };
+}
+
+export function GetPortalBasicReportingCertificatesToJSON(json: any): GetPortalBasicReportingCertificates {
+    return GetPortalBasicReportingCertificatesToJSONTyped(json, false);
+}
+
+export function GetPortalBasicReportingCertificatesToJSONTyped(value?: GetPortalBasicReportingCertificates | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'certificates_earned_count': value['certificatesEarnedCount'],
+    };
+}
+

package/src/models/GetPortalBasicReportingPortalInfo.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';
+/**
+ * 
+ * @export
+ * @interface GetPortalBasicReportingPortalInfo
+ */
+export interface GetPortalBasicReportingPortalInfo {
+    /**
+     * Total number of students in the portal
+     * @type {number}
+     * @memberof GetPortalBasicReportingPortalInfo
+     */
+    studentCount: number;
+    /**
+     * Total number of instructors in the portal
+     * @type {number}
+     * @memberof GetPortalBasicReportingPortalInfo
+     */
+    instructorCount: number;
+    /**
+     * Total number of courses in the portal
+     * @type {number}
+     * @memberof GetPortalBasicReportingPortalInfo
+     */
+    courseCount: number;
+}
+
+/**
+ * Check if a given object implements the GetPortalBasicReportingPortalInfo interface.
+ */
+export function instanceOfGetPortalBasicReportingPortalInfo(value: object): value is GetPortalBasicReportingPortalInfo {
+    if (!('studentCount' in value) || value['studentCount'] === undefined) return false;
+    if (!('instructorCount' in value) || value['instructorCount'] === undefined) return false;
+    if (!('courseCount' in value) || value['courseCount'] === undefined) return false;
+    return true;
+}
+
+export function GetPortalBasicReportingPortalInfoFromJSON(json: any): GetPortalBasicReportingPortalInfo {
+    return GetPortalBasicReportingPortalInfoFromJSONTyped(json, false);
+}
+
+export function GetPortalBasicReportingPortalInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalBasicReportingPortalInfo {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'studentCount': json['student_count'],
+        'instructorCount': json['instructor_count'],
+        'courseCount': json['course_count'],
+    };
+}
+
+export function GetPortalBasicReportingPortalInfoToJSON(json: any): GetPortalBasicReportingPortalInfo {
+    return GetPortalBasicReportingPortalInfoToJSONTyped(json, false);
+}
+
+export function GetPortalBasicReportingPortalInfoToJSONTyped(value?: GetPortalBasicReportingPortalInfo | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'student_count': value['studentCount'],
+        'instructor_count': value['instructorCount'],
+        'course_count': value['courseCount'],
+    };
+}
+

package/src/models/ScormSessionData.ts

@@ -0,0 +1,133 @@
+/* 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 { ScormSessionDataSession } from './ScormSessionDataSession';
+import {
+    ScormSessionDataSessionFromJSON,
+    ScormSessionDataSessionFromJSONTyped,
+    ScormSessionDataSessionToJSON,
+    ScormSessionDataSessionToJSONTyped,
+} from './ScormSessionDataSession';
+import type { ScormSessionDataScore } from './ScormSessionDataScore';
+import {
+    ScormSessionDataScoreFromJSON,
+    ScormSessionDataScoreFromJSONTyped,
+    ScormSessionDataScoreToJSON,
+    ScormSessionDataScoreToJSONTyped,
+} from './ScormSessionDataScore';
+import type { ScormSessionDataStatus } from './ScormSessionDataStatus';
+import {
+    ScormSessionDataStatusFromJSON,
+    ScormSessionDataStatusFromJSONTyped,
+    ScormSessionDataStatusToJSON,
+    ScormSessionDataStatusToJSONTyped,
+} from './ScormSessionDataStatus';
+import type { ScormSessionDataTime } from './ScormSessionDataTime';
+import {
+    ScormSessionDataTimeFromJSON,
+    ScormSessionDataTimeFromJSONTyped,
+    ScormSessionDataTimeToJSON,
+    ScormSessionDataTimeToJSONTyped,
+} from './ScormSessionDataTime';
+import type { ScormSessionDataProgress } from './ScormSessionDataProgress';
+import {
+    ScormSessionDataProgressFromJSON,
+    ScormSessionDataProgressFromJSONTyped,
+    ScormSessionDataProgressToJSON,
+    ScormSessionDataProgressToJSONTyped,
+} from './ScormSessionDataProgress';
+
+/**
+ * Detailed SCORM session data
+ * @export
+ * @interface ScormSessionData
+ */
+export interface ScormSessionData {
+    /**
+     * 
+     * @type {ScormSessionDataStatus}
+     * @memberof ScormSessionData
+     */
+    status?: ScormSessionDataStatus;
+    /**
+     * 
+     * @type {ScormSessionDataScore}
+     * @memberof ScormSessionData
+     */
+    score?: ScormSessionDataScore;
+    /**
+     * 
+     * @type {ScormSessionDataTime}
+     * @memberof ScormSessionData
+     */
+    time?: ScormSessionDataTime;
+    /**
+     * 
+     * @type {ScormSessionDataSession}
+     * @memberof ScormSessionData
+     */
+    session?: ScormSessionDataSession;
+    /**
+     * 
+     * @type {ScormSessionDataProgress}
+     * @memberof ScormSessionData
+     */
+    progress?: ScormSessionDataProgress;
+}
+
+/**
+ * Check if a given object implements the ScormSessionData interface.
+ */
+export function instanceOfScormSessionData(value: object): value is ScormSessionData {
+    return true;
+}
+
+export function ScormSessionDataFromJSON(json: any): ScormSessionData {
+    return ScormSessionDataFromJSONTyped(json, false);
+}
+
+export function ScormSessionDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScormSessionData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'status': json['status'] == null ? undefined : ScormSessionDataStatusFromJSON(json['status']),
+        'score': json['score'] == null ? undefined : ScormSessionDataScoreFromJSON(json['score']),
+        'time': json['time'] == null ? undefined : ScormSessionDataTimeFromJSON(json['time']),
+        'session': json['session'] == null ? undefined : ScormSessionDataSessionFromJSON(json['session']),
+        'progress': json['progress'] == null ? undefined : ScormSessionDataProgressFromJSON(json['progress']),
+    };
+}
+
+export function ScormSessionDataToJSON(json: any): ScormSessionData {
+    return ScormSessionDataToJSONTyped(json, false);
+}
+
+export function ScormSessionDataToJSONTyped(value?: ScormSessionData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'status': ScormSessionDataStatusToJSON(value['status']),
+        'score': ScormSessionDataScoreToJSON(value['score']),
+        'time': ScormSessionDataTimeToJSON(value['time']),
+        'session': ScormSessionDataSessionToJSON(value['session']),
+        'progress': ScormSessionDataProgressToJSON(value['progress']),
+    };
+}
+