@easyedu/js-lsm-api 1.28.0 → 1.29.0

package/src/models/GetContentSessionDetail.ts

@@ -0,0 +1,178 @@
+/* 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 { GetContentSessionDetailUserData } from './GetContentSessionDetailUserData';
+import {
+    GetContentSessionDetailUserDataFromJSON,
+    GetContentSessionDetailUserDataFromJSONTyped,
+    GetContentSessionDetailUserDataToJSON,
+    GetContentSessionDetailUserDataToJSONTyped,
+} from './GetContentSessionDetailUserData';
+import type { GetContentSessionDetailScormSessionData } from './GetContentSessionDetailScormSessionData';
+import {
+    GetContentSessionDetailScormSessionDataFromJSON,
+    GetContentSessionDetailScormSessionDataFromJSONTyped,
+    GetContentSessionDetailScormSessionDataToJSON,
+    GetContentSessionDetailScormSessionDataToJSONTyped,
+} from './GetContentSessionDetailScormSessionData';
+
+/**
+ * Detailed content session information
+ * @export
+ * @interface GetContentSessionDetail
+ */
+export interface GetContentSessionDetail {
+    /**
+     * The external ID of the content session
+     * @type {string}
+     * @memberof GetContentSessionDetail
+     */
+    id: string;
+    /**
+     * The date and time the content session was created (Unix timestamp)
+     * @type {number}
+     * @memberof GetContentSessionDetail
+     */
+    createdAt: number;
+    /**
+     * The date and time the content session was updated (Unix timestamp)
+     * @type {number}
+     * @memberof GetContentSessionDetail
+     */
+    updatedAt: number;
+    /**
+     * The external ID of the content
+     * @type {string}
+     * @memberof GetContentSessionDetail
+     */
+    contentId: string;
+    /**
+     * The completion status of the content session
+     * @type {string}
+     * @memberof GetContentSessionDetail
+     */
+    completionStatus: GetContentSessionDetailCompletionStatusEnum;
+    /**
+     * The grade status of the content session
+     * @type {string}
+     * @memberof GetContentSessionDetail
+     */
+    gradeStatus: GetContentSessionDetailGradeStatusEnum;
+    /**
+     * The total duration of the session in seconds
+     * @type {number}
+     * @memberof GetContentSessionDetail
+     */
+    durationInSeconds: number;
+    /**
+     * 
+     * @type {GetContentSessionDetailUserData}
+     * @memberof GetContentSessionDetail
+     */
+    userData: GetContentSessionDetailUserData;
+    /**
+     * 
+     * @type {GetContentSessionDetailScormSessionData}
+     * @memberof GetContentSessionDetail
+     */
+    scormSessionData: GetContentSessionDetailScormSessionData | null;
+}
+
+
+/**
+ * @export
+ */
+export const GetContentSessionDetailCompletionStatusEnum = {
+    NotAttempted: 'NotAttempted',
+    InProgress: 'InProgress',
+    Completed: 'Completed'
+} as const;
+export type GetContentSessionDetailCompletionStatusEnum = typeof GetContentSessionDetailCompletionStatusEnum[keyof typeof GetContentSessionDetailCompletionStatusEnum];
+
+/**
+ * @export
+ */
+export const GetContentSessionDetailGradeStatusEnum = {
+    Ungraded: 'Ungraded',
+    Passed: 'Passed',
+    Failed: 'Failed',
+    PointsEarned: 'PointsEarned',
+    PercentageEarned: 'PercentageEarned',
+    NotApplicable: 'NotApplicable'
+} as const;
+export type GetContentSessionDetailGradeStatusEnum = typeof GetContentSessionDetailGradeStatusEnum[keyof typeof GetContentSessionDetailGradeStatusEnum];
+
+
+/**
+ * Check if a given object implements the GetContentSessionDetail interface.
+ */
+export function instanceOfGetContentSessionDetail(value: object): value is GetContentSessionDetail {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('contentId' in value) || value['contentId'] === undefined) return false;
+    if (!('completionStatus' in value) || value['completionStatus'] === undefined) return false;
+    if (!('gradeStatus' in value) || value['gradeStatus'] === undefined) return false;
+    if (!('durationInSeconds' in value) || value['durationInSeconds'] === undefined) return false;
+    if (!('userData' in value) || value['userData'] === undefined) return false;
+    if (!('scormSessionData' in value) || value['scormSessionData'] === undefined) return false;
+    return true;
+}
+
+export function GetContentSessionDetailFromJSON(json: any): GetContentSessionDetail {
+    return GetContentSessionDetailFromJSONTyped(json, false);
+}
+
+export function GetContentSessionDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentSessionDetail {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'contentId': json['content_id'],
+        'completionStatus': json['completion_status'],
+        'gradeStatus': json['grade_status'],
+        'durationInSeconds': json['duration_in_seconds'],
+        'userData': GetContentSessionDetailUserDataFromJSON(json['user_data']),
+        'scormSessionData': GetContentSessionDetailScormSessionDataFromJSON(json['scorm_session_data']),
+    };
+}
+
+export function GetContentSessionDetailToJSON(json: any): GetContentSessionDetail {
+    return GetContentSessionDetailToJSONTyped(json, false);
+}
+
+export function GetContentSessionDetailToJSONTyped(value?: GetContentSessionDetail | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'content_id': value['contentId'],
+        'completion_status': value['completionStatus'],
+        'grade_status': value['gradeStatus'],
+        'duration_in_seconds': value['durationInSeconds'],
+        'user_data': GetContentSessionDetailUserDataToJSON(value['userData']),
+        'scorm_session_data': GetContentSessionDetailScormSessionDataToJSON(value['scormSessionData']),
+    };
+}
+

