@easyedu/js-lsm-api 1.93.0 → 1.94.0

package/docs/GetLibraryQuizCriteriaPreview.md

@@ -0,0 +1,36 @@
+
+# GetLibraryQuizCriteriaPreview
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalUniqueQuestions` | number
+`criteria` | [Array<LibraryQuizCriterionPreview>](LibraryQuizCriterionPreview.md)
+
+## Example
+
+```typescript
+import type { GetLibraryQuizCriteriaPreview } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalUniqueQuestions": null,
+  "criteria": null,
+} satisfies GetLibraryQuizCriteriaPreview
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetLibraryQuizCriteriaPreview
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/LibraryQuizCriteriaPreviewQuestion.md

@@ -0,0 +1,48 @@
+
+# LibraryQuizCriteriaPreviewQuestion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`questionText` | [RichTextDocument](RichTextDocument.md)
+`questionType` | string
+`versionNumber` | number
+`version` | string
+`topic` | string
+`difficultyLevel` | string
+`tags` | Array<string>
+
+## Example
+
+```typescript
+import type { LibraryQuizCriteriaPreviewQuestion } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "questionText": null,
+  "questionType": null,
+  "versionNumber": null,
+  "version": null,
+  "topic": null,
+  "difficultyLevel": null,
+  "tags": null,
+} satisfies LibraryQuizCriteriaPreviewQuestion
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as LibraryQuizCriteriaPreviewQuestion
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/LibraryQuizCriterionPreview.md

@@ -0,0 +1,44 @@
+
+# LibraryQuizCriterionPreview
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`priority` | number
+`matchingQuestionCount` | number
+`minimumQuestions` | number
+`maximumQuestions` | number
+`minimumSatisfied` | boolean
+`questions` | [Array<LibraryQuizCriteriaPreviewQuestion>](LibraryQuizCriteriaPreviewQuestion.md)
+
+## Example
+
+```typescript
+import type { LibraryQuizCriterionPreview } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "priority": null,
+  "matchingQuestionCount": null,
+  "minimumQuestions": null,
+  "maximumQuestions": null,
+  "minimumSatisfied": null,
+  "questions": null,
+} satisfies LibraryQuizCriterionPreview
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as LibraryQuizCriterionPreview
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.93.0",
+  "version": "1.94.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/ContentLibraryQuizApi.ts

@@ -23,6 +23,11 @@ import {
     GetLibraryQuizAnalyticsFromJSON,
     GetLibraryQuizAnalyticsToJSON,
 } from '../models/GetLibraryQuizAnalytics';
+import {
+    type GetLibraryQuizCriteriaPreview,
+    GetLibraryQuizCriteriaPreviewFromJSON,
+    GetLibraryQuizCriteriaPreviewToJSON,
+} from '../models/GetLibraryQuizCriteriaPreview';
 import {
     type GetLibraryQuizList,
     GetLibraryQuizListFromJSON,
@@ -197,6 +202,12 @@ export interface PostLibraryQuizArchiveRequest {
     quizId: string;
 }
 
+export interface PostLibraryQuizCriteriaPreviewRequest {
+    quizId: string;
+    versionId: string;
+    putLibraryQuizCriteria: PutLibraryQuizCriteria;
+}
+
 export interface PostLibraryQuizSessionRequest {
     quizId: string;
     versionId: string;
@@ -996,6 +1007,69 @@ export class ContentLibraryQuizApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for postLibraryQuizCriteriaPreview without sending the request
+     */
+    async postLibraryQuizCriteriaPreviewRequestOpts(requestParameters: PostLibraryQuizCriteriaPreviewRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['quizId'] == null) {
+            throw new runtime.RequiredError(
+                'quizId',
+                'Required parameter "quizId" was null or undefined when calling postLibraryQuizCriteriaPreview().'
+            );
+        }
+
+        if (requestParameters['versionId'] == null) {
+            throw new runtime.RequiredError(
+                'versionId',
+                'Required parameter "versionId" was null or undefined when calling postLibraryQuizCriteriaPreview().'
+            );
+        }
+
+        if (requestParameters['putLibraryQuizCriteria'] == null) {
+            throw new runtime.RequiredError(
+                'putLibraryQuizCriteria',
+                'Required parameter "putLibraryQuizCriteria" was null or undefined when calling postLibraryQuizCriteriaPreview().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/content-library/quizzes/{quizId}/versions/{versionId}/criteria/preview`;
+        urlPath = urlPath.replace('{quizId}', encodeURIComponent(String(requestParameters['quizId'])));
+        urlPath = urlPath.replace('{versionId}', encodeURIComponent(String(requestParameters['versionId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutLibraryQuizCriteriaToJSON(requestParameters['putLibraryQuizCriteria']),
+        };
+    }
+
+    /**
+     * Preview questions matching unsaved quiz-selection criteria
+     */
+    async postLibraryQuizCriteriaPreviewRaw(requestParameters: PostLibraryQuizCriteriaPreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLibraryQuizCriteriaPreview>> {
+        const requestOptions = await this.postLibraryQuizCriteriaPreviewRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetLibraryQuizCriteriaPreviewFromJSON(jsonValue));
+    }
+
+    /**
+     * Preview questions matching unsaved quiz-selection criteria
+     */
+    async postLibraryQuizCriteriaPreview(requestParameters: PostLibraryQuizCriteriaPreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLibraryQuizCriteriaPreview> {
+        const response = await this.postLibraryQuizCriteriaPreviewRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for postLibraryQuizSession without sending the request
      */

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/index.ts

@@ -104,6 +104,7 @@ export * from './GetEmailTemplateList';
 export * from './GetEmailTemplatePreview';
 export * from './GetLibraryQuiz';
 export * from './GetLibraryQuizAnalytics';
+export * from './GetLibraryQuizCriteriaPreview';
 export * from './GetLibraryQuizList';
 export * from './GetLibraryQuizResult';
 export * from './GetLibraryQuizSession';
@@ -232,7 +233,9 @@ export * from './GetUserQuizAttemptsAllOfAttempts';
 export * from './GetUserQuizAttemptsAllOfFilters';
 export * from './GetUserQuizAttemptsAllOfSummary';
 export * from './GetUserRole';
+export * from './LibraryQuizCriteriaPreviewQuestion';
 export * from './LibraryQuizCriterion';
+export * from './LibraryQuizCriterionPreview';
 export * from './LibraryQuizQuestion';
 export * from './LibraryQuizQuestionInput';
 export * from './LibraryQuizSessionAnswerChoice';