@easyedu/js-lsm-api 1.93.0 → 1.95.0

package/src/models/GetCourseVersionReporting.ts

@@ -0,0 +1,164 @@
+/* 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';
+import type { GetCourseVersionModuleReporting } from './GetCourseVersionModuleReporting';
+import {
+    GetCourseVersionModuleReportingFromJSON,
+    GetCourseVersionModuleReportingFromJSONTyped,
+    GetCourseVersionModuleReportingToJSON,
+    GetCourseVersionModuleReportingToJSONTyped,
+} from './GetCourseVersionModuleReporting';
+
+/**
+ * 
+ * @export
+ * @interface GetCourseVersionReporting
+ */
+export interface GetCourseVersionReporting {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionReporting
+     */
+    courseId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionReporting
+     */
+    courseVersionId: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionReporting
+     */
+    versionNumber: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionReporting
+     */
+    enrollmentCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionReporting
+     */
+    completedCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionReporting
+     */
+    inProgressCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionReporting
+     */
+    notStartedCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionReporting
+     */
+    completionRatePercentage: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionReporting
+     */
+    avgScorePercentage: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionReporting
+     */
+    totalDurationSeconds: number;
+    /**
+     * 
+     * @type {Array<GetCourseVersionModuleReporting>}
+     * @memberof GetCourseVersionReporting
+     */
+    modules: Array<GetCourseVersionModuleReporting>;
+}
+
+/**
+ * Check if a given object implements the GetCourseVersionReporting interface.
+ */
+export function instanceOfGetCourseVersionReporting(value: object): value is GetCourseVersionReporting {
+    if (!('courseId' in value) || value['courseId'] === undefined) return false;
+    if (!('courseVersionId' in value) || value['courseVersionId'] === undefined) return false;
+    if (!('versionNumber' in value) || value['versionNumber'] === undefined) return false;
+    if (!('enrollmentCount' in value) || value['enrollmentCount'] === undefined) return false;
+    if (!('completedCount' in value) || value['completedCount'] === undefined) return false;
+    if (!('inProgressCount' in value) || value['inProgressCount'] === undefined) return false;
+    if (!('notStartedCount' in value) || value['notStartedCount'] === undefined) return false;
+    if (!('completionRatePercentage' in value) || value['completionRatePercentage'] === undefined) return false;
+    if (!('avgScorePercentage' in value) || value['avgScorePercentage'] === undefined) return false;
+    if (!('totalDurationSeconds' in value) || value['totalDurationSeconds'] === undefined) return false;
+    if (!('modules' in value) || value['modules'] === undefined) return false;
+    return true;
+}
+
+export function GetCourseVersionReportingFromJSON(json: any): GetCourseVersionReporting {
+    return GetCourseVersionReportingFromJSONTyped(json, false);
+}
+
+export function GetCourseVersionReportingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionReporting {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'courseId': json['course_id'],
+        'courseVersionId': json['course_version_id'],
+        'versionNumber': json['version_number'],
+        'enrollmentCount': json['enrollment_count'],
+        'completedCount': json['completed_count'],
+        'inProgressCount': json['in_progress_count'],
+        'notStartedCount': json['not_started_count'],
+        'completionRatePercentage': json['completion_rate_percentage'],
+        'avgScorePercentage': json['avg_score_percentage'],
+        'totalDurationSeconds': json['total_duration_seconds'],
+        'modules': ((json['modules'] as Array<any>).map(GetCourseVersionModuleReportingFromJSON)),
+    };
+}
+
+export function GetCourseVersionReportingToJSON(json: any): GetCourseVersionReporting {
+    return GetCourseVersionReportingToJSONTyped(json, false);
+}
+
+export function GetCourseVersionReportingToJSONTyped(value?: GetCourseVersionReporting | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'course_id': value['courseId'],
+        'course_version_id': value['courseVersionId'],
+        'version_number': value['versionNumber'],
+        'enrollment_count': value['enrollmentCount'],
+        'completed_count': value['completedCount'],
+        'in_progress_count': value['inProgressCount'],
+        'not_started_count': value['notStartedCount'],
+        'completion_rate_percentage': value['completionRatePercentage'],
+        'avg_score_percentage': value['avgScorePercentage'],
+        'total_duration_seconds': value['totalDurationSeconds'],
+        'modules': ((value['modules'] as Array<any>).map(GetCourseVersionModuleReportingToJSON)),
+    };
+}
+

package/src/models/GetLibraryQuizCriteriaPreview.ts

