@easyedu/js-lsm-api 1.7.0 → 1.9.0

package/dist/models/GetPortalUser.js

@@ -0,0 +1,79 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetPortalUserRoleEnum = void 0;
+exports.instanceOfGetPortalUser = instanceOfGetPortalUser;
+exports.GetPortalUserFromJSON = GetPortalUserFromJSON;
+exports.GetPortalUserFromJSONTyped = GetPortalUserFromJSONTyped;
+exports.GetPortalUserToJSON = GetPortalUserToJSON;
+exports.GetPortalUserToJSONTyped = GetPortalUserToJSONTyped;
+/**
+ * @export
+ */
+exports.GetPortalUserRoleEnum = {
+    Admin: 'Admin',
+    Instructor: 'Instructor',
+    Learner: 'Learner'
+};
+/**
+ * Check if a given object implements the GetPortalUser interface.
+ */
+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;
+}
+function GetPortalUserFromJSON(json) {
+    return GetPortalUserFromJSONTyped(json, false);
+}
+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'],
+    };
+}
+function GetPortalUserToJSON(json) {
+    return GetPortalUserToJSONTyped(json, false);
+}
+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/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/models/GetPortalUserList.js

@@ -0,0 +1,67 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetPortalUserList = instanceOfGetPortalUserList;
+exports.GetPortalUserListFromJSON = GetPortalUserListFromJSON;
+exports.GetPortalUserListFromJSONTyped = GetPortalUserListFromJSONTyped;
+exports.GetPortalUserListToJSON = GetPortalUserListToJSON;
+exports.GetPortalUserListToJSONTyped = GetPortalUserListToJSONTyped;
+const GetPortalUser_1 = require("./GetPortalUser");
+/**
+ * Check if a given object implements the GetPortalUserList interface.
+ */
+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;
+}
+function GetPortalUserListFromJSON(json) {
+    return GetPortalUserListFromJSONTyped(json, false);
+}
+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(GetPortalUser_1.GetPortalUserFromJSON)),
+    };
+}
+function GetPortalUserListToJSON(json) {
+    return GetPortalUserListToJSONTyped(json, false);
+}
+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(GetPortalUser_1.GetPortalUserToJSON)),
+    };
+}

package/dist/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/models/PostContentSession.js

@@ -44,6 +44,7 @@ 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'],
     };
 }
 function PostContentSessionToJSON(json) {
@@ -58,5 +59,6 @@ function PostContentSessionToJSONTyped(value, ignoreDiscriminator = false) {
         'user_id': value['userId'],
         'launch_url': value['launchUrl'],
         'created_at': value['createdAt'],
+        'player_session_id': value['playerSessionId'],
     };
 }

package/dist/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/models/PostCourseEnrollment.js

@@ -22,8 +22,6 @@ exports.PostCourseEnrollmentToJSONTyped = PostCourseEnrollmentToJSONTyped;
  * Check if a given object implements the PostCourseEnrollment interface.
  */
 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)
