@easyedu/js-lsm-api 1.25.0 → 1.27.0

package/src/models/GetContentVersionList.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 { GetContentVersionListItemsInner } from './GetContentVersionListItemsInner';
+import {
+    GetContentVersionListItemsInnerFromJSON,
+    GetContentVersionListItemsInnerFromJSONTyped,
+    GetContentVersionListItemsInnerToJSON,
+    GetContentVersionListItemsInnerToJSONTyped,
+} from './GetContentVersionListItemsInner';
+
+/**
+ * A paginated list of content versions
+ * @export
+ * @interface GetContentVersionList
+ */
+export interface GetContentVersionList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetContentVersionList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetContentVersionList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetContentVersionList
+     */
+    totalPages: number;
+    /**
+     * The total number of versions
+     * @type {number}
+     * @memberof GetContentVersionList
+     */
+    totalItems: number;
+    /**
+     * List of content versions
+     * @type {Array<GetContentVersionListItemsInner>}
+     * @memberof GetContentVersionList
+     */
+    items: Array<GetContentVersionListItemsInner>;
+}
+
+/**
+ * Check if a given object implements the GetContentVersionList interface.
+ */
+export function instanceOfGetContentVersionList(value: object): value is GetContentVersionList {
+    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 GetContentVersionListFromJSON(json: any): GetContentVersionList {
+    return GetContentVersionListFromJSONTyped(json, false);
+}
+
+export function GetContentVersionListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentVersionList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalPages': json['total_pages'],
+        'totalItems': json['total_items'],
+        'items': ((json['items'] as Array<any>).map(GetContentVersionListItemsInnerFromJSON)),
+    };
+}
+
+export function GetContentVersionListToJSON(json: any): GetContentVersionList {
+    return GetContentVersionListToJSONTyped(json, false);
+}
+
+export function GetContentVersionListToJSONTyped(value?: GetContentVersionList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_pages': value['totalPages'],
+        'total_items': value['totalItems'],
+        'items': ((value['items'] as Array<any>).map(GetContentVersionListItemsInnerToJSON)),
+    };
+}
+

package/src/models/GetContentVersionListItemsInner.ts

@@ -0,0 +1,102 @@
+/* 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 GetContentVersionListItemsInner
+ */
+export interface GetContentVersionListItemsInner {
+    /**
+     * The external_id (UUID) for this version
+     * @type {string}
+     * @memberof GetContentVersionListItemsInner
+     */
+    id: string;
+    /**
+     * Version number
+     * @type {number}
+     * @memberof GetContentVersionListItemsInner
+     */
+    version: number;
+    /**
+     * Whether this is the currently active version
+     * @type {boolean}
+     * @memberof GetContentVersionListItemsInner
+     */
+    isActive: boolean;
+    /**
+     * When this version was created
+     * @type {Date}
+     * @memberof GetContentVersionListItemsInner
+     */
+    createdAt: Date;
+    /**
+     * When this version was last updated
+     * @type {Date}
+     * @memberof GetContentVersionListItemsInner
+     */
+    updatedAt: Date;
+}
+
+/**
+ * Check if a given object implements the GetContentVersionListItemsInner interface.
+ */
+export function instanceOfGetContentVersionListItemsInner(value: object): value is GetContentVersionListItemsInner {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('version' in value) || value['version'] === 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 GetContentVersionListItemsInnerFromJSON(json: any): GetContentVersionListItemsInner {
+    return GetContentVersionListItemsInnerFromJSONTyped(json, false);
+}
+
+export function GetContentVersionListItemsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentVersionListItemsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'version': json['version'],
+        'isActive': json['is_active'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+
+export function GetContentVersionListItemsInnerToJSON(json: any): GetContentVersionListItemsInner {
+    return GetContentVersionListItemsInnerToJSONTyped(json, false);
+}
+
+export function GetContentVersionListItemsInnerToJSONTyped(value?: GetContentVersionListItemsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'version': value['version'],
+        'is_active': value['isActive'],
+        'created_at': ((value['createdAt']).toISOString()),
+        'updated_at': ((value['updatedAt']).toISOString()),
+    };
+}
+

package/src/models/GetContentVersionSandbox.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';
+/**
+ * Sandbox data for this version
+ * @export
+ * @interface GetContentVersionSandbox
+ */
+export interface GetContentVersionSandbox {
+    /**
+     * URL to launch the content in sandbox mode
+     * @type {string}
+     * @memberof GetContentVersionSandbox
+     */
+    launchUrl: string;
+}
+
+/**
+ * Check if a given object implements the GetContentVersionSandbox interface.
+ */
+export function instanceOfGetContentVersionSandbox(value: object): value is GetContentVersionSandbox {
+    if (!('launchUrl' in value) || value['launchUrl'] === undefined) return false;
+    return true;
+}
+
+export function GetContentVersionSandboxFromJSON(json: any): GetContentVersionSandbox {
+    return GetContentVersionSandboxFromJSONTyped(json, false);
+}
+
+export function GetContentVersionSandboxFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentVersionSandbox {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'launchUrl': json['launch_url'],
+    };
+}
+
+export function GetContentVersionSandboxToJSON(json: any): GetContentVersionSandbox {
+    return GetContentVersionSandboxToJSONTyped(json, false);
+}
+
+export function GetContentVersionSandboxToJSONTyped(value?: GetContentVersionSandbox | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'launch_url': value['launchUrl'],
+    };
+}
+

