@easyedu/js-lsm-api 1.82.0 → 1.84.0

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

@@ -0,0 +1,101 @@
+/**
+ * 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 { GetCourseVersionModule } from './GetCourseVersionModule';
+import type { ContentLibraryVersionStatus } from './ContentLibraryVersionStatus';
+import type { RichTextDocument } from './RichTextDocument';
+/**
+ *
+ * @export
+ * @interface GetCourseVersion
+ */
+export interface GetCourseVersion {
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersion
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersion
+     */
+    courseId: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersion
+     */
+    versionNumber: number;
+    /**
+     *
+     * @type {ContentLibraryVersionStatus}
+     * @memberof GetCourseVersion
+     */
+    status: ContentLibraryVersionStatus;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersion
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersion
+     */
+    description: string;
+    /**
+     *
+     * @type {RichTextDocument}
+     * @memberof GetCourseVersion
+     */
+    descriptionRich: RichTextDocument;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersion
+     */
+    changeNotes?: string | null;
+    /**
+     *
+     * @type {Array<GetCourseVersionModule>}
+     * @memberof GetCourseVersion
+     */
+    modules: Array<GetCourseVersionModule>;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersion
+     */
+    createdAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersion
+     */
+    updatedAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersion
+     */
+    publishedAt?: number | null;
+}
+/**
+ * Check if a given object implements the GetCourseVersion interface.
+ */
+export declare function instanceOfGetCourseVersion(value: object): value is GetCourseVersion;
+export declare function GetCourseVersionFromJSON(json: any): GetCourseVersion;
+export declare function GetCourseVersionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersion;
+export declare function GetCourseVersionToJSON(json: any): GetCourseVersion;
+export declare function GetCourseVersionToJSONTyped(value?: GetCourseVersion | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetCourseVersion.js

@@ -0,0 +1,86 @@
+/* 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 { GetCourseVersionModuleFromJSON, GetCourseVersionModuleToJSON, } from './GetCourseVersionModule';
+import { ContentLibraryVersionStatusFromJSON, ContentLibraryVersionStatusToJSON, } from './ContentLibraryVersionStatus';
+import { RichTextDocumentFromJSON, RichTextDocumentToJSON, } from './RichTextDocument';
+/**
+ * Check if a given object implements the GetCourseVersion interface.
+ */
+export function instanceOfGetCourseVersion(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    if (!('versionNumber' in value) || value['versionNumber'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('descriptionRich' in value) || value['descriptionRich'] === undefined)
+        return false;
+    if (!('modules' in value) || value['modules'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function GetCourseVersionFromJSON(json) {
+    return GetCourseVersionFromJSONTyped(json, false);
+}
+export function GetCourseVersionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'courseId': json['course_id'],
+        'versionNumber': json['version_number'],
+        'status': ContentLibraryVersionStatusFromJSON(json['status']),
+        'name': json['name'],
+        'description': json['description'],
+        'descriptionRich': RichTextDocumentFromJSON(json['description_rich']),
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+        'modules': (json['modules'].map(GetCourseVersionModuleFromJSON)),
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'publishedAt': json['published_at'] == null ? undefined : json['published_at'],
+    };
+}
+export function GetCourseVersionToJSON(json) {
+    return GetCourseVersionToJSONTyped(json, false);
+}
+export function GetCourseVersionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'course_id': value['courseId'],
+        'version_number': value['versionNumber'],
+        'status': ContentLibraryVersionStatusToJSON(value['status']),
+        'name': value['name'],
+        'description': value['description'],
+        'description_rich': RichTextDocumentToJSON(value['descriptionRich']),
+        'change_notes': value['changeNotes'],
+        'modules': (value['modules'].map(GetCourseVersionModuleToJSON)),
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'published_at': value['publishedAt'],
+    };
+}

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

@@ -0,0 +1,135 @@
+/**
+ * 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 GetCourseVersionItem
+ */
+export interface GetCourseVersionItem {
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItem
+     */
+    id: string;
+    /**
+     *
+     * @type {GetCourseVersionItemSourceKindEnum}
+     * @memberof GetCourseVersionItem
+     */
+    sourceKind: GetCourseVersionItemSourceKindEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItem
+     */
+    contentLibraryItemId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItem
+     */
+    contentLibraryVersionId?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItem
+     */
+    resourceVersionNumber?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItem
+     */
+    latestPublishedVersionId?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItem
+     */
+    latestPublishedVersionNumber?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof GetCourseVersionItem
+     */
+    updateAvailable: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItem
+     */
+    displayName: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItem
+     */
+    displayOrder: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof GetCourseVersionItem
+     */
+    isVisible: boolean;
+    /**
+     *
+     * @type {ContentLaunchMode}
+     * @memberof GetCourseVersionItem
+     */
+    launchMode: ContentLaunchMode;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItem
+     */
+    maxAttempts: number;
+    /**
+     *
+     * @type {GetCourseVersionItemScoreRollupStrategyEnum}
+     * @memberof GetCourseVersionItem
+     */
+    scoreRollupStrategy: GetCourseVersionItemScoreRollupStrategyEnum;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof GetCourseVersionItem
+     */
+    settings: {
+        [key: string]: any;
+    };
+}
+/**
+ * @export
+ */
+export declare const GetCourseVersionItemSourceKindEnum: {
+    readonly Library: "library";
+    readonly QuizSnapshot: "quiz_snapshot";
+};
+export type GetCourseVersionItemSourceKindEnum = typeof GetCourseVersionItemSourceKindEnum[keyof typeof GetCourseVersionItemSourceKindEnum];
+/**
+ * @export
+ */
+export declare const GetCourseVersionItemScoreRollupStrategyEnum: {
+    readonly Latest: "Latest";
+    readonly Best: "Best";
+};
+export type GetCourseVersionItemScoreRollupStrategyEnum = typeof GetCourseVersionItemScoreRollupStrategyEnum[keyof typeof GetCourseVersionItemScoreRollupStrategyEnum];
+/**
+ * Check if a given object implements the GetCourseVersionItem interface.
+ */
+export declare function instanceOfGetCourseVersionItem(value: object): value is GetCourseVersionItem;
+export declare function GetCourseVersionItemFromJSON(json: any): GetCourseVersionItem;
+export declare function GetCourseVersionItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionItem;
+export declare function GetCourseVersionItemToJSON(json: any): GetCourseVersionItem;
+export declare function GetCourseVersionItemToJSONTyped(value?: GetCourseVersionItem | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetCourseVersionItem.js

@@ -0,0 +1,104 @@
+/* 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 GetCourseVersionItemSourceKindEnum = {
+    Library: 'library',
+    QuizSnapshot: 'quiz_snapshot'
+};
+/**
+ * @export
+ */
+export const GetCourseVersionItemScoreRollupStrategyEnum = {
+    Latest: 'Latest',
+    Best: 'Best'
+};
+/**
+ * Check if a given object implements the GetCourseVersionItem interface.
+ */
+export function instanceOfGetCourseVersionItem(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('sourceKind' in value) || value['sourceKind'] === undefined)
+        return false;
+    if (!('updateAvailable' in value) || value['updateAvailable'] === undefined)
+        return false;
+    if (!('displayName' in value) || value['displayName'] === undefined)
+        return false;
+    if (!('displayOrder' in value) || value['displayOrder'] === undefined)
+        return false;
+    if (!('isVisible' in value) || value['isVisible'] === undefined)
+        return false;
+    if (!('launchMode' in value) || value['launchMode'] === undefined)
+        return false;
+    if (!('maxAttempts' in value) || value['maxAttempts'] === undefined)
+        return false;
+    if (!('scoreRollupStrategy' in value) || value['scoreRollupStrategy'] === undefined)
+        return false;
+    if (!('settings' in value) || value['settings'] === undefined)
+        return false;
+    return true;
+}
+export function GetCourseVersionItemFromJSON(json) {
+    return GetCourseVersionItemFromJSONTyped(json, false);
+}
+export function GetCourseVersionItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'sourceKind': json['source_kind'],
+        'contentLibraryItemId': json['content_library_item_id'] == null ? undefined : json['content_library_item_id'],
+        'contentLibraryVersionId': json['content_library_version_id'] == null ? undefined : json['content_library_version_id'],
+        'resourceVersionNumber': json['resource_version_number'] == null ? undefined : json['resource_version_number'],
+        'latestPublishedVersionId': json['latest_published_version_id'] == null ? undefined : json['latest_published_version_id'],
+        'latestPublishedVersionNumber': json['latest_published_version_number'] == null ? undefined : json['latest_published_version_number'],
+        'updateAvailable': json['update_available'],
+        'displayName': json['display_name'],
+        'displayOrder': json['display_order'],
+        'isVisible': json['is_visible'],
+        'launchMode': ContentLaunchModeFromJSON(json['launch_mode']),
+        'maxAttempts': json['max_attempts'],
+        'scoreRollupStrategy': json['score_rollup_strategy'],
+        'settings': json['settings'],
+    };
+}
+export function GetCourseVersionItemToJSON(json) {
+    return GetCourseVersionItemToJSONTyped(json, false);
+}
+export function GetCourseVersionItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'source_kind': value['sourceKind'],
+        'content_library_item_id': value['contentLibraryItemId'],
+        'content_library_version_id': value['contentLibraryVersionId'],
+        'resource_version_number': value['resourceVersionNumber'],
+        'latest_published_version_id': value['latestPublishedVersionId'],
+        'latest_published_version_number': value['latestPublishedVersionNumber'],
+        'update_available': value['updateAvailable'],
+        '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/GetCourseVersionItemLaunch.d.ts