package/src/models/GetContentSessionDetailScormSessionData.ts

@@ -0,0 +1,66 @@
+/* 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';
+/**
+ * SCORM session data if this is a SCORM session, null otherwise
+ * @export
+ * @interface GetContentSessionDetailScormSessionData
+ */
+export interface GetContentSessionDetailScormSessionData {
+    /**
+     * The external ID of the SCORM session
+     * @type {string}
+     * @memberof GetContentSessionDetailScormSessionData
+     */
+    scormSessionId: string;
+}
+
+/**
+ * Check if a given object implements the GetContentSessionDetailScormSessionData interface.
+ */
+export function instanceOfGetContentSessionDetailScormSessionData(value: object): value is GetContentSessionDetailScormSessionData {
+    if (!('scormSessionId' in value) || value['scormSessionId'] === undefined) return false;
+    return true;
+}
+
+export function GetContentSessionDetailScormSessionDataFromJSON(json: any): GetContentSessionDetailScormSessionData {
+    return GetContentSessionDetailScormSessionDataFromJSONTyped(json, false);
+}
+
+export function GetContentSessionDetailScormSessionDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentSessionDetailScormSessionData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'scormSessionId': json['scorm_session_id'],
+    };
+}
+
+export function GetContentSessionDetailScormSessionDataToJSON(json: any): GetContentSessionDetailScormSessionData {
+    return GetContentSessionDetailScormSessionDataToJSONTyped(json, false);
+}
+
+export function GetContentSessionDetailScormSessionDataToJSONTyped(value?: GetContentSessionDetailScormSessionData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'scorm_session_id': value['scormSessionId'],
+    };
+}
+

package/src/models/GetContentSessionDetailUserData.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 GetContentSessionDetailUserData
+ */
+export interface GetContentSessionDetailUserData {
+    /**
+     * The external ID of the user
+     * @type {string}
+     * @memberof GetContentSessionDetailUserData
+     */
+    userId: string;
+    /**
+     * The name of the user
+     * @type {string}
+     * @memberof GetContentSessionDetailUserData
+     */
+    userName: string;
+}
+
+/**
+ * Check if a given object implements the GetContentSessionDetailUserData interface.
+ */
+export function instanceOfGetContentSessionDetailUserData(value: object): value is GetContentSessionDetailUserData {
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    if (!('userName' in value) || value['userName'] === undefined) return false;
+    return true;
+}
+
+export function GetContentSessionDetailUserDataFromJSON(json: any): GetContentSessionDetailUserData {
+    return GetContentSessionDetailUserDataFromJSONTyped(json, false);
+}
+
+export function GetContentSessionDetailUserDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentSessionDetailUserData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'userId': json['user_id'],
+        'userName': json['user_name'],
+    };
+}
+
+export function GetContentSessionDetailUserDataToJSON(json: any): GetContentSessionDetailUserData {
+    return GetContentSessionDetailUserDataToJSONTyped(json, false);
+}
+
+export function GetContentSessionDetailUserDataToJSONTyped(value?: GetContentSessionDetailUserData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'user_id': value['userId'],
+        'user_name': value['userName'],
+    };
+}
+

