@easyedu/js-lsm-api 1.83.0 → 1.84.0

package/dist/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/models/GetCourseVersionItemLaunch.js

@@ -0,0 +1,89 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetCourseVersionItemLaunch = instanceOfGetCourseVersionItemLaunch;
+exports.GetCourseVersionItemLaunchFromJSON = GetCourseVersionItemLaunchFromJSON;
+exports.GetCourseVersionItemLaunchFromJSONTyped = GetCourseVersionItemLaunchFromJSONTyped;
+exports.GetCourseVersionItemLaunchToJSON = GetCourseVersionItemLaunchToJSON;
+exports.GetCourseVersionItemLaunchToJSONTyped = GetCourseVersionItemLaunchToJSONTyped;
+const RichTextDocument_1 = require("./RichTextDocument");
+const ResourceType_1 = require("./ResourceType");
+const ContentLaunchMode_1 = require("./ContentLaunchMode");
+/**
+ * Check if a given object implements the GetCourseVersionItemLaunch interface.
+ */
+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;
+}
+function GetCourseVersionItemLaunchFromJSON(json) {
+    return GetCourseVersionItemLaunchFromJSONTyped(json, false);
+}
+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': (0, ResourceType_1.ResourceTypeFromJSON)(json['resource_type']),
+        'launchMode': (0, ContentLaunchMode_1.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 : (0, RichTextDocument_1.RichTextDocumentFromJSON)(json['rich_text']),
+        'metadata': json['metadata'],
+    };
+}
+function GetCourseVersionItemLaunchToJSON(json) {
+    return GetCourseVersionItemLaunchToJSONTyped(json, false);
+}
+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': (0, ResourceType_1.ResourceTypeToJSON)(value['resourceType']),
+        'launch_mode': (0, ContentLaunchMode_1.ContentLaunchModeToJSON)(value['launchMode']),
+        'max_attempts': value['maxAttempts'],
+        'url': value['url'],
+        'filename': value['filename'],
+        'mime_type': value['mimeType'],
+        'rich_text': (0, RichTextDocument_1.RichTextDocumentToJSON)(value['richText']),
+        'metadata': value['metadata'],
+    };
+}

package/dist/models/GetCourseVersionItemSession.d.ts

