@easyedu/js-lsm-api 1.98.0 → 1.99.0

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/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/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';