@easyedu/js-lsm-api 1.78.0 → 1.80.0

package/src/models/GetCourseEnrollmentListItem.ts

@@ -0,0 +1,207 @@
+/* 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';
+/**
+ * A course enrollment in a list view
+ * @export
+ * @interface GetCourseEnrollmentListItem
+ */
+export interface GetCourseEnrollmentListItem {
+    /**
+     * The external ID of the enrollment
+     * @type {string}
+     * @memberof GetCourseEnrollmentListItem
+     */
+    id: string;
+    /**
+     * The external ID of the course
+     * @type {string}
+     * @memberof GetCourseEnrollmentListItem
+     */
+    courseId: string;
+    /**
+     * The external ID of the enrolled user
+     * @type {string}
+     * @memberof GetCourseEnrollmentListItem
+     */
+    userId: string;
+    /**
+     * The first name of the enrolled user
+     * @type {string}
+     * @memberof GetCourseEnrollmentListItem
+     */
+    firstName: string;
+    /**
+     * The last name of the enrolled user
+     * @type {string}
+     * @memberof GetCourseEnrollmentListItem
+     */
+    lastName: string;
+    /**
+     * Start date of the enrollment (Unix timestamp)
+     * @type {number}
+     * @memberof GetCourseEnrollmentListItem
+     */
+    enrollmentDateStart: number;
+    /**
+     * End date of the enrollment (Unix timestamp)
+     * @type {number}
+     * @memberof GetCourseEnrollmentListItem
+     */
+    enrollmentDateEnd: number | null;
+    /**
+     * Current status of the enrollment
+     * @type {GetCourseEnrollmentListItemStatusEnum}
+     * @memberof GetCourseEnrollmentListItem
+     */
+    status: GetCourseEnrollmentListItemStatusEnum;
+    /**
+     * Derived learner access state for UI indicators and access decisions.
+     * @type {GetCourseEnrollmentListItemAccessStateEnum}
+     * @memberof GetCourseEnrollmentListItem
+     */
+    accessState: GetCourseEnrollmentListItemAccessStateEnum;
+    /**
+     * Whole days until access expiry; null for never-expiring or already inactive enrollments.
+     * @type {number}
+     * @memberof GetCourseEnrollmentListItem
+     */
+    daysUntilExpiry: number | null;
+    /**
+     * The role/type of the user in this enrollment
+     * @type {GetCourseEnrollmentListItemUserTypeEnum}
+     * @memberof GetCourseEnrollmentListItem
+     */
+    userType: GetCourseEnrollmentListItemUserTypeEnum;
+    /**
+     * Date the course was completed (Unix timestamp)
+     * @type {number}
+     * @memberof GetCourseEnrollmentListItem
+     */
+    completionDate: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const GetCourseEnrollmentListItemStatusEnum = {
+    Enrolled: 'Enrolled',
+    InProgress: 'InProgress',
+    Completed: 'Completed',
+    Failed: 'Failed',
+    Expired: 'Expired',
+    Withdrawn: 'Withdrawn',
+    Removed: 'Removed',
+    Archived: 'Archived',
+    Suspended: 'Suspended'
+} as const;
+export type GetCourseEnrollmentListItemStatusEnum = typeof GetCourseEnrollmentListItemStatusEnum[keyof typeof GetCourseEnrollmentListItemStatusEnum];
+
+/**
+ * @export
+ */
+export const GetCourseEnrollmentListItemAccessStateEnum = {
+    Active: 'active',
+    CompletedReview: 'completed_review',
+    Expired: 'expired',
+    Suspended: 'suspended',
+    Failed: 'failed',
+    Withdrawn: 'withdrawn',
+    Removed: 'removed',
+    Archived: 'archived'
+} as const;
+export type GetCourseEnrollmentListItemAccessStateEnum = typeof GetCourseEnrollmentListItemAccessStateEnum[keyof typeof GetCourseEnrollmentListItemAccessStateEnum];
+
+/**
+ * @export
+ */
+export const GetCourseEnrollmentListItemUserTypeEnum = {
+    Student: 'Student',
+    Instructor: 'Instructor'
+} as const;
+export type GetCourseEnrollmentListItemUserTypeEnum = typeof GetCourseEnrollmentListItemUserTypeEnum[keyof typeof GetCourseEnrollmentListItemUserTypeEnum];
+
+
+/**
+ * Check if a given object implements the GetCourseEnrollmentListItem interface.
+ */
+export function instanceOfGetCourseEnrollmentListItem(value: object): value is GetCourseEnrollmentListItem {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('courseId' in value) || value['courseId'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    if (!('firstName' in value) || value['firstName'] === undefined) return false;
+    if (!('lastName' in value) || value['lastName'] === undefined) return false;
+    if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined) return false;
+    if (!('enrollmentDateEnd' in value) || value['enrollmentDateEnd'] === 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 (!('completionDate' in value) || value['completionDate'] === undefined) return false;
+    return true;
+}
+
+export function GetCourseEnrollmentListItemFromJSON(json: any): GetCourseEnrollmentListItem {
+    return GetCourseEnrollmentListItemFromJSONTyped(json, false);
+}
+
+export function GetCourseEnrollmentListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseEnrollmentListItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'courseId': json['course_id'],
+        'userId': json['user_id'],
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+        'enrollmentDateStart': json['enrollment_date_start'],
+        'enrollmentDateEnd': json['enrollment_date_end'],
+        'status': json['status'],
+        'accessState': json['access_state'],
+        'daysUntilExpiry': json['days_until_expiry'],
+        'userType': json['user_type'],
+        'completionDate': json['completion_date'],
+    };
+}
+
+export function GetCourseEnrollmentListItemToJSON(json: any): GetCourseEnrollmentListItem {
+    return GetCourseEnrollmentListItemToJSONTyped(json, false);
+}
+
+export function GetCourseEnrollmentListItemToJSONTyped(value?: GetCourseEnrollmentListItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'course_id': value['courseId'],
+        'user_id': value['userId'],
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+        'enrollment_date_start': value['enrollmentDateStart'],
+        'enrollment_date_end': value['enrollmentDateEnd'],
+        'status': value['status'],
+        'access_state': value['accessState'],
+        'days_until_expiry': value['daysUntilExpiry'],
+        'user_type': value['userType'],
+        'completion_date': value['completionDate'],
+    };
+}
+