@@ -38,9 +36,10 @@ 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'],
     };
 }
 function PostCourseEnrollmentToJSON(json) {
@@ -51,8 +50,9 @@ function PostCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
         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/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/models/PutCourseEnrollment.js

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

package/dist/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/models/index.js

@@ -34,6 +34,8 @@ __exportStar(require("./GetModule"), exports);
 __exportStar(require("./GetModuleList"), exports);
 __exportStar(require("./GetPortal"), exports);
 __exportStar(require("./GetPortalList"), exports);
+__exportStar(require("./GetPortalUser"), exports);
+__exportStar(require("./GetPortalUserList"), exports);
 __exportStar(require("./GetQuestion"), exports);
 __exportStar(require("./GetQuestionAnswerChoicesInner"), exports);
 __exportStar(require("./GetQuestionList"), exports);
@@ -128,6 +130,7 @@ __exportStar(require("./PostResetPassword"), exports);
 __exportStar(require("./PostSendResetPassword"), exports);
 __exportStar(require("./PutContent"), exports);
 __exportStar(require("./PutCourse"), exports);
+__exportStar(require("./PutCourseEnrollment"), exports);
 __exportStar(require("./PutModule"), exports);
 __exportStar(require("./PutPortalBranding"), exports);
 __exportStar(require("./PutQuestion"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.7.0",
+  "version": "1.9.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/CourseApi.ts

@@ -22,6 +22,7 @@ import type {
   PostCourse,
   PostCourseEnrollment,
   PutCourse,
+  PutCourseEnrollment,
 } from '../models/index';
 import {
     GetCourseFromJSON,
@@ -38,13 +39,15 @@ import {
     PostCourseEnrollmentToJSON,
     PutCourseFromJSON,
     PutCourseToJSON,
+    PutCourseEnrollmentFromJSON,
+    PutCourseEnrollmentToJSON,
 } from '../models/index';
 
 export interface GetCourseRequest {
     courseId: string;
 }
 
-export interface GetCourseEnrollmentRequest {
+export interface GetCourseEnrollmentsRequest {
     courseId: string;
 }
 
@@ -62,6 +65,12 @@ export interface PutCourseRequest {
     putCourse: Omit<PutCourse, 'id'>;
 }
 
+export interface PutCourseEnrollmentRequest {
+    courseId: string;
+    enrollmentId: string;
+    putCourseEnrollment: PutCourseEnrollment;
+}
+
 /**
  * 
  */
@@ -101,13 +110,13 @@ export class CourseApi extends runtime.BaseAPI {
     }
 
     /**
-     * get course enrollment
+     * Get course enrollments
      */
-    async getCourseEnrollmentRaw(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollmentList>> {
+    async getCourseEnrollmentsRaw(requestParameters: GetCourseEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollmentList>> {
         if (requestParameters['courseId'] == null) {
             throw new runtime.RequiredError(
                 'courseId',
-                'Required parameter "courseId" was null or undefined when calling getCourseEnrollment().'
+                'Required parameter "courseId" was null or undefined when calling getCourseEnrollments().'
             );
         }
 
@@ -116,7 +125,7 @@ export class CourseApi extends runtime.BaseAPI {
         const headerParameters: runtime.HTTPHeaders = {};
 
         const response = await this.request({
-            path: `/courses/{courseId}/enroll`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
+            path: `/courses/{courseId}/enrollments`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
@@ -126,10 +135,10 @@ export class CourseApi extends runtime.BaseAPI {
     }
 
     /**
-     * get course enrollment
+     * Get course enrollments
      */
-    async getCourseEnrollment(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollmentList> {
-        const response = await this.getCourseEnrollmentRaw(requestParameters, initOverrides);
+    async getCourseEnrollments(requestParameters: GetCourseEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollmentList> {
+        const response = await this.getCourseEnrollmentsRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
@@ -196,7 +205,7 @@ export class CourseApi extends runtime.BaseAPI {
     }
 
     /**
-     * Post a new course enrollment
+     * Create a new course enrollment
      */
     async postCourseEnrollmentRaw(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>> {
         if (requestParameters['courseId'] == null) {
@@ -220,7 +229,7 @@ export class CourseApi extends runtime.BaseAPI {
         headerParameters['Content-Type'] = 'application/json';
 
         const response = await this.request({
-            path: `/courses/{courseId}/enroll`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
+            path: `/courses/{courseId}/enrollments`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
@@ -231,7 +240,7 @@ export class CourseApi extends runtime.BaseAPI {
     }
 
     /**
-     * Post a new course enrollment
+     * Create a new course enrollment
      */
     async postCourseEnrollment(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment> {
         const response = await this.postCourseEnrollmentRaw(requestParameters, initOverrides);
@@ -281,4 +290,54 @@ export class CourseApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Update a course enrollment
+     */
+    async putCourseEnrollmentRaw(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling putCourseEnrollment().'
+            );
+        }
+
+        if (requestParameters['enrollmentId'] == null) {
+            throw new runtime.RequiredError(
+                'enrollmentId',
+                'Required parameter "enrollmentId" was null or undefined when calling putCourseEnrollment().'
+            );
+        }
+
+        if (requestParameters['putCourseEnrollment'] == null) {
+            throw new runtime.RequiredError(
+                'putCourseEnrollment',
+                'Required parameter "putCourseEnrollment" was null or undefined when calling putCourseEnrollment().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/courses/{courseId}/enrollments/{enrollmentId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"enrollmentId"}}`, encodeURIComponent(String(requestParameters['enrollmentId']))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutCourseEnrollmentToJSON(requestParameters['putCourseEnrollment']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseEnrollmentFromJSON(jsonValue));
+    }
+
+    /**
+     * Update a course enrollment
+     */
+    async putCourseEnrollment(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment> {
+        const response = await this.putCourseEnrollmentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }