@easyedu/js-lsm-api 1.111.0 → 1.113.0

package/dist/esm/models/PostQuestionImportParseResponse.js

@@ -0,0 +1,70 @@
+/* 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 { QuestionImportDraftFromJSON, QuestionImportDraftToJSON, } from './QuestionImportDraft';
+import { QuestionImportSourceFromJSON, QuestionImportSourceToJSON, } from './QuestionImportSource';
+import { QuestionImportPreviewImageFromJSON, QuestionImportPreviewImageToJSON, } from './QuestionImportPreviewImage';
+/**
+ * Check if a given object implements the PostQuestionImportParseResponse interface.
+ */
+export function instanceOfPostQuestionImportParseResponse(value) {
+    if (!('importToken' in value) || value['importToken'] === undefined)
+        return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined)
+        return false;
+    if (!('source' in value) || value['source'] === undefined)
+        return false;
+    if (!('questions' in value) || value['questions'] === undefined)
+        return false;
+    if (!('images' in value) || value['images'] === undefined)
+        return false;
+    if (!('parser' in value) || value['parser'] === undefined)
+        return false;
+    if (!('warnings' in value) || value['warnings'] === undefined)
+        return false;
+    return true;
+}
+export function PostQuestionImportParseResponseFromJSON(json) {
+    return PostQuestionImportParseResponseFromJSONTyped(json, false);
+}
+export function PostQuestionImportParseResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'importToken': json['import_token'],
+        'expiresAt': (new Date(json['expires_at'])),
+        'source': QuestionImportSourceFromJSON(json['source']),
+        'questions': (json['questions'].map(QuestionImportDraftFromJSON)),
+        'images': (json['images'].map(QuestionImportPreviewImageFromJSON)),
+        'parser': json['parser'],
+        'warnings': json['warnings'],
+    };
+}
+export function PostQuestionImportParseResponseToJSON(json) {
+    return PostQuestionImportParseResponseToJSONTyped(json, false);
+}
+export function PostQuestionImportParseResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'import_token': value['importToken'],
+        'expires_at': value['expiresAt'].toISOString(),
+        'source': QuestionImportSourceToJSON(value['source']),
+        'questions': (value['questions'].map(QuestionImportDraftToJSON)),
+        'images': (value['images'].map(QuestionImportPreviewImageToJSON)),
+        'parser': value['parser'],
+        'warnings': value['warnings'],
+    };
+}

package/dist/esm/models/PutQuestion.d.ts

@@ -59,6 +59,12 @@ export interface PutQuestion {
      * @memberof PutQuestion
      */
     version?: string;
+    /**
+     * Optional note describing the changes in the new version
+     * @type {string}
+     * @memberof PutQuestion
+     */
+    versionReason?: string;
 }
 /**
  * @export

package/dist/esm/models/PutQuestion.js

@@ -45,6 +45,7 @@ export function PutQuestionFromJSONTyped(json, ignoreDiscriminator) {
         'explanation': json['explanation'] == null ? undefined : RichTextInputFromJSON(json['explanation']),
         'tags': json['tags'] == null ? undefined : json['tags'],
         'version': json['version'] == null ? undefined : json['version'],
+        'versionReason': json['version_reason'] == null ? undefined : json['version_reason'],
     };
 }
 export function PutQuestionToJSON(json) {
@@ -62,5 +63,6 @@ export function PutQuestionToJSONTyped(value, ignoreDiscriminator = false) {
         'explanation': RichTextInputToJSON(value['explanation']),
         'tags': value['tags'],
         'version': value['version'],
+        'version_reason': value['versionReason'],
     };
 }

package/dist/esm/models/QuestionImportCommitResult.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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 QuestionImportCommitResult
+ */
+export interface QuestionImportCommitResult {
+    /**
+     *
+     * @type {string}
+     * @memberof QuestionImportCommitResult
+     */
+    draftId: string;
+    /**
+     *
+     * @type {QuestionImportCommitResultActionEnum}
+     * @memberof QuestionImportCommitResult
+     */
+    action: QuestionImportCommitResultActionEnum;
+    /**
+     * Identifier of the newly created question or question version
+     * @type {string}
+     * @memberof QuestionImportCommitResult
+     */
+    questionId?: string | null;
+}
+/**
+ * @export
+ */
+export declare const QuestionImportCommitResultActionEnum: {
+    readonly Created: "created";
+    readonly Versioned: "versioned";
+    readonly Skipped: "skipped";
+};
+export type QuestionImportCommitResultActionEnum = typeof QuestionImportCommitResultActionEnum[keyof typeof QuestionImportCommitResultActionEnum];
+/**
+ * Check if a given object implements the QuestionImportCommitResult interface.
+ */
+export declare function instanceOfQuestionImportCommitResult(value: object): value is QuestionImportCommitResult;
+export declare function QuestionImportCommitResultFromJSON(json: any): QuestionImportCommitResult;
+export declare function QuestionImportCommitResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuestionImportCommitResult;
+export declare function QuestionImportCommitResultToJSON(json: any): QuestionImportCommitResult;
+export declare function QuestionImportCommitResultToJSONTyped(value?: QuestionImportCommitResult | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/QuestionImportCommitResult.js

@@ -0,0 +1,57 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const QuestionImportCommitResultActionEnum = {
+    Created: 'created',
+    Versioned: 'versioned',
+    Skipped: 'skipped'
+};
+/**
+ * Check if a given object implements the QuestionImportCommitResult interface.
+ */
+export function instanceOfQuestionImportCommitResult(value) {
+    if (!('draftId' in value) || value['draftId'] === undefined)
+        return false;
+    if (!('action' in value) || value['action'] === undefined)
+        return false;
+    return true;
+}
+export function QuestionImportCommitResultFromJSON(json) {
+    return QuestionImportCommitResultFromJSONTyped(json, false);
+}
+export function QuestionImportCommitResultFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'draftId': json['draft_id'],
+        'action': json['action'],
+        'questionId': json['question_id'] == null ? undefined : json['question_id'],
+    };
+}
+export function QuestionImportCommitResultToJSON(json) {
+    return QuestionImportCommitResultToJSONTyped(json, false);
+}
+export function QuestionImportCommitResultToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'draft_id': value['draftId'],
+        'action': value['action'],
+        'question_id': value['questionId'],
+    };
+}

