@easyedu/js-lsm-api 1.7.0 → 1.9.0

package/dist/esm/models/GetCourseEnrollment.js

@@ -16,15 +16,15 @@
  */
 export const GetCourseEnrollmentStatusEnum = {
     Enrolled: 'Enrolled',
-    Dropped: 'Dropped',
     Completed: 'Completed',
-    Waitlisted: 'Waitlisted',
-    Unknown: 'Unknown'
+    Removed: 'Removed'
 };
 /**
  * Check if a given object implements the GetCourseEnrollment interface.
  */
 export function instanceOfGetCourseEnrollment(value) {
+    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)
@@ -49,6 +49,7 @@ export function GetCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'id': json['id'],
         'courseId': json['course_id'],
         'userId': json['user_id'],
         'enrollmentDateStart': json['enrollment_date_start'],
@@ -66,6 +67,7 @@ export function GetCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = fals
         return value;
     }
     return {
+        'id': value['id'],
         'course_id': value['courseId'],
         'user_id': value['userId'],
         'enrollment_date_start': value['enrollmentDateStart'],

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

@@ -0,0 +1,71 @@
+/**
+ * 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 user with their portal access information
+ * @export
+ * @interface GetPortalUser
+ */
+export interface GetPortalUser {
+    /**
+     * The unique identifier for the user
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    userId: string;
+    /**
+     * The user's email address
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    email: string;
+    /**
+     * The user's first name
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    firstName: string;
+    /**
+     * The user's last name
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    lastName: string;
+    /**
+     * The user's role in the portal
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    role: GetPortalUserRoleEnum;
+    /**
+     * Whether the user's portal access is active
+     * @type {boolean}
+     * @memberof GetPortalUser
+     */
+    isActive: boolean;
+}
+/**
+ * @export
+ */
+export declare const GetPortalUserRoleEnum: {
+    readonly Admin: "Admin";
+    readonly Instructor: "Instructor";
+    readonly Learner: "Learner";
+};
+export type GetPortalUserRoleEnum = typeof GetPortalUserRoleEnum[keyof typeof GetPortalUserRoleEnum];
+/**
+ * Check if a given object implements the GetPortalUser interface.
+ */
+export declare function instanceOfGetPortalUser(value: object): value is GetPortalUser;
+export declare function GetPortalUserFromJSON(json: any): GetPortalUser;
+export declare function GetPortalUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalUser;
+export declare function GetPortalUserToJSON(json: any): GetPortalUser;
+export declare function GetPortalUserToJSONTyped(value?: GetPortalUser | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetPortalUser.js

@@ -0,0 +1,71 @@
+/* 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 GetPortalUserRoleEnum = {
+    Admin: 'Admin',
+    Instructor: 'Instructor',
+    Learner: 'Learner'
+};
+/**
+ * Check if a given object implements the GetPortalUser interface.
+ */
+export function instanceOfGetPortalUser(value) {
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('email' in value) || value['email'] === undefined)
+        return false;
+    if (!('firstName' in value) || value['firstName'] === undefined)
+        return false;
+    if (!('lastName' in value) || value['lastName'] === undefined)
+        return false;
+    if (!('role' in value) || value['role'] === undefined)
+        return false;
+    if (!('isActive' in value) || value['isActive'] === undefined)
+        return false;
+    return true;
+}
+export function GetPortalUserFromJSON(json) {
+    return GetPortalUserFromJSONTyped(json, false);
+}
+export function GetPortalUserFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'userId': json['user_id'],
+        'email': json['email'],
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+        'role': json['role'],
+        'isActive': json['is_active'],
+    };
+}
+export function GetPortalUserToJSON(json) {
+    return GetPortalUserToJSONTyped(json, false);
+}
+export function GetPortalUserToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'user_id': value['userId'],
+        'email': value['email'],
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+        'role': value['role'],
+        'is_active': value['isActive'],
+    };
+}

