@easyedu/js-lsm-api 1.0.0-677fab496294ee48248fd8a03fee59e3bf0dcf02

package/dist/esm/models/GetCourse.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface GetCourse
+ */
+export interface GetCourse {
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourse
+     */
+    readonly id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourse
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourse
+     */
+    description: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourse
+     */
+    instructor?: string;
+}
+/**
+ * Check if a given object implements the GetCourse interface.
+ */
+export declare function instanceOfGetCourse(value: object): value is GetCourse;
+export declare function GetCourseFromJSON(json: any): GetCourse;
+export declare function GetCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourse;
+export declare function GetCourseToJSON(json: any): GetCourse;
+export declare function GetCourseToJSONTyped(value?: Omit<GetCourse, 'id'> | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetCourse.js

@@ -0,0 +1,52 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the GetCourse interface.
+ */
+export function instanceOfGetCourse(value) {
+    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;
+    return true;
+}
+export function GetCourseFromJSON(json) {
+    return GetCourseFromJSONTyped(json, false);
+}
+export function GetCourseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'instructor': json['instructor'] == null ? undefined : json['instructor'],
+    };
+}
+export function GetCourseToJSON(json) {
+    return GetCourseToJSONTyped(json, false);
+}
+export function GetCourseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'description': value['description'],
+        'instructor': value['instructor'],
+    };
+}

package/dist/esm/models/GetCourseEnrollment.d.ts

@@ -0,0 +1,79 @@
+/**
+ * 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.
+ */
+/**
+ * A course enrollment
+ * @export
+ * @interface GetCourseEnrollment
+ */
+export interface GetCourseEnrollment {
+    /**
+     * The ID of the course
+     * @type {string}
+     * @memberof GetCourseEnrollment
+     */
+    courseId: string;
+    /**
+     * The ID of the enrolled user
+     * @type {string}
+     * @memberof GetCourseEnrollment
+     */
+    userId: string;
+    /**
+     * Start date of the enrollment (Unix timestamp)
+     * @type {number}
+     * @memberof GetCourseEnrollment
+     */
+    enrollmentDateStart: number;
+    /**
+     * End date of the enrollment (Unix timestamp)
+     * @type {number}
+     * @memberof GetCourseEnrollment
+     */
+    enrollmentDateEnd: number;
+    /**
+     * Optional notes about the enrollment
+     * @type {string}
+     * @memberof GetCourseEnrollment
+     */
+    notes: string | null;
+    /**
+     * Current status of the enrollment
+     * @type {string}
+     * @memberof GetCourseEnrollment
+     */
+    status: GetCourseEnrollmentStatusEnum;
+    /**
+     * Date the course was completed (Unix timestamp)
+     * @type {number}
+     * @memberof GetCourseEnrollment
+     */
+    completionDate: number | null;
+}
+/**
+ * @export
+ */
+export declare const GetCourseEnrollmentStatusEnum: {
+    readonly Enrolled: "Enrolled";
+    readonly Dropped: "Dropped";
+    readonly Completed: "Completed";
+    readonly Waitlisted: "Waitlisted";
+    readonly Unknown: "Unknown";
+};
+export type GetCourseEnrollmentStatusEnum = typeof GetCourseEnrollmentStatusEnum[keyof typeof GetCourseEnrollmentStatusEnum];
+/**
+ * Check if a given object implements the GetCourseEnrollment interface.
+ */
+export declare function instanceOfGetCourseEnrollment(value: object): value is GetCourseEnrollment;
+export declare function GetCourseEnrollmentFromJSON(json: any): GetCourseEnrollment;
+export declare function GetCourseEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseEnrollment;
+export declare function GetCourseEnrollmentToJSON(json: any): GetCourseEnrollment;
+export declare function GetCourseEnrollmentToJSONTyped(value?: GetCourseEnrollment | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetCourseEnrollment.js

@@ -0,0 +1,77 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const GetCourseEnrollmentStatusEnum = {
+    Enrolled: 'Enrolled',
+    Dropped: 'Dropped',
+    Completed: 'Completed',
+    Waitlisted: 'Waitlisted',
+    Unknown: 'Unknown'
+};
+/**
+ * Check if a given object implements the GetCourseEnrollment interface.
+ */
+export function instanceOfGetCourseEnrollment(value) {
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined)
+        return false;
+    if (!('enrollmentDateEnd' in value) || value['enrollmentDateEnd'] === undefined)
+        return false;
+    if (!('notes' in value) || value['notes'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('completionDate' in value) || value['completionDate'] === undefined)
+        return false;
+    return true;
+}
+export function GetCourseEnrollmentFromJSON(json) {
+    return GetCourseEnrollmentFromJSONTyped(json, false);
+}
+export function GetCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'courseId': json['course_id'],
+        'userId': json['user_id'],
+        'enrollmentDateStart': json['enrollment_date_start'],
+        'enrollmentDateEnd': json['enrollment_date_end'],
+        'notes': json['notes'],
+        'status': json['status'],
+        'completionDate': json['completion_date'],
+    };
+}
+export function GetCourseEnrollmentToJSON(json) {
+    return GetCourseEnrollmentToJSONTyped(json, false);
+}
+export function GetCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'course_id': value['courseId'],
+        'user_id': value['userId'],
+        'enrollment_date_start': value['enrollmentDateStart'],
+        'enrollment_date_end': value['enrollmentDateEnd'],
+        'notes': value['notes'],
+        'status': value['status'],
+        'completion_date': value['completionDate'],
+    };
+}