package/src/models/GetContentSessionList.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 { GetContentSessionListItem } from './GetContentSessionListItem';
+import {
+    GetContentSessionListItemFromJSON,
+    GetContentSessionListItemFromJSONTyped,
+    GetContentSessionListItemToJSON,
+    GetContentSessionListItemToJSONTyped,
+} from './GetContentSessionListItem';
+
+/**
+ * A list of content sessions with pagination information
+ * @export
+ * @interface GetContentSessionList
+ */
+export interface GetContentSessionList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetContentSessionList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetContentSessionList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetContentSessionList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetContentSessionList
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {Array<GetContentSessionListItem>}
+     * @memberof GetContentSessionList
+     */
+    items: Array<GetContentSessionListItem>;
+}
+
+/**
+ * Check if a given object implements the GetContentSessionList interface.
+ */
+export function instanceOfGetContentSessionList(value: object): value is GetContentSessionList {
+    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 GetContentSessionListFromJSON(json: any): GetContentSessionList {
+    return GetContentSessionListFromJSONTyped(json, false);
+}
+
+export function GetContentSessionListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentSessionList {
+    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(GetContentSessionListItemFromJSON)),
+    };
+}
+
+export function GetContentSessionListToJSON(json: any): GetContentSessionList {
+    return GetContentSessionListToJSONTyped(json, false);
+}
+
+export function GetContentSessionListToJSONTyped(value?: GetContentSessionList | 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(GetContentSessionListItemToJSON)),
+    };
+}
+

package/src/models/GetContentSessionListItem.ts

@@ -0,0 +1,126 @@
+/* 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 { GetContentSessionDetailUserData } from './GetContentSessionDetailUserData';
+import {
+    GetContentSessionDetailUserDataFromJSON,
+    GetContentSessionDetailUserDataFromJSONTyped,
+    GetContentSessionDetailUserDataToJSON,
+    GetContentSessionDetailUserDataToJSONTyped,
+} from './GetContentSessionDetailUserData';
+import type { GetContentSessionDetailScormSessionData } from './GetContentSessionDetailScormSessionData';
+import {
+    GetContentSessionDetailScormSessionDataFromJSON,
+    GetContentSessionDetailScormSessionDataFromJSONTyped,
+    GetContentSessionDetailScormSessionDataToJSON,
+    GetContentSessionDetailScormSessionDataToJSONTyped,
+} from './GetContentSessionDetailScormSessionData';
+
+/**
+ * A content session list item
+ * @export
+ * @interface GetContentSessionListItem
+ */
+export interface GetContentSessionListItem {
+    /**
+     * The external ID of the content session
+     * @type {string}
+     * @memberof GetContentSessionListItem
+     */
+    id: string;
+    /**
+     * The date and time the content session was created (Unix timestamp)
+     * @type {number}
+     * @memberof GetContentSessionListItem
+     */
+    createdAt: number;
+    /**
+     * The date and time the content session was updated (Unix timestamp)
+     * @type {number}
+     * @memberof GetContentSessionListItem
+     */
+    updatedAt: number;
+    /**
+     * The external ID of the content
+     * @type {string}
+     * @memberof GetContentSessionListItem
+     */
+    contentId: string;
+    /**
+     * 
+     * @type {GetContentSessionDetailUserData}
+     * @memberof GetContentSessionListItem
+     */
+    userData: GetContentSessionDetailUserData;
+    /**
+     * 
+     * @type {GetContentSessionDetailScormSessionData}
+     * @memberof GetContentSessionListItem
+     */
+    scormSessionData: GetContentSessionDetailScormSessionData | null;
+}
+
+/**
+ * Check if a given object implements the GetContentSessionListItem interface.
+ */
+export function instanceOfGetContentSessionListItem(value: object): value is GetContentSessionListItem {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('contentId' in value) || value['contentId'] === undefined) return false;
+    if (!('userData' in value) || value['userData'] === undefined) return false;
+    if (!('scormSessionData' in value) || value['scormSessionData'] === undefined) return false;
+    return true;
+}
+
+export function GetContentSessionListItemFromJSON(json: any): GetContentSessionListItem {
+    return GetContentSessionListItemFromJSONTyped(json, false);
+}
+
+export function GetContentSessionListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentSessionListItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'contentId': json['content_id'],
+        'userData': GetContentSessionDetailUserDataFromJSON(json['user_data']),
+        'scormSessionData': GetContentSessionDetailScormSessionDataFromJSON(json['scorm_session_data']),
+    };
+}
+
+export function GetContentSessionListItemToJSON(json: any): GetContentSessionListItem {
+    return GetContentSessionListItemToJSONTyped(json, false);
+}
+
+export function GetContentSessionListItemToJSONTyped(value?: GetContentSessionListItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'content_id': value['contentId'],
+        'user_data': GetContentSessionDetailUserDataToJSON(value['userData']),
+        'scorm_session_data': GetContentSessionDetailScormSessionDataToJSON(value['scormSessionData']),
+    };
+}
+

