@easyedu/js-lsm-api 1.97.0 → 1.99.0

package/dist/models/PostResourceSessionActivityEvent.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare const PostResourceSessionActivityEventEventTypeEnum: {
+    readonly Start: "start";
+    readonly Heartbeat: "heartbeat";
+    readonly Pause: "pause";
+    readonly Complete: "complete";
+    readonly MediaPlay: "media_play";
+    readonly MediaPause: "media_pause";
+    readonly MediaSeek: "media_seek";
+    readonly MediaEnded: "media_ended";
+    readonly Download: "download";
+    readonly LinkOpen: "link_open";
+    readonly DocumentOpen: "document_open";
+    readonly Terminate: "terminate";
+};
+export type PostResourceSessionActivityEventEventTypeEnum = typeof PostResourceSessionActivityEventEventTypeEnum[keyof typeof PostResourceSessionActivityEventEventTypeEnum];
+/**
+ * Check if a given object implements the PostResourceSessionActivityEvent interface.
+ */
+export declare function instanceOfPostResourceSessionActivityEvent(value: object): value is PostResourceSessionActivityEvent;
+export declare function PostResourceSessionActivityEventFromJSON(json: any): PostResourceSessionActivityEvent;
+export declare function PostResourceSessionActivityEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostResourceSessionActivityEvent;
+export declare function PostResourceSessionActivityEventToJSON(json: any): PostResourceSessionActivityEvent;
+export declare function PostResourceSessionActivityEventToJSONTyped(value?: PostResourceSessionActivityEvent | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PostResourceSessionActivityEvent.js

@@ -0,0 +1,74 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostResourceSessionActivityEventEventTypeEnum = void 0;
+exports.instanceOfPostResourceSessionActivityEvent = instanceOfPostResourceSessionActivityEvent;
+exports.PostResourceSessionActivityEventFromJSON = PostResourceSessionActivityEventFromJSON;
+exports.PostResourceSessionActivityEventFromJSONTyped = PostResourceSessionActivityEventFromJSONTyped;
+exports.PostResourceSessionActivityEventToJSON = PostResourceSessionActivityEventToJSON;
+exports.PostResourceSessionActivityEventToJSONTyped = PostResourceSessionActivityEventToJSONTyped;
+/**
+ * @export
+ */
+exports.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'
+};
+/**
+ * Check if a given object implements the PostResourceSessionActivityEvent interface.
+ */
+function instanceOfPostResourceSessionActivityEvent(value) {
+    if (!('eventId' in value) || value['eventId'] === undefined)
+        return false;
+    if (!('eventType' in value) || value['eventType'] === undefined)
+        return false;
+    return true;
+}
+function PostResourceSessionActivityEventFromJSON(json) {
+    return PostResourceSessionActivityEventFromJSONTyped(json, false);
+}
+function PostResourceSessionActivityEventFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'eventId': json['event_id'],
+        'eventType': json['event_type'],
+        'positionSeconds': json['position_seconds'] == null ? undefined : json['position_seconds'],
+    };
+}
+function PostResourceSessionActivityEventToJSON(json) {
+    return PostResourceSessionActivityEventToJSONTyped(json, false);
+}
+function PostResourceSessionActivityEventToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'event_id': value['eventId'],
+        'event_type': value['eventType'],
+        'position_seconds': value['positionSeconds'],
+    };
+}

package/dist/models/PutCourseEnrollment.d.ts

