@easyedu/js-lsm-api 1.97.0 → 1.99.0

package/src/models/GetResourceSessionActivity.ts

@@ -0,0 +1,199 @@
+/* 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';
+/**
+ * Per-activity learner state within a resource-session attempt.
+ * @export
+ * @interface GetResourceSessionActivity
+ */
+export interface GetResourceSessionActivity {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionActivity
+     */
+    id: string;
+    /**
+     * Stable source identifier, such as a SCORM activity identifier or resource.
+     * @type {string}
+     * @memberof GetResourceSessionActivity
+     */
+    identifier: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionActivity
+     */
+    title: string;
+    /**
+     * 
+     * @type {GetResourceSessionActivityActivityTypeEnum}
+     * @memberof GetResourceSessionActivity
+     */
+    activityType: GetResourceSessionActivityActivityTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionActivity
+     */
+    completionStatus: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionActivity
+     */
+    gradeStatus: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivity
+     */
+    scoreRaw?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivity
+     */
+    durationSeconds: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetResourceSessionActivity
+     */
+    isActive: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivity
+     */
+    initializedAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivity
+     */
+    terminatedAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivity
+     */
+    completedAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivity
+     */
+    lastSeenAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivity
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivity
+     */
+    updatedAt: number;
+}
+
+
+/**
+ * @export
+ */
+export const GetResourceSessionActivityActivityTypeEnum = {
+    Resource: 'resource',
+    Sco: 'sco',
+    Asset: 'asset'
+} as const;
+export type GetResourceSessionActivityActivityTypeEnum = typeof GetResourceSessionActivityActivityTypeEnum[keyof typeof GetResourceSessionActivityActivityTypeEnum];
+
+
+/**
+ * Check if a given object implements the GetResourceSessionActivity interface.
+ */
+export function instanceOfGetResourceSessionActivity(value: object): value is GetResourceSessionActivity {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('identifier' in value) || value['identifier'] === undefined) return false;
+    if (!('title' in value) || value['title'] === undefined) return false;
+    if (!('activityType' in value) || value['activityType'] === undefined) return false;
+    if (!('completionStatus' in value) || value['completionStatus'] === undefined) return false;
+    if (!('gradeStatus' in value) || value['gradeStatus'] === undefined) return false;
+    if (!('durationSeconds' in value) || value['durationSeconds'] === undefined) return false;
+    if (!('isActive' in value) || value['isActive'] === 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 GetResourceSessionActivityFromJSON(json: any): GetResourceSessionActivity {
+    return GetResourceSessionActivityFromJSONTyped(json, false);
+}
+
+export function GetResourceSessionActivityFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSessionActivity {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'identifier': json['identifier'],
+        'title': json['title'],
+        'activityType': json['activity_type'],
+        'completionStatus': json['completion_status'],
+        'gradeStatus': json['grade_status'],
+        'scoreRaw': json['score_raw'] == null ? undefined : json['score_raw'],
+        'durationSeconds': json['duration_seconds'],
+        'isActive': json['is_active'],
+        'initializedAt': json['initialized_at'] == null ? undefined : json['initialized_at'],
+        'terminatedAt': json['terminated_at'] == null ? undefined : json['terminated_at'],
+        'completedAt': json['completed_at'] == null ? undefined : json['completed_at'],
+        'lastSeenAt': json['last_seen_at'] == null ? undefined : json['last_seen_at'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+    };
+}
+
+export function GetResourceSessionActivityToJSON(json: any): GetResourceSessionActivity {
+    return GetResourceSessionActivityToJSONTyped(json, false);
+}
+
+export function GetResourceSessionActivityToJSONTyped(value?: GetResourceSessionActivity | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'identifier': value['identifier'],
+        'title': value['title'],
+        'activity_type': value['activityType'],
+        'completion_status': value['completionStatus'],
+        'grade_status': value['gradeStatus'],
+        'score_raw': value['scoreRaw'],
+        'duration_seconds': value['durationSeconds'],
+        'is_active': value['isActive'],
+        'initialized_at': value['initializedAt'],
+        'terminated_at': value['terminatedAt'],
+        'completed_at': value['completedAt'],
+        'last_seen_at': value['lastSeenAt'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}
+

package/src/models/GetResourceSessionActivityEvent.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';
+/**
+ * A recorded learner activity event.
+ * @export
+ * @interface GetResourceSessionActivityEvent
+ */
+export interface GetResourceSessionActivityEvent {
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivityEvent
+     */
+    id: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionActivityEvent
+     */
+    eventId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionActivityEvent
+     */
+    activityId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionActivityEvent
+     */
+    eventType: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivityEvent
+     */
+    positionSeconds?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivityEvent
+     */
+    createdAt: number;
+}
+
+/**
+ * Check if a given object implements the GetResourceSessionActivityEvent interface.
+ */
+export function instanceOfGetResourceSessionActivityEvent(value: object): value is GetResourceSessionActivityEvent {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('eventId' in value) || value['eventId'] === undefined) return false;
+    if (!('activityId' in value) || value['activityId'] === undefined) return false;
+    if (!('eventType' in value) || value['eventType'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function GetResourceSessionActivityEventFromJSON(json: any): GetResourceSessionActivityEvent {
+    return GetResourceSessionActivityEventFromJSONTyped(json, false);
+}
+
+export function GetResourceSessionActivityEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSessionActivityEvent {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'eventId': json['event_id'],
+        'activityId': json['activity_id'],
+        'eventType': json['event_type'],
+        'positionSeconds': json['position_seconds'] == null ? undefined : json['position_seconds'],
+        'createdAt': json['created_at'],
+    };
+}
+
+export function GetResourceSessionActivityEventToJSON(json: any): GetResourceSessionActivityEvent {
+    return GetResourceSessionActivityEventToJSONTyped(json, false);
+}
+
+export function GetResourceSessionActivityEventToJSONTyped(value?: GetResourceSessionActivityEvent | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'event_id': value['eventId'],
+        'activity_id': value['activityId'],
+        'event_type': value['eventType'],
+        'position_seconds': value['positionSeconds'],
+        'created_at': value['createdAt'],
+    };
+}
+

package/src/models/GetResourceSessionActivityEventList.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 { GetResourceSessionActivityEvent } from './GetResourceSessionActivityEvent';
+import {
+    GetResourceSessionActivityEventFromJSON,
+    GetResourceSessionActivityEventFromJSONTyped,
+    GetResourceSessionActivityEventToJSON,
+    GetResourceSessionActivityEventToJSONTyped,
+} from './GetResourceSessionActivityEvent';
+
+/**
+ * Recorded learner activity events for one resource-session attempt.
+ * @export
+ * @interface GetResourceSessionActivityEventList
+ */
+export interface GetResourceSessionActivityEventList {
+    /**
+     * 
+     * @type {Array<GetResourceSessionActivityEvent>}
+     * @memberof GetResourceSessionActivityEventList
+     */
+    items: Array<GetResourceSessionActivityEvent>;
+}
+
+/**
+ * Check if a given object implements the GetResourceSessionActivityEventList interface.
+ */
+export function instanceOfGetResourceSessionActivityEventList(value: object): value is GetResourceSessionActivityEventList {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetResourceSessionActivityEventListFromJSON(json: any): GetResourceSessionActivityEventList {
+    return GetResourceSessionActivityEventListFromJSONTyped(json, false);
+}
+
+export function GetResourceSessionActivityEventListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSessionActivityEventList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(GetResourceSessionActivityEventFromJSON)),
+    };
+}
+
+export function GetResourceSessionActivityEventListToJSON(json: any): GetResourceSessionActivityEventList {
+    return GetResourceSessionActivityEventListToJSONTyped(json, false);
+}
+
+export function GetResourceSessionActivityEventListToJSONTyped(value?: GetResourceSessionActivityEventList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(GetResourceSessionActivityEventToJSON)),
+    };
+}
+

