@easyedu/js-lsm-api 1.32.0 → 1.34.0

package/dist/models/GetRole.d.ts

@@ -0,0 +1,88 @@
+/**
+ * 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 type { GetPermission } from './GetPermission';
+/**
+ * A role with its assigned permissions
+ * @export
+ * @interface GetRole
+ */
+export interface GetRole {
+    /**
+     * External UUID of the role
+     * @type {string}
+     * @memberof GetRole
+     */
+    id: string;
+    /**
+     * Display name of the role
+     * @type {string}
+     * @memberof GetRole
+     */
+    name: string;
+    /**
+     * Optional description of the role
+     * @type {string}
+     * @memberof GetRole
+     */
+    description?: string | null;
+    /**
+     * The base role type this role derives from
+     * @type {GetRoleBaseTypeEnum}
+     * @memberof GetRole
+     */
+    baseType: GetRoleBaseTypeEnum;
+    /**
+     * Portal this role is scoped to (null for system roles)
+     * @type {string}
+     * @memberof GetRole
+     */
+    portalId?: string | null;
+    /**
+     * Whether this is a built-in system role (cannot be modified)
+     * @type {boolean}
+     * @memberof GetRole
+     */
+    isSystem: boolean;
+    /**
+     * Whether this role is active
+     * @type {boolean}
+     * @memberof GetRole
+     */
+    isActive: boolean;
+    /**
+     *
+     * @type {Array<GetPermission>}
+     * @memberof GetRole
+     */
+    permissions: Array<GetPermission>;
+}
+/**
+ * @export
+ */
+export declare const GetRoleBaseTypeEnum: {
+    readonly Owner: "Owner";
+    readonly Admin: "Admin";
+    readonly Instructor: "Instructor";
+    readonly Learner: "Learner";
+    readonly ClientSuperAdmin: "ClientSuperAdmin";
+    readonly ClientManager: "ClientManager";
+    readonly PortalClientAdministrator: "PortalClientAdministrator";
+};
+export type GetRoleBaseTypeEnum = typeof GetRoleBaseTypeEnum[keyof typeof GetRoleBaseTypeEnum];
+/**
+ * Check if a given object implements the GetRole interface.
+ */
+export declare function instanceOfGetRole(value: object): value is GetRole;
+export declare function GetRoleFromJSON(json: any): GetRole;
+export declare function GetRoleFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetRole;
+export declare function GetRoleToJSON(json: any): GetRole;
+export declare function GetRoleToJSONTyped(value?: GetRole | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetRole.js

@@ -0,0 +1,88 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetRoleBaseTypeEnum = void 0;
+exports.instanceOfGetRole = instanceOfGetRole;
+exports.GetRoleFromJSON = GetRoleFromJSON;
+exports.GetRoleFromJSONTyped = GetRoleFromJSONTyped;
+exports.GetRoleToJSON = GetRoleToJSON;
+exports.GetRoleToJSONTyped = GetRoleToJSONTyped;
+const GetPermission_1 = require("./GetPermission");
+/**
+ * @export
+ */
+exports.GetRoleBaseTypeEnum = {
+    Owner: 'Owner',
+    Admin: 'Admin',
+    Instructor: 'Instructor',
+    Learner: 'Learner',
+    ClientSuperAdmin: 'ClientSuperAdmin',
+    ClientManager: 'ClientManager',
+    PortalClientAdministrator: 'PortalClientAdministrator'
+};
+/**
+ * Check if a given object implements the GetRole interface.
+ */
+function instanceOfGetRole(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('baseType' in value) || value['baseType'] === undefined)
+        return false;
+    if (!('isSystem' in value) || value['isSystem'] === undefined)
+        return false;
+    if (!('isActive' in value) || value['isActive'] === undefined)
+        return false;
+    if (!('permissions' in value) || value['permissions'] === undefined)
+        return false;
+    return true;
+}
+function GetRoleFromJSON(json) {
+    return GetRoleFromJSONTyped(json, false);
+}
+function GetRoleFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'baseType': json['base_type'],
+        'portalId': json['portal_id'] == null ? undefined : json['portal_id'],
+        'isSystem': json['is_system'],
+        'isActive': json['is_active'],
+        'permissions': (json['permissions'].map(GetPermission_1.GetPermissionFromJSON)),
+    };
+}
+function GetRoleToJSON(json) {
+    return GetRoleToJSONTyped(json, false);
+}
+function GetRoleToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'base_type': value['baseType'],
+        'portal_id': value['portalId'],
+        'is_system': value['isSystem'],
+        'is_active': value['isActive'],
+        'permissions': (value['permissions'].map(GetPermission_1.GetPermissionToJSON)),
+    };
+}

