@easyedu/js-lsm-api 1.32.0 → 1.34.0

package/dist/esm/apis/UserApi.js

@@ -27,19 +27,28 @@ import { GetUserFromJSON, LoginResFromJSON, PostLoginToJSON, PostResetPasswordTo
  */
 export class UserApi extends runtime.BaseAPI {
     /**
-     * Check if a user is logged in
+     * Creates request options for getAuthCheck without sending the request
      */
-    getAuthCheckRaw(initOverrides) {
+    getAuthCheckRequestOpts() {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/auth/check`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Check if a user is logged in
+     */
+    getAuthCheckRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getAuthCheckRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.VoidApiResponse(response);
         });
     }
@@ -52,9 +61,9 @@ export class UserApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get a user by id
+     * Creates request options for getUser without sending the request
      */
-    getUserRaw(requestParameters, initOverrides) {
+    getUserRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['userId'] == null) {
                 throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling getUser().');
@@ -63,12 +72,21 @@ export class UserApi extends runtime.BaseAPI {
             const headerParameters = {};
             let urlPath = `/users/{userId}`;
             urlPath = urlPath.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Get a user by id
+     */
+    getUserRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getUserRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => GetUserFromJSON(jsonValue));
         });
     }
@@ -82,9 +100,9 @@ export class UserApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Post a new login
+     * Creates request options for postLogin without sending the request
      */
-    postLoginRaw(requestParameters, initOverrides) {
+    postLoginRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['postLogin'] == null) {
                 throw new runtime.RequiredError('postLogin', 'Required parameter "postLogin" was null or undefined when calling postLogin().');
@@ -93,13 +111,22 @@ export class UserApi extends runtime.BaseAPI {
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/auth/login`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
                 body: PostLoginToJSON(requestParameters['postLogin']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Post a new login
+     */
+    postLoginRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postLoginRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => LoginResFromJSON(jsonValue));
         });
     }
@@ -113,19 +140,28 @@ export class UserApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Logout a user
+     * Creates request options for postLogout without sending the request
      */
-    postLogoutRaw(initOverrides) {
+    postLogoutRequestOpts() {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/auth/logout`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Logout a user
+     */
+    postLogoutRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postLogoutRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.VoidApiResponse(response);
         });
     }
@@ -138,9 +174,9 @@ export class UserApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Update a user by id
+     * Creates request options for putUser without sending the request
      */
-    putUserRaw(requestParameters, initOverrides) {
+    putUserRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['userId'] == null) {
                 throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling putUser().');
@@ -153,13 +189,22 @@ export class UserApi extends runtime.BaseAPI {
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/users/{userId}`;
             urlPath = urlPath.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'PUT',
                 headers: headerParameters,
                 query: queryParameters,
                 body: PutUserToJSON(requestParameters['putUser']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Update a user by id
+     */
+    putUserRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.putUserRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => GetUserFromJSON(jsonValue));
         });
     }
@@ -173,9 +218,9 @@ export class UserApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Reset a users password
+     * Creates request options for resetPassword without sending the request
      */
-    resetPasswordRaw(requestParameters, initOverrides) {
+    resetPasswordRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['postResetPassword'] == null) {
                 throw new runtime.RequiredError('postResetPassword', 'Required parameter "postResetPassword" was null or undefined when calling resetPassword().');
@@ -184,13 +229,22 @@ export class UserApi extends runtime.BaseAPI {
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/auth/reset-password`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
                 body: PostResetPasswordToJSON(requestParameters['postResetPassword']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Reset a users password
+     */
+    resetPasswordRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.resetPasswordRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.VoidApiResponse(response);
         });
     }
@@ -203,9 +257,9 @@ export class UserApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Send a reset password email
+     * Creates request options for sendResetPassword without sending the request
      */
-    sendResetPasswordRaw(requestParameters, initOverrides) {
+    sendResetPasswordRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['postSendResetPassword'] == null) {
                 throw new runtime.RequiredError('postSendResetPassword', 'Required parameter "postSendResetPassword" was null or undefined when calling sendResetPassword().');
@@ -214,13 +268,22 @@ export class UserApi extends runtime.BaseAPI {
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/auth/send-reset-password`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
                 body: PostSendResetPasswordToJSON(requestParameters['postSendResetPassword']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Send a reset password email
+     */
+    sendResetPasswordRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.sendResetPasswordRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.VoidApiResponse(response);
         });
     }

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

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

package/dist/esm/apis/index.js

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

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

