@easyedu/js-lsm-api 1.89.0 → 1.91.0

package/src/models/GetResourceSessionScormData.ts

@@ -0,0 +1,134 @@
+/* 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 { GetResourceSessionScormDataActivity } from './GetResourceSessionScormDataActivity';
+import {
+    GetResourceSessionScormDataActivityFromJSON,
+    GetResourceSessionScormDataActivityFromJSONTyped,
+    GetResourceSessionScormDataActivityToJSON,
+    GetResourceSessionScormDataActivityToJSONTyped,
+} from './GetResourceSessionScormDataActivity';
+
+/**
+ * Current SCORM CMI state for a reusable resource session.
+ * @export
+ * @interface GetResourceSessionScormData
+ */
+export interface GetResourceSessionScormData {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionScormData
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionScormData
+     */
+    scormVersion: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionScormData
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionScormData
+     */
+    updatedAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionScormData
+     */
+    initializedAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionScormData
+     */
+    terminatedAt?: number | null;
+    /**
+     * 
+     * @type {GetResourceSessionScormDataActivity}
+     * @memberof GetResourceSessionScormData
+     */
+    activity?: GetResourceSessionScormDataActivity | null;
+    /**
+     * 
+     * @type {{ [key: string]: string; }}
+     * @memberof GetResourceSessionScormData
+     */
+    cmiData: { [key: string]: string; };
+}
+
+/**
+ * Check if a given object implements the GetResourceSessionScormData interface.
+ */
+export function instanceOfGetResourceSessionScormData(value: object): value is GetResourceSessionScormData {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('scormVersion' in value) || value['scormVersion'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('cmiData' in value) || value['cmiData'] === undefined) return false;
+    return true;
+}
+
+export function GetResourceSessionScormDataFromJSON(json: any): GetResourceSessionScormData {
+    return GetResourceSessionScormDataFromJSONTyped(json, false);
+}
+
+export function GetResourceSessionScormDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSessionScormData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'scormVersion': json['scorm_version'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'initializedAt': json['initialized_at'] == null ? undefined : json['initialized_at'],
+        'terminatedAt': json['terminated_at'] == null ? undefined : json['terminated_at'],
+        'activity': json['activity'] == null ? undefined : GetResourceSessionScormDataActivityFromJSON(json['activity']),
+        'cmiData': json['cmi_data'],
+    };
+}
+
+export function GetResourceSessionScormDataToJSON(json: any): GetResourceSessionScormData {
+    return GetResourceSessionScormDataToJSONTyped(json, false);
+}
+
+export function GetResourceSessionScormDataToJSONTyped(value?: GetResourceSessionScormData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'scorm_version': value['scormVersion'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'initialized_at': value['initializedAt'],
+        'terminated_at': value['terminatedAt'],
+        'activity': GetResourceSessionScormDataActivityToJSON(value['activity']),
+        'cmi_data': value['cmiData'],
+    };
+}
+

package/src/models/GetResourceSessionScormDataActivity.ts

@@ -0,0 +1,81 @@
+/* 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 GetResourceSessionScormDataActivity
+ */
+export interface GetResourceSessionScormDataActivity {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionScormDataActivity
+     */
+    identifier?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionScormDataActivity
+     */
+    name?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionScormDataActivity
+     */
+    launchPath?: string | null;
+}
+
+/**
+ * Check if a given object implements the GetResourceSessionScormDataActivity interface.
+ */
+export function instanceOfGetResourceSessionScormDataActivity(value: object): value is GetResourceSessionScormDataActivity {
+    return true;
+}
+
+export function GetResourceSessionScormDataActivityFromJSON(json: any): GetResourceSessionScormDataActivity {
+    return GetResourceSessionScormDataActivityFromJSONTyped(json, false);
+}
+
+export function GetResourceSessionScormDataActivityFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSessionScormDataActivity {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'identifier': json['identifier'] == null ? undefined : json['identifier'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'launchPath': json['launch_path'] == null ? undefined : json['launch_path'],
+    };
+}
+
+export function GetResourceSessionScormDataActivityToJSON(json: any): GetResourceSessionScormDataActivity {
+    return GetResourceSessionScormDataActivityToJSONTyped(json, false);
+}
+
+export function GetResourceSessionScormDataActivityToJSONTyped(value?: GetResourceSessionScormDataActivity | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'identifier': value['identifier'],
+        'name': value['name'],
+        'launch_path': value['launchPath'],
+    };
+}
+