@@ -0,0 +1,83 @@
+/* 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';
+import type { LibraryQuizCriterionPreview } from './LibraryQuizCriterionPreview';
+import {
+    LibraryQuizCriterionPreviewFromJSON,
+    LibraryQuizCriterionPreviewFromJSONTyped,
+    LibraryQuizCriterionPreviewToJSON,
+    LibraryQuizCriterionPreviewToJSONTyped,
+} from './LibraryQuizCriterionPreview';
+
+/**
+ * 
+ * @export
+ * @interface GetLibraryQuizCriteriaPreview
+ */
+export interface GetLibraryQuizCriteriaPreview {
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizCriteriaPreview
+     */
+    totalUniqueQuestions: number;
+    /**
+     * 
+     * @type {Array<LibraryQuizCriterionPreview>}
+     * @memberof GetLibraryQuizCriteriaPreview
+     */
+    criteria: Array<LibraryQuizCriterionPreview>;
+}
+
+/**
+ * Check if a given object implements the GetLibraryQuizCriteriaPreview interface.
+ */
+export function instanceOfGetLibraryQuizCriteriaPreview(value: object): value is GetLibraryQuizCriteriaPreview {
+    if (!('totalUniqueQuestions' in value) || value['totalUniqueQuestions'] === undefined) return false;
+    if (!('criteria' in value) || value['criteria'] === undefined) return false;
+    return true;
+}
+
+export function GetLibraryQuizCriteriaPreviewFromJSON(json: any): GetLibraryQuizCriteriaPreview {
+    return GetLibraryQuizCriteriaPreviewFromJSONTyped(json, false);
+}
+
+export function GetLibraryQuizCriteriaPreviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLibraryQuizCriteriaPreview {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'totalUniqueQuestions': json['total_unique_questions'],
+        'criteria': ((json['criteria'] as Array<any>).map(LibraryQuizCriterionPreviewFromJSON)),
+    };
+}
+
+export function GetLibraryQuizCriteriaPreviewToJSON(json: any): GetLibraryQuizCriteriaPreview {
+    return GetLibraryQuizCriteriaPreviewToJSONTyped(json, false);
+}
+
+export function GetLibraryQuizCriteriaPreviewToJSONTyped(value?: GetLibraryQuizCriteriaPreview | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'total_unique_questions': value['totalUniqueQuestions'],
+        'criteria': ((value['criteria'] as Array<any>).map(LibraryQuizCriterionPreviewToJSON)),
+    };
+}
+

package/src/models/LibraryQuizCriteriaPreviewQuestion.ts