package/dist/esm/models/QuestionImportDraft.d.ts

@@ -0,0 +1,76 @@
+/**
+ * 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 { QuestionImportDuplicate } from './QuestionImportDuplicate';
+import type { PostQuestion } from './PostQuestion';
+/**
+ *
+ * @export
+ * @interface QuestionImportDraft
+ */
+export interface QuestionImportDraft {
+    /**
+     *
+     * @type {string}
+     * @memberof QuestionImportDraft
+     */
+    draftId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuestionImportDraft
+     */
+    sourceKey?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof QuestionImportDraft
+     */
+    sourceLocation?: string | null;
+    /**
+     *
+     * @type {PostQuestion}
+     * @memberof QuestionImportDraft
+     */
+    question: PostQuestion;
+    /**
+     *
+     * @type {QuestionImportDuplicate}
+     * @memberof QuestionImportDraft
+     */
+    duplicate: QuestionImportDuplicate;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof QuestionImportDraft
+     */
+    warnings: Array<string>;
+    /**
+     *
+     * @type {number}
+     * @memberof QuestionImportDraft
+     */
+    confidence: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof QuestionImportDraft
+     */
+    included: boolean;
+}
+/**
+ * Check if a given object implements the QuestionImportDraft interface.
+ */
+export declare function instanceOfQuestionImportDraft(value: object): value is QuestionImportDraft;
+export declare function QuestionImportDraftFromJSON(json: any): QuestionImportDraft;
+export declare function QuestionImportDraftFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuestionImportDraft;
+export declare function QuestionImportDraftToJSON(json: any): QuestionImportDraft;
+export declare function QuestionImportDraftToJSONTyped(value?: QuestionImportDraft | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/QuestionImportDraft.js

@@ -0,0 +1,69 @@
+/* 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 { QuestionImportDuplicateFromJSON, QuestionImportDuplicateToJSON, } from './QuestionImportDuplicate';
+import { PostQuestionFromJSON, PostQuestionToJSON, } from './PostQuestion';
+/**
+ * Check if a given object implements the QuestionImportDraft interface.
+ */
+export function instanceOfQuestionImportDraft(value) {
+    if (!('draftId' in value) || value['draftId'] === undefined)
+        return false;
+    if (!('question' in value) || value['question'] === undefined)
+        return false;
+    if (!('duplicate' in value) || value['duplicate'] === undefined)
+        return false;
+    if (!('warnings' in value) || value['warnings'] === undefined)
+        return false;
+    if (!('confidence' in value) || value['confidence'] === undefined)
+        return false;
+    if (!('included' in value) || value['included'] === undefined)
+        return false;
+    return true;
+}
+export function QuestionImportDraftFromJSON(json) {
+    return QuestionImportDraftFromJSONTyped(json, false);
+}
+export function QuestionImportDraftFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'draftId': json['draft_id'],
+        'sourceKey': json['source_key'] == null ? undefined : json['source_key'],
+        'sourceLocation': json['source_location'] == null ? undefined : json['source_location'],
+        'question': PostQuestionFromJSON(json['question']),
+        'duplicate': QuestionImportDuplicateFromJSON(json['duplicate']),
+        'warnings': json['warnings'],
+        'confidence': json['confidence'],
+        'included': json['included'],
+    };
+}
+export function QuestionImportDraftToJSON(json) {
+    return QuestionImportDraftToJSONTyped(json, false);
+}
+export function QuestionImportDraftToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'draft_id': value['draftId'],
+        'source_key': value['sourceKey'],
+        'source_location': value['sourceLocation'],
+        'question': PostQuestionToJSON(value['question']),
+        'duplicate': QuestionImportDuplicateToJSON(value['duplicate']),
+        'warnings': value['warnings'],
+        'confidence': value['confidence'],
+        'included': value['included'],
+    };
+}