package/dist/esm/models/GetPortalUserList.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 { GetPortalUser } from './GetPortalUser';
+/**
+ * A list of portal users with pagination information
+ * @export
+ * @interface GetPortalUserList
+ */
+export interface GetPortalUserList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetPortalUserList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetPortalUserList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetPortalUserList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetPortalUserList
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {Array<GetPortalUser>}
+     * @memberof GetPortalUserList
+     */
+    items: Array<GetPortalUser>;
+}
+/**
+ * Check if a given object implements the GetPortalUserList interface.
+ */
+export declare function instanceOfGetPortalUserList(value: object): value is GetPortalUserList;
+export declare function GetPortalUserListFromJSON(json: any): GetPortalUserList;
+export declare function GetPortalUserListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalUserList;
+export declare function GetPortalUserListToJSON(json: any): GetPortalUserList;
+export declare function GetPortalUserListToJSONTyped(value?: GetPortalUserList | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetPortalUserList.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 { GetPortalUserFromJSON, GetPortalUserToJSON, } from './GetPortalUser';
+/**
+ * Check if a given object implements the GetPortalUserList interface.
+ */
+export function instanceOfGetPortalUserList(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 GetPortalUserListFromJSON(json) {
+    return GetPortalUserListFromJSONTyped(json, false);
+}
+export function GetPortalUserListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalPages': json['total_pages'],
+        'totalItems': json['total_items'],
+        'items': (json['items'].map(GetPortalUserFromJSON)),
+    };
+}
+export function GetPortalUserListToJSON(json) {
+    return GetPortalUserListToJSONTyped(json, false);
+}
+export function GetPortalUserListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_pages': value['totalPages'],
+        'total_items': value['totalItems'],
+        'items': (value['items'].map(GetPortalUserToJSON)),
+    };
+}

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

@@ -39,6 +39,12 @@ export interface PostContentSession {
      * @memberof PostContentSession
      */
     createdAt: number;
+    /**
+     * The player session ID (used for SCORM, Quiz, and other interactive content). This is the external_id of the session that the player should use.
+     * @type {string}
+     * @memberof PostContentSession
+     */
+    playerSessionId?: string | null;
 }
 /**
  * Check if a given object implements the PostContentSession interface.

package/dist/esm/models/PostContentSession.js

@@ -37,6 +37,7 @@ export function PostContentSessionFromJSONTyped(json, ignoreDiscriminator) {
         'userId': json['user_id'],
         'launchUrl': json['launch_url'],
         'createdAt': json['created_at'],
+        'playerSessionId': json['player_session_id'] == null ? undefined : json['player_session_id'],
     };
 }
 export function PostContentSessionToJSON(json) {
@@ -51,5 +52,6 @@ export function PostContentSessionToJSONTyped(value, ignoreDiscriminator = false
         'user_id': value['userId'],
         'launch_url': value['launchUrl'],
         'created_at': value['createdAt'],
+        'player_session_id': value['playerSessionId'],
     };
 }

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

@@ -16,23 +16,29 @@
  */
 export interface PostCourseEnrollment {
     /**
-     * The ID of the course
+     * The external ID of the user to enroll
      * @type {string}
      * @memberof PostCourseEnrollment
      */
-    courseId: string;
+    userId: string;
     /**
-     * The ID of the enrolled user
-     * @type {string}
+     * Start date of the enrollment (Unix timestamp)
+     * @type {number}
      * @memberof PostCourseEnrollment
      */
-    userId: string;
+    enrollmentDateStart: number;
     /**
-     *
+     * End date of the enrollment (Unix timestamp)
      * @type {number}
      * @memberof PostCourseEnrollment
      */
-    enrollmentDateStart: number;
+    enrollmentDateEnd?: number | null;
+    /**
+     * Optional notes about the enrollment
+     * @type {string}
+     * @memberof PostCourseEnrollment
+     */
+    notes?: string | null;
 }
 /**
  * Check if a given object implements the PostCourseEnrollment interface.

package/dist/esm/models/PostCourseEnrollment.js

@@ -15,8 +15,6 @@
  * Check if a given object implements the PostCourseEnrollment interface.
  */
 export function instanceOfPostCourseEnrollment(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)
@@ -31,9 +29,10 @@ export function PostCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
-        'courseId': json['course_id'],
         'userId': json['user_id'],
         'enrollmentDateStart': json['enrollment_date_start'],
