@easyedu/js-lsm-api 1.111.0 → 1.113.0

package/dist/models/QuestionImportPreviewImage.d.ts

@@ -0,0 +1,84 @@
+/**
+ * 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
+ * @interface QuestionImportPreviewImage
+ */
+export interface QuestionImportPreviewImage {
+    /**
+     * Import-scoped image identifier used by source: image placeholders
+     * @type {string}
+     * @memberof QuestionImportPreviewImage
+     */
+    sourceId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuestionImportPreviewImage
+     */
+    filename: string;
+    /**
+     *
+     * @type {QuestionImportPreviewImageMimeTypeEnum}
+     * @memberof QuestionImportPreviewImage
+     */
+    mimeType: QuestionImportPreviewImageMimeTypeEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof QuestionImportPreviewImage
+     */
+    byteSize: number;
+    /**
+     *
+     * @type {number}
+     * @memberof QuestionImportPreviewImage
+     */
+    width?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof QuestionImportPreviewImage
+     */
+    height?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof QuestionImportPreviewImage
+     */
+    sha256: string;
+    /**
+     * Base64 image bytes for stateless review; reposted unchanged when committing
+     * @type {string}
+     * @memberof QuestionImportPreviewImage
+     */
+    dataBase64: string;
+}
+/**
+ * @export
+ */
+export declare const QuestionImportPreviewImageMimeTypeEnum: {
+    readonly ImagePng: "image/png";
+    readonly ImageJpeg: "image/jpeg";
+    readonly ImageWebp: "image/webp";
+    readonly ImageGif: "image/gif";
+};
+export type QuestionImportPreviewImageMimeTypeEnum = typeof QuestionImportPreviewImageMimeTypeEnum[keyof typeof QuestionImportPreviewImageMimeTypeEnum];
+/**
+ * Check if a given object implements the QuestionImportPreviewImage interface.
+ */
+export declare function instanceOfQuestionImportPreviewImage(value: object): value is QuestionImportPreviewImage;
+export declare function QuestionImportPreviewImageFromJSON(json: any): QuestionImportPreviewImage;
+export declare function QuestionImportPreviewImageFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuestionImportPreviewImage;
+export declare function QuestionImportPreviewImageToJSON(json: any): QuestionImportPreviewImage;
+export declare function QuestionImportPreviewImageToJSONTyped(value?: QuestionImportPreviewImage | null, ignoreDiscriminator?: boolean): any;

package/dist/models/QuestionImportPreviewImage.js

@@ -0,0 +1,84 @@
+"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.QuestionImportPreviewImageMimeTypeEnum = void 0;
+exports.instanceOfQuestionImportPreviewImage = instanceOfQuestionImportPreviewImage;
+exports.QuestionImportPreviewImageFromJSON = QuestionImportPreviewImageFromJSON;
+exports.QuestionImportPreviewImageFromJSONTyped = QuestionImportPreviewImageFromJSONTyped;
+exports.QuestionImportPreviewImageToJSON = QuestionImportPreviewImageToJSON;
+exports.QuestionImportPreviewImageToJSONTyped = QuestionImportPreviewImageToJSONTyped;
+/**
+ * @export
+ */
+exports.QuestionImportPreviewImageMimeTypeEnum = {
+    ImagePng: 'image/png',
+    ImageJpeg: 'image/jpeg',
+    ImageWebp: 'image/webp',
+    ImageGif: 'image/gif'
+};
+/**
+ * Check if a given object implements the QuestionImportPreviewImage interface.
+ */
+function instanceOfQuestionImportPreviewImage(value) {
+    if (!('sourceId' in value) || value['sourceId'] === undefined)
+        return false;
+    if (!('filename' in value) || value['filename'] === undefined)
+        return false;
+    if (!('mimeType' in value) || value['mimeType'] === undefined)
+        return false;
+    if (!('byteSize' in value) || value['byteSize'] === undefined)
+        return false;
+    if (!('sha256' in value) || value['sha256'] === undefined)
+        return false;
+    if (!('dataBase64' in value) || value['dataBase64'] === undefined)
+        return false;
+    return true;
+}
+function QuestionImportPreviewImageFromJSON(json) {
+    return QuestionImportPreviewImageFromJSONTyped(json, false);
+}
+function QuestionImportPreviewImageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'sourceId': json['source_id'],
+        'filename': json['filename'],
+        'mimeType': json['mime_type'],
+        'byteSize': json['byte_size'],
+        'width': json['width'] == null ? undefined : json['width'],
+        'height': json['height'] == null ? undefined : json['height'],
+        'sha256': json['sha256'],
+        'dataBase64': json['data_base64'],
+    };
+}
+function QuestionImportPreviewImageToJSON(json) {
+    return QuestionImportPreviewImageToJSONTyped(json, false);
+}
+function QuestionImportPreviewImageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'source_id': value['sourceId'],
+        'filename': value['filename'],
+        'mime_type': value['mimeType'],
+        'byte_size': value['byteSize'],
+        'width': value['width'],
+        'height': value['height'],
+        'sha256': value['sha256'],
+        'data_base64': value['dataBase64'],
+    };
+}