package/src/models/GetContentVersionScormData.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-specific data (only present for SCORM content type)
+ * @export
+ * @interface GetContentVersionScormData
+ */
+export interface GetContentVersionScormData {
+    /**
+     * The external_id (UUID) of the scorm_content record
+     * @type {string}
+     * @memberof GetContentVersionScormData
+     */
+    scormPackageId: string;
+}
+
+/**
+ * Check if a given object implements the GetContentVersionScormData interface.
+ */
+export function instanceOfGetContentVersionScormData(value: object): value is GetContentVersionScormData {
+    if (!('scormPackageId' in value) || value['scormPackageId'] === undefined) return false;
+    return true;
+}
+
+export function GetContentVersionScormDataFromJSON(json: any): GetContentVersionScormData {
+    return GetContentVersionScormDataFromJSONTyped(json, false);
+}
+
+export function GetContentVersionScormDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentVersionScormData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'scormPackageId': json['scorm_package_id'],
+    };
+}
+
+export function GetContentVersionScormDataToJSON(json: any): GetContentVersionScormData {
+    return GetContentVersionScormDataToJSONTyped(json, false);
+}
+
+export function GetContentVersionScormDataToJSONTyped(value?: GetContentVersionScormData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'scorm_package_id': value['scormPackageId'],
+    };
+}
+

package/src/models/GetCourseExport.ts

@@ -0,0 +1,149 @@
+/* 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';
+/**
+ * Details of a course SCORM export
+ * @export
+ * @interface GetCourseExport
+ */
+export interface GetCourseExport {
+    /**
+     * Unique identifier for the export
+     * @type {string}
+     * @memberof GetCourseExport
+     */
+    id: string;
+    /**
+     * ID of the course being exported
+     * @type {string}
+     * @memberof GetCourseExport
+     */
+    courseId: string;
+    /**
+     * The SCORM version to export
+     * @type {string}
+     * @memberof GetCourseExport
+     */
+    scormVersion: GetCourseExportScormVersionEnum;
+    /**
+     * Current status of the export generation
+     * @type {string}
+     * @memberof GetCourseExport
+     */
+    status: GetCourseExportStatusEnum;
+    /**
+     * URL to download the export zip file (null if not yet completed)
+     * @type {string}
+     * @memberof GetCourseExport
+     */
+    downloadUrl?: string | null;
+    /**
+     * Size of the export file in bytes (null if not yet completed)
+     * @type {number}
+     * @memberof GetCourseExport
+     */
+    fileSize?: number | null;
+    /**
+     * Error message if status is FAILED
+     * @type {string}
+     * @memberof GetCourseExport
+     */
+    errorMessage?: string | null;
+    /**
+     * Unix epoch timestamp when the export was created
+     * @type {number}
+     * @memberof GetCourseExport
+     */
+    createdAt: number;
+}
+
+
+/**
+ * @export
+ */
+export const GetCourseExportScormVersionEnum = {
+    Scorm12: 'SCORM_1_2',
+    Scorm20043RdEdition: 'SCORM_2004_3RD_EDITION',
+    Scorm20044ThEdition: 'SCORM_2004_4TH_EDITION'
+} as const;
+export type GetCourseExportScormVersionEnum = typeof GetCourseExportScormVersionEnum[keyof typeof GetCourseExportScormVersionEnum];
+
+/**
+ * @export
+ */
+export const GetCourseExportStatusEnum = {
+    Pending: 'PENDING',
+    Processing: 'PROCESSING',
+    Completed: 'COMPLETED',
+    Failed: 'FAILED'
+} as const;
+export type GetCourseExportStatusEnum = typeof GetCourseExportStatusEnum[keyof typeof GetCourseExportStatusEnum];
+
+
+/**
+ * Check if a given object implements the GetCourseExport interface.
+ */
+export function instanceOfGetCourseExport(value: object): value is GetCourseExport {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('courseId' in value) || value['courseId'] === undefined) return false;
+    if (!('scormVersion' in value) || value['scormVersion'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function GetCourseExportFromJSON(json: any): GetCourseExport {
+    return GetCourseExportFromJSONTyped(json, false);
+}
+
+export function GetCourseExportFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseExport {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'courseId': json['course_id'],
+        'scormVersion': json['scorm_version'],
+        'status': json['status'],
+        'downloadUrl': json['download_url'] == null ? undefined : json['download_url'],
+        'fileSize': json['file_size'] == null ? undefined : json['file_size'],
+        'errorMessage': json['error_message'] == null ? undefined : json['error_message'],
+        'createdAt': json['created_at'],
+    };
+}
+
+export function GetCourseExportToJSON(json: any): GetCourseExport {
+    return GetCourseExportToJSONTyped(json, false);
+}
+
+export function GetCourseExportToJSONTyped(value?: GetCourseExport | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'course_id': value['courseId'],
+        'scorm_version': value['scormVersion'],
+        'status': value['status'],
+        'download_url': value['downloadUrl'],
+        'file_size': value['fileSize'],
+        'error_message': value['errorMessage'],
+        'created_at': value['createdAt'],
+    };
+}
+