package/src/models/PostResourceVersionSession.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 an isolated demo session for an exact resource version.
+ * @export
+ * @interface PostResourceVersionSession
+ */
+export interface PostResourceVersionSession {
+    /**
+     * Create a clean demo attempt instead of resuming the current demo session.
+     * @type {boolean}
+     * @memberof PostResourceVersionSession
+     */
+    restart?: boolean;
+}
+
+/**
+ * Check if a given object implements the PostResourceVersionSession interface.
+ */
+export function instanceOfPostResourceVersionSession(value: object): value is PostResourceVersionSession {
+    return true;
+}
+
+export function PostResourceVersionSessionFromJSON(json: any): PostResourceVersionSession {
+    return PostResourceVersionSessionFromJSONTyped(json, false);
+}
+
+export function PostResourceVersionSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostResourceVersionSession {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'restart': json['restart'] == null ? undefined : json['restart'],
+    };
+}
+
+export function PostResourceVersionSessionToJSON(json: any): PostResourceVersionSession {
+    return PostResourceVersionSessionToJSONTyped(json, false);
+}
+
+export function PostResourceVersionSessionToJSONTyped(value?: PostResourceVersionSession | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'restart': value['restart'],
+    };
+}
+

package/src/models/ResourceSessionEnvironment.ts