package/src/models/GetResourceSessionActivityList.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 { GetResourceSessionActivity } from './GetResourceSessionActivity';
+import {
+    GetResourceSessionActivityFromJSON,
+    GetResourceSessionActivityFromJSONTyped,
+    GetResourceSessionActivityToJSON,
+    GetResourceSessionActivityToJSONTyped,
+} from './GetResourceSessionActivity';
+
+/**
+ * Activities belonging to one resource-session attempt.
+ * @export
+ * @interface GetResourceSessionActivityList
+ */
+export interface GetResourceSessionActivityList {
+    /**
+     * 
+     * @type {Array<GetResourceSessionActivity>}
+     * @memberof GetResourceSessionActivityList
+     */
+    items: Array<GetResourceSessionActivity>;
+}
+
+/**
+ * Check if a given object implements the GetResourceSessionActivityList interface.
+ */
+export function instanceOfGetResourceSessionActivityList(value: object): value is GetResourceSessionActivityList {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetResourceSessionActivityListFromJSON(json: any): GetResourceSessionActivityList {
+    return GetResourceSessionActivityListFromJSONTyped(json, false);
+}
+
+export function GetResourceSessionActivityListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSessionActivityList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(GetResourceSessionActivityFromJSON)),
+    };
+}
+
+export function GetResourceSessionActivityListToJSON(json: any): GetResourceSessionActivityList {
+    return GetResourceSessionActivityListToJSONTyped(json, false);
+}
+
+export function GetResourceSessionActivityListToJSONTyped(value?: GetResourceSessionActivityList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(GetResourceSessionActivityToJSON)),
+    };
+}
+

