@easyedu/js-lsm-api 1.32.0 → 1.33.0

package/dist/esm/models/PostPortalInvite.js

@@ -15,9 +15,13 @@
  * @export
  */
 export const PostPortalInviteUserTypeEnum = {
+    Owner: 'Owner',
     Admin: 'Admin',
     Instructor: 'Instructor',
-    Learner: 'Learner'
+    Learner: 'Learner',
+    ClientSuperAdmin: 'ClientSuperAdmin',
+    ClientManager: 'ClientManager',
+    PortalClientAdministrator: 'PortalClientAdministrator'
 };
 /**
  * Check if a given object implements the PostPortalInvite interface.

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

@@ -24,7 +24,7 @@ export interface PostQuestion {
     questionText: string;
     /**
      * Type of question: single answer (True/False, multiple choice), multiple answer, or fill in the blank
-     * @type {string}
+     * @type {PostQuestionQuestionTypeEnum}
      * @memberof PostQuestion
      */
     questionType: PostQuestionQuestionTypeEnum;
@@ -60,7 +60,7 @@ export interface PostQuestion {
     course?: string;
     /**
      * Difficulty level of the question
-     * @type {string}
+     * @type {PostQuestionDifficultyLevelEnum}
      * @memberof PostQuestion
      */
     difficultyLevel: PostQuestionDifficultyLevelEnum;

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

@@ -24,7 +24,7 @@ export interface PostQuiz {
     contentId: string;
     /**
      * How questions are selected for this quiz
-     * @type {string}
+     * @type {PostQuizQuestionSelectionMethodEnum}
      * @memberof PostQuiz
      */
     questionSelectionMethod: PostQuizQuestionSelectionMethodEnum;

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

@@ -53,7 +53,7 @@ export interface PostQuizAttemptAttempt {
     attemptNumber: number;
     /**
      * Current attempt status
-     * @type {string}
+     * @type {PostQuizAttemptAttemptStatusEnum}
      * @memberof PostQuizAttemptAttempt
      */
     status: PostQuizAttemptAttemptStatusEnum;

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

@@ -48,7 +48,7 @@ export interface PostQuizAttemptQuestionsInner {
     questionText: string;
     /**
      * Question type
-     * @type {string}
+     * @type {PostQuizAttemptQuestionsInnerQuestionTypeEnum}
      * @memberof PostQuizAttemptQuestionsInner
      */
     questionType: PostQuizAttemptQuestionsInnerQuestionTypeEnum;

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

@@ -18,7 +18,7 @@ import type { PostQuizAttemptSubmitFinalAnswersInner } from './PostQuizAttemptSu
 export interface PostQuizAttemptSubmit {
     /**
      * How the quiz was submitted
-     * @type {string}
+     * @type {PostQuizAttemptSubmitSubmissionTypeEnum}
      * @memberof PostQuizAttemptSubmit
      */
     submissionType: PostQuizAttemptSubmitSubmissionTypeEnum;

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

@@ -23,13 +23,13 @@ export interface PostQuizCriteriaCriteriaInner {
     topic?: string;
     /**
      * Filter by difficulty level (null for any difficulty)
-     * @type {string}
+     * @type {PostQuizCriteriaCriteriaInnerDifficultyLevelEnum}
      * @memberof PostQuizCriteriaCriteriaInner
      */
     difficultyLevel?: PostQuizCriteriaCriteriaInnerDifficultyLevelEnum;
     /**
      * Filter by question type (null for any type)
-     * @type {string}
+     * @type {PostQuizCriteriaCriteriaInnerQuestionTypeEnum}
      * @memberof PostQuizCriteriaCriteriaInner
      */
     questionType?: PostQuizCriteriaCriteriaInnerQuestionTypeEnum;

package/dist/esm/models/PostRole.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.
+ */
+/**
+ * Request body for creating a new custom role
+ * @export
+ * @interface PostRole
+ */
+export interface PostRole {
+    /**
+     * Display name for the role
+     * @type {string}
+     * @memberof PostRole
+     */
+    name: string;
+    /**
+     * Optional description
+     * @type {string}
+     * @memberof PostRole
+     */
+    description?: string | null;
+    /**
+     * The base role type to derive from (determines default permissions)
+     * @type {PostRoleBaseTypeEnum}
+     * @memberof PostRole
+     */
+    baseType: PostRoleBaseTypeEnum;
+}
+/**
+ * @export
+ */
+export declare const PostRoleBaseTypeEnum: {
+    readonly Owner: "Owner";
+    readonly Admin: "Admin";
+    readonly Instructor: "Instructor";
+    readonly Learner: "Learner";
+    readonly ClientSuperAdmin: "ClientSuperAdmin";
+    readonly ClientManager: "ClientManager";
+    readonly PortalClientAdministrator: "PortalClientAdministrator";
+};
+export type PostRoleBaseTypeEnum = typeof PostRoleBaseTypeEnum[keyof typeof PostRoleBaseTypeEnum];
+/**
+ * Check if a given object implements the PostRole interface.
+ */
+export declare function instanceOfPostRole(value: object): value is PostRole;
+export declare function PostRoleFromJSON(json: any): PostRole;
+export declare function PostRoleFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostRole;
+export declare function PostRoleToJSON(json: any): PostRole;
+export declare function PostRoleToJSONTyped(value?: PostRole | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostRole.js

@@ -0,0 +1,61 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const PostRoleBaseTypeEnum = {
+    Owner: 'Owner',
+    Admin: 'Admin',
+    Instructor: 'Instructor',
+    Learner: 'Learner',
+    ClientSuperAdmin: 'ClientSuperAdmin',
+    ClientManager: 'ClientManager',
+    PortalClientAdministrator: 'PortalClientAdministrator'
+};
+/**
+ * Check if a given object implements the PostRole interface.
+ */
+export function instanceOfPostRole(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('baseType' in value) || value['baseType'] === undefined)
+        return false;
+    return true;
+}
+export function PostRoleFromJSON(json) {
+    return PostRoleFromJSONTyped(json, false);
+}
+export function PostRoleFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'baseType': json['base_type'],
+    };
+}
+export function PostRoleToJSON(json) {
+    return PostRoleToJSONTyped(json, false);
+}
+export function PostRoleToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'description': value['description'],
+        'base_type': value['baseType'],
+    };
+}

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

@@ -17,13 +17,13 @@
 export interface PutCourseEnrollment {
     /**
      * Current status of the enrollment
-     * @type {string}
+     * @type {PutCourseEnrollmentStatusEnum}
      * @memberof PutCourseEnrollment
      */
     status?: PutCourseEnrollmentStatusEnum;
     /**
      * The role/type of the user in this enrollment
-     * @type {string}
+     * @type {PutCourseEnrollmentUserTypeEnum}
      * @memberof PutCourseEnrollment
      */
     userType?: PutCourseEnrollmentUserTypeEnum;

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

@@ -24,7 +24,7 @@ export interface PutQuestion {
     questionText?: string;
     /**
      * Type of question: single answer (True/False, multiple choice), multiple answer, or fill in the blank
-     * @type {string}
+     * @type {PutQuestionQuestionTypeEnum}
      * @memberof PutQuestion
      */
     questionType?: PutQuestionQuestionTypeEnum;
@@ -60,7 +60,7 @@ export interface PutQuestion {
     course?: string;
     /**
      * Difficulty level of the question
-     * @type {string}
+     * @type {PutQuestionDifficultyLevelEnum}
      * @memberof PutQuestion
      */
     difficultyLevel?: PutQuestionDifficultyLevelEnum;

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

@@ -18,7 +18,7 @@ import type { PutQuizSettings } from './PutQuizSettings';
 export interface PutQuiz {
     /**
      * How questions are selected for this quiz
-     * @type {string}
+     * @type {PutQuizQuestionSelectionMethodEnum}
      * @memberof PutQuiz
      */
     questionSelectionMethod?: PutQuizQuestionSelectionMethodEnum;

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

@@ -0,0 +1,38 @@
+/**
+ * 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.
+ */
+/**
+ * Request body for updating a custom role
+ * @export
+ * @interface PutRole
+ */
+export interface PutRole {
+    /**
+     * Updated display name
+     * @type {string}
+     * @memberof PutRole
+     */
+    name: string;
+    /**
+     * Updated description
+     * @type {string}
+     * @memberof PutRole
+     */
+    description?: string | null;
+}
+/**
+ * Check if a given object implements the PutRole interface.
+ */
+export declare function instanceOfPutRole(value: object): value is PutRole;
+export declare function PutRoleFromJSON(json: any): PutRole;
+export declare function PutRoleFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutRole;
+export declare function PutRoleToJSON(json: any): PutRole;
+export declare function PutRoleToJSONTyped(value?: PutRole | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PutRole.js

@@ -0,0 +1,45 @@
+/* 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 PutRole interface.
+ */
+export function instanceOfPutRole(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+export function PutRoleFromJSON(json) {
+    return PutRoleFromJSONTyped(json, false);
+}
+export function PutRoleFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+export function PutRoleToJSON(json) {
+    return PutRoleToJSONTyped(json, false);
+}
+export function PutRoleToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'description': value['description'],
+    };
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ * Request body for replacing all permissions on a role
+ * @export
+ * @interface PutRolePermissions
+ */
+export interface PutRolePermissions {
+    /**
+     * List of permission keys to assign (e.g. ["course:create", "module:update"])
+     * @type {Array<string>}
+     * @memberof PutRolePermissions
+     */
+    permissionKeys: Array<string>;
+}
+/**
+ * Check if a given object implements the PutRolePermissions interface.
+ */
+export declare function instanceOfPutRolePermissions(value: object): value is PutRolePermissions;
+export declare function PutRolePermissionsFromJSON(json: any): PutRolePermissions;
+export declare function PutRolePermissionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutRolePermissions;
+export declare function PutRolePermissionsToJSON(json: any): PutRolePermissions;
+export declare function PutRolePermissionsToJSONTyped(value?: PutRolePermissions | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PutRolePermissions.js

@@ -0,0 +1,43 @@
+/* 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 PutRolePermissions interface.
+ */
+export function instanceOfPutRolePermissions(value) {
+    if (!('permissionKeys' in value) || value['permissionKeys'] === undefined)
+        return false;
+    return true;
+}
+export function PutRolePermissionsFromJSON(json) {
+    return PutRolePermissionsFromJSONTyped(json, false);
+}
+export function PutRolePermissionsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'permissionKeys': json['permission_keys'],
+    };
+}
+export function PutRolePermissionsToJSON(json) {
+    return PutRolePermissionsToJSONTyped(json, false);
+}
+export function PutRolePermissionsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'permission_keys': value['permissionKeys'],
+    };
+}

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

@@ -19,7 +19,7 @@ import type { QuizContentSettings } from './QuizContentSettings';
 export interface QuizContent {
     /**
      * Type of quiz
-     * @type {string}
+     * @type {QuizContentQuizTypeEnum}
      * @memberof QuizContent
      */
     quizType: QuizContentQuizTypeEnum;

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

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

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

@@ -50,6 +50,7 @@ export * from './GetModuleList';
 export * from './GetModuleStudentReporting';
 export * from './GetModuleStudentReportingAccess';
 export * from './GetModuleStudentReportingProgress';
+export * from './GetPermission';
 export * from './GetPortal';
 export * from './GetPortalBasicReporting';
 export * from './GetPortalBasicReportingCertificates';
@@ -109,6 +110,7 @@ export * from './GetQuizResultsQuestionsInnerStudentAnswer';
 export * from './GetQuizResultsScore';
 export * from './GetQuizResultsTiming';
 export * from './GetQuizStatistics';
+export * from './GetRole';
 export * from './GetScormApiLogItem';
 export * from './GetScormApiLogs';
 export * from './GetScormPackage';
@@ -120,6 +122,7 @@ export * from './GetUserQuizAttempts';
 export * from './GetUserQuizAttemptsAllOfAttempts';
 export * from './GetUserQuizAttemptsAllOfFilters';
 export * from './GetUserQuizAttemptsAllOfSummary';
+export * from './GetUserRole';
 export * from './LoginRes';
 export * from './LoginResAuthData';
 export * from './LoginResUserData';
@@ -161,6 +164,7 @@ export * from './PostQuizQuestions';
 export * from './PostQuizQuestionsQuestionsInner';
 export * from './PostQuizSettings';
 export * from './PostResetPassword';
+export * from './PostRole';
 export * from './PostSendResetPassword';
 export * from './PostVerifyManifest';
 export * from './PostVerifyManifestItemsInner';
@@ -177,6 +181,8 @@ export * from './PutQuiz';
 export * from './PutQuizAnswer';
 export * from './PutQuizAnswerAnswer';
 export * from './PutQuizSettings';
+export * from './PutRole';
+export * from './PutRolePermissions';
 export * from './PutUser';
 export * from './QuizContent';
 export * from './QuizContentAssignment';

package/dist/esm/models/index.js

@@ -52,6 +52,7 @@ export * from './GetModuleList';
 export * from './GetModuleStudentReporting';
 export * from './GetModuleStudentReportingAccess';
 export * from './GetModuleStudentReportingProgress';
+export * from './GetPermission';
 export * from './GetPortal';
 export * from './GetPortalBasicReporting';
 export * from './GetPortalBasicReportingCertificates';
@@ -111,6 +112,7 @@ export * from './GetQuizResultsQuestionsInnerStudentAnswer';
 export * from './GetQuizResultsScore';
 export * from './GetQuizResultsTiming';
 export * from './GetQuizStatistics';
+export * from './GetRole';
 export * from './GetScormApiLogItem';
 export * from './GetScormApiLogs';
 export * from './GetScormPackage';
@@ -122,6 +124,7 @@ export * from './GetUserQuizAttempts';
 export * from './GetUserQuizAttemptsAllOfAttempts';
 export * from './GetUserQuizAttemptsAllOfFilters';
 export * from './GetUserQuizAttemptsAllOfSummary';
+export * from './GetUserRole';
 export * from './LoginRes';
 export * from './LoginResAuthData';
 export * from './LoginResUserData';
@@ -163,6 +166,7 @@ export * from './PostQuizQuestions';
 export * from './PostQuizQuestionsQuestionsInner';
 export * from './PostQuizSettings';
 export * from './PostResetPassword';
+export * from './PostRole';
 export * from './PostSendResetPassword';
 export * from './PostVerifyManifest';
 export * from './PostVerifyManifestItemsInner';
@@ -179,6 +183,8 @@ export * from './PutQuiz';
 export * from './PutQuizAnswer';
 export * from './PutQuizAnswerAnswer';
 export * from './PutQuizSettings';
+export * from './PutRole';
+export * from './PutRolePermissions';
 export * from './PutUser';
 export * from './QuizContent';
 export * from './QuizContentAssignment';

package/dist/esm/runtime.js

@@ -223,6 +223,11 @@ export class ResponseError extends Error {
         super(msg);
         this.response = response;
         this.name = "ResponseError";
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
     }
 }
 export class FetchError extends Error {
@@ -230,6 +235,11 @@ export class FetchError extends Error {
         super(msg);
         this.cause = cause;
         this.name = "FetchError";
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
     }
 }
 export class RequiredError extends Error {
@@ -237,6 +247,11 @@ export class RequiredError extends Error {
         super(msg);
         this.field = field;
         this.name = "RequiredError";
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
     }
 }
 export const COLLECTION_FORMATS = {

package/dist/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/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/models/FillInBlank.d.ts

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

package/dist/models/FillInBlank1.d.ts

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

package/dist/models/GetContent.d.ts

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

package/dist/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/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/models/GetContentInstructorBasicReportingContentInfo.d.ts

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