@@ -0,0 +1,124 @@
+/**
+ * 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 { ResourceType } from './ResourceType';
+import type { ContentLaunchMode } from './ContentLaunchMode';
+/**
+ * A learner resource attempt pinned to an immutable course and Content Library version.
+ * @export
+ * @interface GetCourseVersionItemSession
+ */
+export interface GetCourseVersionItemSession {
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    courseVersionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    itemId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    contentLibraryItemId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    contentLibraryVersionId: string;
+    /**
+     *
+     * @type {ResourceType}
+     * @memberof GetCourseVersionItemSession
+     */
+    resourceType: ResourceType;
+    /**
+     *
+     * @type {ContentLaunchMode}
+     * @memberof GetCourseVersionItemSession
+     */
+    launchMode: ContentLaunchMode;
+    /**
+     * Session-aware player URL, direct asset URL, or external link.
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    launchUrl: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    attemptNumber: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof GetCourseVersionItemSession
+     */
+    isCurrent: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    completionStatus: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    gradeStatus: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    scoreRaw?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    createdAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    updatedAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    completedAt?: number | null;
+}
+/**
+ * Check if a given object implements the GetCourseVersionItemSession interface.
+ */
+export declare function instanceOfGetCourseVersionItemSession(value: object): value is GetCourseVersionItemSession;
+export declare function GetCourseVersionItemSessionFromJSON(json: any): GetCourseVersionItemSession;
+export declare function GetCourseVersionItemSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionItemSession;
+export declare function GetCourseVersionItemSessionToJSON(json: any): GetCourseVersionItemSession;
+export declare function GetCourseVersionItemSessionToJSONTyped(value?: GetCourseVersionItemSession | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetCourseVersionItemSession.js

@@ -0,0 +1,108 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetCourseVersionItemSession = instanceOfGetCourseVersionItemSession;
+exports.GetCourseVersionItemSessionFromJSON = GetCourseVersionItemSessionFromJSON;
+exports.GetCourseVersionItemSessionFromJSONTyped = GetCourseVersionItemSessionFromJSONTyped;
+exports.GetCourseVersionItemSessionToJSON = GetCourseVersionItemSessionToJSON;
+exports.GetCourseVersionItemSessionToJSONTyped = GetCourseVersionItemSessionToJSONTyped;
+const ResourceType_1 = require("./ResourceType");
+const ContentLaunchMode_1 = require("./ContentLaunchMode");
+/**
+ * Check if a given object implements the GetCourseVersionItemSession interface.
+ */
+function instanceOfGetCourseVersionItemSession(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    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 (!('launchUrl' in value) || value['launchUrl'] === undefined)
+        return false;
+    if (!('attemptNumber' in value) || value['attemptNumber'] === undefined)
+        return false;
+    if (!('isCurrent' in value) || value['isCurrent'] === undefined)
+        return false;
+    if (!('completionStatus' in value) || value['completionStatus'] === undefined)
+        return false;
+    if (!('gradeStatus' in value) || value['gradeStatus'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+function GetCourseVersionItemSessionFromJSON(json) {
+    return GetCourseVersionItemSessionFromJSONTyped(json, false);
+}
+function GetCourseVersionItemSessionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'courseVersionId': json['course_version_id'],
+        'itemId': json['item_id'],
+        'contentLibraryItemId': json['content_library_item_id'],
+        'contentLibraryVersionId': json['content_library_version_id'],
+        'resourceType': (0, ResourceType_1.ResourceTypeFromJSON)(json['resource_type']),
+        'launchMode': (0, ContentLaunchMode_1.ContentLaunchModeFromJSON)(json['launch_mode']),
+        'launchUrl': json['launch_url'],
+        'attemptNumber': json['attempt_number'],
+        'isCurrent': json['is_current'],
+        'completionStatus': json['completion_status'],
+        'gradeStatus': json['grade_status'],
+        'scoreRaw': json['score_raw'] == null ? undefined : json['score_raw'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'completedAt': json['completed_at'] == null ? undefined : json['completed_at'],
+    };
+}
+function GetCourseVersionItemSessionToJSON(json) {
+    return GetCourseVersionItemSessionToJSONTyped(json, false);
+}
+function GetCourseVersionItemSessionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'course_version_id': value['courseVersionId'],
+        'item_id': value['itemId'],
+        'content_library_item_id': value['contentLibraryItemId'],
+        'content_library_version_id': value['contentLibraryVersionId'],
+        'resource_type': (0, ResourceType_1.ResourceTypeToJSON)(value['resourceType']),
+        'launch_mode': (0, ContentLaunchMode_1.ContentLaunchModeToJSON)(value['launchMode']),
+        'launch_url': value['launchUrl'],
+        'attempt_number': value['attemptNumber'],
+        'is_current': value['isCurrent'],
+        'completion_status': value['completionStatus'],
+        'grade_status': value['gradeStatus'],
+        'score_raw': value['scoreRaw'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'completed_at': value['completedAt'],
+    };
+}

package/dist/models/GetCourseVersionList.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 { GetCourseVersion } from './GetCourseVersion';
+/**
+ *
+ * @export
+ * @interface GetCourseVersionList
+ */
+export interface GetCourseVersionList {
+    /**
+     *
+     * @type {Array<GetCourseVersion>}
+     * @memberof GetCourseVersionList
+     */
+    items: Array<GetCourseVersion>;
+}
+/**
+ * Check if a given object implements the GetCourseVersionList interface.
+ */
+export declare function instanceOfGetCourseVersionList(value: object): value is GetCourseVersionList;
+export declare function GetCourseVersionListFromJSON(json: any): GetCourseVersionList;
+export declare function GetCourseVersionListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionList;
+export declare function GetCourseVersionListToJSON(json: any): GetCourseVersionList;
+export declare function GetCourseVersionListToJSONTyped(value?: GetCourseVersionList | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetCourseVersionList.js

@@ -0,0 +1,51 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetCourseVersionList = instanceOfGetCourseVersionList;
+exports.GetCourseVersionListFromJSON = GetCourseVersionListFromJSON;
+exports.GetCourseVersionListFromJSONTyped = GetCourseVersionListFromJSONTyped;
+exports.GetCourseVersionListToJSON = GetCourseVersionListToJSON;
+exports.GetCourseVersionListToJSONTyped = GetCourseVersionListToJSONTyped;
+const GetCourseVersion_1 = require("./GetCourseVersion");
+/**
+ * Check if a given object implements the GetCourseVersionList interface.
+ */
+function instanceOfGetCourseVersionList(value) {
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+function GetCourseVersionListFromJSON(json) {
+    return GetCourseVersionListFromJSONTyped(json, false);
+}
+function GetCourseVersionListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'items': (json['items'].map(GetCourseVersion_1.GetCourseVersionFromJSON)),
+    };
+}
+function GetCourseVersionListToJSON(json) {
+    return GetCourseVersionListToJSONTyped(json, false);
+}
+function GetCourseVersionListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'items': (value['items'].map(GetCourseVersion_1.GetCourseVersionToJSON)),
+    };
+}