@@ -48,6 +48,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;
 }
 /**
  * @export

package/dist/models/PutCourseEnrollment.js

@@ -57,6 +57,7 @@ function PutCourseEnrollmentFromJSONTyped(json, 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'],
     };
 }
 function PutCourseEnrollmentToJSON(json) {
@@ -72,5 +73,6 @@ function PutCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
         'enrollment_date_end': value['enrollmentDateEnd'],
         'extension_days': value['extensionDays'],
         'notes': value['notes'],
+        'course_version_id': value['courseVersionId'],
     };
 }

package/dist/models/index.d.ts

@@ -89,6 +89,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';
@@ -184,6 +188,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';

package/dist/models/index.js

@@ -107,6 +107,10 @@ __exportStar(require("./GetQuestionQuizzesInner"), exports);
 __exportStar(require("./GetResource"), exports);
 __exportStar(require("./GetResourceList"), exports);
 __exportStar(require("./GetResourceSession"), exports);
+__exportStar(require("./GetResourceSessionActivity"), exports);
+__exportStar(require("./GetResourceSessionActivityEvent"), exports);
+__exportStar(require("./GetResourceSessionActivityEventList"), exports);
+__exportStar(require("./GetResourceSessionActivityList"), exports);
 __exportStar(require("./GetResourceSessionDiagnostics"), exports);
 __exportStar(require("./GetResourceSessionDiagnosticsCourseContext"), exports);
 __exportStar(require("./GetResourceSessionDiagnosticsResource"), exports);
@@ -202,6 +206,7 @@ __exportStar(require("./PostQuestion"), exports);
 __exportStar(require("./PostQuestionAnswerChoicesInner"), exports);
 __exportStar(require("./PostResetPassword"), exports);
 __exportStar(require("./PostResource"), exports);
+__exportStar(require("./PostResourceSessionActivityEvent"), exports);
 __exportStar(require("./PostResourceVersion"), exports);
 __exportStar(require("./PostResourceVersionComplete"), exports);
 __exportStar(require("./PostResourceVersionSession"), exports);

package/docs/ContentLibraryQuizApi.md

@@ -537,7 +537,7 @@ async function example() {
   const api = new ContentLibraryQuizApi();
 
   const body = {
-    // string | Internal user ID, or `current` for the authenticated user. (optional)
+    // string | External user ID, legacy internal user ID, or `current` for the authenticated user. (optional)
     userId: userId_example,
     // string (optional)
     quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
@@ -576,7 +576,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **userId** | `string` | Internal user ID, or `current` for the authenticated user. | [Optional] [Defaults to `undefined`] |
+| **userId** | `string` | External user ID, legacy internal user ID, or `current` for the authenticated user. | [Optional] [Defaults to `undefined`] |
 | **quizId** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **quizVersionId** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **courseId** | `string` |  | [Optional] [Defaults to `undefined`] |

package/docs/GetCourseEnrollment.md

@@ -10,6 +10,8 @@ Name | Type
 `id` | string
 `courseId` | string
 `userId` | string
+`courseVersionId` | string
+`courseVersionNumber` | number
 `enrollmentDateStart` | number
 `enrollmentDateEnd` | number
 `notes` | string
@@ -29,6 +31,8 @@ const example = {
   "id": null,
   "courseId": null,
   "userId": null,
+  "courseVersionId": null,
+  "courseVersionNumber": null,
   "enrollmentDateStart": null,
   "enrollmentDateEnd": null,
   "notes": null,

package/docs/GetCourseEnrollmentListItem.md

@@ -10,6 +10,8 @@ Name | Type
 `id` | string
 `courseId` | string
 `userId` | string
+`courseVersionId` | string
+`courseVersionNumber` | number
 `firstName` | string
 `lastName` | string
 `enrollmentDateStart` | number
@@ -30,6 +32,8 @@ const example = {
   "id": null,
   "courseId": null,
   "userId": null,
+  "courseVersionId": null,
+  "courseVersionNumber": null,
   "firstName": null,
   "lastName": null,
   "enrollmentDateStart": null,

package/docs/GetCourseVersionItemSession.md

@@ -21,6 +21,7 @@ Name | Type
 `completionStatus` | string
 `gradeStatus` | string
 `scoreRaw` | number
+`durationSeconds` | number
 `createdAt` | number
 `updatedAt` | number
 `completedAt` | number
@@ -46,6 +47,7 @@ const example = {
   "completionStatus": null,
   "gradeStatus": null,
   "scoreRaw": null,
+  "durationSeconds": null,
   "createdAt": null,
   "updatedAt": null,
   "completedAt": null,

package/docs/GetLibraryQuizSession.md

@@ -29,6 +29,7 @@ Name | Type
 `createdAt` | number
 `updatedAt` | number
 `completedAt` | number
+`durationSeconds` | number
 
 ## Example
 
@@ -60,6 +61,7 @@ const example = {
   "createdAt": null,
   "updatedAt": null,
   "completedAt": null,
+  "durationSeconds": null,
 } satisfies GetLibraryQuizSession
 
 console.log(example)

package/docs/GetResourceSession.md

@@ -29,6 +29,7 @@ Name | Type
 `completionStatus` | string
 `gradeStatus` | string
 `scoreRaw` | number
+`durationSeconds` | number
 `initializedAt` | number
 `terminatedAt` | number
 `createdAt` | number
@@ -64,6 +65,7 @@ const example = {
   "completionStatus": null,
   "gradeStatus": null,
   "scoreRaw": null,
+  "durationSeconds": null,
   "initializedAt": null,
   "terminatedAt": null,
   "createdAt": null,

package/docs/GetResourceSessionActivity.md

@@ -0,0 +1,63 @@
+
+# GetResourceSessionActivity
+
+Per-activity learner state within a resource-session attempt.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`identifier` | string
+`title` | string
+`activityType` | string
+`completionStatus` | string
+`gradeStatus` | string
+`scoreRaw` | number
+`durationSeconds` | number
+`isActive` | boolean
+`initializedAt` | number
+`terminatedAt` | number
+`completedAt` | number
+`lastSeenAt` | number
+`createdAt` | number
+`updatedAt` | number
+
+## Example
+
+```typescript
+import type { GetResourceSessionActivity } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "identifier": null,
+  "title": null,
+  "activityType": null,
+  "completionStatus": null,
+  "gradeStatus": null,
+  "scoreRaw": null,
+  "durationSeconds": null,
+  "isActive": null,
+  "initializedAt": null,
+  "terminatedAt": null,
+  "completedAt": null,
+  "lastSeenAt": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies GetResourceSessionActivity
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetResourceSessionActivity
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetResourceSessionActivityEvent.md

@@ -0,0 +1,45 @@
+
+# GetResourceSessionActivityEvent
+
+A recorded learner activity event.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`eventId` | string
+`activityId` | string
+`eventType` | string
+`positionSeconds` | number
+`createdAt` | number
+
+## Example
+
+```typescript
+import type { GetResourceSessionActivityEvent } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "eventId": null,
+  "activityId": null,
+  "eventType": null,
+  "positionSeconds": null,
+  "createdAt": null,
+} satisfies GetResourceSessionActivityEvent
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetResourceSessionActivityEvent
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetResourceSessionActivityEventList.md

@@ -0,0 +1,35 @@
+
+# GetResourceSessionActivityEventList
+
+Recorded learner activity events for one resource-session attempt.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<GetResourceSessionActivityEvent>](GetResourceSessionActivityEvent.md)
+
+## Example
+
+```typescript
+import type { GetResourceSessionActivityEventList } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+} satisfies GetResourceSessionActivityEventList
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetResourceSessionActivityEventList
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetResourceSessionActivityList.md

@@ -0,0 +1,35 @@
+
+# GetResourceSessionActivityList
+
+Activities belonging to one resource-session attempt.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<GetResourceSessionActivity>](GetResourceSessionActivity.md)
+
+## Example
+
+```typescript
+import type { GetResourceSessionActivityList } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+} satisfies GetResourceSessionActivityList
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetResourceSessionActivityList
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+