@easyedu/js-lsm-api 1.82.0 → 1.84.0

package/dist/esm/models/PostResourceVersion.js

@@ -0,0 +1,46 @@
+/* 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 { RichTextInputFromJSON, RichTextInputToJSON, } from './RichTextInput';
+/**
+ * Check if a given object implements the PostResourceVersion interface.
+ */
+export function instanceOfPostResourceVersion(value) {
+    return true;
+}
+export function PostResourceVersionFromJSON(json) {
+    return PostResourceVersionFromJSONTyped(json, false);
+}
+export function PostResourceVersionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+        'linkUrl': json['link_url'] == null ? undefined : json['link_url'],
+        'richText': json['rich_text'] == null ? undefined : RichTextInputFromJSON(json['rich_text']),
+    };
+}
+export function PostResourceVersionToJSON(json) {
+    return PostResourceVersionToJSONTyped(json, false);
+}
+export function PostResourceVersionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'change_notes': value['changeNotes'],
+        'link_url': value['linkUrl'],
+        'rich_text': RichTextInputToJSON(value['richText']),
+    };
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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 PostResourceVersionComplete
+ */
+export interface PostResourceVersionComplete {
+    /**
+     *
+     * @type {string}
+     * @memberof PostResourceVersionComplete
+     */
+    checksumSha256: string;
+}
+/**
+ * Check if a given object implements the PostResourceVersionComplete interface.
+ */
+export declare function instanceOfPostResourceVersionComplete(value: object): value is PostResourceVersionComplete;
+export declare function PostResourceVersionCompleteFromJSON(json: any): PostResourceVersionComplete;
+export declare function PostResourceVersionCompleteFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostResourceVersionComplete;
+export declare function PostResourceVersionCompleteToJSON(json: any): PostResourceVersionComplete;
+export declare function PostResourceVersionCompleteToJSONTyped(value?: PostResourceVersionComplete | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostResourceVersionComplete.js

@@ -0,0 +1,43 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the PostResourceVersionComplete interface.
+ */
+export function instanceOfPostResourceVersionComplete(value) {
+    if (!('checksumSha256' in value) || value['checksumSha256'] === undefined)
+        return false;
+    return true;
+}
+export function PostResourceVersionCompleteFromJSON(json) {
+    return PostResourceVersionCompleteFromJSONTyped(json, false);
+}
+export function PostResourceVersionCompleteFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'checksumSha256': json['checksum_sha256'],
+    };
+}
+export function PostResourceVersionCompleteToJSON(json) {
+    return PostResourceVersionCompleteToJSONTyped(json, false);
+}
+export function PostResourceVersionCompleteToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'checksum_sha256': value['checksumSha256'],
+    };
+}

package/dist/esm/models/PostResourceVersionUpload.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 PostResourceVersionUpload
+ */
+export interface PostResourceVersionUpload {
+    /**
+     *
+     * @type {string}
+     * @memberof PostResourceVersionUpload
+     */
+    filename: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostResourceVersionUpload
+     */
+    mimeType: string;
+    /**
+     *
+     * @type {number}
+     * @memberof PostResourceVersionUpload
+     */
+    fileSizeBytes: number;
+    /**
+     *
+     * @type {string}
+     * @memberof PostResourceVersionUpload
+     */
+    checksumSha256: string;
+}
+/**
+ * Check if a given object implements the PostResourceVersionUpload interface.
+ */
+export declare function instanceOfPostResourceVersionUpload(value: object): value is PostResourceVersionUpload;
+export declare function PostResourceVersionUploadFromJSON(json: any): PostResourceVersionUpload;
+export declare function PostResourceVersionUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostResourceVersionUpload;
+export declare function PostResourceVersionUploadToJSON(json: any): PostResourceVersionUpload;
+export declare function PostResourceVersionUploadToJSONTyped(value?: PostResourceVersionUpload | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostResourceVersionUpload.js

@@ -0,0 +1,55 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the PostResourceVersionUpload interface.
+ */
+export function instanceOfPostResourceVersionUpload(value) {
+    if (!('filename' in value) || value['filename'] === undefined)
+        return false;
+    if (!('mimeType' in value) || value['mimeType'] === undefined)
+        return false;
+    if (!('fileSizeBytes' in value) || value['fileSizeBytes'] === undefined)
+        return false;
+    if (!('checksumSha256' in value) || value['checksumSha256'] === undefined)
+        return false;
+    return true;
+}
+export function PostResourceVersionUploadFromJSON(json) {
+    return PostResourceVersionUploadFromJSONTyped(json, false);
+}
+export function PostResourceVersionUploadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'filename': json['filename'],
+        'mimeType': json['mime_type'],
+        'fileSizeBytes': json['file_size_bytes'],
+        'checksumSha256': json['checksum_sha256'],
+    };
+}
+export function PostResourceVersionUploadToJSON(json) {
+    return PostResourceVersionUploadToJSONTyped(json, false);
+}
+export function PostResourceVersionUploadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'filename': value['filename'],
+        'mime_type': value['mimeType'],
+        'file_size_bytes': value['fileSizeBytes'],
+        'checksum_sha256': value['checksumSha256'],
+    };
+}

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

