@easyedu/js-lsm-api 1.111.0 → 1.113.0

package/src/models/PostQuestionImportParseResponse.ts

@@ -0,0 +1,142 @@
+/* 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 { QuestionImportDraft } from './QuestionImportDraft';
+import {
+    QuestionImportDraftFromJSON,
+    QuestionImportDraftFromJSONTyped,
+    QuestionImportDraftToJSON,
+    QuestionImportDraftToJSONTyped,
+} from './QuestionImportDraft';
+import type { QuestionImportSource } from './QuestionImportSource';
+import {
+    QuestionImportSourceFromJSON,
+    QuestionImportSourceFromJSONTyped,
+    QuestionImportSourceToJSON,
+    QuestionImportSourceToJSONTyped,
+} from './QuestionImportSource';
+import type { QuestionImportPreviewImage } from './QuestionImportPreviewImage';
+import {
+    QuestionImportPreviewImageFromJSON,
+    QuestionImportPreviewImageFromJSONTyped,
+    QuestionImportPreviewImageToJSON,
+    QuestionImportPreviewImageToJSONTyped,
+} from './QuestionImportPreviewImage';
+
+/**
+ * 
+ * @export
+ * @interface PostQuestionImportParseResponse
+ */
+export interface PostQuestionImportParseResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostQuestionImportParseResponse
+     */
+    importToken: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof PostQuestionImportParseResponse
+     */
+    expiresAt: Date;
+    /**
+     * 
+     * @type {QuestionImportSource}
+     * @memberof PostQuestionImportParseResponse
+     */
+    source: QuestionImportSource;
+    /**
+     * 
+     * @type {Array<QuestionImportDraft>}
+     * @memberof PostQuestionImportParseResponse
+     */
+    questions: Array<QuestionImportDraft>;
+    /**
+     * 
+     * @type {Array<QuestionImportPreviewImage>}
+     * @memberof PostQuestionImportParseResponse
+     */
+    images: Array<QuestionImportPreviewImage>;
+    /**
+     * Parser adapter and strategy used for the uploaded document
+     * @type {string}
+     * @memberof PostQuestionImportParseResponse
+     */
+    parser: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof PostQuestionImportParseResponse
+     */
+    warnings: Array<string>;
+}
+
+/**
+ * Check if a given object implements the PostQuestionImportParseResponse interface.
+ */
+export function instanceOfPostQuestionImportParseResponse(value: object): value is PostQuestionImportParseResponse {
+    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: any): PostQuestionImportParseResponse {
+    return PostQuestionImportParseResponseFromJSONTyped(json, false);
+}
+
+export function PostQuestionImportParseResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostQuestionImportParseResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'importToken': json['import_token'],
+        'expiresAt': (new Date(json['expires_at'])),
+        'source': QuestionImportSourceFromJSON(json['source']),
+        'questions': ((json['questions'] as Array<any>).map(QuestionImportDraftFromJSON)),
+        'images': ((json['images'] as Array<any>).map(QuestionImportPreviewImageFromJSON)),
+        'parser': json['parser'],
+        'warnings': json['warnings'],
+    };
+}
+
+export function PostQuestionImportParseResponseToJSON(json: any): PostQuestionImportParseResponse {
+    return PostQuestionImportParseResponseToJSONTyped(json, false);
+}
+
+export function PostQuestionImportParseResponseToJSONTyped(value?: PostQuestionImportParseResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'import_token': value['importToken'],
+        'expires_at': value['expiresAt'].toISOString(),
+        'source': QuestionImportSourceToJSON(value['source']),
+        'questions': ((value['questions'] as Array<any>).map(QuestionImportDraftToJSON)),
+        'images': ((value['images'] as Array<any>).map(QuestionImportPreviewImageToJSON)),
+        'parser': value['parser'],
+        'warnings': value['warnings'],
+    };
+}
+

package/src/models/PutQuestion.ts

@@ -76,6 +76,12 @@ export interface PutQuestion {
      * @memberof PutQuestion
      */
     version?: string;
+    /**
+     * Optional note describing the changes in the new version
+     * @type {string}
+     * @memberof PutQuestion
+     */
+    versionReason?: string;
 }
 
 