package/src/models/GetCourseExportList.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 { GetCourseExport } from './GetCourseExport';
+import {
+    GetCourseExportFromJSON,
+    GetCourseExportFromJSONTyped,
+    GetCourseExportToJSON,
+    GetCourseExportToJSONTyped,
+} from './GetCourseExport';
+
+/**
+ * A list of course exports with pagination information
+ * @export
+ * @interface GetCourseExportList
+ */
+export interface GetCourseExportList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetCourseExportList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetCourseExportList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetCourseExportList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetCourseExportList
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {Array<GetCourseExport>}
+     * @memberof GetCourseExportList
+     */
+    items: Array<GetCourseExport>;
+}
+
+/**
+ * Check if a given object implements the GetCourseExportList interface.
+ */
+export function instanceOfGetCourseExportList(value: object): value is GetCourseExportList {
+    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 GetCourseExportListFromJSON(json: any): GetCourseExportList {
+    return GetCourseExportListFromJSONTyped(json, false);
+}
+
+export function GetCourseExportListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseExportList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalPages': json['total_pages'],
+        'totalItems': json['total_items'],
+        'items': ((json['items'] as Array<any>).map(GetCourseExportFromJSON)),
+    };
+}
+
+export function GetCourseExportListToJSON(json: any): GetCourseExportList {
+    return GetCourseExportListToJSONTyped(json, false);
+}
+
+export function GetCourseExportListToJSONTyped(value?: GetCourseExportList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_pages': value['totalPages'],
+        'total_items': value['totalItems'],
+        'items': ((value['items'] as Array<any>).map(GetCourseExportToJSON)),
+    };
+}
+

package/src/models/GetScormPackage.ts

@@ -0,0 +1,83 @@
+/* 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 { GetScormPackagePackageInfo } from './GetScormPackagePackageInfo';
+import {
+    GetScormPackagePackageInfoFromJSON,
+    GetScormPackagePackageInfoFromJSONTyped,
+    GetScormPackagePackageInfoToJSON,
+    GetScormPackagePackageInfoToJSONTyped,
+} from './GetScormPackagePackageInfo';
+
+/**
+ * Details of a SCORM package
+ * @export
+ * @interface GetScormPackage
+ */
+export interface GetScormPackage {
+    /**
+     * 
+     * @type {GetScormPackagePackageInfo}
+     * @memberof GetScormPackage
+     */
+    packageInfo: GetScormPackagePackageInfo;
+    /**
+     * Hierarchical table of contents from the SCORM manifest (flexible JSON structure)
+     * @type {object}
+     * @memberof GetScormPackage
+     */
+    tableOfContents: object;
+}
+
+/**
+ * Check if a given object implements the GetScormPackage interface.
+ */
+export function instanceOfGetScormPackage(value: object): value is GetScormPackage {
+    if (!('packageInfo' in value) || value['packageInfo'] === undefined) return false;
+    if (!('tableOfContents' in value) || value['tableOfContents'] === undefined) return false;
+    return true;
+}
+
+export function GetScormPackageFromJSON(json: any): GetScormPackage {
+    return GetScormPackageFromJSONTyped(json, false);
+}
+
+export function GetScormPackageFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetScormPackage {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'packageInfo': GetScormPackagePackageInfoFromJSON(json['package_info']),
+        'tableOfContents': json['table_of_contents'],
+    };
+}
+
+export function GetScormPackageToJSON(json: any): GetScormPackage {
+    return GetScormPackageToJSONTyped(json, false);
+}
+
+export function GetScormPackageToJSONTyped(value?: GetScormPackage | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'package_info': GetScormPackagePackageInfoToJSON(value['packageInfo']),
+        'table_of_contents': value['tableOfContents'],
+    };
+}
+