@easyedu/js-lsm-api 1.89.0 → 1.91.0

package/src/models/GetResourceSession.ts

@@ -0,0 +1,313 @@
+/* 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 { ResourceSessionEnvironment } from './ResourceSessionEnvironment';
+import {
+    ResourceSessionEnvironmentFromJSON,
+    ResourceSessionEnvironmentFromJSONTyped,
+    ResourceSessionEnvironmentToJSON,
+    ResourceSessionEnvironmentToJSONTyped,
+} from './ResourceSessionEnvironment';
+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 user-owned session pinned to an immutable Content Library resource version.
+ * @export
+ * @interface GetResourceSession
+ */
+export interface GetResourceSession {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    userId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    userName: string;
+    /**
+     * 
+     * @type {ResourceSessionEnvironment}
+     * @memberof GetResourceSession
+     */
+    environment: ResourceSessionEnvironment;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    courseId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    courseName?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    courseVersionId?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSession
+     */
+    courseVersionNumber?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    itemId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    contentLibraryItemId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    contentLibraryVersionId: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSession
+     */
+    contentLibraryVersionNumber: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    contentLibraryVersionStatus: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    resourceName: string;
+    /**
+     * 
+     * @type {ResourceType}
+     * @memberof GetResourceSession
+     */
+    resourceType: ResourceType;
+    /**
+     * 
+     * @type {ContentLaunchMode}
+     * @memberof GetResourceSession
+     */
+    launchMode?: ContentLaunchMode | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    launchUrl?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSession
+     */
+    attemptNumber: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetResourceSession
+     */
+    isCurrent: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    completionStatus: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    gradeStatus: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSession
+     */
+    scoreRaw?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSession
+     */
+    initializedAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSession
+     */
+    terminatedAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSession
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSession
+     */
+    updatedAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSession
+     */
+    completedAt?: number | null;
+}
+
+
+
+/**
+ * Check if a given object implements the GetResourceSession interface.
+ */
+export function instanceOfGetResourceSession(value: object): value is GetResourceSession {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    if (!('userName' in value) || value['userName'] === undefined) return false;
+    if (!('environment' in value) || value['environment'] === undefined) return false;
+    if (!('contentLibraryItemId' in value) || value['contentLibraryItemId'] === undefined) return false;
+    if (!('contentLibraryVersionId' in value) || value['contentLibraryVersionId'] === undefined) return false;
+    if (!('contentLibraryVersionNumber' in value) || value['contentLibraryVersionNumber'] === undefined) return false;
+    if (!('contentLibraryVersionStatus' in value) || value['contentLibraryVersionStatus'] === undefined) return false;
+    if (!('resourceName' in value) || value['resourceName'] === undefined) return false;
+    if (!('resourceType' in value) || value['resourceType'] === 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 GetResourceSessionFromJSON(json: any): GetResourceSession {
+    return GetResourceSessionFromJSONTyped(json, false);
+}
+
+export function GetResourceSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSession {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'userId': json['user_id'],
+        'userName': json['user_name'],
+        'environment': ResourceSessionEnvironmentFromJSON(json['environment']),
+        'courseId': json['course_id'] == null ? undefined : json['course_id'],
+        'courseName': json['course_name'] == null ? undefined : json['course_name'],
+        'courseVersionId': json['course_version_id'] == null ? undefined : json['course_version_id'],
+        'courseVersionNumber': json['course_version_number'] == null ? undefined : json['course_version_number'],
+        'itemId': json['item_id'] == null ? undefined : json['item_id'],
+        'contentLibraryItemId': json['content_library_item_id'],
+        'contentLibraryVersionId': json['content_library_version_id'],
+        'contentLibraryVersionNumber': json['content_library_version_number'],
+        'contentLibraryVersionStatus': json['content_library_version_status'],
+        'resourceName': json['resource_name'],
+        'resourceType': ResourceTypeFromJSON(json['resource_type']),
+        'launchMode': json['launch_mode'] == null ? undefined : ContentLaunchModeFromJSON(json['launch_mode']),
+        'launchUrl': json['launch_url'] == null ? undefined : 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'],
+        'initializedAt': json['initialized_at'] == null ? undefined : json['initialized_at'],
+        'terminatedAt': json['terminated_at'] == null ? undefined : json['terminated_at'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'completedAt': json['completed_at'] == null ? undefined : json['completed_at'],
+    };
+}
+
+export function GetResourceSessionToJSON(json: any): GetResourceSession {
+    return GetResourceSessionToJSONTyped(json, false);
+}
+
+export function GetResourceSessionToJSONTyped(value?: GetResourceSession | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'user_id': value['userId'],
+        'user_name': value['userName'],
+        'environment': ResourceSessionEnvironmentToJSON(value['environment']),
+        'course_id': value['courseId'],
+        'course_name': value['courseName'],
+        'course_version_id': value['courseVersionId'],
+        'course_version_number': value['courseVersionNumber'],
+        'item_id': value['itemId'],
+        'content_library_item_id': value['contentLibraryItemId'],
+        'content_library_version_id': value['contentLibraryVersionId'],
+        'content_library_version_number': value['contentLibraryVersionNumber'],
+        'content_library_version_status': value['contentLibraryVersionStatus'],
+        'resource_name': value['resourceName'],
+        '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'],
+        'initialized_at': value['initializedAt'],
+        'terminated_at': value['terminatedAt'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'completed_at': value['completedAt'],
+    };
+}
+

package/src/models/GetResourceSessionDiagnostics.ts

@@ -0,0 +1,161 @@
+/* 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 { GetResourceSessionDiagnosticsResource } from './GetResourceSessionDiagnosticsResource';
+import {
+    GetResourceSessionDiagnosticsResourceFromJSON,
+    GetResourceSessionDiagnosticsResourceFromJSONTyped,
+    GetResourceSessionDiagnosticsResourceToJSON,
+    GetResourceSessionDiagnosticsResourceToJSONTyped,
+} from './GetResourceSessionDiagnosticsResource';
+import type { GetResourceSessionDiagnosticsScormSummary } from './GetResourceSessionDiagnosticsScormSummary';
+import {
+    GetResourceSessionDiagnosticsScormSummaryFromJSON,
+    GetResourceSessionDiagnosticsScormSummaryFromJSONTyped,
+    GetResourceSessionDiagnosticsScormSummaryToJSON,
+    GetResourceSessionDiagnosticsScormSummaryToJSONTyped,
+} from './GetResourceSessionDiagnosticsScormSummary';
+import type { GetResourceSessionDiagnosticsUser } from './GetResourceSessionDiagnosticsUser';
+import {
+    GetResourceSessionDiagnosticsUserFromJSON,
+    GetResourceSessionDiagnosticsUserFromJSONTyped,
+    GetResourceSessionDiagnosticsUserToJSON,
+    GetResourceSessionDiagnosticsUserToJSONTyped,
+} from './GetResourceSessionDiagnosticsUser';
+import type { GetResourceSession } from './GetResourceSession';
+import {
+    GetResourceSessionFromJSON,
+    GetResourceSessionFromJSONTyped,
+    GetResourceSessionToJSON,
+    GetResourceSessionToJSONTyped,
+} from './GetResourceSession';
+import type { GetResourceSessionDiagnosticsCourseContext } from './GetResourceSessionDiagnosticsCourseContext';
+import {
+    GetResourceSessionDiagnosticsCourseContextFromJSON,
+    GetResourceSessionDiagnosticsCourseContextFromJSONTyped,
+    GetResourceSessionDiagnosticsCourseContextToJSON,
+    GetResourceSessionDiagnosticsCourseContextToJSONTyped,
+} from './GetResourceSessionDiagnosticsCourseContext';
+import type { GetResourceSessionDiagnosticsVersion } from './GetResourceSessionDiagnosticsVersion';
+import {
+    GetResourceSessionDiagnosticsVersionFromJSON,
+    GetResourceSessionDiagnosticsVersionFromJSONTyped,
+    GetResourceSessionDiagnosticsVersionToJSON,
+    GetResourceSessionDiagnosticsVersionToJSONTyped,
+} from './GetResourceSessionDiagnosticsVersion';
+
+/**
+ * Administrator diagnostics for a resource session and its exact resource-version pin.
+ * @export
+ * @interface GetResourceSessionDiagnostics
+ */
+export interface GetResourceSessionDiagnostics {
+    /**
+     * 
+     * @type {GetResourceSession}
+     * @memberof GetResourceSessionDiagnostics
+     */
+    session: GetResourceSession;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof GetResourceSessionDiagnostics
+     */
+    sessionData: { [key: string]: any; };
+    /**
+     * 
+     * @type {GetResourceSessionDiagnosticsUser}
+     * @memberof GetResourceSessionDiagnostics
+     */
+    user: GetResourceSessionDiagnosticsUser;
+    /**
+     * 
+     * @type {GetResourceSessionDiagnosticsResource}
+     * @memberof GetResourceSessionDiagnostics
+     */
+    resource: GetResourceSessionDiagnosticsResource;
+    /**
+     * 
+     * @type {GetResourceSessionDiagnosticsVersion}
+     * @memberof GetResourceSessionDiagnostics
+     */
+    version: GetResourceSessionDiagnosticsVersion;
+    /**
+     * 
+     * @type {GetResourceSessionDiagnosticsCourseContext}
+     * @memberof GetResourceSessionDiagnostics
+     */
+    courseContext?: GetResourceSessionDiagnosticsCourseContext | null;
+    /**
+     * 
+     * @type {GetResourceSessionDiagnosticsScormSummary}
+     * @memberof GetResourceSessionDiagnostics
+     */
+    scormSummary?: GetResourceSessionDiagnosticsScormSummary | null;
+}
+
+/**
+ * Check if a given object implements the GetResourceSessionDiagnostics interface.
+ */
+export function instanceOfGetResourceSessionDiagnostics(value: object): value is GetResourceSessionDiagnostics {
+    if (!('session' in value) || value['session'] === undefined) return false;
+    if (!('sessionData' in value) || value['sessionData'] === undefined) return false;
+    if (!('user' in value) || value['user'] === undefined) return false;
+    if (!('resource' in value) || value['resource'] === undefined) return false;
+    if (!('version' in value) || value['version'] === undefined) return false;
+    return true;
+}
+
+export function GetResourceSessionDiagnosticsFromJSON(json: any): GetResourceSessionDiagnostics {
+    return GetResourceSessionDiagnosticsFromJSONTyped(json, false);
+}
+
+export function GetResourceSessionDiagnosticsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSessionDiagnostics {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'session': GetResourceSessionFromJSON(json['session']),
+        'sessionData': json['session_data'],
+        'user': GetResourceSessionDiagnosticsUserFromJSON(json['user']),
+        'resource': GetResourceSessionDiagnosticsResourceFromJSON(json['resource']),
+        'version': GetResourceSessionDiagnosticsVersionFromJSON(json['version']),
+        'courseContext': json['course_context'] == null ? undefined : GetResourceSessionDiagnosticsCourseContextFromJSON(json['course_context']),
+        'scormSummary': json['scorm_summary'] == null ? undefined : GetResourceSessionDiagnosticsScormSummaryFromJSON(json['scorm_summary']),
+    };
+}
+
+export function GetResourceSessionDiagnosticsToJSON(json: any): GetResourceSessionDiagnostics {
+    return GetResourceSessionDiagnosticsToJSONTyped(json, false);
+}
+
+export function GetResourceSessionDiagnosticsToJSONTyped(value?: GetResourceSessionDiagnostics | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'session': GetResourceSessionToJSON(value['session']),
+        'session_data': value['sessionData'],
+        'user': GetResourceSessionDiagnosticsUserToJSON(value['user']),
+        'resource': GetResourceSessionDiagnosticsResourceToJSON(value['resource']),
+        'version': GetResourceSessionDiagnosticsVersionToJSON(value['version']),
+        'course_context': GetResourceSessionDiagnosticsCourseContextToJSON(value['courseContext']),
+        'scorm_summary': GetResourceSessionDiagnosticsScormSummaryToJSON(value['scormSummary']),
+    };
+}
+