+        'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
+        'notes': json['notes'] == null ? undefined : json['notes'],
     };
 }
 export function PostCourseEnrollmentToJSON(json) {
@@ -44,8 +43,9 @@ export function PostCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = fal
         return value;
     }
     return {
-        'course_id': value['courseId'],
         'user_id': value['userId'],
         'enrollment_date_start': value['enrollmentDateStart'],
+        'enrollment_date_end': value['enrollmentDateEnd'],
+        'notes': value['notes'],
     };
 }

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

@@ -0,0 +1,53 @@
+/**
+ * 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 PutCourseEnrollment
+ */
+export interface PutCourseEnrollment {
+    /**
+     * Current status of the enrollment
+     * @type {string}
+     * @memberof PutCourseEnrollment
+     */
+    status?: PutCourseEnrollmentStatusEnum;
+    /**
+     * End date of the enrollment (Unix timestamp)
+     * @type {number}
+     * @memberof PutCourseEnrollment
+     */
+    enrollmentDateEnd?: number;
+    /**
+     * Optional notes about the enrollment
+     * @type {string}
+     * @memberof PutCourseEnrollment
+     */
+    notes?: string;
+}
+/**
+ * @export
+ */
+export declare const PutCourseEnrollmentStatusEnum: {
+    readonly Enrolled: "Enrolled";
+    readonly Completed: "Completed";
+    readonly Removed: "Removed";
+};
+export type PutCourseEnrollmentStatusEnum = typeof PutCourseEnrollmentStatusEnum[keyof typeof PutCourseEnrollmentStatusEnum];
+/**
+ * Check if a given object implements the PutCourseEnrollment interface.
+ */
+export declare function instanceOfPutCourseEnrollment(value: object): value is PutCourseEnrollment;
+export declare function PutCourseEnrollmentFromJSON(json: any): PutCourseEnrollment;
+export declare function PutCourseEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCourseEnrollment;
+export declare function PutCourseEnrollmentToJSON(json: any): PutCourseEnrollment;
+export declare function PutCourseEnrollmentToJSONTyped(value?: PutCourseEnrollment | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PutCourseEnrollment.js

@@ -0,0 +1,53 @@
+/* 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 PutCourseEnrollmentStatusEnum = {
+    Enrolled: 'Enrolled',
+    Completed: 'Completed',
+    Removed: 'Removed'
+};
+/**
+ * Check if a given object implements the PutCourseEnrollment interface.
+ */
+export function instanceOfPutCourseEnrollment(value) {
+    return true;
+}
+export function PutCourseEnrollmentFromJSON(json) {
+    return PutCourseEnrollmentFromJSONTyped(json, false);
+}
+export function PutCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'status': json['status'] == null ? undefined : json['status'],
+        'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
+        'notes': json['notes'] == null ? undefined : json['notes'],
+    };
+}
+export function PutCourseEnrollmentToJSON(json) {
+    return PutCourseEnrollmentToJSONTyped(json, false);
+}
+export function PutCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'status': value['status'],
+        'enrollment_date_end': value['enrollmentDateEnd'],
+        'notes': value['notes'],
+    };
+}

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

@@ -16,6 +16,8 @@ export * from './GetModule';
 export * from './GetModuleList';
 export * from './GetPortal';
 export * from './GetPortalList';
+export * from './GetPortalUser';
+export * from './GetPortalUserList';
 export * from './GetQuestion';
 export * from './GetQuestionAnswerChoicesInner';
 export * from './GetQuestionList';
@@ -110,6 +112,7 @@ export * from './PostResetPassword';
 export * from './PostSendResetPassword';
 export * from './PutContent';
 export * from './PutCourse';
+export * from './PutCourseEnrollment';
 export * from './PutModule';
 export * from './PutPortalBranding';
 export * from './PutQuestion';

package/dist/esm/models/index.js

@@ -18,6 +18,8 @@ export * from './GetModule';
 export * from './GetModuleList';
 export * from './GetPortal';
 export * from './GetPortalList';
+export * from './GetPortalUser';
+export * from './GetPortalUserList';
 export * from './GetQuestion';
 export * from './GetQuestionAnswerChoicesInner';
 export * from './GetQuestionList';