package/src/models/PostCourseVersionPublish.ts

@@ -25,6 +25,16 @@ export interface PostCourseVersionPublish {
      * @memberof PostCourseVersionPublish
      */
     changeNotes?: string;
+    /**
+     * When true, assign all Enrolled, InProgress, and Suspended Student enrollments
+     * for this course to the newly published version. Completed and other historical
+     * enrollments remain pinned to their original version. Existing progress and
+     * session history remain stored against the previous version and are not transferred.
+     * 
+     * @type {boolean}
+     * @memberof PostCourseVersionPublish
+     */
+    promoteActiveEnrollments?: boolean;
 }
 
 /**
@@ -45,6 +55,7 @@ export function PostCourseVersionPublishFromJSONTyped(json: any, ignoreDiscrimin
     return {
         
         'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+        'promoteActiveEnrollments': json['promote_active_enrollments'] == null ? undefined : json['promote_active_enrollments'],
     };
 }
 
@@ -60,6 +71,7 @@ export function PostCourseVersionPublishToJSONTyped(value?: PostCourseVersionPub
     return {
         
         'change_notes': value['changeNotes'],
+        'promote_active_enrollments': value['promoteActiveEnrollments'],
     };
 }
 

package/src/models/PostResourceSessionActivityEvent.ts

@@ -0,0 +1,104 @@
+/* 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 learner activity signal. Timing is calculated from server receipt times.
+ * @export
+ * @interface PostResourceSessionActivityEvent
+ */
+export interface PostResourceSessionActivityEvent {
+    /**
+     * Client-generated idempotency identifier.
+     * @type {string}
+     * @memberof PostResourceSessionActivityEvent
+     */
+    eventId: string;
+    /**
+     * 
+     * @type {PostResourceSessionActivityEventEventTypeEnum}
+     * @memberof PostResourceSessionActivityEvent
+     */
+    eventType: PostResourceSessionActivityEventEventTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostResourceSessionActivityEvent
+     */
+    positionSeconds?: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const PostResourceSessionActivityEventEventTypeEnum = {
+    Start: 'start',
+    Heartbeat: 'heartbeat',
+    Pause: 'pause',
+    Complete: 'complete',
+    MediaPlay: 'media_play',
+    MediaPause: 'media_pause',
+    MediaSeek: 'media_seek',
+    MediaEnded: 'media_ended',
+    Download: 'download',
+    LinkOpen: 'link_open',
+    DocumentOpen: 'document_open',
+    Terminate: 'terminate'
+} as const;
+export type PostResourceSessionActivityEventEventTypeEnum = typeof PostResourceSessionActivityEventEventTypeEnum[keyof typeof PostResourceSessionActivityEventEventTypeEnum];
+
+
+/**
+ * Check if a given object implements the PostResourceSessionActivityEvent interface.
+ */
+export function instanceOfPostResourceSessionActivityEvent(value: object): value is PostResourceSessionActivityEvent {
+    if (!('eventId' in value) || value['eventId'] === undefined) return false;
+    if (!('eventType' in value) || value['eventType'] === undefined) return false;
+    return true;
+}
+
+export function PostResourceSessionActivityEventFromJSON(json: any): PostResourceSessionActivityEvent {
+    return PostResourceSessionActivityEventFromJSONTyped(json, false);
+}
+
+export function PostResourceSessionActivityEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostResourceSessionActivityEvent {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'eventId': json['event_id'],
+        'eventType': json['event_type'],
+        'positionSeconds': json['position_seconds'] == null ? undefined : json['position_seconds'],
+    };
+}
+
+export function PostResourceSessionActivityEventToJSON(json: any): PostResourceSessionActivityEvent {
+    return PostResourceSessionActivityEventToJSONTyped(json, false);
+}
+
+export function PostResourceSessionActivityEventToJSONTyped(value?: PostResourceSessionActivityEvent | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'event_id': value['eventId'],
+        'event_type': value['eventType'],
+        'position_seconds': value['positionSeconds'],
+    };
+}
+