package/src/models/GetResourceSessionDiagnosticsCourseContext.ts

@@ -0,0 +1,148 @@
+/* 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 GetResourceSessionDiagnosticsCourseContext
+ */
+export interface GetResourceSessionDiagnosticsCourseContext {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionDiagnosticsCourseContext
+     */
+    courseId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionDiagnosticsCourseContext
+     */
+    courseName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionDiagnosticsCourseContext
+     */
+    courseVersionId: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionDiagnosticsCourseContext
+     */
+    courseVersionNumber: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionDiagnosticsCourseContext
+     */
+    itemId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionDiagnosticsCourseContext
+     */
+    displayName: string;
+    /**
+     * 
+     * @type {ContentLaunchMode}
+     * @memberof GetResourceSessionDiagnosticsCourseContext
+     */
+    launchMode: ContentLaunchMode;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionDiagnosticsCourseContext
+     */
+    maxAttempts: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionDiagnosticsCourseContext
+     */
+    scoreRollupStrategy: string;
+}
+
+
+
+/**
+ * Check if a given object implements the GetResourceSessionDiagnosticsCourseContext interface.
+ */
+export function instanceOfGetResourceSessionDiagnosticsCourseContext(value: object): value is GetResourceSessionDiagnosticsCourseContext {
+    if (!('courseId' in value) || value['courseId'] === undefined) return false;
+    if (!('courseName' in value) || value['courseName'] === undefined) return false;
+    if (!('courseVersionId' in value) || value['courseVersionId'] === undefined) return false;
+    if (!('courseVersionNumber' in value) || value['courseVersionNumber'] === undefined) return false;
+    if (!('itemId' in value) || value['itemId'] === undefined) return false;
+    if (!('displayName' in value) || value['displayName'] === 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;
+    return true;
+}
+
+export function GetResourceSessionDiagnosticsCourseContextFromJSON(json: any): GetResourceSessionDiagnosticsCourseContext {
+    return GetResourceSessionDiagnosticsCourseContextFromJSONTyped(json, false);
+}
+
+export function GetResourceSessionDiagnosticsCourseContextFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSessionDiagnosticsCourseContext {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'courseId': json['course_id'],
+        'courseName': json['course_name'],
+        'courseVersionId': json['course_version_id'],
+        'courseVersionNumber': json['course_version_number'],
+        'itemId': json['item_id'],
+        'displayName': json['display_name'],
+        'launchMode': ContentLaunchModeFromJSON(json['launch_mode']),
+        'maxAttempts': json['max_attempts'],
+        'scoreRollupStrategy': json['score_rollup_strategy'],
+    };
+}
+
+export function GetResourceSessionDiagnosticsCourseContextToJSON(json: any): GetResourceSessionDiagnosticsCourseContext {
+    return GetResourceSessionDiagnosticsCourseContextToJSONTyped(json, false);
+}
+
+export function GetResourceSessionDiagnosticsCourseContextToJSONTyped(value?: GetResourceSessionDiagnosticsCourseContext | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'course_id': value['courseId'],
+        'course_name': value['courseName'],
+        'course_version_id': value['courseVersionId'],
+        'course_version_number': value['courseVersionNumber'],
+        'item_id': value['itemId'],
+        'display_name': value['displayName'],
+        'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
+        'max_attempts': value['maxAttempts'],
+        'score_rollup_strategy': value['scoreRollupStrategy'],
+    };
+}
+