@@ -112,6 +114,7 @@ export * from './PostResetPassword';
 export * from './PostSendResetPassword';
 export * from './PutContent';
 export * from './PutCourse';
+export * from './PutCourseEnrollment';
 export * from './PutModule';
 export * from './PutPortalBranding';
 export * from './PutQuestion';

package/dist/models/GetCourseEnrollment.d.ts

@@ -16,13 +16,19 @@
  */
 export interface GetCourseEnrollment {
     /**
-     * The ID of the course
+     * The external ID of the enrollment
+     * @type {string}
+     * @memberof GetCourseEnrollment
+     */
+    id: string;
+    /**
+     * The external ID of the course
      * @type {string}
      * @memberof GetCourseEnrollment
      */
     courseId: string;
     /**
-     * The ID of the enrolled user
+     * The external ID of the enrolled user
      * @type {string}
      * @memberof GetCourseEnrollment
      */
@@ -63,10 +69,8 @@ export interface GetCourseEnrollment {
  */
 export declare const GetCourseEnrollmentStatusEnum: {
     readonly Enrolled: "Enrolled";
-    readonly Dropped: "Dropped";
     readonly Completed: "Completed";
-    readonly Waitlisted: "Waitlisted";
-    readonly Unknown: "Unknown";
+    readonly Removed: "Removed";
 };
 export type GetCourseEnrollmentStatusEnum = typeof GetCourseEnrollmentStatusEnum[keyof typeof GetCourseEnrollmentStatusEnum];
 /**

package/dist/models/GetCourseEnrollment.js

@@ -24,15 +24,15 @@ exports.GetCourseEnrollmentToJSONTyped = GetCourseEnrollmentToJSONTyped;
  */
 exports.GetCourseEnrollmentStatusEnum = {
     Enrolled: 'Enrolled',
-    Dropped: 'Dropped',
     Completed: 'Completed',
-    Waitlisted: 'Waitlisted',
-    Unknown: 'Unknown'
+    Removed: 'Removed'
 };
 /**
  * Check if a given object implements the GetCourseEnrollment interface.
  */
 function instanceOfGetCourseEnrollment(value) {
+    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)
@@ -57,6 +57,7 @@ function GetCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'id': json['id'],
         'courseId': json['course_id'],
         'userId': json['user_id'],
         'enrollmentDateStart': json['enrollment_date_start'],
@@ -74,6 +75,7 @@ function GetCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
         return value;
     }
     return {
+        'id': value['id'],
         'course_id': value['courseId'],
         'user_id': value['userId'],
         'enrollment_date_start': value['enrollmentDateStart'],

package/dist/models/GetPortalUser.d.ts

@@ -0,0 +1,71 @@
+/**
+ * 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 user with their portal access information
+ * @export
+ * @interface GetPortalUser
+ */
+export interface GetPortalUser {
+    /**
+     * The unique identifier for the user
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    userId: string;
+    /**
+     * The user's email address
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    email: string;
+    /**
+     * The user's first name
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    firstName: string;
+    /**
+     * The user's last name
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    lastName: string;
+    /**
+     * The user's role in the portal
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    role: GetPortalUserRoleEnum;
+    /**
+     * Whether the user's portal access is active
+     * @type {boolean}
+     * @memberof GetPortalUser
+     */
+    isActive: boolean;
+}
+/**
+ * @export
+ */
+export declare const GetPortalUserRoleEnum: {
+    readonly Admin: "Admin";
+    readonly Instructor: "Instructor";
+    readonly Learner: "Learner";
+};
+export type GetPortalUserRoleEnum = typeof GetPortalUserRoleEnum[keyof typeof GetPortalUserRoleEnum];
+/**
+ * Check if a given object implements the GetPortalUser interface.
+ */
+export declare function instanceOfGetPortalUser(value: object): value is GetPortalUser;
+export declare function GetPortalUserFromJSON(json: any): GetPortalUser;
+export declare function GetPortalUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalUser;
+export declare function GetPortalUserToJSON(json: any): GetPortalUser;
+export declare function GetPortalUserToJSONTyped(value?: GetPortalUser | null, ignoreDiscriminator?: boolean): any;