package/src/models/PutCourseEnrollment.ts

@@ -52,6 +52,15 @@ export interface PutCourseEnrollment {
      * @memberof PutCourseEnrollment
      */
     notes?: string;
+    /**
+     * Reassign this learner enrollment to a published version of the same course.
+     * Only active or suspended Student enrollments can be reassigned. Progress and
+     * session history for the previous version are retained but are not transferred.
+     * 
+     * @type {string}
+     * @memberof PutCourseEnrollment
+     */
+    courseVersionId?: string;
 }
 
 
@@ -101,6 +110,7 @@ export function PutCourseEnrollmentFromJSONTyped(json: any, ignoreDiscriminator:
         'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
         'extensionDays': json['extension_days'] == null ? undefined : json['extension_days'],
         'notes': json['notes'] == null ? undefined : json['notes'],
+        'courseVersionId': json['course_version_id'] == null ? undefined : json['course_version_id'],
     };
 }
 
@@ -120,6 +130,7 @@ export function PutCourseEnrollmentToJSONTyped(value?: PutCourseEnrollment | nul
         'enrollment_date_end': value['enrollmentDateEnd'],
         'extension_days': value['extensionDays'],
         'notes': value['notes'],
+        'course_version_id': value['courseVersionId'],
     };
 }
 

package/src/models/index.ts

@@ -91,6 +91,10 @@ export * from './GetQuestionQuizzesInner';
 export * from './GetResource';
 export * from './GetResourceList';
 export * from './GetResourceSession';
+export * from './GetResourceSessionActivity';
+export * from './GetResourceSessionActivityEvent';
+export * from './GetResourceSessionActivityEventList';
+export * from './GetResourceSessionActivityList';
 export * from './GetResourceSessionDiagnostics';
 export * from './GetResourceSessionDiagnosticsCourseContext';
 export * from './GetResourceSessionDiagnosticsResource';
@@ -186,6 +190,7 @@ export * from './PostQuestion';
 export * from './PostQuestionAnswerChoicesInner';
 export * from './PostResetPassword';
 export * from './PostResource';
+export * from './PostResourceSessionActivityEvent';
 export * from './PostResourceVersion';
 export * from './PostResourceVersionComplete';
 export * from './PostResourceVersionSession';