@easyedu/js-lsm-api 1.32.0 → 1.33.0

package/src/apis/UserApi.ts

@@ -64,9 +64,9 @@ export interface SendResetPasswordRequest {
 export class UserApi extends runtime.BaseAPI {
 
     /**
-     * Check if a user is logged in
+     * Creates request options for getAuthCheck without sending the request
      */
-    async getAuthCheckRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+    async getAuthCheckRequestOpts(): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
         const headerParameters: runtime.HTTPHeaders = {};
@@ -74,12 +74,20 @@ export class UserApi extends runtime.BaseAPI {
 
         let urlPath = `/auth/check`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Check if a user is logged in
+     */
+    async getAuthCheckRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.getAuthCheckRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.VoidApiResponse(response);
     }
@@ -92,9 +100,9 @@ export class UserApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get a user by id
+     * Creates request options for getUser without sending the request
      */
-    async getUserRaw(requestParameters: GetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUser>> {
+    async getUserRequestOpts(requestParameters: GetUserRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['userId'] == null) {
             throw new runtime.RequiredError(
                 'userId',
@@ -110,12 +118,20 @@ export class UserApi extends runtime.BaseAPI {
         let urlPath = `/users/{userId}`;
         urlPath = urlPath.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get a user by id
+     */
+    async getUserRaw(requestParameters: GetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUser>> {
+        const requestOptions = await this.getUserRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetUserFromJSON(jsonValue));
     }
@@ -129,9 +145,9 @@ export class UserApi extends runtime.BaseAPI {
     }
 
     /**
-     * Post a new login
+     * Creates request options for postLogin without sending the request
      */
-    async postLoginRaw(requestParameters: PostLoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LoginRes>> {
+    async postLoginRequestOpts(requestParameters: PostLoginRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['postLogin'] == null) {
             throw new runtime.RequiredError(
                 'postLogin',
@@ -148,13 +164,21 @@ export class UserApi extends runtime.BaseAPI {
 
         let urlPath = `/auth/login`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: PostLoginToJSON(requestParameters['postLogin']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Post a new login
+     */
+    async postLoginRaw(requestParameters: PostLoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LoginRes>> {
+        const requestOptions = await this.postLoginRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => LoginResFromJSON(jsonValue));
     }
@@ -168,9 +192,9 @@ export class UserApi extends runtime.BaseAPI {
     }
 
     /**
-     * Logout a user
+     * Creates request options for postLogout without sending the request
      */
-    async postLogoutRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+    async postLogoutRequestOpts(): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
         const headerParameters: runtime.HTTPHeaders = {};
@@ -178,12 +202,20 @@ export class UserApi extends runtime.BaseAPI {
 
         let urlPath = `/auth/logout`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Logout a user
+     */
+    async postLogoutRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.postLogoutRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.VoidApiResponse(response);
     }
@@ -196,9 +228,9 @@ export class UserApi extends runtime.BaseAPI {
     }
 
     /**
-     * Update a user by id
+     * Creates request options for putUser without sending the request
      */
-    async putUserRaw(requestParameters: PutUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUser>> {
+    async putUserRequestOpts(requestParameters: PutUserRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['userId'] == null) {
             throw new runtime.RequiredError(
                 'userId',
@@ -223,13 +255,21 @@ export class UserApi extends runtime.BaseAPI {
         let urlPath = `/users/{userId}`;
         urlPath = urlPath.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'PUT',
             headers: headerParameters,
             query: queryParameters,
             body: PutUserToJSON(requestParameters['putUser']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Update a user by id
+     */
+    async putUserRaw(requestParameters: PutUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUser>> {
+        const requestOptions = await this.putUserRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetUserFromJSON(jsonValue));
     }
@@ -243,9 +283,9 @@ export class UserApi extends runtime.BaseAPI {
     }
 
     /**
-     * Reset a users password
+     * Creates request options for resetPassword without sending the request
      */
-    async resetPasswordRaw(requestParameters: ResetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+    async resetPasswordRequestOpts(requestParameters: ResetPasswordRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['postResetPassword'] == null) {
             throw new runtime.RequiredError(
                 'postResetPassword',
@@ -262,13 +302,21 @@ export class UserApi extends runtime.BaseAPI {
 
         let urlPath = `/auth/reset-password`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: PostResetPasswordToJSON(requestParameters['postResetPassword']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Reset a users password
+     */
+    async resetPasswordRaw(requestParameters: ResetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.resetPasswordRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.VoidApiResponse(response);
     }
@@ -281,9 +329,9 @@ export class UserApi extends runtime.BaseAPI {
     }
 
     /**
-     * Send a reset password email
+     * Creates request options for sendResetPassword without sending the request
      */
-    async sendResetPasswordRaw(requestParameters: SendResetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+    async sendResetPasswordRequestOpts(requestParameters: SendResetPasswordRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['postSendResetPassword'] == null) {
             throw new runtime.RequiredError(
                 'postSendResetPassword',
@@ -300,13 +348,21 @@ export class UserApi extends runtime.BaseAPI {
 
         let urlPath = `/auth/send-reset-password`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: PostSendResetPasswordToJSON(requestParameters['postSendResetPassword']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Send a reset password email
+     */
+    async sendResetPasswordRaw(requestParameters: SendResetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.sendResetPasswordRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.VoidApiResponse(response);
     }

package/src/apis/index.ts

@@ -8,4 +8,5 @@ export * from './PortalApi';
 export * from './QuestionApi';
 export * from './QuizApi';
 export * from './ReportingApi';
+export * from './RoleApi';
 export * from './UserApi';

package/src/models/CriteriaBasedSelection.ts

@@ -36,7 +36,7 @@ import {
 export interface CriteriaBasedSelection {
     /**
      * 
-     * @type {string}
+     * @type {CriteriaBasedSelectionMethodEnum}
      * @memberof CriteriaBasedSelection
      */
     method: CriteriaBasedSelectionMethodEnum;

package/src/models/CriteriaBasedSelectionCriteria.ts

@@ -27,13 +27,13 @@ export interface CriteriaBasedSelectionCriteria {
     topics?: Array<string>;
     /**
      * Difficulty levels to include
-     * @type {Array<string>}
+     * @type {Array<CriteriaBasedSelectionCriteriaDifficultyLevelsEnum>}
      * @memberof CriteriaBasedSelectionCriteria
      */
     difficultyLevels?: Array<CriteriaBasedSelectionCriteriaDifficultyLevelsEnum>;
     /**
      * Question types to include
-     * @type {Array<string>}
+     * @type {Array<CriteriaBasedSelectionCriteriaQuestionTypesEnum>}
      * @memberof CriteriaBasedSelectionCriteria
      */
     questionTypes?: Array<CriteriaBasedSelectionCriteriaQuestionTypesEnum>;

package/src/models/FillInBlank.ts

@@ -21,7 +21,7 @@ import { mapValues } from '../runtime';
 export interface FillInBlank {
     /**
      * 
-     * @type {string}
+     * @type {FillInBlankTypeEnum}
      * @memberof FillInBlank
      */
     type: FillInBlankTypeEnum;

package/src/models/FillInBlank1.ts

@@ -21,7 +21,7 @@ import { mapValues } from '../runtime';
 export interface FillInBlank1 {
     /**
      * 
-     * @type {string}
+     * @type {FillInBlank1TypeEnum}
      * @memberof FillInBlank1
      */
     type: FillInBlank1TypeEnum;

package/src/models/GetContent.ts

@@ -53,7 +53,7 @@ export interface GetContent {
     description?: string;
     /**
      * 
-     * @type {string}
+     * @type {GetContentContentTypeEnum}
      * @memberof GetContent
      */
     contentType: GetContentContentTypeEnum;

package/src/models/GetContentGradeDetail.ts

@@ -48,13 +48,13 @@ export interface GetContentGradeDetail {
     user: GetContentGradesItemsInnerUser;
     /**
      * Content completion status
-     * @type {string}
+     * @type {GetContentGradeDetailCompletionEnum}
      * @memberof GetContentGradeDetail
      */
     completion: GetContentGradeDetailCompletionEnum;
     /**
      * Content grade status
-     * @type {string}
+     * @type {GetContentGradeDetailGradeStatusEnum}
      * @memberof GetContentGradeDetail
      */
     gradeStatus: GetContentGradeDetailGradeStatusEnum;
@@ -72,7 +72,7 @@ export interface GetContentGradeDetail {
     updatedAt: number | null;
     /**
      * Type of content
-     * @type {string}
+     * @type {GetContentGradeDetailContentTypeEnum}
      * @memberof GetContentGradeDetail
      */
     contentType: GetContentGradeDetailContentTypeEnum;

package/src/models/GetContentGradesItemsInner.ts

@@ -41,13 +41,13 @@ export interface GetContentGradesItemsInner {
     user: GetContentGradesItemsInnerUser;
     /**
      * Content completion status
-     * @type {string}
+     * @type {GetContentGradesItemsInnerCompletionEnum}
      * @memberof GetContentGradesItemsInner
      */
     completion: GetContentGradesItemsInnerCompletionEnum;
     /**
      * Content grade status
-     * @type {string}
+     * @type {GetContentGradesItemsInnerGradeStatusEnum}
      * @memberof GetContentGradesItemsInner
      */
     gradeStatus: GetContentGradesItemsInnerGradeStatusEnum;

package/src/models/GetContentInstructorBasicReportingContentInfo.ts

@@ -27,7 +27,7 @@ export interface GetContentInstructorBasicReportingContentInfo {
     contentId: string;
     /**
      * Type of content
-     * @type {string}
+     * @type {GetContentInstructorBasicReportingContentInfoContentTypeEnum}
      * @memberof GetContentInstructorBasicReportingContentInfo
      */
     contentType: GetContentInstructorBasicReportingContentInfoContentTypeEnum;

package/src/models/GetContentSessionDetail.ts

@@ -60,13 +60,13 @@ export interface GetContentSessionDetail {
     contentId: string;
     /**
      * The completion status of the content session
-     * @type {string}
+     * @type {GetContentSessionDetailCompletionStatusEnum}
      * @memberof GetContentSessionDetail
      */
     completionStatus: GetContentSessionDetailCompletionStatusEnum;
     /**
      * The grade status of the content session
-     * @type {string}
+     * @type {GetContentSessionDetailGradeStatusEnum}
      * @memberof GetContentSessionDetail
      */
     gradeStatus: GetContentSessionDetailGradeStatusEnum;

package/src/models/GetCourseEnrollment.ts

@@ -57,13 +57,13 @@ export interface GetCourseEnrollment {
     notes: string | null;
     /**
      * Current status of the enrollment
-     * @type {string}
+     * @type {GetCourseEnrollmentStatusEnum}
      * @memberof GetCourseEnrollment
      */
     status: GetCourseEnrollmentStatusEnum;
     /**
      * The role/type of the user in this enrollment
-     * @type {string}
+     * @type {GetCourseEnrollmentUserTypeEnum}
      * @memberof GetCourseEnrollment
      */
     userType: GetCourseEnrollmentUserTypeEnum;

package/src/models/GetCourseEnrollmentListItem.ts

@@ -63,13 +63,13 @@ export interface GetCourseEnrollmentListItem {
     enrollmentDateEnd: number;
     /**
      * Current status of the enrollment
-     * @type {string}
+     * @type {GetCourseEnrollmentListItemStatusEnum}
      * @memberof GetCourseEnrollmentListItem
      */
     status: GetCourseEnrollmentListItemStatusEnum;
     /**
      * The role/type of the user in this enrollment
-     * @type {string}
+     * @type {GetCourseEnrollmentListItemUserTypeEnum}
      * @memberof GetCourseEnrollmentListItem
      */
     userType: GetCourseEnrollmentListItemUserTypeEnum;

package/src/models/GetCourseExport.ts

@@ -33,13 +33,13 @@ export interface GetCourseExport {
     courseId: string;
     /**
      * The SCORM version to export
-     * @type {string}
+     * @type {GetCourseExportScormVersionEnum}
      * @memberof GetCourseExport
      */
     scormVersion: GetCourseExportScormVersionEnum;
     /**
      * Current status of the export generation
-     * @type {string}
+     * @type {GetCourseExportStatusEnum}
      * @memberof GetCourseExport
      */
     status: GetCourseExportStatusEnum;

package/src/models/GetPermission.ts

@@ -0,0 +1,92 @@
+/* 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 permission that can be assigned to roles
+ * @export
+ * @interface GetPermission
+ */
+export interface GetPermission {
+    /**
+     * External UUID of the permission
+     * @type {string}
+     * @memberof GetPermission
+     */
+    id: string;
+    /**
+     * Permission key in domain:action format (e.g. course:create)
+     * @type {string}
+     * @memberof GetPermission
+     */
+    key: string;
+    /**
+     * Human-readable description
+     * @type {string}
+     * @memberof GetPermission
+     */
+    description?: string | null;
+    /**
+     * Grouping domain (e.g. course, module, content)
+     * @type {string}
+     * @memberof GetPermission
+     */
+    domain: string;
+}
+
+/**
+ * Check if a given object implements the GetPermission interface.
+ */
+export function instanceOfGetPermission(value: object): value is GetPermission {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('key' in value) || value['key'] === undefined) return false;
+    if (!('domain' in value) || value['domain'] === undefined) return false;
+    return true;
+}
+
+export function GetPermissionFromJSON(json: any): GetPermission {
+    return GetPermissionFromJSONTyped(json, false);
+}
+
+export function GetPermissionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPermission {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'key': json['key'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'domain': json['domain'],
+    };
+}
+
+export function GetPermissionToJSON(json: any): GetPermission {
+    return GetPermissionToJSONTyped(json, false);
+}
+
+export function GetPermissionToJSONTyped(value?: GetPermission | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'key': value['key'],
+        'description': value['description'],
+        'domain': value['domain'],
+    };
+}
+

package/src/models/GetPortal.ts

@@ -56,17 +56,23 @@ export interface GetPortal {
      */
     headerTextColor: string;
     /**
-     * 
-     * @type {string}
+     * The user's current active role (mapped from base_type for backwards compatibility)
+     * @type {GetPortalSelectedUserRoleEnum}
      * @memberof GetPortal
      */
     selectedUserRole?: GetPortalSelectedUserRoleEnum;
     /**
-     * 
-     * @type {string}
+     * The user's base role (mapped from base_type for backwards compatibility)
+     * @type {GetPortalBaseUserRoleEnum}
      * @memberof GetPortal
      */
     baseUserRole?: GetPortalBaseUserRoleEnum;
+    /**
+     * The user's highest-privilege role base type for this portal
+     * @type {GetPortalBaseTypeEnum}
+     * @memberof GetPortal
+     */
+    baseType?: GetPortalBaseTypeEnum;
 }
 
 
@@ -90,6 +96,20 @@ export const GetPortalBaseUserRoleEnum = {
 } as const;
 export type GetPortalBaseUserRoleEnum = typeof GetPortalBaseUserRoleEnum[keyof typeof GetPortalBaseUserRoleEnum];
 
+/**
+ * @export
+ */
+export const GetPortalBaseTypeEnum = {
+    Owner: 'Owner',
+    Admin: 'Admin',
+    Instructor: 'Instructor',
+    Learner: 'Learner',
+    ClientSuperAdmin: 'ClientSuperAdmin',
+    ClientManager: 'ClientManager',
+    PortalClientAdministrator: 'PortalClientAdministrator'
+} as const;
+export type GetPortalBaseTypeEnum = typeof GetPortalBaseTypeEnum[keyof typeof GetPortalBaseTypeEnum];
+
 
 /**
  * Check if a given object implements the GetPortal interface.
@@ -121,6 +141,7 @@ export function GetPortalFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'headerTextColor': json['header_text_color'],
         'selectedUserRole': json['selected_user_role'] == null ? undefined : json['selected_user_role'],
         'baseUserRole': json['base_user_role'] == null ? undefined : json['base_user_role'],
+        'baseType': json['base_type'] == null ? undefined : json['base_type'],
     };
 }
 
@@ -143,6 +164,7 @@ export function GetPortalToJSONTyped(value?: GetPortal | null, ignoreDiscriminat
         'header_text_color': value['headerTextColor'],
         'selected_user_role': value['selectedUserRole'],
         'base_user_role': value['baseUserRole'],
+        'base_type': value['baseType'],
     };
 }
 

package/src/models/GetPortalUser.ts

@@ -44,11 +44,11 @@ export interface GetPortalUser {
      */
     lastName: string;
     /**
-     * The user's role in the portal
+     * The user's role name in the portal (e.g. Admin, Instructor, Learner, or a custom role name)
      * @type {string}
      * @memberof GetPortalUser
      */
-    role: GetPortalUserRoleEnum;
+    role: string;
     /**
      * Whether the user's portal access is active
      * @type {boolean}
@@ -57,18 +57,6 @@ export interface 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.
  */

package/src/models/GetQuestion.ts

@@ -41,7 +41,7 @@ export interface GetQuestion {
     questionText: string;
     /**
      * Type of question: single answer (True/False, multiple choice), multiple answer, or fill in the blank
-     * @type {string}
+     * @type {GetQuestionQuestionTypeEnum}
      * @memberof GetQuestion
      */
     questionType: GetQuestionQuestionTypeEnum;
@@ -77,7 +77,7 @@ export interface GetQuestion {
     course?: string;
     /**
      * Difficulty level of the question
-     * @type {string}
+     * @type {GetQuestionDifficultyLevelEnum}
      * @memberof GetQuestion
      */
     difficultyLevel: GetQuestionDifficultyLevelEnum;

package/src/models/GetQuestionListFilters.ts

@@ -33,13 +33,13 @@ export interface GetQuestionListFilters {
     course?: string;
     /**
      * Filter by question type
-     * @type {string}
+     * @type {GetQuestionListFiltersQuestionTypeEnum}
      * @memberof GetQuestionListFilters
      */
     questionType?: GetQuestionListFiltersQuestionTypeEnum;
     /**
      * Filter by difficulty level
-     * @type {string}
+     * @type {GetQuestionListFiltersDifficultyLevelEnum}
      * @memberof GetQuestionListFilters
      */
     difficultyLevel?: GetQuestionListFiltersDifficultyLevelEnum;

package/src/models/GetQuiz.ts

@@ -47,7 +47,7 @@ export interface GetQuiz {
     contentId: string;
     /**
      * How questions are selected
-     * @type {string}
+     * @type {GetQuizQuestionSelectionMethodEnum}
      * @memberof GetQuiz
      */
     questionSelectionMethod: GetQuizQuestionSelectionMethodEnum;