package/dist/models/QuestionImportSource.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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
+ * @interface QuestionImportSource
+ */
+export interface QuestionImportSource {
+    /**
+     * Editable source label proposed from the detected quiz title or filename
+     * @type {string}
+     * @memberof QuestionImportSource
+     */
+    label: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuestionImportSource
+     */
+    detectedTitle?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof QuestionImportSource
+     */
+    originalFilename: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuestionImportSource
+     */
+    mediaType: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuestionImportSource
+     */
+    fileSha256: string;
+}
+/**
+ * Check if a given object implements the QuestionImportSource interface.
+ */
+export declare function instanceOfQuestionImportSource(value: object): value is QuestionImportSource;
+export declare function QuestionImportSourceFromJSON(json: any): QuestionImportSource;
+export declare function QuestionImportSourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuestionImportSource;
+export declare function QuestionImportSourceToJSON(json: any): QuestionImportSource;
+export declare function QuestionImportSourceToJSONTyped(value?: QuestionImportSource | null, ignoreDiscriminator?: boolean): any;

package/dist/models/QuestionImportSource.js

@@ -0,0 +1,64 @@
+"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.instanceOfQuestionImportSource = instanceOfQuestionImportSource;
+exports.QuestionImportSourceFromJSON = QuestionImportSourceFromJSON;
+exports.QuestionImportSourceFromJSONTyped = QuestionImportSourceFromJSONTyped;
+exports.QuestionImportSourceToJSON = QuestionImportSourceToJSON;
+exports.QuestionImportSourceToJSONTyped = QuestionImportSourceToJSONTyped;
+/**
+ * Check if a given object implements the QuestionImportSource interface.
+ */
+function instanceOfQuestionImportSource(value) {
+    if (!('label' in value) || value['label'] === undefined)
+        return false;
+    if (!('originalFilename' in value) || value['originalFilename'] === undefined)
+        return false;
+    if (!('mediaType' in value) || value['mediaType'] === undefined)
+        return false;
+    if (!('fileSha256' in value) || value['fileSha256'] === undefined)
+        return false;
+    return true;
+}
+function QuestionImportSourceFromJSON(json) {
+    return QuestionImportSourceFromJSONTyped(json, false);
+}
+function QuestionImportSourceFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'label': json['label'],
+        'detectedTitle': json['detected_title'] == null ? undefined : json['detected_title'],
+        'originalFilename': json['original_filename'],
+        'mediaType': json['media_type'],
+        'fileSha256': json['file_sha256'],
+    };
+}
+function QuestionImportSourceToJSON(json) {
+    return QuestionImportSourceToJSONTyped(json, false);
+}
+function QuestionImportSourceToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'label': value['label'],
+        'detected_title': value['detectedTitle'],
+        'original_filename': value['originalFilename'],
+        'media_type': value['mediaType'],
+        'file_sha256': value['fileSha256'],
+    };
+}

package/dist/models/QuestionImportSourceSummary.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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
+ * @interface QuestionImportSourceSummary
+ */
+export interface QuestionImportSourceSummary {
+    /**
+     *
+     * @type {string}
+     * @memberof QuestionImportSourceSummary
+     */
+    label: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuestionImportSourceSummary
+     */
+    originalFilename: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuestionImportSourceSummary
+     */
+    sourceKey?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuestionImportSourceSummary
+     */
+    importedAt: Date;
+}
+/**
+ * Check if a given object implements the QuestionImportSourceSummary interface.
+ */
+export declare function instanceOfQuestionImportSourceSummary(value: object): value is QuestionImportSourceSummary;
+export declare function QuestionImportSourceSummaryFromJSON(json: any): QuestionImportSourceSummary;
+export declare function QuestionImportSourceSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuestionImportSourceSummary;
+export declare function QuestionImportSourceSummaryToJSON(json: any): QuestionImportSourceSummary;
+export declare function QuestionImportSourceSummaryToJSONTyped(value?: QuestionImportSourceSummary | null, ignoreDiscriminator?: boolean): any;