package/src/models/GetCourseExport.ts

@@ -0,0 +1,167 @@
+/* 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';
+/**
+ * Details of a course export
+ * @export
+ * @interface GetCourseExport
+ */
+export interface GetCourseExport {
+    /**
+     * Unique identifier for the export
+     * @type {string}
+     * @memberof GetCourseExport
+     */
+    id: string;
+    /**
+     * ID of the course being exported
+     * @type {string}
+     * @memberof GetCourseExport
+     */
+    courseId: string;
+    /**
+     * The export format type
+     * @type {GetCourseExportExportTypeEnum}
+     * @memberof GetCourseExport
+     */
+    exportType: GetCourseExportExportTypeEnum;
+    /**
+     * IDs of the modules included in the export
+     * @type {Array<string>}
+     * @memberof GetCourseExport
+     */
+    moduleIds: Array<string>;
+    /**
+     * ID of the user who requested the export
+     * @type {number}
+     * @memberof GetCourseExport
+     */
+    createdBy: number;
+    /**
+     * Current status of the export generation
+     * @type {GetCourseExportStatusEnum}
+     * @memberof GetCourseExport
+     */
+    status: GetCourseExportStatusEnum;
+    /**
+     * URL to download the export file (null if not yet completed)
+     * @type {string}
+     * @memberof GetCourseExport
+     */
+    downloadUrl?: string | null;
+    /**
+     * Size of the export file in bytes (null if not yet completed)
+     * @type {number}
+     * @memberof GetCourseExport
+     */
+    fileSize?: number | null;
+    /**
+     * Error message if status is FAILED
+     * @type {string}
+     * @memberof GetCourseExport
+     */
+    errorMessage?: string | null;
+    /**
+     * Unix epoch timestamp when the export was created
+     * @type {number}
+     * @memberof GetCourseExport
+     */
+    createdAt: number;
+}
+
+
+/**
+ * @export
+ */
+export const GetCourseExportExportTypeEnum = {
+    Scorm12: 'SCORM_1_2',
+    Scorm20043RdEdition: 'SCORM_2004_3RD_EDITION',
+    Scorm20044ThEdition: 'SCORM_2004_4TH_EDITION'
+} as const;
+export type GetCourseExportExportTypeEnum = typeof GetCourseExportExportTypeEnum[keyof typeof GetCourseExportExportTypeEnum];
+
+/**
+ * @export
+ */
+export const GetCourseExportStatusEnum = {
+    Pending: 'PENDING',
+    Processing: 'PROCESSING',
+    Completed: 'COMPLETED',
+    Failed: 'FAILED'
+} as const;
+export type GetCourseExportStatusEnum = typeof GetCourseExportStatusEnum[keyof typeof GetCourseExportStatusEnum];
+
+
+/**
+ * Check if a given object implements the GetCourseExport interface.
+ */
+export function instanceOfGetCourseExport(value: object): value is GetCourseExport {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('courseId' in value) || value['courseId'] === undefined) return false;
+    if (!('exportType' in value) || value['exportType'] === undefined) return false;
+    if (!('moduleIds' in value) || value['moduleIds'] === undefined) return false;
+    if (!('createdBy' in value) || value['createdBy'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function GetCourseExportFromJSON(json: any): GetCourseExport {
+    return GetCourseExportFromJSONTyped(json, false);
+}
+
+export function GetCourseExportFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseExport {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'courseId': json['course_id'],
+        'exportType': json['export_type'],
+        'moduleIds': json['module_ids'],
+        'createdBy': json['created_by'],
+        'status': json['status'],
+        'downloadUrl': json['download_url'] == null ? undefined : json['download_url'],
+        'fileSize': json['file_size'] == null ? undefined : json['file_size'],
+        'errorMessage': json['error_message'] == null ? undefined : json['error_message'],
+        'createdAt': json['created_at'],
+    };
+}
+
+export function GetCourseExportToJSON(json: any): GetCourseExport {
+    return GetCourseExportToJSONTyped(json, false);
+}
+
+export function GetCourseExportToJSONTyped(value?: GetCourseExport | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'course_id': value['courseId'],
+        'export_type': value['exportType'],
+        'module_ids': value['moduleIds'],
+        'created_by': value['createdBy'],
+        'status': value['status'],
+        'download_url': value['downloadUrl'],
+        'file_size': value['fileSize'],
+        'error_message': value['errorMessage'],
+        'created_at': value['createdAt'],
+    };
+}
+

