@easyedu/js-lsm-api 1.83.0 → 1.84.0

package/src/models/PostCourseVersionItem.ts

@@ -0,0 +1,158 @@
+/* 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 PostCourseVersionItem
+ */
+export interface PostCourseVersionItem {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCourseVersionItem
+     */
+    contentLibraryItemId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCourseVersionItem
+     */
+    contentLibraryVersionId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCourseVersionItem
+     */
+    moduleId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCourseVersionItem
+     */
+    displayName?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostCourseVersionItem
+     */
+    displayOrder?: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostCourseVersionItem
+     */
+    isVisible?: boolean;
+    /**
+     * 
+     * @type {ContentLaunchMode}
+     * @memberof PostCourseVersionItem
+     */
+    launchMode?: ContentLaunchMode;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostCourseVersionItem
+     */
+    maxAttempts?: number;
+    /**
+     * 
+     * @type {PostCourseVersionItemScoreRollupStrategyEnum}
+     * @memberof PostCourseVersionItem
+     */
+    scoreRollupStrategy?: PostCourseVersionItemScoreRollupStrategyEnum;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof PostCourseVersionItem
+     */
+    settings?: { [key: string]: any; };
+}
+
+
+/**
+ * @export
+ */
+export const PostCourseVersionItemScoreRollupStrategyEnum = {
+    Latest: 'Latest',
+    Best: 'Best'
+} as const;
+export type PostCourseVersionItemScoreRollupStrategyEnum = typeof PostCourseVersionItemScoreRollupStrategyEnum[keyof typeof PostCourseVersionItemScoreRollupStrategyEnum];
+
+
+/**
+ * Check if a given object implements the PostCourseVersionItem interface.
+ */
+export function instanceOfPostCourseVersionItem(value: object): value is PostCourseVersionItem {
+    if (!('contentLibraryItemId' in value) || value['contentLibraryItemId'] === undefined) return false;
+    if (!('moduleId' in value) || value['moduleId'] === undefined) return false;
+    return true;
+}
+
+export function PostCourseVersionItemFromJSON(json: any): PostCourseVersionItem {
+    return PostCourseVersionItemFromJSONTyped(json, false);
+}
+
+export function PostCourseVersionItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'contentLibraryItemId': json['content_library_item_id'],
+        'contentLibraryVersionId': json['content_library_version_id'] == null ? undefined : json['content_library_version_id'],
+        'moduleId': json['module_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 PostCourseVersionItemToJSON(json: any): PostCourseVersionItem {
+    return PostCourseVersionItemToJSONTyped(json, false);
+}
+
+export function PostCourseVersionItemToJSONTyped(value?: PostCourseVersionItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'content_library_item_id': value['contentLibraryItemId'],
+        'content_library_version_id': value['contentLibraryVersionId'],
+        'module_id': value['moduleId'],
+        '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/PostCourseVersionItemSession.ts

@@ -0,0 +1,65 @@
+/* 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';
+/**
+ * Start or resume a learner attempt for an exact course resource version.
+ * @export
+ * @interface PostCourseVersionItemSession
+ */
+export interface PostCourseVersionItemSession {
+    /**
+     * Create a new attempt instead of returning the current attempt.
+     * @type {boolean}
+     * @memberof PostCourseVersionItemSession
+     */
+    retake?: boolean;
+}
+
+/**
+ * Check if a given object implements the PostCourseVersionItemSession interface.
+ */
+export function instanceOfPostCourseVersionItemSession(value: object): value is PostCourseVersionItemSession {
+    return true;
+}
+
+export function PostCourseVersionItemSessionFromJSON(json: any): PostCourseVersionItemSession {
+    return PostCourseVersionItemSessionFromJSONTyped(json, false);
+}
+
+export function PostCourseVersionItemSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionItemSession {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'retake': json['retake'] == null ? undefined : json['retake'],
+    };
+}
+
+export function PostCourseVersionItemSessionToJSON(json: any): PostCourseVersionItemSession {
+    return PostCourseVersionItemSessionToJSONTyped(json, false);
+}
+
+export function PostCourseVersionItemSessionToJSONTyped(value?: PostCourseVersionItemSession | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'retake': value['retake'],
+    };
+}
+

package/src/models/PostCourseVersionPublish.ts

@@ -0,0 +1,65 @@
+/* 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 PostCourseVersionPublish
+ */
+export interface PostCourseVersionPublish {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCourseVersionPublish
+     */
+    changeNotes?: string;
+}
+
+/**
+ * Check if a given object implements the PostCourseVersionPublish interface.
+ */
+export function instanceOfPostCourseVersionPublish(value: object): value is PostCourseVersionPublish {
+    return true;
+}
+
+export function PostCourseVersionPublishFromJSON(json: any): PostCourseVersionPublish {
+    return PostCourseVersionPublishFromJSONTyped(json, false);
+}
+
+export function PostCourseVersionPublishFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionPublish {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+    };
+}
+
+export function PostCourseVersionPublishToJSON(json: any): PostCourseVersionPublish {
+    return PostCourseVersionPublishToJSONTyped(json, false);
+}
+
+export function PostCourseVersionPublishToJSONTyped(value?: PostCourseVersionPublish | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'change_notes': value['changeNotes'],
+    };
+}
+

package/src/models/PostResource.ts

@@ -0,0 +1,116 @@
+/* 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 { ResourceType } from './ResourceType';
+import {
+    ResourceTypeFromJSON,
+    ResourceTypeFromJSONTyped,
+    ResourceTypeToJSON,
+    ResourceTypeToJSONTyped,
+} from './ResourceType';
+import type { RichTextInput } from './RichTextInput';
+import {
+    RichTextInputFromJSON,
+    RichTextInputFromJSONTyped,
+    RichTextInputToJSON,
+    RichTextInputToJSONTyped,
+} from './RichTextInput';
+
+/**
+ * 
+ * @export
+ * @interface PostResource
+ */
+export interface PostResource {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostResource
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostResource
+     */
+    description?: string;
+    /**
+     * 
+     * @type {ResourceType}
+     * @memberof PostResource
+     */
+    resourceType: ResourceType;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostResource
+     */
+    linkUrl?: string | null;
+    /**
+     * 
+     * @type {RichTextInput}
+     * @memberof PostResource
+     */
+    richText?: RichTextInput | null;
+}
+
+
+
+/**
+ * Check if a given object implements the PostResource interface.
+ */
+export function instanceOfPostResource(value: object): value is PostResource {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('resourceType' in value) || value['resourceType'] === undefined) return false;
+    return true;
+}
+
+export function PostResourceFromJSON(json: any): PostResource {
+    return PostResourceFromJSONTyped(json, false);
+}
+
+export function PostResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'resourceType': ResourceTypeFromJSON(json['resource_type']),
+        'linkUrl': json['link_url'] == null ? undefined : json['link_url'],
+        'richText': json['rich_text'] == null ? undefined : RichTextInputFromJSON(json['rich_text']),
+    };
+}
+
+export function PostResourceToJSON(json: any): PostResource {
+    return PostResourceToJSONTyped(json, false);
+}
+
+export function PostResourceToJSONTyped(value?: PostResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        'resource_type': ResourceTypeToJSON(value['resourceType']),
+        'link_url': value['linkUrl'],
+        'rich_text': RichTextInputToJSON(value['richText']),
+    };
+}
+

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