package/dist/models/QuestionImportSourceSummary.js

@@ -0,0 +1,60 @@
+"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.instanceOfQuestionImportSourceSummary = instanceOfQuestionImportSourceSummary;
+exports.QuestionImportSourceSummaryFromJSON = QuestionImportSourceSummaryFromJSON;
+exports.QuestionImportSourceSummaryFromJSONTyped = QuestionImportSourceSummaryFromJSONTyped;
+exports.QuestionImportSourceSummaryToJSON = QuestionImportSourceSummaryToJSON;
+exports.QuestionImportSourceSummaryToJSONTyped = QuestionImportSourceSummaryToJSONTyped;
+/**
+ * Check if a given object implements the QuestionImportSourceSummary interface.
+ */
+function instanceOfQuestionImportSourceSummary(value) {
+    if (!('label' in value) || value['label'] === undefined)
+        return false;
+    if (!('originalFilename' in value) || value['originalFilename'] === undefined)
+        return false;
+    if (!('importedAt' in value) || value['importedAt'] === undefined)
+        return false;
+    return true;
+}
+function QuestionImportSourceSummaryFromJSON(json) {
+    return QuestionImportSourceSummaryFromJSONTyped(json, false);
+}
+function QuestionImportSourceSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'label': json['label'],
+        'originalFilename': json['original_filename'],
+        'sourceKey': json['source_key'] == null ? undefined : json['source_key'],
+        'importedAt': (new Date(json['imported_at'])),
+    };
+}
+function QuestionImportSourceSummaryToJSON(json) {
+    return QuestionImportSourceSummaryToJSONTyped(json, false);
+}
+function QuestionImportSourceSummaryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'label': value['label'],
+        'original_filename': value['originalFilename'],
+        'source_key': value['sourceKey'],
+        'imported_at': value['importedAt'].toISOString(),
+    };
+}

package/dist/models/index.d.ts

@@ -229,6 +229,10 @@ export * from './PostPortal';
 export * from './PostPortalInvite';
 export * from './PostQuestion';
 export * from './PostQuestionAnswerChoicesInner';
+export * from './PostQuestionImportCommit';
+export * from './PostQuestionImportCommitItem';
+export * from './PostQuestionImportCommitResponse';
+export * from './PostQuestionImportParseResponse';
 export * from './PostResetPassword';
 export * from './PostResource';
 export * from './PostResourceSessionActivityEvent';
@@ -282,6 +286,12 @@ export * from './PutRole';
 export * from './PutRolePermissions';
 export * from './PutSupportTicket';
 export * from './PutUser';
+export * from './QuestionImportCommitResult';
+export * from './QuestionImportDraft';
+export * from './QuestionImportDuplicate';
+export * from './QuestionImportPreviewImage';
+export * from './QuestionImportSource';
+export * from './QuestionImportSourceSummary';
 export * from './QuestionSelectionMethod';
 export * from './ResourceSessionEnvironment';
 export * from './ResourceSessionScormApiLogItem';

package/dist/models/index.js

@@ -247,6 +247,10 @@ __exportStar(require("./PostPortal"), exports);
 __exportStar(require("./PostPortalInvite"), exports);
 __exportStar(require("./PostQuestion"), exports);
 __exportStar(require("./PostQuestionAnswerChoicesInner"), exports);
+__exportStar(require("./PostQuestionImportCommit"), exports);
+__exportStar(require("./PostQuestionImportCommitItem"), exports);
+__exportStar(require("./PostQuestionImportCommitResponse"), exports);
+__exportStar(require("./PostQuestionImportParseResponse"), exports);
 __exportStar(require("./PostResetPassword"), exports);
 __exportStar(require("./PostResource"), exports);
 __exportStar(require("./PostResourceSessionActivityEvent"), exports);
@@ -300,6 +304,12 @@ __exportStar(require("./PutRole"), exports);
 __exportStar(require("./PutRolePermissions"), exports);
 __exportStar(require("./PutSupportTicket"), exports);
 __exportStar(require("./PutUser"), exports);
+__exportStar(require("./QuestionImportCommitResult"), exports);
+__exportStar(require("./QuestionImportDraft"), exports);
+__exportStar(require("./QuestionImportDuplicate"), exports);
+__exportStar(require("./QuestionImportPreviewImage"), exports);
+__exportStar(require("./QuestionImportSource"), exports);
+__exportStar(require("./QuestionImportSourceSummary"), exports);
 __exportStar(require("./QuestionSelectionMethod"), exports);
 __exportStar(require("./ResourceSessionEnvironment"), exports);
 __exportStar(require("./ResourceSessionScormApiLogItem"), exports);