package/dist/esm/models/QuestionImportDuplicate.d.ts

@@ -0,0 +1,66 @@
+/**
+ * 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 QuestionImportDuplicate
+ */
+export interface QuestionImportDuplicate {
+    /**
+     *
+     * @type {QuestionImportDuplicateStatusEnum}
+     * @memberof QuestionImportDuplicate
+     */
+    status: QuestionImportDuplicateStatusEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof QuestionImportDuplicate
+     */
+    matchedQuestionId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof QuestionImportDuplicate
+     */
+    matchedDraftId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof QuestionImportDuplicate
+     */
+    matchedQuestionText?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof QuestionImportDuplicate
+     */
+    similarity: number;
+}
+/**
+ * @export
+ */
+export declare const QuestionImportDuplicateStatusEnum: {
+    readonly New: "new";
+    readonly Exact: "exact";
+    readonly Possible: "possible";
+    readonly WithinUpload: "within_upload";
+};
+export type QuestionImportDuplicateStatusEnum = typeof QuestionImportDuplicateStatusEnum[keyof typeof QuestionImportDuplicateStatusEnum];
+/**
+ * Check if a given object implements the QuestionImportDuplicate interface.
+ */
+export declare function instanceOfQuestionImportDuplicate(value: object): value is QuestionImportDuplicate;
+export declare function QuestionImportDuplicateFromJSON(json: any): QuestionImportDuplicate;
+export declare function QuestionImportDuplicateFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuestionImportDuplicate;
+export declare function QuestionImportDuplicateToJSON(json: any): QuestionImportDuplicate;
+export declare function QuestionImportDuplicateToJSONTyped(value?: QuestionImportDuplicate | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/QuestionImportDuplicate.js

@@ -0,0 +1,62 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const QuestionImportDuplicateStatusEnum = {
+    New: 'new',
+    Exact: 'exact',
+    Possible: 'possible',
+    WithinUpload: 'within_upload'
+};
+/**
+ * Check if a given object implements the QuestionImportDuplicate interface.
+ */
+export function instanceOfQuestionImportDuplicate(value) {
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('similarity' in value) || value['similarity'] === undefined)
+        return false;
+    return true;
+}
+export function QuestionImportDuplicateFromJSON(json) {
+    return QuestionImportDuplicateFromJSONTyped(json, false);
+}
+export function QuestionImportDuplicateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'status': json['status'],
+        'matchedQuestionId': json['matched_question_id'] == null ? undefined : json['matched_question_id'],
+        'matchedDraftId': json['matched_draft_id'] == null ? undefined : json['matched_draft_id'],
+        'matchedQuestionText': json['matched_question_text'] == null ? undefined : json['matched_question_text'],
+        'similarity': json['similarity'],
+    };
+}
+export function QuestionImportDuplicateToJSON(json) {
+    return QuestionImportDuplicateToJSONTyped(json, false);
+}
+export function QuestionImportDuplicateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'status': value['status'],
+        'matched_question_id': value['matchedQuestionId'],
+        'matched_draft_id': value['matchedDraftId'],
+        'matched_question_text': value['matchedQuestionText'],
+        'similarity': value['similarity'],
+    };
+}

package/dist/esm/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/esm/models/QuestionImportPreviewImage.js

@@ -0,0 +1,76 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const QuestionImportPreviewImageMimeTypeEnum = {
+    ImagePng: 'image/png',
+    ImageJpeg: 'image/jpeg',
+    ImageWebp: 'image/webp',
+    ImageGif: 'image/gif'
+};
+/**
+ * Check if a given object implements the QuestionImportPreviewImage interface.
+ */
+export 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;
+}
+export function QuestionImportPreviewImageFromJSON(json) {
+    return QuestionImportPreviewImageFromJSONTyped(json, false);
+}
+export 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'],
+    };
+}
+export function QuestionImportPreviewImageToJSON(json) {
+    return QuestionImportPreviewImageToJSONTyped(json, false);
+}
+export 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'],
+    };
+}