@easyedu/js-lsm-api 1.82.0 → 1.84.0

package/src/models/PostResourceVersion.ts

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

package/src/models/PostResourceVersionComplete.ts

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

package/src/models/PostResourceVersionUpload.ts

@@ -0,0 +1,93 @@
+/* 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 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 function instanceOfPostResourceVersionUpload(value: object): value is PostResourceVersionUpload {
+    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: any): PostResourceVersionUpload {
+    return PostResourceVersionUploadFromJSONTyped(json, false);
+}
+
+export function PostResourceVersionUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostResourceVersionUpload {
+    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: any): PostResourceVersionUpload {
+    return PostResourceVersionUploadToJSONTyped(json, false);
+}
+
+export function PostResourceVersionUploadToJSONTyped(value?: PostResourceVersionUpload | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'filename': value['filename'],
+        'mime_type': value['mimeType'],
+        'file_size_bytes': value['fileSizeBytes'],
+        'checksum_sha256': value['checksumSha256'],
+    };
+}
+

package/src/models/PutCourseVersionItem.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';
+import type { ContentLaunchMode } from './ContentLaunchMode';
+import {
+    ContentLaunchModeFromJSON,
+    ContentLaunchModeFromJSONTyped,
+    ContentLaunchModeToJSON,
+    ContentLaunchModeToJSONTyped,
+} 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 const PutCourseVersionItemScoreRollupStrategyEnum = {
+    Latest: 'Latest',
+    Best: 'Best'
+} as const;
+export type PutCourseVersionItemScoreRollupStrategyEnum = typeof PutCourseVersionItemScoreRollupStrategyEnum[keyof typeof PutCourseVersionItemScoreRollupStrategyEnum];
+
+
+/**
+ * Check if a given object implements the PutCourseVersionItem interface.
+ */
+export function instanceOfPutCourseVersionItem(value: object): value is PutCourseVersionItem {
+    return true;
+}
+
+export function PutCourseVersionItemFromJSON(json: any): PutCourseVersionItem {
+    return PutCourseVersionItemFromJSONTyped(json, false);
+}
+
+export function PutCourseVersionItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCourseVersionItem {
+    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: any): PutCourseVersionItem {
+    return PutCourseVersionItemToJSONTyped(json, false);
+}
+
+export function PutCourseVersionItemToJSONTyped(value?: PutCourseVersionItem | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/PutQuizAnswerResponse.ts

@@ -0,0 +1,146 @@
+/* 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 { PutQuizAnswerResponseProgress } from './PutQuizAnswerResponseProgress';
+import {
+    PutQuizAnswerResponseProgressFromJSON,
+    PutQuizAnswerResponseProgressFromJSONTyped,
+    PutQuizAnswerResponseProgressToJSON,
+    PutQuizAnswerResponseProgressToJSONTyped,
+} from './PutQuizAnswerResponseProgress';
+import type { RichTextDocument } from './RichTextDocument';
+import {
+    RichTextDocumentFromJSON,
+    RichTextDocumentFromJSONTyped,
+    RichTextDocumentToJSON,
+    RichTextDocumentToJSONTyped,
+} from './RichTextDocument';
+import type { PutQuizAnswerResponseNextQuestion } from './PutQuizAnswerResponseNextQuestion';
+import {
+    PutQuizAnswerResponseNextQuestionFromJSON,
+    PutQuizAnswerResponseNextQuestionFromJSONTyped,
+    PutQuizAnswerResponseNextQuestionToJSON,
+    PutQuizAnswerResponseNextQuestionToJSONTyped,
+} 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 function instanceOfPutQuizAnswerResponse(value: object): value is PutQuizAnswerResponse {
+    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: any): PutQuizAnswerResponse {
+    return PutQuizAnswerResponseFromJSONTyped(json, false);
+}
+
+export function PutQuizAnswerResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutQuizAnswerResponse {
+    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: any): PutQuizAnswerResponse {
+    return PutQuizAnswerResponseToJSONTyped(json, false);
+}
+
+export function PutQuizAnswerResponseToJSONTyped(value?: PutQuizAnswerResponse | null, ignoreDiscriminator: boolean = false): any {
+    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']),
+    };
+}
+