@easyedu/js-lsm-api 1.88.0 → 1.90.0

package/src/models/GetResourceSession.ts

@@ -0,0 +1,270 @@
+/* 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 {ResourceSessionEnvironment}
+     * @memberof GetResourceSession
+     */
+    environment: ResourceSessionEnvironment;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    courseId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    courseVersionId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    itemId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    contentLibraryItemId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    contentLibraryVersionId: 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 (!('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 (!('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'],
+        'environment': ResourceSessionEnvironmentFromJSON(json['environment']),
+        'courseId': json['course_id'] == null ? undefined : json['course_id'],
+        'courseVersionId': json['course_version_id'] == null ? undefined : json['course_version_id'],
+        'itemId': json['item_id'] == null ? undefined : json['item_id'],
+        'contentLibraryItemId': json['content_library_item_id'],
+        'contentLibraryVersionId': json['content_library_version_id'],
+        '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'],
+        'environment': ResourceSessionEnvironmentToJSON(value['environment']),
+        'course_id': value['courseId'],
+        'course_version_id': value['courseVersionId'],
+        'item_id': value['itemId'],
+        'content_library_item_id': value['contentLibraryItemId'],
+        'content_library_version_id': value['contentLibraryVersionId'],
+        '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/GetResourceSessionList.ts

@@ -0,0 +1,110 @@
+/* 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 { GetResourceSession } from './GetResourceSession';
+import {
+    GetResourceSessionFromJSON,
+    GetResourceSessionFromJSONTyped,
+    GetResourceSessionToJSON,
+    GetResourceSessionToJSONTyped,
+} from './GetResourceSession';
+
+/**
+ * A filtered page of resource sessions.
+ * @export
+ * @interface GetResourceSessionList
+ */
+export interface GetResourceSessionList {
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionList
+     */
+    page: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionList
+     */
+    pageSize: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionList
+     */
+    totalPages: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionList
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {Array<GetResourceSession>}
+     * @memberof GetResourceSessionList
+     */
+    items: Array<GetResourceSession>;
+}
+
+/**
+ * Check if a given object implements the GetResourceSessionList interface.
+ */
+export function instanceOfGetResourceSessionList(value: object): value is GetResourceSessionList {
+    if (!('page' in value) || value['page'] === undefined) return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined) return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined) return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined) return false;
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetResourceSessionListFromJSON(json: any): GetResourceSessionList {
+    return GetResourceSessionListFromJSONTyped(json, false);
+}
+
+export function GetResourceSessionListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSessionList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': ((json['items'] as Array<any>).map(GetResourceSessionFromJSON)),
+    };
+}
+
+export function GetResourceSessionListToJSON(json: any): GetResourceSessionList {
+    return GetResourceSessionListToJSONTyped(json, false);
+}
+
+export function GetResourceSessionListToJSONTyped(value?: GetResourceSessionList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': ((value['items'] as Array<any>).map(GetResourceSessionToJSON)),
+    };
+}
+

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/index.ts

@@ -182,6 +182,8 @@ export * from './GetQuizResultsTiming';
 export * from './GetQuizStatistics';
 export * from './GetResource';
 export * from './GetResourceList';
+export * from './GetResourceSession';
+export * from './GetResourceSessionList';
 export * from './GetResourceUsage';
 export * from './GetResourceUsageCoursesInner';
 export * from './GetResourceVersionUpload';
@@ -299,6 +301,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 +353,7 @@ export * from './PutUser';
 export * from './QuizContent';
 export * from './QuizContentAssignment';
 export * from './QuizContentSettings';
+export * from './ResourceSessionEnvironment';
 export * from './ResourceType';
 export * from './RichTextAsset';
 export * from './RichTextDocument';