@easyedu/js-lsm-api 1.7.0 → 1.9.0

package/src/apis/PortalApi.ts

@@ -17,6 +17,7 @@ import * as runtime from '../runtime';
 import type {
   GetPortal,
   GetPortalList,
+  GetPortalUserList,
   PostPortal,
   PostPortalInvite,
   PutPortalBranding,
@@ -26,6 +27,8 @@ import {
     GetPortalToJSON,
     GetPortalListFromJSON,
     GetPortalListToJSON,
+    GetPortalUserListFromJSON,
+    GetPortalUserListToJSON,
     PostPortalFromJSON,
     PostPortalToJSON,
     PostPortalInviteFromJSON,
@@ -38,6 +41,13 @@ export interface GetPortalByIdRequest {
     portalId: string;
 }
 
+export interface GetPortalUsersRequest {
+    portalId: string;
+    roles?: Array<GetPortalUsersRolesEnum>;
+    page?: number;
+    pageSize?: number;
+}
+
 export interface InviteUserToPortalRequest {
     portalId: string;
     postPortalInvite: PostPortalInvite;
@@ -121,6 +131,51 @@ export class PortalApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get all users for a portal with optional role filtering
+     */
+    async getPortalUsersRaw(requestParameters: GetPortalUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalUserList>> {
+        if (requestParameters['portalId'] == null) {
+            throw new runtime.RequiredError(
+                'portalId',
+                'Required parameter "portalId" was null or undefined when calling getPortalUsers().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['roles'] != null) {
+            queryParameters['roles'] = requestParameters['roles'];
+        }
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['page_size'] = requestParameters['pageSize'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/portals/{portalId}/users`.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalUserListFromJSON(jsonValue));
+    }
+
+    /**
+     * Get all users for a portal with optional role filtering
+     */
+    async getPortalUsers(requestParameters: GetPortalUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalUserList> {
+        const response = await this.getPortalUsersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Invite a new user to a portal
      */
@@ -279,3 +334,13 @@ export class PortalApi extends runtime.BaseAPI {
     }
 
 }
+
+/**
+ * @export
+ */
+export const GetPortalUsersRolesEnum = {
+    Admin: 'Admin',
+    Instructor: 'Instructor',
+    Learner: 'Learner'
+} as const;
+export type GetPortalUsersRolesEnum = typeof GetPortalUsersRolesEnum[keyof typeof GetPortalUsersRolesEnum];

package/src/models/GetCourseEnrollment.ts

@@ -20,13 +20,19 @@ import { mapValues } from '../runtime';
  */
 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
      */
@@ -69,10 +75,8 @@ export interface GetCourseEnrollment {
  */
 export const GetCourseEnrollmentStatusEnum = {
     Enrolled: 'Enrolled',
-    Dropped: 'Dropped',
     Completed: 'Completed',
-    Waitlisted: 'Waitlisted',
-    Unknown: 'Unknown'
+    Removed: 'Removed'
 } as const;
 export type GetCourseEnrollmentStatusEnum = typeof GetCourseEnrollmentStatusEnum[keyof typeof GetCourseEnrollmentStatusEnum];
 
@@ -81,6 +85,7 @@ export type GetCourseEnrollmentStatusEnum = typeof GetCourseEnrollmentStatusEnum
  * Check if a given object implements the GetCourseEnrollment interface.
  */
 export function instanceOfGetCourseEnrollment(value: object): value is GetCourseEnrollment {
+    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 (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined) return false;
@@ -101,6 +106,7 @@ export function GetCourseEnrollmentFromJSONTyped(json: any, ignoreDiscriminator:
     }
     return {
         
+        'id': json['id'],
         'courseId': json['course_id'],
         'userId': json['user_id'],
         'enrollmentDateStart': json['enrollment_date_start'],
@@ -122,6 +128,7 @@ export function GetCourseEnrollmentToJSONTyped(value?: GetCourseEnrollment | nul
 
     return {
         
+        'id': value['id'],
         'course_id': value['courseId'],
         'user_id': value['userId'],
         'enrollment_date_start': value['enrollmentDateStart'],

package/src/models/GetPortalUser.ts

@@ -0,0 +1,123 @@
+/* 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 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 const GetPortalUserRoleEnum = {
+    Admin: 'Admin',
+    Instructor: 'Instructor',
+    Learner: 'Learner'
+} as const;
+export type GetPortalUserRoleEnum = typeof GetPortalUserRoleEnum[keyof typeof GetPortalUserRoleEnum];
+
+
+/**
+ * Check if a given object implements the GetPortalUser interface.
+ */
+export function instanceOfGetPortalUser(value: object): value is GetPortalUser {
+    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: any): GetPortalUser {
+    return GetPortalUserFromJSONTyped(json, false);
+}
+
+export function GetPortalUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalUser {
+    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: any): GetPortalUser {
+    return GetPortalUserToJSONTyped(json, false);
+}
+
+export function GetPortalUserToJSONTyped(value?: GetPortalUser | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/GetPortalUserList.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 { GetPortalUser } from './GetPortalUser';
+import {
+    GetPortalUserFromJSON,
+    GetPortalUserFromJSONTyped,
+    GetPortalUserToJSON,
+    GetPortalUserToJSONTyped,
+} 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 function instanceOfGetPortalUserList(value: object): value is GetPortalUserList {
+    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: any): GetPortalUserList {
+    return GetPortalUserListFromJSONTyped(json, false);
+}
+
+export function GetPortalUserListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalUserList {
+    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(GetPortalUserFromJSON)),
+    };
+}
+
+export function GetPortalUserListToJSON(json: any): GetPortalUserList {
+    return GetPortalUserListToJSONTyped(json, false);
+}
+
+export function GetPortalUserListToJSONTyped(value?: GetPortalUserList | 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(GetPortalUserToJSON)),
+    };
+}
+

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

@@ -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';