@@ -0,0 +1,53 @@
+/* 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.
+ */
+
+
+/**
+ * Whether the session contributes to learner activity or is isolated administrator testing.
+ * @export
+ */
+export const ResourceSessionEnvironment = {
+    Live: 'live',
+    Demo: 'demo'
+} as const;
+export type ResourceSessionEnvironment = typeof ResourceSessionEnvironment[keyof typeof ResourceSessionEnvironment];
+
+
+export function instanceOfResourceSessionEnvironment(value: any): boolean {
+    for (const key in ResourceSessionEnvironment) {
+        if (Object.prototype.hasOwnProperty.call(ResourceSessionEnvironment, key)) {
+            if (ResourceSessionEnvironment[key as keyof typeof ResourceSessionEnvironment] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function ResourceSessionEnvironmentFromJSON(json: any): ResourceSessionEnvironment {
+    return ResourceSessionEnvironmentFromJSONTyped(json, false);
+}
+
+export function ResourceSessionEnvironmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResourceSessionEnvironment {
+    return json as ResourceSessionEnvironment;
+}
+
+export function ResourceSessionEnvironmentToJSON(value?: ResourceSessionEnvironment | null): any {
+    return value as any;
+}
+
+export function ResourceSessionEnvironmentToJSONTyped(value: any, ignoreDiscriminator: boolean): ResourceSessionEnvironment {
+    return value as ResourceSessionEnvironment;
+}
+

package/src/models/ResourceSessionScormApiLogItem.ts

@@ -0,0 +1,132 @@
+/* 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';
+/**
+ * A recorded SCORM runtime call for a resource session.
+ * @export
+ * @interface ResourceSessionScormApiLogItem
+ */
+export interface ResourceSessionScormApiLogItem {
+    /**
+     * 
+     * @type {number}
+     * @memberof ResourceSessionScormApiLogItem
+     */
+    id: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ResourceSessionScormApiLogItem
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {ResourceSessionScormApiLogItemMethodEnum}
+     * @memberof ResourceSessionScormApiLogItem
+     */
+    method: ResourceSessionScormApiLogItemMethodEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ResourceSessionScormApiLogItem
+     */
+    element?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ResourceSessionScormApiLogItem
+     */
+    value?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ResourceSessionScormApiLogItem
+     */
+    valueTruncated: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof ResourceSessionScormApiLogItem
+     */
+    errorCode: string;
+}
+
+
+/**
+ * @export
+ */
+export const ResourceSessionScormApiLogItemMethodEnum = {
+    Initialize: 'Initialize',
+    GetValue: 'GetValue',
+    SetValue: 'SetValue',
+    Commit: 'Commit',
+    Terminate: 'Terminate'
+} as const;
+export type ResourceSessionScormApiLogItemMethodEnum = typeof ResourceSessionScormApiLogItemMethodEnum[keyof typeof ResourceSessionScormApiLogItemMethodEnum];
+
+
+/**
+ * Check if a given object implements the ResourceSessionScormApiLogItem interface.
+ */
+export function instanceOfResourceSessionScormApiLogItem(value: object): value is ResourceSessionScormApiLogItem {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('method' in value) || value['method'] === undefined) return false;
+    if (!('valueTruncated' in value) || value['valueTruncated'] === undefined) return false;
+    if (!('errorCode' in value) || value['errorCode'] === undefined) return false;
+    return true;
+}
+
+export function ResourceSessionScormApiLogItemFromJSON(json: any): ResourceSessionScormApiLogItem {
+    return ResourceSessionScormApiLogItemFromJSONTyped(json, false);
+}
+
+export function ResourceSessionScormApiLogItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResourceSessionScormApiLogItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'createdAt': json['created_at'],
+        'method': json['method'],
+        'element': json['element'] == null ? undefined : json['element'],
+        'value': json['value'] == null ? undefined : json['value'],
+        'valueTruncated': json['value_truncated'],
+        'errorCode': json['error_code'],
+    };
+}
+
+export function ResourceSessionScormApiLogItemToJSON(json: any): ResourceSessionScormApiLogItem {
+    return ResourceSessionScormApiLogItemToJSONTyped(json, false);
+}
+
+export function ResourceSessionScormApiLogItemToJSONTyped(value?: ResourceSessionScormApiLogItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'created_at': value['createdAt'],
+        'method': value['method'],
+        'element': value['element'],
+        'value': value['value'],
+        'value_truncated': value['valueTruncated'],
+        'error_code': value['errorCode'],
+    };
+}
+

package/src/models/index.ts

@@ -182,6 +182,17 @@ export * from './GetQuizResultsTiming';
 export * from './GetQuizStatistics';
 export * from './GetResource';
 export * from './GetResourceList';
+export * from './GetResourceSession';
+export * from './GetResourceSessionDiagnostics';
+export * from './GetResourceSessionDiagnosticsCourseContext';
+export * from './GetResourceSessionDiagnosticsResource';
+export * from './GetResourceSessionDiagnosticsScormSummary';
+export * from './GetResourceSessionDiagnosticsUser';
+export * from './GetResourceSessionDiagnosticsVersion';
+export * from './GetResourceSessionList';
+export * from './GetResourceSessionScormApiLogs';
+export * from './GetResourceSessionScormData';
+export * from './GetResourceSessionScormDataActivity';
 export * from './GetResourceUsage';
 export * from './GetResourceUsageCoursesInner';
 export * from './GetResourceVersionUpload';
@@ -299,6 +310,7 @@ export * from './PostResetPassword';
 export * from './PostResource';
 export * from './PostResourceVersion';
 export * from './PostResourceVersionComplete';
+export * from './PostResourceVersionSession';
 export * from './PostResourceVersionUpload';
 export * from './PostRevokeCertificate';
 export * from './PostRichTextAssetComplete';
@@ -350,6 +362,8 @@ export * from './PutUser';
 export * from './QuizContent';
 export * from './QuizContentAssignment';
 export * from './QuizContentSettings';
+export * from './ResourceSessionEnvironment';
+export * from './ResourceSessionScormApiLogItem';
 export * from './ResourceType';
 export * from './RichTextAsset';
 export * from './RichTextDocument';