@easyedu/js-lsm-api 1.83.0 → 1.85.0

package/src/models/GetCourseVersionItem.ts

@@ -0,0 +1,215 @@
+/* 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 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 const GetCourseVersionItemSourceKindEnum = {
+    Library: 'library',
+    QuizSnapshot: 'quiz_snapshot'
+} as const;
+export type GetCourseVersionItemSourceKindEnum = typeof GetCourseVersionItemSourceKindEnum[keyof typeof GetCourseVersionItemSourceKindEnum];
+
+/**
+ * @export
+ */
+export const GetCourseVersionItemScoreRollupStrategyEnum = {
+    Latest: 'Latest',
+    Best: 'Best'
+} as const;
+export type GetCourseVersionItemScoreRollupStrategyEnum = typeof GetCourseVersionItemScoreRollupStrategyEnum[keyof typeof GetCourseVersionItemScoreRollupStrategyEnum];
+
+
+/**
+ * Check if a given object implements the GetCourseVersionItem interface.
+ */
+export function instanceOfGetCourseVersionItem(value: object): value is GetCourseVersionItem {
+    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: any): GetCourseVersionItem {
+    return GetCourseVersionItemFromJSONTyped(json, false);
+}
+
+export function GetCourseVersionItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionItem {
+    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: any): GetCourseVersionItem {
+    return GetCourseVersionItemToJSONTyped(json, false);
+}
+
+export function GetCourseVersionItemToJSONTyped(value?: GetCourseVersionItem | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/GetCourseVersionItemLaunch.ts

@@ -0,0 +1,185 @@
+/* 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 { RichTextDocument } from './RichTextDocument';
+import {
+    RichTextDocumentFromJSON,
+    RichTextDocumentFromJSONTyped,
+    RichTextDocumentToJSON,
+    RichTextDocumentToJSONTyped,
+} from './RichTextDocument';
+import type { ResourceType } from './ResourceType';
+import {
+    ResourceTypeFromJSON,
+    ResourceTypeFromJSONTyped,
+    ResourceTypeToJSON,
+    ResourceTypeToJSONTyped,
+} from './ResourceType';
+import type { ContentLaunchMode } from './ContentLaunchMode';
+import {
+    ContentLaunchModeFromJSON,
+    ContentLaunchModeFromJSONTyped,
+    ContentLaunchModeToJSON,
+    ContentLaunchModeToJSONTyped,
+} 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 function instanceOfGetCourseVersionItemLaunch(value: object): value is GetCourseVersionItemLaunch {
+    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: any): GetCourseVersionItemLaunch {
+    return GetCourseVersionItemLaunchFromJSONTyped(json, false);
+}
+
+export function GetCourseVersionItemLaunchFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionItemLaunch {
+    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: any): GetCourseVersionItemLaunch {
+    return GetCourseVersionItemLaunchToJSONTyped(json, false);
+}
+
+export function GetCourseVersionItemLaunchToJSONTyped(value?: GetCourseVersionItemLaunch | null, ignoreDiscriminator: boolean = false): any {
+    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'],
+    };
+}
+

package/src/models/GetCourseVersionItemSession.ts

@@ -0,0 +1,216 @@
+/* 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 { ContentLaunchMode } from './ContentLaunchMode';
+import {
+    ContentLaunchModeFromJSON,
+    ContentLaunchModeFromJSONTyped,
+    ContentLaunchModeToJSON,
+    ContentLaunchModeToJSONTyped,
+} 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 function instanceOfGetCourseVersionItemSession(value: object): value is GetCourseVersionItemSession {
+    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;
+}
+
+export function GetCourseVersionItemSessionFromJSON(json: any): GetCourseVersionItemSession {
+    return GetCourseVersionItemSessionFromJSONTyped(json, false);
+}
+
+export function GetCourseVersionItemSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionItemSession {
+    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': ResourceTypeFromJSON(json['resource_type']),
+        'launchMode': 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'],
+    };
+}
+
+export function GetCourseVersionItemSessionToJSON(json: any): GetCourseVersionItemSession {
+    return GetCourseVersionItemSessionToJSONTyped(json, false);
+}
+
+export function GetCourseVersionItemSessionToJSONTyped(value?: GetCourseVersionItemSession | null, ignoreDiscriminator: boolean = false): any {
+    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': ResourceTypeToJSON(value['resourceType']),
+        'launch_mode': 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/src/models/GetCourseVersionList.ts

@@ -0,0 +1,74 @@
+/* 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 { GetCourseVersion } from './GetCourseVersion';
+import {
+    GetCourseVersionFromJSON,
+    GetCourseVersionFromJSONTyped,
+    GetCourseVersionToJSON,
+    GetCourseVersionToJSONTyped,
+} 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 function instanceOfGetCourseVersionList(value: object): value is GetCourseVersionList {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetCourseVersionListFromJSON(json: any): GetCourseVersionList {
+    return GetCourseVersionListFromJSONTyped(json, false);
+}
+
+export function GetCourseVersionListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(GetCourseVersionFromJSON)),
+    };
+}
+
+export function GetCourseVersionListToJSON(json: any): GetCourseVersionList {
+    return GetCourseVersionListToJSONTyped(json, false);
+}
+
+export function GetCourseVersionListToJSONTyped(value?: GetCourseVersionList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(GetCourseVersionToJSON)),
+    };
+}
+