package/dist/models/GetScormApiLogItem.d.ts

@@ -29,7 +29,7 @@ export interface GetScormApiLogItem {
     createdAt: number;
     /**
      * The SCORM API method that was called
-     * @type {string}
+     * @type {GetScormApiLogItemMethodEnum}
      * @memberof GetScormApiLogItem
      */
     method: GetScormApiLogItemMethodEnum;

package/dist/models/GetUserQuizAttemptsAllOfAttempts.d.ts

@@ -65,7 +65,7 @@ export interface GetUserQuizAttemptsAllOfAttempts {
     attemptNumber: number;
     /**
      * Attempt status
-     * @type {string}
+     * @type {GetUserQuizAttemptsAllOfAttemptsStatusEnum}
      * @memberof GetUserQuizAttemptsAllOfAttempts
      */
     status: GetUserQuizAttemptsAllOfAttemptsStatusEnum;

package/dist/models/GetUserQuizAttemptsAllOfFilters.d.ts

@@ -36,7 +36,7 @@ export interface GetUserQuizAttemptsAllOfFilters {
     quizId?: string;
     /**
      * Filter by attempt status
-     * @type {string}
+     * @type {GetUserQuizAttemptsAllOfFiltersStatusEnum}
      * @memberof GetUserQuizAttemptsAllOfFilters
      */
     status?: GetUserQuizAttemptsAllOfFiltersStatusEnum;

package/dist/models/GetUserRole.d.ts

@@ -0,0 +1,63 @@
+/**
+ * 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 role assigned to a user in a portal
+ * @export
+ * @interface GetUserRole
+ */
+export interface GetUserRole {
+    /**
+     * External UUID of the role
+     * @type {string}
+     * @memberof GetUserRole
+     */
+    id: string;
+    /**
+     * Role name
+     * @type {string}
+     * @memberof GetUserRole
+     */
+    name: string;
+    /**
+     * Base role type
+     * @type {GetUserRoleBaseTypeEnum}
+     * @memberof GetUserRole
+     */
+    baseType: GetUserRoleBaseTypeEnum;
+    /**
+     * Whether this is a system role
+     * @type {boolean}
+     * @memberof GetUserRole
+     */
+    isSystem: boolean;
+}
+/**
+ * @export
+ */
+export declare const GetUserRoleBaseTypeEnum: {
+    readonly Owner: "Owner";
+    readonly Admin: "Admin";
+    readonly Instructor: "Instructor";
+    readonly Learner: "Learner";
+    readonly ClientSuperAdmin: "ClientSuperAdmin";
+    readonly ClientManager: "ClientManager";
+    readonly PortalClientAdministrator: "PortalClientAdministrator";
+};
+export type GetUserRoleBaseTypeEnum = typeof GetUserRoleBaseTypeEnum[keyof typeof GetUserRoleBaseTypeEnum];
+/**
+ * Check if a given object implements the GetUserRole interface.
+ */
+export declare function instanceOfGetUserRole(value: object): value is GetUserRole;
+export declare function GetUserRoleFromJSON(json: any): GetUserRole;
+export declare function GetUserRoleFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserRole;
+export declare function GetUserRoleToJSON(json: any): GetUserRole;
+export declare function GetUserRoleToJSONTyped(value?: GetUserRole | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetUserRole.js

@@ -0,0 +1,75 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetUserRoleBaseTypeEnum = void 0;
+exports.instanceOfGetUserRole = instanceOfGetUserRole;
+exports.GetUserRoleFromJSON = GetUserRoleFromJSON;
+exports.GetUserRoleFromJSONTyped = GetUserRoleFromJSONTyped;
+exports.GetUserRoleToJSON = GetUserRoleToJSON;
+exports.GetUserRoleToJSONTyped = GetUserRoleToJSONTyped;
+/**
+ * @export
+ */
+exports.GetUserRoleBaseTypeEnum = {
+    Owner: 'Owner',
+    Admin: 'Admin',
+    Instructor: 'Instructor',
+    Learner: 'Learner',
+    ClientSuperAdmin: 'ClientSuperAdmin',
+    ClientManager: 'ClientManager',
+    PortalClientAdministrator: 'PortalClientAdministrator'
+};
+/**
+ * Check if a given object implements the GetUserRole interface.
+ */
+function instanceOfGetUserRole(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('baseType' in value) || value['baseType'] === undefined)
+        return false;
+    if (!('isSystem' in value) || value['isSystem'] === undefined)
+        return false;
+    return true;
+}
+function GetUserRoleFromJSON(json) {
+    return GetUserRoleFromJSONTyped(json, false);
+}
+function GetUserRoleFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'baseType': json['base_type'],
+        'isSystem': json['is_system'],
+    };
+}
+function GetUserRoleToJSON(json) {
+    return GetUserRoleToJSONTyped(json, false);
+}
+function GetUserRoleToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'base_type': value['baseType'],
+        'is_system': value['isSystem'],
+    };
+}

