@easyedu/js-lsm-api 1.8.0 → 1.10.0

package/src/models/GetCourseEnrollmentList.ts

@@ -13,13 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
-import type { GetCourseEnrollment } from './GetCourseEnrollment';
+import type { GetCourseEnrollmentListItem } from './GetCourseEnrollmentListItem';
 import {
-    GetCourseEnrollmentFromJSON,
-    GetCourseEnrollmentFromJSONTyped,
-    GetCourseEnrollmentToJSON,
-    GetCourseEnrollmentToJSONTyped,
-} from './GetCourseEnrollment';
+    GetCourseEnrollmentListItemFromJSON,
+    GetCourseEnrollmentListItemFromJSONTyped,
+    GetCourseEnrollmentListItemToJSON,
+    GetCourseEnrollmentListItemToJSONTyped,
+} from './GetCourseEnrollmentListItem';
 
 /**
  * A list of course enrollments with pagination information
@@ -53,10 +53,10 @@ export interface GetCourseEnrollmentList {
     totalItems: number;
     /**
      * 
-     * @type {Array<GetCourseEnrollment>}
+     * @type {Array<GetCourseEnrollmentListItem>}
      * @memberof GetCourseEnrollmentList
      */
-    items: Array<GetCourseEnrollment>;
+    items: Array<GetCourseEnrollmentListItem>;
 }
 
 /**
@@ -85,7 +85,7 @@ export function GetCourseEnrollmentListFromJSONTyped(json: any, ignoreDiscrimina
         'pageSize': json['pageSize'],
         'totalPages': json['totalPages'],
         'totalItems': json['totalItems'],
-        'items': ((json['items'] as Array<any>).map(GetCourseEnrollmentFromJSON)),
+        'items': ((json['items'] as Array<any>).map(GetCourseEnrollmentListItemFromJSON)),
     };
 }
 
@@ -104,7 +104,7 @@ export function GetCourseEnrollmentListToJSONTyped(value?: GetCourseEnrollmentLi
         'pageSize': value['pageSize'],
         'totalPages': value['totalPages'],
         'totalItems': value['totalItems'],
-        'items': ((value['items'] as Array<any>).map(GetCourseEnrollmentToJSON)),
+        'items': ((value['items'] as Array<any>).map(GetCourseEnrollmentListItemToJSON)),
     };
 }
 

package/src/models/GetCourseEnrollmentListItem.ts

@@ -0,0 +1,150 @@
+/* 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;
+    /**
+     * Current status of the enrollment
+     * @type {string}
+     * @memberof GetCourseEnrollmentListItem
+     */
+    status: GetCourseEnrollmentListItemStatusEnum;
+    /**
+     * Date the course was completed (Unix timestamp)
+     * @type {number}
+     * @memberof GetCourseEnrollmentListItem
+     */
+    completionDate: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const GetCourseEnrollmentListItemStatusEnum = {
+    Enrolled: 'Enrolled',
+    Completed: 'Completed',
+    Removed: 'Removed'
+} as const;
+export type GetCourseEnrollmentListItemStatusEnum = typeof GetCourseEnrollmentListItemStatusEnum[keyof typeof GetCourseEnrollmentListItemStatusEnum];
+
+
+/**
+ * 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 (!('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'],
+        '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'],
+        'completion_date': value['completionDate'],
+    };
+}
+

package/src/models/PostContentSession.ts

@@ -43,6 +43,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;
 }
 
 /**
@@ -70,6 +76,7 @@ export function PostContentSessionFromJSONTyped(json: any, ignoreDiscriminator:
         'userId': json['user_id'],
         'launchUrl': json['launch_url'],
         'createdAt': json['created_at'],
+        'playerSessionId': json['player_session_id'] == null ? undefined : json['player_session_id'],
     };
 }
 
@@ -88,6 +95,7 @@ export function PostContentSessionToJSONTyped(value?: PostContentSession | null,
         'user_id': value['userId'],
         'launch_url': value['launchUrl'],
         'created_at': value['createdAt'],
+        'player_session_id': value['playerSessionId'],
     };
 }
 

package/src/models/PostCourseEnrollment.ts

@@ -20,30 +20,35 @@ import { mapValues } from '../runtime';
  */
 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.
  */
 export function instanceOfPostCourseEnrollment(value: object): value is PostCourseEnrollment {
-    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;
     return true;
@@ -59,9 +64,10 @@ export function PostCourseEnrollmentFromJSONTyped(json: any, ignoreDiscriminator
     }
     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'],
     };
 }
 
@@ -76,9 +82,10 @@ export function PostCourseEnrollmentToJSONTyped(value?: PostCourseEnrollment | n
 
     return {
         
-        'course_id': value['courseId'],
         'user_id': value['userId'],
         'enrollment_date_start': value['enrollmentDateStart'],
+        'enrollment_date_end': value['enrollmentDateEnd'],
+        'notes': value['notes'],
     };
 }
 

package/src/models/PutCourseEnrollment.ts

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

package/src/models/index.ts

@@ -13,6 +13,7 @@ export * from './GetContentUpload';
 export * from './GetCourse';
 export * from './GetCourseEnrollment';
 export * from './GetCourseEnrollmentList';
+export * from './GetCourseEnrollmentListItem';
 export * from './GetCourseList';
 export * from './GetModule';
 export * from './GetModuleList';
@@ -114,6 +115,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';