package/docs/GetQuestion.md

@@ -15,11 +15,14 @@ Name | Type
 `tags` | [Array<ContentLibraryTag>](ContentLibraryTag.md)
 `version` | string
 `versionNumber` | number
+`isLatestVersion` | boolean
+`versionCreatedReason` | string
 `createdDate` | Date
 `updatedDate` | Date
 `createdBy` | string
 `quizCount` | number
 `quizzes` | [Array<GetQuestionQuizzesInner>](GetQuestionQuizzesInner.md)
+`importSource` | [QuestionImportSourceSummary](QuestionImportSourceSummary.md)
 
 ## Example
 
@@ -37,11 +40,14 @@ const example = {
   "tags": null,
   "version": null,
   "versionNumber": null,
+  "isLatestVersion": null,
+  "versionCreatedReason": null,
   "createdDate": null,
   "updatedDate": null,
   "createdBy": null,
   "quizCount": null,
   "quizzes": null,
+  "importSource": null,
 } satisfies GetQuestion
 
 console.log(example)

package/docs/PostQuestionImportCommit.md

@@ -0,0 +1,42 @@
+
+# PostQuestionImportCommit
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`importToken` | string
+`sourceLabel` | string
+`tags` | Array<string>
+`questions` | [Array<PostQuestionImportCommitItem>](PostQuestionImportCommitItem.md)
+`images` | [Array<QuestionImportPreviewImage>](QuestionImportPreviewImage.md)
+
+## Example
+
+```typescript
+import type { PostQuestionImportCommit } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "importToken": null,
+  "sourceLabel": null,
+  "tags": null,
+  "questions": null,
+  "images": null,
+} satisfies PostQuestionImportCommit
+
+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 PostQuestionImportCommit
+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/PostQuestionImportCommitItem.md

@@ -0,0 +1,44 @@
+
+# PostQuestionImportCommitItem
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`draftId` | string
+`action` | string
+`targetQuestionId` | string
+`sourceKey` | string
+`sourceLocation` | string
+`question` | [PostQuestion](PostQuestion.md)
+
+## Example
+
+```typescript
+import type { PostQuestionImportCommitItem } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "draftId": null,
+  "action": null,
+  "targetQuestionId": null,
+  "sourceKey": null,
+  "sourceLocation": null,
+  "question": null,
+} satisfies PostQuestionImportCommitItem
+
+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 PostQuestionImportCommitItem
+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/PostQuestionImportCommitResponse.md

@@ -0,0 +1,40 @@
+
+# PostQuestionImportCommitResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdCount` | number
+`versionedCount` | number
+`skippedCount` | number
+`items` | [Array<QuestionImportCommitResult>](QuestionImportCommitResult.md)
+
+## Example
+
+```typescript
+import type { PostQuestionImportCommitResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdCount": null,
+  "versionedCount": null,
+  "skippedCount": null,
+  "items": null,
+} satisfies PostQuestionImportCommitResponse
+
+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 PostQuestionImportCommitResponse
+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/PostQuestionImportParseResponse.md

@@ -0,0 +1,46 @@
+
+# PostQuestionImportParseResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`importToken` | string
+`expiresAt` | Date
+`source` | [QuestionImportSource](QuestionImportSource.md)
+`questions` | [Array<QuestionImportDraft>](QuestionImportDraft.md)
+`images` | [Array<QuestionImportPreviewImage>](QuestionImportPreviewImage.md)
+`parser` | string
+`warnings` | Array<string>
+
+## Example
+
+```typescript
+import type { PostQuestionImportParseResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "importToken": null,
+  "expiresAt": null,
+  "source": null,
+  "questions": null,
+  "images": null,
+  "parser": null,
+  "warnings": null,
+} satisfies PostQuestionImportParseResponse
+
+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 PostQuestionImportParseResponse
+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/PutQuestion.md

@@ -13,6 +13,7 @@ Name | Type
 `explanation` | [RichTextInput](RichTextInput.md)
 `tags` | Array<string>
 `version` | string
+`versionReason` | string
 
 ## Example
 
@@ -28,6 +29,7 @@ const example = {
   "explanation": null,
   "tags": null,
   "version": null,
+  "versionReason": null,
 } satisfies PutQuestion
 
 console.log(example)