@@ -117,6 +123,7 @@ export function PutQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolean
         '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'],
     };
 }
 
@@ -138,6 +145,7 @@ export function PutQuestionToJSONTyped(value?: PutQuestion | null, ignoreDiscrim
         'explanation': RichTextInputToJSON(value['explanation']),
         'tags': value['tags'],
         'version': value['version'],
+        'version_reason': value['versionReason'],
     };
 }
 

package/src/models/QuestionImportCommitResult.ts

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

package/src/models/QuestionImportDraft.ts

@@ -0,0 +1,142 @@
+/* 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 { QuestionImportDuplicate } from './QuestionImportDuplicate';
+import {
+    QuestionImportDuplicateFromJSON,
+    QuestionImportDuplicateFromJSONTyped,
+    QuestionImportDuplicateToJSON,
+    QuestionImportDuplicateToJSONTyped,
+} from './QuestionImportDuplicate';
+import type { PostQuestion } from './PostQuestion';
+import {
+    PostQuestionFromJSON,
+    PostQuestionFromJSONTyped,
+    PostQuestionToJSON,
+    PostQuestionToJSONTyped,
+} 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 function instanceOfQuestionImportDraft(value: object): value is QuestionImportDraft {
+    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: any): QuestionImportDraft {
+    return QuestionImportDraftFromJSONTyped(json, false);
+}
+
+export function QuestionImportDraftFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuestionImportDraft {
+    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: any): QuestionImportDraft {
+    return QuestionImportDraftToJSONTyped(json, false);
+}
+
+export function QuestionImportDraftToJSONTyped(value?: QuestionImportDraft | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/QuestionImportDuplicate.ts

@@ -0,0 +1,112 @@
+/* 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';
+/**
+ * 
+ * @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 const QuestionImportDuplicateStatusEnum = {
+    New: 'new',
+    Exact: 'exact',
+    Possible: 'possible',
+    WithinUpload: 'within_upload'
+} as const;
+export type QuestionImportDuplicateStatusEnum = typeof QuestionImportDuplicateStatusEnum[keyof typeof QuestionImportDuplicateStatusEnum];
+
+
+/**
+ * Check if a given object implements the QuestionImportDuplicate interface.
+ */
+export function instanceOfQuestionImportDuplicate(value: object): value is QuestionImportDuplicate {
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('similarity' in value) || value['similarity'] === undefined) return false;
+    return true;
+}
+
+export function QuestionImportDuplicateFromJSON(json: any): QuestionImportDuplicate {
+    return QuestionImportDuplicateFromJSONTyped(json, false);
+}
+
+export function QuestionImportDuplicateFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuestionImportDuplicate {
+    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: any): QuestionImportDuplicate {
+    return QuestionImportDuplicateToJSONTyped(json, false);
+}
+
+export function QuestionImportDuplicateToJSONTyped(value?: QuestionImportDuplicate | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/QuestionImportPreviewImage.ts

@@ -0,0 +1,140 @@
+/* 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';
+/**
+ * 
+ * @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 const QuestionImportPreviewImageMimeTypeEnum = {
+    ImagePng: 'image/png',
+    ImageJpeg: 'image/jpeg',
+    ImageWebp: 'image/webp',
+    ImageGif: 'image/gif'
+} as const;
+export type QuestionImportPreviewImageMimeTypeEnum = typeof QuestionImportPreviewImageMimeTypeEnum[keyof typeof QuestionImportPreviewImageMimeTypeEnum];
+
+
+/**
+ * Check if a given object implements the QuestionImportPreviewImage interface.
+ */
+export function instanceOfQuestionImportPreviewImage(value: object): value is QuestionImportPreviewImage {
+    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: any): QuestionImportPreviewImage {
+    return QuestionImportPreviewImageFromJSONTyped(json, false);
+}
+
+export function QuestionImportPreviewImageFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuestionImportPreviewImage {
+    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: any): QuestionImportPreviewImage {
+    return QuestionImportPreviewImageToJSONTyped(json, false);
+}
+
+export function QuestionImportPreviewImageToJSONTyped(value?: QuestionImportPreviewImage | null, ignoreDiscriminator: boolean = false): any {
+    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'],
+    };
+}
+