@@ -0,0 +1,85 @@
+/**
+ * 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 { ContentLaunchMode } from './ContentLaunchMode';
+/**
+ *
+ * @export
+ * @interface PutCourseVersionItem
+ */
+export interface PutCourseVersionItem {
+    /**
+     *
+     * @type {string}
+     * @memberof PutCourseVersionItem
+     */
+    contentLibraryVersionId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PutCourseVersionItem
+     */
+    displayName?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof PutCourseVersionItem
+     */
+    displayOrder?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PutCourseVersionItem
+     */
+    isVisible?: boolean;
+    /**
+     *
+     * @type {ContentLaunchMode}
+     * @memberof PutCourseVersionItem
+     */
+    launchMode?: ContentLaunchMode;
+    /**
+     *
+     * @type {number}
+     * @memberof PutCourseVersionItem
+     */
+    maxAttempts?: number;
+    /**
+     *
+     * @type {PutCourseVersionItemScoreRollupStrategyEnum}
+     * @memberof PutCourseVersionItem
+     */
+    scoreRollupStrategy?: PutCourseVersionItemScoreRollupStrategyEnum;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof PutCourseVersionItem
+     */
+    settings?: {
+        [key: string]: any;
+    };
+}
+/**
+ * @export
+ */
+export declare const PutCourseVersionItemScoreRollupStrategyEnum: {
+    readonly Latest: "Latest";
+    readonly Best: "Best";
+};
+export type PutCourseVersionItemScoreRollupStrategyEnum = typeof PutCourseVersionItemScoreRollupStrategyEnum[keyof typeof PutCourseVersionItemScoreRollupStrategyEnum];
+/**
+ * Check if a given object implements the PutCourseVersionItem interface.
+ */
+export declare function instanceOfPutCourseVersionItem(value: object): value is PutCourseVersionItem;
+export declare function PutCourseVersionItemFromJSON(json: any): PutCourseVersionItem;
+export declare function PutCourseVersionItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCourseVersionItem;
+export declare function PutCourseVersionItemToJSON(json: any): PutCourseVersionItem;
+export declare function PutCourseVersionItemToJSONTyped(value?: PutCourseVersionItem | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PutCourseVersionItem.js

@@ -0,0 +1,63 @@
+/* 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 { ContentLaunchModeFromJSON, ContentLaunchModeToJSON, } from './ContentLaunchMode';
+/**
+ * @export
+ */
+export const PutCourseVersionItemScoreRollupStrategyEnum = {
+    Latest: 'Latest',
+    Best: 'Best'
+};
+/**
+ * Check if a given object implements the PutCourseVersionItem interface.
+ */
+export function instanceOfPutCourseVersionItem(value) {
+    return true;
+}
+export function PutCourseVersionItemFromJSON(json) {
+    return PutCourseVersionItemFromJSONTyped(json, false);
+}
+export function PutCourseVersionItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'contentLibraryVersionId': json['content_library_version_id'] == null ? undefined : json['content_library_version_id'],
+        'displayName': json['display_name'] == null ? undefined : json['display_name'],
+        'displayOrder': json['display_order'] == null ? undefined : json['display_order'],
+        'isVisible': json['is_visible'] == null ? undefined : json['is_visible'],
+        'launchMode': json['launch_mode'] == null ? undefined : ContentLaunchModeFromJSON(json['launch_mode']),
+        'maxAttempts': json['max_attempts'] == null ? undefined : json['max_attempts'],
+        'scoreRollupStrategy': json['score_rollup_strategy'] == null ? undefined : json['score_rollup_strategy'],
+        'settings': json['settings'] == null ? undefined : json['settings'],
+    };
+}
+export function PutCourseVersionItemToJSON(json) {
+    return PutCourseVersionItemToJSONTyped(json, false);
+}
+export function PutCourseVersionItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'content_library_version_id': value['contentLibraryVersionId'],
+        'display_name': value['displayName'],
+        'display_order': value['displayOrder'],
+        'is_visible': value['isVisible'],
+        'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
+        'max_attempts': value['maxAttempts'],
+        'score_rollup_strategy': value['scoreRollupStrategy'],
+        'settings': value['settings'],
+    };
+}

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