package/src/models/GetScormApiLogItem.ts

@@ -0,0 +1,125 @@
+/* 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 SCORM API call log entry
+ * @export
+ * @interface GetScormApiLogItem
+ */
+export interface GetScormApiLogItem {
+    /**
+     * The ID of the log entry
+     * @type {number}
+     * @memberof GetScormApiLogItem
+     */
+    id: number;
+    /**
+     * The date and time the API call was made (Unix timestamp)
+     * @type {number}
+     * @memberof GetScormApiLogItem
+     */
+    createdAt: number;
+    /**
+     * The SCORM API method that was called
+     * @type {string}
+     * @memberof GetScormApiLogItem
+     */
+    method: GetScormApiLogItemMethodEnum;
+    /**
+     * The CMI element (e.g., 'cmi.score.raw') - nullable for Initialize, Commit, Terminate
+     * @type {string}
+     * @memberof GetScormApiLogItem
+     */
+    element: string | null;
+    /**
+     * The value set or returned - nullable for some operations
+     * @type {string}
+     * @memberof GetScormApiLogItem
+     */
+    value: string | null;
+    /**
+     * The SCORM error code ('0' for success, '301', '401', etc.')
+     * @type {string}
+     * @memberof GetScormApiLogItem
+     */
+    errorCode: string;
+}
+
+
+/**
+ * @export
+ */
+export const GetScormApiLogItemMethodEnum = {
+    Initialize: 'Initialize',
+    SetValue: 'SetValue',
+    GetValue: 'GetValue',
+    Commit: 'Commit',
+    Terminate: 'Terminate'
+} as const;
+export type GetScormApiLogItemMethodEnum = typeof GetScormApiLogItemMethodEnum[keyof typeof GetScormApiLogItemMethodEnum];
+
+
+/**
+ * Check if a given object implements the GetScormApiLogItem interface.
+ */
+export function instanceOfGetScormApiLogItem(value: object): value is GetScormApiLogItem {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('method' in value) || value['method'] === undefined) return false;
+    if (!('element' in value) || value['element'] === undefined) return false;
+    if (!('value' in value) || value['value'] === undefined) return false;
+    if (!('errorCode' in value) || value['errorCode'] === undefined) return false;
+    return true;
+}
+
+export function GetScormApiLogItemFromJSON(json: any): GetScormApiLogItem {
+    return GetScormApiLogItemFromJSONTyped(json, false);
+}
+
+export function GetScormApiLogItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetScormApiLogItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'createdAt': json['created_at'],
+        'method': json['method'],
+        'element': json['element'],
+        'value': json['value'],
+        'errorCode': json['error_code'],
+    };
+}
+
+export function GetScormApiLogItemToJSON(json: any): GetScormApiLogItem {
+    return GetScormApiLogItemToJSONTyped(json, false);
+}
+
+export function GetScormApiLogItemToJSONTyped(value?: GetScormApiLogItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'created_at': value['createdAt'],
+        'method': value['method'],
+        'element': value['element'],
+        'value': value['value'],
+        'error_code': value['errorCode'],
+    };
+}
+