package/src/models/GetCourseExportList.ts

@@ -0,0 +1,110 @@
+/* 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 { GetCourseExport } from './GetCourseExport';
+import {
+    GetCourseExportFromJSON,
+    GetCourseExportFromJSONTyped,
+    GetCourseExportToJSON,
+    GetCourseExportToJSONTyped,
+} from './GetCourseExport';
+
+/**
+ * A list of course exports with pagination information
+ * @export
+ * @interface GetCourseExportList
+ */
+export interface GetCourseExportList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetCourseExportList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetCourseExportList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetCourseExportList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetCourseExportList
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {Array<GetCourseExport>}
+     * @memberof GetCourseExportList
+     */
+    items: Array<GetCourseExport>;
+}
+
+/**
+ * Check if a given object implements the GetCourseExportList interface.
+ */
+export function instanceOfGetCourseExportList(value: object): value is GetCourseExportList {
+    if (!('page' in value) || value['page'] === undefined) return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined) return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined) return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined) return false;
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetCourseExportListFromJSON(json: any): GetCourseExportList {
+    return GetCourseExportListFromJSONTyped(json, false);
+}
+
+export function GetCourseExportListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseExportList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalPages': json['total_pages'],
+        'totalItems': json['total_items'],
+        'items': ((json['items'] as Array<any>).map(GetCourseExportFromJSON)),
+    };
+}
+
+export function GetCourseExportListToJSON(json: any): GetCourseExportList {
+    return GetCourseExportListToJSONTyped(json, false);
+}
+
+export function GetCourseExportListToJSONTyped(value?: GetCourseExportList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_pages': value['totalPages'],
+        'total_items': value['totalItems'],
+        'items': ((value['items'] as Array<any>).map(GetCourseExportToJSON)),
+    };
+}
+

package/src/models/GetCourseImageUpload.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 GetCourseImageUpload
+ */
+export interface GetCourseImageUpload {
+    /**
+     * Presigned URL for the uploaded course image
+     * @type {string}
+     * @memberof GetCourseImageUpload
+     */
+    imageUrl: string;
+}
+
+/**
+ * Check if a given object implements the GetCourseImageUpload interface.
+ */
+export function instanceOfGetCourseImageUpload(value: object): value is GetCourseImageUpload {
+    if (!('imageUrl' in value) || value['imageUrl'] === undefined) return false;
+    return true;
+}
+
+export function GetCourseImageUploadFromJSON(json: any): GetCourseImageUpload {
+    return GetCourseImageUploadFromJSONTyped(json, false);
+}
+
+export function GetCourseImageUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseImageUpload {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'imageUrl': json['image_url'],
+    };
+}
+
+export function GetCourseImageUploadToJSON(json: any): GetCourseImageUpload {
+    return GetCourseImageUploadToJSONTyped(json, false);
+}
+
+export function GetCourseImageUploadToJSONTyped(value?: GetCourseImageUpload | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'image_url': value['imageUrl'],
+    };
+}
+

package/src/models/GetCourseList.ts

@@ -0,0 +1,110 @@
+/* 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 { GetCourse } from './GetCourse';
+import {
+    GetCourseFromJSON,
+    GetCourseFromJSONTyped,
+    GetCourseToJSON,
+    GetCourseToJSONTyped,
+} from './GetCourse';
+
+/**
+ * A list of courses with pagination information
+ * @export
+ * @interface GetCourseList
+ */
+export interface GetCourseList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetCourseList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetCourseList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetCourseList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetCourseList
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {Array<GetCourse>}
+     * @memberof GetCourseList
+     */
+    items: Array<GetCourse>;
+}
+
+/**
+ * Check if a given object implements the GetCourseList interface.
+ */
+export function instanceOfGetCourseList(value: object): value is GetCourseList {
+    if (!('page' in value) || value['page'] === undefined) return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined) return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined) return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined) return false;
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetCourseListFromJSON(json: any): GetCourseList {
+    return GetCourseListFromJSONTyped(json, false);
+}
+
+export function GetCourseListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalPages': json['total_pages'],
+        'totalItems': json['total_items'],
+        'items': ((json['items'] as Array<any>).map(GetCourseFromJSON)),
+    };
+}
+
+export function GetCourseListToJSON(json: any): GetCourseList {
+    return GetCourseListToJSONTyped(json, false);
+}
+
+export function GetCourseListToJSONTyped(value?: GetCourseList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_pages': value['totalPages'],
+        'total_items': value['totalItems'],
+        'items': ((value['items'] as Array<any>).map(GetCourseToJSON)),
+    };
+}
+