@@ -0,0 +1,77 @@
+/**
+ * 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 { PutQuizAnswerResponseProgress } from './PutQuizAnswerResponseProgress';
+import type { RichTextDocument } from './RichTextDocument';
+import type { PutQuizAnswerResponseNextQuestion } from './PutQuizAnswerResponseNextQuestion';
+/**
+ *
+ * @export
+ * @interface PutQuizAnswerResponse
+ */
+export interface PutQuizAnswerResponse {
+    /**
+     * Whether the answer was saved
+     * @type {boolean}
+     * @memberof PutQuizAnswerResponse
+     */
+    success: boolean;
+    /**
+     * Question ID that was answered
+     * @type {number}
+     * @memberof PutQuizAnswerResponse
+     */
+    questionId: number;
+    /**
+     * Immediate correctness feedback when review is disabled
+     * @type {boolean}
+     * @memberof PutQuizAnswerResponse
+     */
+    isCorrect?: boolean;
+    /**
+     * Immediate points earned when review is disabled
+     * @type {number}
+     * @memberof PutQuizAnswerResponse
+     */
+    pointsEarned?: number;
+    /**
+     * Plain-text explanation when immediate feedback is enabled
+     * @type {string}
+     * @memberof PutQuizAnswerResponse
+     */
+    explanation?: string;
+    /**
+     *
+     * @type {RichTextDocument}
+     * @memberof PutQuizAnswerResponse
+     */
+    explanationRich?: RichTextDocument;
+    /**
+     *
+     * @type {PutQuizAnswerResponseNextQuestion}
+     * @memberof PutQuizAnswerResponse
+     */
+    nextQuestion?: PutQuizAnswerResponseNextQuestion;
+    /**
+     *
+     * @type {PutQuizAnswerResponseProgress}
+     * @memberof PutQuizAnswerResponse
+     */
+    progress: PutQuizAnswerResponseProgress;
+}
+/**
+ * Check if a given object implements the PutQuizAnswerResponse interface.
+ */
+export declare function instanceOfPutQuizAnswerResponse(value: object): value is PutQuizAnswerResponse;
+export declare function PutQuizAnswerResponseFromJSON(json: any): PutQuizAnswerResponse;
+export declare function PutQuizAnswerResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutQuizAnswerResponse;
+export declare function PutQuizAnswerResponseToJSON(json: any): PutQuizAnswerResponse;
+export declare function PutQuizAnswerResponseToJSONTyped(value?: PutQuizAnswerResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PutQuizAnswerResponse.js

@@ -0,0 +1,64 @@
+/* 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 { PutQuizAnswerResponseProgressFromJSON, PutQuizAnswerResponseProgressToJSON, } from './PutQuizAnswerResponseProgress';
+import { RichTextDocumentFromJSON, RichTextDocumentToJSON, } from './RichTextDocument';
+import { PutQuizAnswerResponseNextQuestionFromJSON, PutQuizAnswerResponseNextQuestionToJSON, } from './PutQuizAnswerResponseNextQuestion';
+/**
+ * Check if a given object implements the PutQuizAnswerResponse interface.
+ */
+export function instanceOfPutQuizAnswerResponse(value) {
+    if (!('success' in value) || value['success'] === undefined)
+        return false;
+    if (!('questionId' in value) || value['questionId'] === undefined)
+        return false;
+    if (!('progress' in value) || value['progress'] === undefined)
+        return false;
+    return true;
+}
+export function PutQuizAnswerResponseFromJSON(json) {
+    return PutQuizAnswerResponseFromJSONTyped(json, false);
+}
+export function PutQuizAnswerResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'success': json['success'],
+        'questionId': json['question_id'],
+        'isCorrect': json['is_correct'] == null ? undefined : json['is_correct'],
+        'pointsEarned': json['points_earned'] == null ? undefined : json['points_earned'],
+        'explanation': json['explanation'] == null ? undefined : json['explanation'],
+        'explanationRich': json['explanation_rich'] == null ? undefined : RichTextDocumentFromJSON(json['explanation_rich']),
+        'nextQuestion': json['next_question'] == null ? undefined : PutQuizAnswerResponseNextQuestionFromJSON(json['next_question']),
+        'progress': PutQuizAnswerResponseProgressFromJSON(json['progress']),
+    };
+}
+export function PutQuizAnswerResponseToJSON(json) {
+    return PutQuizAnswerResponseToJSONTyped(json, false);
+}
+export function PutQuizAnswerResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'success': value['success'],
+        'question_id': value['questionId'],
+        'is_correct': value['isCorrect'],
+        'points_earned': value['pointsEarned'],
+        'explanation': value['explanation'],
+        'explanation_rich': RichTextDocumentToJSON(value['explanationRich']),
+        'next_question': PutQuizAnswerResponseNextQuestionToJSON(value['nextQuestion']),
+        'progress': PutQuizAnswerResponseProgressToJSON(value['progress']),
+    };
+}

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

