@easyedu/js-lsm-api 1.24.0 → 1.26.0

package/dist/esm/apis/ReportingApi.js

@@ -27,7 +27,7 @@ import { GetContentGradeDetailFromJSON, GetContentGradesFromJSON, GetContentInst
  */
 export class ReportingApi extends runtime.BaseAPI {
     /**
-     * Get detailed grade information for a specific student and content
+     * Get detailed grade information for a specific student and content (can use \'current\' for studentId)
      */
     getContentGradeDetailRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -55,7 +55,7 @@ export class ReportingApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get detailed grade information for a specific student and content
+     * Get detailed grade information for a specific student and content (can use \'current\' for studentId)
      */
     getContentGradeDetail(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -169,7 +169,7 @@ export class ReportingApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get student-specific reporting for a course
+     * Get student-specific reporting for a course (can use \'current\' for studentId)
      */
     getCourseStudentReportingRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -191,7 +191,7 @@ export class ReportingApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get student-specific reporting for a course
+     * Get student-specific reporting for a course (can use \'current\' for studentId)
      */
     getCourseStudentReporting(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -231,7 +231,7 @@ export class ReportingApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get student-specific reporting for a module
+     * Get student-specific reporting for a module (can use \'current\' for studentId)
      */
     getModuleStudentReportingRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -256,7 +256,7 @@ export class ReportingApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get student-specific reporting for a module
+     * Get student-specific reporting for a module (can use \'current\' for studentId)
      */
     getModuleStudentReporting(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -265,7 +265,7 @@ export class ReportingApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get basic reporting for a portal
+     * Get basic reporting for a portal (can use \'current\' for portalId)
      */
     getPortalBasicReportingRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -284,7 +284,7 @@ export class ReportingApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get basic reporting for a portal
+     * Get basic reporting for a portal (can use \'current\' for portalId)
      */
     getPortalBasicReporting(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -293,7 +293,7 @@ export class ReportingApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get student reporting for a portal
+     * Get student reporting for a portal (can use \'current\' for portalId and studentId)
      */
     getPortalStudentReportingRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -315,7 +315,7 @@ export class ReportingApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get student reporting for a portal
+     * Get student reporting for a portal (can use \'current\' for portalId and studentId)
      */
     getPortalStudentReporting(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/esm/models/GetCourseExport.d.ts

@@ -0,0 +1,93 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare const GetCourseExportScormVersionEnum: {
+    readonly Scorm12: "SCORM_1_2";
+    readonly Scorm20043RdEdition: "SCORM_2004_3RD_EDITION";
+    readonly Scorm20044ThEdition: "SCORM_2004_4TH_EDITION";
+};
+export type GetCourseExportScormVersionEnum = typeof GetCourseExportScormVersionEnum[keyof typeof GetCourseExportScormVersionEnum];
+/**
+ * @export
+ */
+export declare const GetCourseExportStatusEnum: {
+    readonly Pending: "PENDING";
+    readonly Processing: "PROCESSING";
+    readonly Completed: "COMPLETED";
+    readonly Failed: "FAILED";
+};
+export type GetCourseExportStatusEnum = typeof GetCourseExportStatusEnum[keyof typeof GetCourseExportStatusEnum];
+/**
+ * Check if a given object implements the GetCourseExport interface.
+ */
+export declare function instanceOfGetCourseExport(value: object): value is GetCourseExport;
+export declare function GetCourseExportFromJSON(json: any): GetCourseExport;
+export declare function GetCourseExportFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseExport;
+export declare function GetCourseExportToJSON(json: any): GetCourseExport;
+export declare function GetCourseExportToJSONTyped(value?: GetCourseExport | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetCourseExport.js

@@ -0,0 +1,82 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const GetCourseExportScormVersionEnum = {
+    Scorm12: 'SCORM_1_2',
+    Scorm20043RdEdition: 'SCORM_2004_3RD_EDITION',
+    Scorm20044ThEdition: 'SCORM_2004_4TH_EDITION'
+};
+/**
+ * @export
+ */
+export const GetCourseExportStatusEnum = {
+    Pending: 'PENDING',
+    Processing: 'PROCESSING',
+    Completed: 'COMPLETED',
+    Failed: 'FAILED'
+};
+/**
+ * Check if a given object implements the GetCourseExport interface.
+ */
+export function instanceOfGetCourseExport(value) {
+    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) {
+    return GetCourseExportFromJSONTyped(json, false);
+}
+export function GetCourseExportFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return GetCourseExportToJSONTyped(json, false);
+}
+export function GetCourseExportToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/GetCourseExportList.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 type { GetCourseExport } 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 declare function instanceOfGetCourseExportList(value: object): value is GetCourseExportList;
+export declare function GetCourseExportListFromJSON(json: any): GetCourseExportList;
+export declare function GetCourseExportListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseExportList;
+export declare function GetCourseExportListToJSON(json: any): GetCourseExportList;
+export declare function GetCourseExportListToJSONTyped(value?: GetCourseExportList | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetCourseExportList.js

@@ -0,0 +1,60 @@
+/* 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 { GetCourseExportFromJSON, GetCourseExportToJSON, } from './GetCourseExport';
+/**
+ * Check if a given object implements the GetCourseExportList interface.
+ */
+export function instanceOfGetCourseExportList(value) {
+    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) {
+    return GetCourseExportListFromJSONTyped(json, false);
+}
+export function GetCourseExportListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalPages': json['total_pages'],
+        'totalItems': json['total_items'],
+        'items': (json['items'].map(GetCourseExportFromJSON)),
+    };
+}
+export function GetCourseExportListToJSON(json) {
+    return GetCourseExportListToJSONTyped(json, false);
+}
+export function GetCourseExportListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_pages': value['totalPages'],
+        'total_items': value['totalItems'],
+        'items': (value['items'].map(GetCourseExportToJSON)),
+    };
+}

package/dist/esm/models/PostCourseExport.d.ts

@@ -0,0 +1,41 @@
+/**
+ * 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.
+ */
+/**
+ * Request to create a new SCORM export for a course
+ * @export
+ * @interface PostCourseExport
+ */
+export interface PostCourseExport {
+    /**
+     * The SCORM version to export
+     * @type {string}
+     * @memberof PostCourseExport
+     */
+    scormVersion: PostCourseExportScormVersionEnum;
+}
+/**
+ * @export
+ */
+export declare const PostCourseExportScormVersionEnum: {
+    readonly Scorm12: "SCORM_1_2";
+    readonly Scorm20043RdEdition: "SCORM_2004_3RD_EDITION";
+    readonly Scorm20044ThEdition: "SCORM_2004_4TH_EDITION";
+};
+export type PostCourseExportScormVersionEnum = typeof PostCourseExportScormVersionEnum[keyof typeof PostCourseExportScormVersionEnum];
+/**
+ * Check if a given object implements the PostCourseExport interface.
+ */
+export declare function instanceOfPostCourseExport(value: object): value is PostCourseExport;
+export declare function PostCourseExportFromJSON(json: any): PostCourseExport;
+export declare function PostCourseExportFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseExport;
+export declare function PostCourseExportToJSON(json: any): PostCourseExport;
+export declare function PostCourseExportToJSONTyped(value?: PostCourseExport | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostCourseExport.js

@@ -0,0 +1,51 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const PostCourseExportScormVersionEnum = {
+    Scorm12: 'SCORM_1_2',
+    Scorm20043RdEdition: 'SCORM_2004_3RD_EDITION',
+    Scorm20044ThEdition: 'SCORM_2004_4TH_EDITION'
+};
+/**
+ * Check if a given object implements the PostCourseExport interface.
+ */
+export function instanceOfPostCourseExport(value) {
+    if (!('scormVersion' in value) || value['scormVersion'] === undefined)
+        return false;
+    return true;
+}
+export function PostCourseExportFromJSON(json) {
+    return PostCourseExportFromJSONTyped(json, false);
+}
+export function PostCourseExportFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'scormVersion': json['scorm_version'],
+    };
+}
+export function PostCourseExportToJSON(json) {
+    return PostCourseExportToJSONTyped(json, false);
+}
+export function PostCourseExportToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'scorm_version': value['scormVersion'],
+    };
+}

package/dist/esm/models/index.d.ts

@@ -20,6 +20,8 @@ export * from './GetCourse';
 export * from './GetCourseEnrollment';
 export * from './GetCourseEnrollmentList';
 export * from './GetCourseEnrollmentListItem';
+export * from './GetCourseExport';
+export * from './GetCourseExportList';
 export * from './GetCourseList';
 export * from './GetCourseReportingBasic';
 export * from './GetCourseStudentReporting';
@@ -119,6 +121,7 @@ export * from './PostContentSession';
 export * from './PostContentUpload';
 export * from './PostCourse';
 export * from './PostCourseEnrollment';
+export * from './PostCourseExport';
 export * from './PostLogin';
 export * from './PostManualQuestionSelection';
 export * from './PostModule';

package/dist/esm/models/index.js

@@ -22,6 +22,8 @@ export * from './GetCourse';
 export * from './GetCourseEnrollment';
 export * from './GetCourseEnrollmentList';
 export * from './GetCourseEnrollmentListItem';
+export * from './GetCourseExport';
+export * from './GetCourseExportList';
 export * from './GetCourseList';
 export * from './GetCourseReportingBasic';
 export * from './GetCourseStudentReporting';
@@ -121,6 +123,7 @@ export * from './PostContentSession';
 export * from './PostContentUpload';
 export * from './PostCourse';
 export * from './PostCourseEnrollment';
+export * from './PostCourseExport';
 export * from './PostLogin';
 export * from './PostManualQuestionSelection';
 export * from './PostModule';

package/dist/models/GetCourseExport.d.ts

@@ -0,0 +1,93 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare const GetCourseExportScormVersionEnum: {
+    readonly Scorm12: "SCORM_1_2";
+    readonly Scorm20043RdEdition: "SCORM_2004_3RD_EDITION";
+    readonly Scorm20044ThEdition: "SCORM_2004_4TH_EDITION";
+};
+export type GetCourseExportScormVersionEnum = typeof GetCourseExportScormVersionEnum[keyof typeof GetCourseExportScormVersionEnum];
+/**
+ * @export
+ */
+export declare const GetCourseExportStatusEnum: {
+    readonly Pending: "PENDING";
+    readonly Processing: "PROCESSING";
+    readonly Completed: "COMPLETED";
+    readonly Failed: "FAILED";
+};
+export type GetCourseExportStatusEnum = typeof GetCourseExportStatusEnum[keyof typeof GetCourseExportStatusEnum];
+/**
+ * Check if a given object implements the GetCourseExport interface.
+ */
+export declare function instanceOfGetCourseExport(value: object): value is GetCourseExport;
+export declare function GetCourseExportFromJSON(json: any): GetCourseExport;
+export declare function GetCourseExportFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseExport;
+export declare function GetCourseExportToJSON(json: any): GetCourseExport;
+export declare function GetCourseExportToJSONTyped(value?: GetCourseExport | null, ignoreDiscriminator?: boolean): any;