package/dist/models/ManualSelection.d.ts

@@ -17,7 +17,7 @@
 export interface ManualSelection {
     /**
      *
-     * @type {string}
+     * @type {ManualSelectionMethodEnum}
      * @memberof ManualSelection
      */
     method: ManualSelectionMethodEnum;

package/dist/models/MultipleAnswer.d.ts

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

package/dist/models/MultipleAnswer1.d.ts

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

package/dist/models/NoAnswer.d.ts

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

package/dist/models/PostContentUpload.d.ts

@@ -23,7 +23,7 @@ export interface PostContentUpload {
     name: string;
     /**
      * The type of content being uploaded
-     * @type {string}
+     * @type {PostContentUploadContentTypeEnum}
      * @memberof PostContentUpload
      */
     contentType: PostContentUploadContentTypeEnum;

package/dist/models/PostCourseExport.d.ts

@@ -17,7 +17,7 @@
 export interface PostCourseExport {
     /**
      * The SCORM version to export
-     * @type {string}
+     * @type {PostCourseExportScormVersionEnum}
      * @memberof PostCourseExport
      */
     scormVersion: PostCourseExportScormVersionEnum;

package/dist/models/PostPortalInvite.d.ts

@@ -34,8 +34,8 @@ export interface PostPortalInvite {
      */
     lastName: string;
     /**
-     *
-     * @type {string}
+     * Role name to assign to the invited user
+     * @type {PostPortalInviteUserTypeEnum}
      * @memberof PostPortalInvite
      */
     userType: PostPortalInviteUserTypeEnum;
@@ -44,9 +44,13 @@ export interface PostPortalInvite {
  * @export
  */
 export declare const PostPortalInviteUserTypeEnum: {
+    readonly Owner: "Owner";
     readonly Admin: "Admin";
     readonly Instructor: "Instructor";
     readonly Learner: "Learner";
+    readonly ClientSuperAdmin: "ClientSuperAdmin";
+    readonly ClientManager: "ClientManager";
+    readonly PortalClientAdministrator: "PortalClientAdministrator";
 };
 export type PostPortalInviteUserTypeEnum = typeof PostPortalInviteUserTypeEnum[keyof typeof PostPortalInviteUserTypeEnum];
 /**

package/dist/models/PostPortalInvite.js

@@ -23,9 +23,13 @@ exports.PostPortalInviteToJSONTyped = PostPortalInviteToJSONTyped;
  * @export
  */
 exports.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/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/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/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/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/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/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/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/models/PostRole.js

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

package/dist/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;