@@ -0,0 +1,161 @@
+/* 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';
+import type { RichTextDocument } from './RichTextDocument';
+import {
+    RichTextDocumentFromJSON,
+    RichTextDocumentFromJSONTyped,
+    RichTextDocumentToJSON,
+    RichTextDocumentToJSONTyped,
+} from './RichTextDocument';
+
+/**
+ * 
+ * @export
+ * @interface LibraryQuizCriteriaPreviewQuestion
+ */
+export interface LibraryQuizCriteriaPreviewQuestion {
+    /**
+     * 
+     * @type {string}
+     * @memberof LibraryQuizCriteriaPreviewQuestion
+     */
+    id: string;
+    /**
+     * 
+     * @type {RichTextDocument}
+     * @memberof LibraryQuizCriteriaPreviewQuestion
+     */
+    questionText: RichTextDocument;
+    /**
+     * 
+     * @type {LibraryQuizCriteriaPreviewQuestionQuestionTypeEnum}
+     * @memberof LibraryQuizCriteriaPreviewQuestion
+     */
+    questionType: LibraryQuizCriteriaPreviewQuestionQuestionTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizCriteriaPreviewQuestion
+     */
+    versionNumber: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof LibraryQuizCriteriaPreviewQuestion
+     */
+    version?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof LibraryQuizCriteriaPreviewQuestion
+     */
+    topic: string;
+    /**
+     * 
+     * @type {LibraryQuizCriteriaPreviewQuestionDifficultyLevelEnum}
+     * @memberof LibraryQuizCriteriaPreviewQuestion
+     */
+    difficultyLevel: LibraryQuizCriteriaPreviewQuestionDifficultyLevelEnum;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof LibraryQuizCriteriaPreviewQuestion
+     */
+    tags: Array<string>;
+}
+
+
+/**
+ * @export
+ */
+export const LibraryQuizCriteriaPreviewQuestionQuestionTypeEnum = {
+    SingleAnswer: 'single_answer',
+    MultipleAnswer: 'multiple_answer',
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
+} as const;
+export type LibraryQuizCriteriaPreviewQuestionQuestionTypeEnum = typeof LibraryQuizCriteriaPreviewQuestionQuestionTypeEnum[keyof typeof LibraryQuizCriteriaPreviewQuestionQuestionTypeEnum];
+
+/**
+ * @export
+ */
+export const LibraryQuizCriteriaPreviewQuestionDifficultyLevelEnum = {
+    Beginner: 'beginner',
+    Intermediate: 'intermediate',
+    Advanced: 'advanced'
+} as const;
+export type LibraryQuizCriteriaPreviewQuestionDifficultyLevelEnum = typeof LibraryQuizCriteriaPreviewQuestionDifficultyLevelEnum[keyof typeof LibraryQuizCriteriaPreviewQuestionDifficultyLevelEnum];
+
+
+/**
+ * Check if a given object implements the LibraryQuizCriteriaPreviewQuestion interface.
+ */
+export function instanceOfLibraryQuizCriteriaPreviewQuestion(value: object): value is LibraryQuizCriteriaPreviewQuestion {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('questionText' in value) || value['questionText'] === undefined) return false;
+    if (!('questionType' in value) || value['questionType'] === undefined) return false;
+    if (!('versionNumber' in value) || value['versionNumber'] === undefined) return false;
+    if (!('topic' in value) || value['topic'] === undefined) return false;
+    if (!('difficultyLevel' in value) || value['difficultyLevel'] === undefined) return false;
+    if (!('tags' in value) || value['tags'] === undefined) return false;
+    return true;
+}
+
+export function LibraryQuizCriteriaPreviewQuestionFromJSON(json: any): LibraryQuizCriteriaPreviewQuestion {
+    return LibraryQuizCriteriaPreviewQuestionFromJSONTyped(json, false);
+}
+
+export function LibraryQuizCriteriaPreviewQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolean): LibraryQuizCriteriaPreviewQuestion {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'questionText': RichTextDocumentFromJSON(json['question_text']),
+        'questionType': json['question_type'],
+        'versionNumber': json['version_number'],
+        'version': json['version'] == null ? undefined : json['version'],
+        'topic': json['topic'],
+        'difficultyLevel': json['difficulty_level'],
+        'tags': json['tags'],
+    };
+}
+
+export function LibraryQuizCriteriaPreviewQuestionToJSON(json: any): LibraryQuizCriteriaPreviewQuestion {
+    return LibraryQuizCriteriaPreviewQuestionToJSONTyped(json, false);
+}
+
+export function LibraryQuizCriteriaPreviewQuestionToJSONTyped(value?: LibraryQuizCriteriaPreviewQuestion | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'question_text': RichTextDocumentToJSON(value['questionText']),
+        'question_type': value['questionType'],
+        'version_number': value['versionNumber'],
+        'version': value['version'],
+        'topic': value['topic'],
+        'difficulty_level': value['difficultyLevel'],
+        'tags': value['tags'],
+    };
+}
+

package/src/models/LibraryQuizCriterionPreview.ts

@@ -0,0 +1,118 @@
+/* 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';
+import type { LibraryQuizCriteriaPreviewQuestion } from './LibraryQuizCriteriaPreviewQuestion';
+import {
+    LibraryQuizCriteriaPreviewQuestionFromJSON,
+    LibraryQuizCriteriaPreviewQuestionFromJSONTyped,
+    LibraryQuizCriteriaPreviewQuestionToJSON,
+    LibraryQuizCriteriaPreviewQuestionToJSONTyped,
+} from './LibraryQuizCriteriaPreviewQuestion';
+
+/**
+ * 
+ * @export
+ * @interface LibraryQuizCriterionPreview
+ */
+export interface LibraryQuizCriterionPreview {
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizCriterionPreview
+     */
+    priority: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizCriterionPreview
+     */
+    matchingQuestionCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizCriterionPreview
+     */
+    minimumQuestions: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizCriterionPreview
+     */
+    maximumQuestions?: number | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof LibraryQuizCriterionPreview
+     */
+    minimumSatisfied: boolean;
+    /**
+     * 
+     * @type {Array<LibraryQuizCriteriaPreviewQuestion>}
+     * @memberof LibraryQuizCriterionPreview
+     */
+    questions: Array<LibraryQuizCriteriaPreviewQuestion>;
+}
+
+/**
+ * Check if a given object implements the LibraryQuizCriterionPreview interface.
+ */
+export function instanceOfLibraryQuizCriterionPreview(value: object): value is LibraryQuizCriterionPreview {
+    if (!('priority' in value) || value['priority'] === undefined) return false;
+    if (!('matchingQuestionCount' in value) || value['matchingQuestionCount'] === undefined) return false;
+    if (!('minimumQuestions' in value) || value['minimumQuestions'] === undefined) return false;
+    if (!('minimumSatisfied' in value) || value['minimumSatisfied'] === undefined) return false;
+    if (!('questions' in value) || value['questions'] === undefined) return false;
+    return true;
+}
+
+export function LibraryQuizCriterionPreviewFromJSON(json: any): LibraryQuizCriterionPreview {
+    return LibraryQuizCriterionPreviewFromJSONTyped(json, false);
+}
+
+export function LibraryQuizCriterionPreviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): LibraryQuizCriterionPreview {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'priority': json['priority'],
+        'matchingQuestionCount': json['matching_question_count'],
+        'minimumQuestions': json['minimum_questions'],
+        'maximumQuestions': json['maximum_questions'] == null ? undefined : json['maximum_questions'],
+        'minimumSatisfied': json['minimum_satisfied'],
+        'questions': ((json['questions'] as Array<any>).map(LibraryQuizCriteriaPreviewQuestionFromJSON)),
+    };
+}
+
+export function LibraryQuizCriterionPreviewToJSON(json: any): LibraryQuizCriterionPreview {
+    return LibraryQuizCriterionPreviewToJSONTyped(json, false);
+}
+
+export function LibraryQuizCriterionPreviewToJSONTyped(value?: LibraryQuizCriterionPreview | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'priority': value['priority'],
+        'matching_question_count': value['matchingQuestionCount'],
+        'minimum_questions': value['minimumQuestions'],
+        'maximum_questions': value['maximumQuestions'],
+        'minimum_satisfied': value['minimumSatisfied'],
+        'questions': ((value['questions'] as Array<any>).map(LibraryQuizCriteriaPreviewQuestionToJSON)),
+    };
+}
+