@@ -0,0 +1,103 @@
+/**
+ * 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 { ResourceType } from './ResourceType';
+import type { ContentLaunchMode } from './ContentLaunchMode';
+/**
+ *
+ * @export
+ * @interface GetCourseVersionItemLaunch
+ */
+export interface GetCourseVersionItemLaunch {
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    courseVersionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    itemId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    contentLibraryItemId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    contentLibraryVersionId: string;
+    /**
+     *
+     * @type {ResourceType}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    resourceType: ResourceType;
+    /**
+     *
+     * @type {ContentLaunchMode}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    launchMode: ContentLaunchMode;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    maxAttempts: number;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    url?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    filename?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    mimeType?: string | null;
+    /**
+     *
+     * @type {RichTextDocument}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    richText?: RichTextDocument | null;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof GetCourseVersionItemLaunch
+     */
+    metadata: {
+        [key: string]: any;
+    };
+}
+/**
+ * Check if a given object implements the GetCourseVersionItemLaunch interface.
+ */
+export declare function instanceOfGetCourseVersionItemLaunch(value: object): value is GetCourseVersionItemLaunch;
+export declare function GetCourseVersionItemLaunchFromJSON(json: any): GetCourseVersionItemLaunch;
+export declare function GetCourseVersionItemLaunchFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionItemLaunch;
+export declare function GetCourseVersionItemLaunchToJSON(json: any): GetCourseVersionItemLaunch;
+export declare function GetCourseVersionItemLaunchToJSONTyped(value?: GetCourseVersionItemLaunch | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetCourseVersionItemLaunch.js

@@ -0,0 +1,82 @@
+/* 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 { RichTextDocumentFromJSON, RichTextDocumentToJSON, } from './RichTextDocument';
+import { ResourceTypeFromJSON, ResourceTypeToJSON, } from './ResourceType';
+import { ContentLaunchModeFromJSON, ContentLaunchModeToJSON, } from './ContentLaunchMode';
+/**
+ * Check if a given object implements the GetCourseVersionItemLaunch interface.
+ */
+export function instanceOfGetCourseVersionItemLaunch(value) {
+    if (!('courseVersionId' in value) || value['courseVersionId'] === undefined)
+        return false;
+    if (!('itemId' in value) || value['itemId'] === undefined)
+        return false;
+    if (!('contentLibraryItemId' in value) || value['contentLibraryItemId'] === undefined)
+        return false;
+    if (!('contentLibraryVersionId' in value) || value['contentLibraryVersionId'] === undefined)
+        return false;
+    if (!('resourceType' in value) || value['resourceType'] === undefined)
+        return false;
+    if (!('launchMode' in value) || value['launchMode'] === undefined)
+        return false;
+    if (!('maxAttempts' in value) || value['maxAttempts'] === undefined)
+        return false;
+    if (!('metadata' in value) || value['metadata'] === undefined)
+        return false;
+    return true;
+}
+export function GetCourseVersionItemLaunchFromJSON(json) {
+    return GetCourseVersionItemLaunchFromJSONTyped(json, false);
+}
+export function GetCourseVersionItemLaunchFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'courseVersionId': json['course_version_id'],
+        'itemId': json['item_id'],
+        'contentLibraryItemId': json['content_library_item_id'],
+        'contentLibraryVersionId': json['content_library_version_id'],
+        'resourceType': ResourceTypeFromJSON(json['resource_type']),
+        'launchMode': ContentLaunchModeFromJSON(json['launch_mode']),
+        'maxAttempts': json['max_attempts'],
+        'url': json['url'] == null ? undefined : json['url'],
+        'filename': json['filename'] == null ? undefined : json['filename'],
+        'mimeType': json['mime_type'] == null ? undefined : json['mime_type'],
+        'richText': json['rich_text'] == null ? undefined : RichTextDocumentFromJSON(json['rich_text']),
+        'metadata': json['metadata'],
+    };
+}
+export function GetCourseVersionItemLaunchToJSON(json) {
+    return GetCourseVersionItemLaunchToJSONTyped(json, false);
+}
+export function GetCourseVersionItemLaunchToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'course_version_id': value['courseVersionId'],
+        'item_id': value['itemId'],
+        'content_library_item_id': value['contentLibraryItemId'],
+        'content_library_version_id': value['contentLibraryVersionId'],
+        'resource_type': ResourceTypeToJSON(value['resourceType']),
+        'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
+        'max_attempts': value['maxAttempts'],
+        'url': value['url'],
+        'filename': value['filename'],
+        'mime_type': value['mimeType'],
+        'rich_text': RichTextDocumentToJSON(value['richText']),
+        'metadata': value['metadata'],
+    };
+}