@@ -19,7 +19,7 @@ import type { CriteriaBasedSelectionDistribution } from './CriteriaBasedSelectio
 export interface CriteriaBasedSelection {
     /**
      *
-     * @type {string}
+     * @type {CriteriaBasedSelectionMethodEnum}
      * @memberof CriteriaBasedSelection
      */
     method: CriteriaBasedSelectionMethodEnum;

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

@@ -23,13 +23,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/dist/esm/models/FillInBlank.d.ts

@@ -17,7 +17,7 @@
 export interface FillInBlank {
     /**
      *
-     * @type {string}
+     * @type {FillInBlankTypeEnum}
      * @memberof FillInBlank
      */
     type: FillInBlankTypeEnum;

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

@@ -17,7 +17,7 @@
 export interface FillInBlank1 {
     /**
      *
-     * @type {string}
+     * @type {FillInBlank1TypeEnum}
      * @memberof FillInBlank1
      */
     type: FillInBlank1TypeEnum;

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

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

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

@@ -31,13 +31,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;
@@ -55,7 +55,7 @@ export interface GetContentGradeDetail {
     updatedAt: number | null;
     /**
      * Type of content
-     * @type {string}
+     * @type {GetContentGradeDetailContentTypeEnum}
      * @memberof GetContentGradeDetail
      */
     contentType: GetContentGradeDetailContentTypeEnum;

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

@@ -30,13 +30,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/dist/esm/models/GetContentInstructorBasicReportingContentInfo.d.ts

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

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

@@ -43,13 +43,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/dist/esm/models/GetCourseEnrollment.d.ts

@@ -53,13 +53,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/dist/esm/models/GetCourseEnrollmentListItem.d.ts

@@ -59,13 +59,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/dist/esm/models/GetCourseExport.d.ts

@@ -29,13 +29,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/dist/esm/models/GetPermission.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 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 declare function instanceOfGetPermission(value: object): value is GetPermission;
+export declare function GetPermissionFromJSON(json: any): GetPermission;
+export declare function GetPermissionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPermission;
+export declare function GetPermissionToJSON(json: any): GetPermission;
+export declare function GetPermissionToJSONTyped(value?: GetPermission | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetPermission.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.
+ */
+/**
+ * Check if a given object implements the GetPermission interface.
+ */
+export function instanceOfGetPermission(value) {
+    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) {
+    return GetPermissionFromJSONTyped(json, false);
+}
+export function GetPermissionFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return GetPermissionToJSONTyped(json, false);
+}
+export function GetPermissionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'key': value['key'],
+        'description': value['description'],
+        'domain': value['domain'],
+    };
+}

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

@@ -52,36 +52,25 @@ export interface GetPortal {
      */
     headerTextColor: string;
     /**
-     *
-     * @type {string}
-     * @memberof GetPortal
-     */
-    selectedUserRole?: GetPortalSelectedUserRoleEnum;
-    /**
-     *
-     * @type {string}
+     * The user's highest-privilege role base type for this portal
+     * @type {GetPortalBaseTypeEnum}
      * @memberof GetPortal
      */
-    baseUserRole?: GetPortalBaseUserRoleEnum;
+    baseType?: GetPortalBaseTypeEnum;
 }
 /**
  * @export
  */
-export declare const GetPortalSelectedUserRoleEnum: {
-    readonly Admin: "Admin";
-    readonly Instructor: "Instructor";
-    readonly Learner: "Learner";
-};
-export type GetPortalSelectedUserRoleEnum = typeof GetPortalSelectedUserRoleEnum[keyof typeof GetPortalSelectedUserRoleEnum];
-/**
- * @export
- */
-export declare const GetPortalBaseUserRoleEnum: {
+export declare const GetPortalBaseTypeEnum: {
+    readonly Owner: "Owner";
     readonly Admin: "Admin";
     readonly Instructor: "Instructor";
     readonly Learner: "Learner";
+    readonly ClientSuperAdmin: "ClientSuperAdmin";
+    readonly ClientManager: "ClientManager";
+    readonly PortalClientAdministrator: "PortalClientAdministrator";
 };
-export type GetPortalBaseUserRoleEnum = typeof GetPortalBaseUserRoleEnum[keyof typeof GetPortalBaseUserRoleEnum];
+export type GetPortalBaseTypeEnum = typeof GetPortalBaseTypeEnum[keyof typeof GetPortalBaseTypeEnum];
 /**
  * Check if a given object implements the GetPortal interface.
  */

package/dist/esm/models/GetPortal.js

@@ -14,18 +14,14 @@
 /**
  * @export
  */
-export const GetPortalSelectedUserRoleEnum = {
+export const GetPortalBaseTypeEnum = {
+    Owner: 'Owner',
     Admin: 'Admin',
     Instructor: 'Instructor',
-    Learner: 'Learner'
-};
-/**
- * @export
- */
-export const GetPortalBaseUserRoleEnum = {
-    Admin: 'Admin',
-    Instructor: 'Instructor',
-    Learner: 'Learner'
+    Learner: 'Learner',
+    ClientSuperAdmin: 'ClientSuperAdmin',
+    ClientManager: 'ClientManager',
+    PortalClientAdministrator: 'PortalClientAdministrator'
 };
 /**
  * Check if a given object implements the GetPortal interface.
@@ -57,8 +53,7 @@ export function GetPortalFromJSONTyped(json, ignoreDiscriminator) {
         'logoUrl': json['logo_url'],
         'headerBackgroundColor': json['header_background_color'],
         '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'],
     };
 }
 export function GetPortalToJSON(json) {
@@ -75,7 +70,6 @@ export function GetPortalToJSONTyped(value, ignoreDiscriminator = false) {
         'logo_url': value['logoUrl'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
-        'selected_user_role': value['selectedUserRole'],
-        'base_user_role': value['baseUserRole'],
+        'base_type': value['baseType'],
     };
 }

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

@@ -40,11 +40,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}
@@ -52,15 +52,6 @@ export interface 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.
  */