@@ -0,0 +1,102 @@
+/**
+ * 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 { RichTextDocument } from './RichTextDocument';
+import type { PutQuizAnswerResponseNextQuestionAnswerChoicesInner } from './PutQuizAnswerResponseNextQuestionAnswerChoicesInner';
+/**
+ *
+ * @export
+ * @interface PutQuizAnswerResponseNextQuestion
+ */
+export interface PutQuizAnswerResponseNextQuestion {
+    /**
+     * Attempt question ID
+     * @type {number}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    id: number;
+    /**
+     * Original question ID
+     * @type {number}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    questionId: number;
+    /**
+     * Order of question in this attempt
+     * @type {number}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    questionOrder: number;
+    /**
+     * Points assigned to this question
+     * @type {number}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    points: number;
+    /**
+     * Question text
+     * @type {string}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    questionText: string;
+    /**
+     *
+     * @type {RichTextDocument}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    questionTextRich?: RichTextDocument;
+    /**
+     *
+     * @type {PutQuizAnswerResponseNextQuestionQuestionTypeEnum}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    questionType: PutQuizAnswerResponseNextQuestionQuestionTypeEnum;
+    /**
+     *
+     * @type {Array<PutQuizAnswerResponseNextQuestionAnswerChoicesInner>}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    answerChoices: Array<PutQuizAnswerResponseNextQuestionAnswerChoicesInner>;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    isAnswered: boolean;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    userAnswer?: {
+        [key: string]: any;
+    };
+}
+/**
+ * @export
+ */
+export declare const PutQuizAnswerResponseNextQuestionQuestionTypeEnum: {
+    readonly SingleAnswer: "single_answer";
+    readonly MultipleAnswer: "multiple_answer";
+    readonly FillInBlank: "fill_in_blank";
+    readonly ShortAnswer: "short_answer";
+    readonly Matching: "matching";
+    readonly Essay: "essay";
+};
+export type PutQuizAnswerResponseNextQuestionQuestionTypeEnum = typeof PutQuizAnswerResponseNextQuestionQuestionTypeEnum[keyof typeof PutQuizAnswerResponseNextQuestionQuestionTypeEnum];
+/**
+ * Check if a given object implements the PutQuizAnswerResponseNextQuestion interface.
+ */
+export declare function instanceOfPutQuizAnswerResponseNextQuestion(value: object): value is PutQuizAnswerResponseNextQuestion;
+export declare function PutQuizAnswerResponseNextQuestionFromJSON(json: any): PutQuizAnswerResponseNextQuestion;
+export declare function PutQuizAnswerResponseNextQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutQuizAnswerResponseNextQuestion;
+export declare function PutQuizAnswerResponseNextQuestionToJSON(json: any): PutQuizAnswerResponseNextQuestion;
+export declare function PutQuizAnswerResponseNextQuestionToJSONTyped(value?: PutQuizAnswerResponseNextQuestion | null, ignoreDiscriminator?: boolean): any;