@easyedu/js-lsm-api 1.90.0 → 1.92.0

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'],
+    };
+}
+

package/src/models/GetResourceSessionDiagnosticsResource.ts

@@ -0,0 +1,103 @@
+/* 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';
+
+/**
+ * 
+ * @export
+ * @interface GetResourceSessionDiagnosticsResource
+ */
+export interface GetResourceSessionDiagnosticsResource {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionDiagnosticsResource
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionDiagnosticsResource
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionDiagnosticsResource
+     */
+    description: string;
+    /**
+     * 
+     * @type {ResourceType}
+     * @memberof GetResourceSessionDiagnosticsResource
+     */
+    resourceType: ResourceType;
+}
+
+
+
+/**
+ * Check if a given object implements the GetResourceSessionDiagnosticsResource interface.
+ */
+export function instanceOfGetResourceSessionDiagnosticsResource(value: object): value is GetResourceSessionDiagnosticsResource {
+    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 (!('resourceType' in value) || value['resourceType'] === undefined) return false;
+    return true;
+}
+
+export function GetResourceSessionDiagnosticsResourceFromJSON(json: any): GetResourceSessionDiagnosticsResource {
+    return GetResourceSessionDiagnosticsResourceFromJSONTyped(json, false);
+}
+
+export function GetResourceSessionDiagnosticsResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSessionDiagnosticsResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'resourceType': ResourceTypeFromJSON(json['resource_type']),
+    };
+}
+
+export function GetResourceSessionDiagnosticsResourceToJSON(json: any): GetResourceSessionDiagnosticsResource {
+    return GetResourceSessionDiagnosticsResourceToJSONTyped(json, false);
+}
+
+export function GetResourceSessionDiagnosticsResourceToJSONTyped(value?: GetResourceSessionDiagnosticsResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'resource_type': ResourceTypeToJSON(value['resourceType']),
+    };
+}
+

package/src/models/GetResourceSessionDiagnosticsScormSummary.ts

@@ -0,0 +1,123 @@
+/* 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 GetResourceSessionDiagnosticsScormSummary
+ */
+export interface GetResourceSessionDiagnosticsScormSummary {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionDiagnosticsScormSummary
+     */
+    schemaVersion?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionDiagnosticsScormSummary
+     */
+    manifestIdentifier?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionDiagnosticsScormSummary
+     */
+    organizationIdentifier?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionDiagnosticsScormSummary
+     */
+    organizationTitle?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionDiagnosticsScormSummary
+     */
+    activityIdentifier?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionDiagnosticsScormSummary
+     */
+    activityTitle?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionDiagnosticsScormSummary
+     */
+    cmiElementCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionDiagnosticsScormSummary
+     */
+    apiLogCount: number;
+}
+
+/**
+ * Check if a given object implements the GetResourceSessionDiagnosticsScormSummary interface.
+ */
+export function instanceOfGetResourceSessionDiagnosticsScormSummary(value: object): value is GetResourceSessionDiagnosticsScormSummary {
+    if (!('cmiElementCount' in value) || value['cmiElementCount'] === undefined) return false;
+    if (!('apiLogCount' in value) || value['apiLogCount'] === undefined) return false;
+    return true;
+}
+
+export function GetResourceSessionDiagnosticsScormSummaryFromJSON(json: any): GetResourceSessionDiagnosticsScormSummary {
+    return GetResourceSessionDiagnosticsScormSummaryFromJSONTyped(json, false);
+}
+
+export function GetResourceSessionDiagnosticsScormSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSessionDiagnosticsScormSummary {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'schemaVersion': json['schema_version'] == null ? undefined : json['schema_version'],
+        'manifestIdentifier': json['manifest_identifier'] == null ? undefined : json['manifest_identifier'],
+        'organizationIdentifier': json['organization_identifier'] == null ? undefined : json['organization_identifier'],
+        'organizationTitle': json['organization_title'] == null ? undefined : json['organization_title'],
+        'activityIdentifier': json['activity_identifier'] == null ? undefined : json['activity_identifier'],
+        'activityTitle': json['activity_title'] == null ? undefined : json['activity_title'],
+        'cmiElementCount': json['cmi_element_count'],
+        'apiLogCount': json['api_log_count'],
+    };
+}
+
+export function GetResourceSessionDiagnosticsScormSummaryToJSON(json: any): GetResourceSessionDiagnosticsScormSummary {
+    return GetResourceSessionDiagnosticsScormSummaryToJSONTyped(json, false);
+}
+
+export function GetResourceSessionDiagnosticsScormSummaryToJSONTyped(value?: GetResourceSessionDiagnosticsScormSummary | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'schema_version': value['schemaVersion'],
+        'manifest_identifier': value['manifestIdentifier'],
+        'organization_identifier': value['organizationIdentifier'],
+        'organization_title': value['organizationTitle'],
+        'activity_identifier': value['activityIdentifier'],
+        'activity_title': value['activityTitle'],
+        'cmi_element_count': value['cmiElementCount'],
+        'api_log_count': value['apiLogCount'],
+    };
+}
+

package/src/models/GetResourceSessionDiagnosticsUser.ts

@@ -0,0 +1,75 @@
+/* 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 GetResourceSessionDiagnosticsUser
+ */
+export interface GetResourceSessionDiagnosticsUser {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionDiagnosticsUser
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionDiagnosticsUser
+     */
+    name: string;
+}
+
+/**
+ * Check if a given object implements the GetResourceSessionDiagnosticsUser interface.
+ */
+export function instanceOfGetResourceSessionDiagnosticsUser(value: object): value is GetResourceSessionDiagnosticsUser {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function GetResourceSessionDiagnosticsUserFromJSON(json: any): GetResourceSessionDiagnosticsUser {
+    return GetResourceSessionDiagnosticsUserFromJSONTyped(json, false);
+}
+
+export function GetResourceSessionDiagnosticsUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSessionDiagnosticsUser {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+    };
+}
+
+export function GetResourceSessionDiagnosticsUserToJSON(json: any): GetResourceSessionDiagnosticsUser {
+    return GetResourceSessionDiagnosticsUserToJSONTyped(json, false);
+}
+
+export function GetResourceSessionDiagnosticsUserToJSONTyped(value?: GetResourceSessionDiagnosticsUser | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+    };
+}
+