package/dist/esm/models/GetCourseEnrollmentList.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 type { GetCourseEnrollment } from './GetCourseEnrollment';
+/**
+ * A list of course enrollments with pagination information
+ * @export
+ * @interface GetCourseEnrollmentList
+ */
+export interface GetCourseEnrollmentList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetCourseEnrollmentList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetCourseEnrollmentList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetCourseEnrollmentList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetCourseEnrollmentList
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {Array<GetCourseEnrollment>}
+     * @memberof GetCourseEnrollmentList
+     */
+    items: Array<GetCourseEnrollment>;
+}
+/**
+ * Check if a given object implements the GetCourseEnrollmentList interface.
+ */
+export declare function instanceOfGetCourseEnrollmentList(value: object): value is GetCourseEnrollmentList;
+export declare function GetCourseEnrollmentListFromJSON(json: any): GetCourseEnrollmentList;
+export declare function GetCourseEnrollmentListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseEnrollmentList;
+export declare function GetCourseEnrollmentListToJSON(json: any): GetCourseEnrollmentList;
+export declare function GetCourseEnrollmentListToJSONTyped(value?: GetCourseEnrollmentList | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetCourseEnrollmentList.js

@@ -0,0 +1,60 @@
+/* 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 { GetCourseEnrollmentFromJSON, GetCourseEnrollmentToJSON, } from './GetCourseEnrollment';
+/**
+ * Check if a given object implements the GetCourseEnrollmentList interface.
+ */
+export function instanceOfGetCourseEnrollmentList(value) {
+    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 GetCourseEnrollmentListFromJSON(json) {
+    return GetCourseEnrollmentListFromJSONTyped(json, false);
+}
+export function GetCourseEnrollmentListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': (json['items'].map(GetCourseEnrollmentFromJSON)),
+    };
+}
+export function GetCourseEnrollmentListToJSON(json) {
+    return GetCourseEnrollmentListToJSONTyped(json, false);
+}
+export function GetCourseEnrollmentListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': (value['items'].map(GetCourseEnrollmentToJSON)),
+    };
+}

package/dist/esm/models/GetCourseList.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 type { GetCourse } 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 declare function instanceOfGetCourseList(value: object): value is GetCourseList;
+export declare function GetCourseListFromJSON(json: any): GetCourseList;
+export declare function GetCourseListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseList;
+export declare function GetCourseListToJSON(json: any): GetCourseList;
+export declare function GetCourseListToJSONTyped(value?: GetCourseList | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetCourseList.js

@@ -0,0 +1,60 @@
+/* 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 { GetCourseFromJSON, GetCourseToJSON, } from './GetCourse';
+/**
+ * Check if a given object implements the GetCourseList interface.
+ */
+export function instanceOfGetCourseList(value) {
+    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) {
+    return GetCourseListFromJSONTyped(json, false);
+}
+export function GetCourseListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': (json['items'].map(GetCourseFromJSON)),
+    };
+}
+export function GetCourseListToJSON(json) {
+    return GetCourseListToJSONTyped(json, false);
+}
+export function GetCourseListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': (value['items'].map(GetCourseToJSON)),
+    };
+}

package/dist/esm/models/GetModule.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface GetModule
+ */
+export interface GetModule {
+    /**
+     *
+     * @type {string}
+     * @memberof GetModule
+     */
+    readonly id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetModule
+     */
+    readonly courseId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetModule
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetModule
+     */
+    description: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GetModule
+     */
+    order: number;
+    /**
+     *
+     * @type {string}
+     * @memberof GetModule
+     */
+    lastUpdated: string;
+}
+/**
+ * Check if a given object implements the GetModule interface.
+ */
+export declare function instanceOfGetModule(value: object): value is GetModule;
+export declare function GetModuleFromJSON(json: any): GetModule;
+export declare function GetModuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetModule;
+export declare function GetModuleToJSON(json: any): GetModule;
+export declare function GetModuleToJSONTyped(value?: Omit<GetModule, 'id' | 'course_id'> | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetModule.js

@@ -0,0 +1,61 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the GetModule interface.
+ */
+export function instanceOfGetModule(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('order' in value) || value['order'] === undefined)
+        return false;
+    if (!('lastUpdated' in value) || value['lastUpdated'] === undefined)
+        return false;
+    return true;
+}
+export function GetModuleFromJSON(json) {
+    return GetModuleFromJSONTyped(json, false);
+}
+export function GetModuleFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'courseId': json['course_id'],
+        'name': json['name'],
+        'description': json['description'],
+        'order': json['order'],
+        'lastUpdated': json['last_updated'],
+    };
+}
+export function GetModuleToJSON(json) {
+    return GetModuleToJSONTyped(json, false);
+}
+export function GetModuleToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'description': value['description'],
+        'order': value['order'],
+        'last_updated': value['lastUpdated'],
+    };
+}

package/dist/esm/models/GetModuleList.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 type { GetModule } from './GetModule';
+/**
+ * A list of modules with pagination information
+ * @export
+ * @interface GetModuleList
+ */
+export interface GetModuleList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetModuleList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetModuleList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetModuleList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetModuleList
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {Array<GetModule>}
+     * @memberof GetModuleList
+     */
+    items: Array<GetModule>;
+}
+/**
+ * Check if a given object implements the GetModuleList interface.
+ */
+export declare function instanceOfGetModuleList(value: object): value is GetModuleList;
+export declare function GetModuleListFromJSON(json: any): GetModuleList;
+export declare function GetModuleListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetModuleList;
+export declare function GetModuleListToJSON(json: any): GetModuleList;
+export declare function GetModuleListToJSONTyped(value?: GetModuleList | null, ignoreDiscriminator?: boolean): any;