@easyedu/js-lsm-api 1.32.0 → 1.33.0

package/src/models/PostRole.ts

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

package/src/models/PutCourseEnrollment.ts

@@ -21,13 +21,13 @@ import { mapValues } from '../runtime';
 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/src/models/PutQuestion.ts

@@ -35,7 +35,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;
@@ -71,7 +71,7 @@ export interface PutQuestion {
     course?: string;
     /**
      * Difficulty level of the question
-     * @type {string}
+     * @type {PutQuestionDifficultyLevelEnum}
      * @memberof PutQuestion
      */
     difficultyLevel?: PutQuestionDifficultyLevelEnum;

package/src/models/PutQuiz.ts

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

package/src/models/PutRole.ts

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

package/src/models/PutRolePermissions.ts

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

package/src/models/QuizContent.ts

@@ -36,7 +36,7 @@ import {
 export interface QuizContent {
     /**
      * Type of quiz
-     * @type {string}
+     * @type {QuizContentQuizTypeEnum}
      * @memberof QuizContent
      */
     quizType: QuizContentQuizTypeEnum;

package/src/models/SingleAnswer.ts

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

package/src/models/index.ts

@@ -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/src/runtime.ts

@@ -261,6 +261,12 @@ export class ResponseError extends Error {
     override name: "ResponseError" = "ResponseError";
     constructor(public response: Response, msg?: string) {
         super(msg);
+
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
     }
 }
 
@@ -268,6 +274,12 @@ export class FetchError extends Error {
     override name: "FetchError" = "FetchError";
     constructor(public cause: Error, msg?: string) {
         super(msg);
+
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
     }
 }
 
@@ -275,6 +287,12 @@ export class RequiredError extends Error {
     override name: "RequiredError" = "RequiredError";
     constructor(public field: string, msg?: string) {
         super(msg);
+
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
     }
 }