@easyedu/js-lsm-api 1.110.0 → 1.112.0

package/src/models/PutLearnerExperienceDraft.ts

@@ -0,0 +1,74 @@
+/* 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 PutLearnerExperienceDraft
+ */
+export interface PutLearnerExperienceDraft {
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof PutLearnerExperienceDraft
+     */
+    designDocument: { [key: string]: any; };
+    /**
+     * 
+     * @type {string}
+     * @memberof PutLearnerExperienceDraft
+     */
+    changeNotes?: string | null;
+}
+
+/**
+ * Check if a given object implements the PutLearnerExperienceDraft interface.
+ */
+export function instanceOfPutLearnerExperienceDraft(value: object): value is PutLearnerExperienceDraft {
+    if (!('designDocument' in value) || value['designDocument'] === undefined) return false;
+    return true;
+}
+
+export function PutLearnerExperienceDraftFromJSON(json: any): PutLearnerExperienceDraft {
+    return PutLearnerExperienceDraftFromJSONTyped(json, false);
+}
+
+export function PutLearnerExperienceDraftFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutLearnerExperienceDraft {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'designDocument': json['design_document'],
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+    };
+}
+
+export function PutLearnerExperienceDraftToJSON(json: any): PutLearnerExperienceDraft {
+    return PutLearnerExperienceDraftToJSONTyped(json, false);
+}
+
+export function PutLearnerExperienceDraftToJSONTyped(value?: PutLearnerExperienceDraft | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'design_document': value['designDocument'],
+        'change_notes': value['changeNotes'],
+    };
+}
+

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'],
+    };
+}
+

package/src/models/QuestionImportSource.ts

@@ -0,0 +1,101 @@
+/* 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 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 function instanceOfQuestionImportSource(value: object): value is QuestionImportSource {
+    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;
+}
+
+export function QuestionImportSourceFromJSON(json: any): QuestionImportSource {
+    return QuestionImportSourceFromJSONTyped(json, false);
+}
+
+export function QuestionImportSourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuestionImportSource {
+    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'],
+    };
+}
+
+export function QuestionImportSourceToJSON(json: any): QuestionImportSource {
+    return QuestionImportSourceToJSONTyped(json, false);
+}
+
+export function QuestionImportSourceToJSONTyped(value?: QuestionImportSource | null, ignoreDiscriminator: boolean = false): any {
+    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'],
+    };
+}
+