package/src/models/PostCertificateConfig.ts

@@ -76,7 +76,7 @@ export interface PostCertificateConfig {
      * @type {string}
      * @memberof PostCertificateConfig
      */
-    quizConfigId?: string | null;
+    quizId?: string | null;
     /**
      * 
      * @type {string}
@@ -126,7 +126,7 @@ export function PostCertificateConfigFromJSONTyped(json: any, ignoreDiscriminato
         'expiryMonths': json['expiry_months'] == null ? undefined : json['expiry_months'],
         'requireQuizPass': json['require_quiz_pass'] == null ? undefined : json['require_quiz_pass'],
         'minQuizScore': json['min_quiz_score'] == null ? undefined : json['min_quiz_score'],
-        'quizConfigId': json['quiz_config_id'] == null ? undefined : json['quiz_config_id'],
+        'quizId': json['quiz_id'] == null ? undefined : json['quiz_id'],
         'certificateTemplateId': json['certificate_template_id'] == null ? undefined : json['certificate_template_id'],
         'renewalPolicy': json['renewal_policy'] == null ? undefined : CertificateRenewalPolicyFromJSON(json['renewal_policy']),
         'notificationPolicy': json['notification_policy'] == null ? undefined : CertificateNotificationPolicyFromJSON(json['notification_policy']),
@@ -150,7 +150,7 @@ export function PostCertificateConfigToJSONTyped(value?: PostCertificateConfig |
         'expiry_months': value['expiryMonths'],
         'require_quiz_pass': value['requireQuizPass'],
         'min_quiz_score': value['minQuizScore'],
-        'quiz_config_id': value['quizConfigId'],
+        'quiz_id': value['quizId'],
         'certificate_template_id': value['certificateTemplateId'],
         'renewal_policy': CertificateRenewalPolicyToJSON(value['renewalPolicy']),
         'notification_policy': CertificateNotificationPolicyToJSON(value['notificationPolicy']),

package/src/models/PostCourseExport.ts

@@ -19,6 +19,12 @@ import { mapValues } from '../runtime';
  * @interface PostCourseExport
  */
 export interface PostCourseExport {
+    /**
+     * Immutable course version to export
+     * @type {string}
+     * @memberof PostCourseExport
+     */
+    courseVersionId: string;
     /**
      * The export format type
      * @type {PostCourseExportExportTypeEnum}
@@ -49,6 +55,7 @@ export type PostCourseExportExportTypeEnum = typeof PostCourseExportExportTypeEn
  * Check if a given object implements the PostCourseExport interface.
  */
 export function instanceOfPostCourseExport(value: object): value is PostCourseExport {
+    if (!('courseVersionId' in value) || value['courseVersionId'] === undefined) return false;
     if (!('exportType' in value) || value['exportType'] === undefined) return false;
     if (!('moduleIds' in value) || value['moduleIds'] === undefined) return false;
     return true;
@@ -64,6 +71,7 @@ export function PostCourseExportFromJSONTyped(json: any, ignoreDiscriminator: bo
     }
     return {
         
+        'courseVersionId': json['course_version_id'],
         'exportType': json['export_type'],
         'moduleIds': json['module_ids'],
     };
@@ -80,6 +88,7 @@ export function PostCourseExportToJSONTyped(value?: PostCourseExport | null, ign
 
     return {
         
+        'course_version_id': value['courseVersionId'],
         'export_type': value['exportType'],
         'module_ids': value['moduleIds'],
     };