package/dist/models/GetCourseVersionModule.d.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 { GetCourseVersionItem } from './GetCourseVersionItem';
+import type { RichTextDocument } from './RichTextDocument';
+/**
+ *
+ * @export
+ * @interface GetCourseVersionModule
+ */
+export interface GetCourseVersionModule {
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionModule
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionModule
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionModule
+     */
+    description: string;
+    /**
+     *
+     * @type {RichTextDocument}
+     * @memberof GetCourseVersionModule
+     */
+    descriptionRich: RichTextDocument;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionModule
+     */
+    displayOrder: number;
+    /**
+     *
+     * @type {Array<GetCourseVersionItem>}
+     * @memberof GetCourseVersionModule
+     */
+    items: Array<GetCourseVersionItem>;
+}
+/**
+ * Check if a given object implements the GetCourseVersionModule interface.
+ */
+export declare function instanceOfGetCourseVersionModule(value: object): value is GetCourseVersionModule;
+export declare function GetCourseVersionModuleFromJSON(json: any): GetCourseVersionModule;
+export declare function GetCourseVersionModuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionModule;
+export declare function GetCourseVersionModuleToJSON(json: any): GetCourseVersionModule;
+export declare function GetCourseVersionModuleToJSONTyped(value?: GetCourseVersionModule | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetCourseVersionModule.js

@@ -0,0 +1,72 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetCourseVersionModule = instanceOfGetCourseVersionModule;
+exports.GetCourseVersionModuleFromJSON = GetCourseVersionModuleFromJSON;
+exports.GetCourseVersionModuleFromJSONTyped = GetCourseVersionModuleFromJSONTyped;
+exports.GetCourseVersionModuleToJSON = GetCourseVersionModuleToJSON;
+exports.GetCourseVersionModuleToJSONTyped = GetCourseVersionModuleToJSONTyped;
+const GetCourseVersionItem_1 = require("./GetCourseVersionItem");
+const RichTextDocument_1 = require("./RichTextDocument");
+/**
+ * Check if a given object implements the GetCourseVersionModule interface.
+ */
+function instanceOfGetCourseVersionModule(value) {
+    if (!('id' in value) || value['id'] === 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 (!('displayOrder' in value) || value['displayOrder'] === undefined)
+        return false;
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+function GetCourseVersionModuleFromJSON(json) {
+    return GetCourseVersionModuleFromJSONTyped(json, false);
+}
+function GetCourseVersionModuleFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'descriptionRich': (0, RichTextDocument_1.RichTextDocumentFromJSON)(json['description_rich']),
+        'displayOrder': json['display_order'],
+        'items': (json['items'].map(GetCourseVersionItem_1.GetCourseVersionItemFromJSON)),
+    };
+}
+function GetCourseVersionModuleToJSON(json) {
+    return GetCourseVersionModuleToJSONTyped(json, false);
+}
+function GetCourseVersionModuleToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'description_rich': (0, RichTextDocument_1.RichTextDocumentToJSON)(value['descriptionRich']),
+        'display_order': value['displayOrder'],
+        'items': (value['items'].map(GetCourseVersionItem_1.GetCourseVersionItemToJSON)),
+    };
+}