@easyedu/js-lsm-api 1.25.0 → 1.26.0

package/src/apis/CourseApi.ts

@@ -18,10 +18,13 @@ import type {
   GetCourse,
   GetCourseEnrollment,
   GetCourseEnrollmentList,
+  GetCourseExport,
+  GetCourseExportList,
   GetCourseList,
   GetCourseReportingBasic,
   PostCourse,
   PostCourseEnrollment,
+  PostCourseExport,
   PutCourse,
   PutCourseEnrollment,
 } from '../models/index';
@@ -32,6 +35,10 @@ import {
     GetCourseEnrollmentToJSON,
     GetCourseEnrollmentListFromJSON,
     GetCourseEnrollmentListToJSON,
+    GetCourseExportFromJSON,
+    GetCourseExportToJSON,
+    GetCourseExportListFromJSON,
+    GetCourseExportListToJSON,
     GetCourseListFromJSON,
     GetCourseListToJSON,
     GetCourseReportingBasicFromJSON,
@@ -40,6 +47,8 @@ import {
     PostCourseToJSON,
     PostCourseEnrollmentFromJSON,
     PostCourseEnrollmentToJSON,
+    PostCourseExportFromJSON,
+    PostCourseExportToJSON,
     PutCourseFromJSON,
     PutCourseToJSON,
     PutCourseEnrollmentFromJSON,
@@ -62,6 +71,17 @@ export interface GetCourseEnrollmentsRequest {
     pageSize?: number;
 }
 
+export interface GetCourseExportRequest {
+    courseId: string;
+    exportId: string;
+}
+
+export interface GetCourseExportsRequest {
+    courseId: string;
+    page?: number;
+    pageSize?: number;
+}
+
 export interface GetCourseListRequest {
     enrolled?: boolean;
 }
@@ -79,6 +99,11 @@ export interface PostCourseEnrollmentRequest {
     postCourseEnrollment: PostCourseEnrollment;
 }
 
+export interface PostCourseExportRequest {
+    courseId: string;
+    postCourseExport: PostCourseExport;
+}
+
 export interface PutCourseRequest {
     courseId: string;
     putCourse: Omit<PutCourse, 'id'>;
@@ -213,6 +238,87 @@ export class CourseApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get details of a specific SCORM export
+     */
+    async getCourseExportRaw(requestParameters: GetCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseExport>> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling getCourseExport().'
+            );
+        }
+
+        if (requestParameters['exportId'] == null) {
+            throw new runtime.RequiredError(
+                'exportId',
+                'Required parameter "exportId" was null or undefined when calling getCourseExport().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/courses/{courseId}/exports/{exportId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"exportId"}}`, encodeURIComponent(String(requestParameters['exportId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseExportFromJSON(jsonValue));
+    }
+
+    /**
+     * Get details of a specific SCORM export
+     */
+    async getCourseExport(requestParameters: GetCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseExport> {
+        const response = await this.getCourseExportRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List all SCORM exports for a course
+     */
+    async getCourseExportsRaw(requestParameters: GetCourseExportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseExportList>> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling getCourseExports().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['page_size'] = requestParameters['pageSize'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/courses/{courseId}/exports`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseExportListFromJSON(jsonValue));
+    }
+
+    /**
+     * List all SCORM exports for a course
+     */
+    async getCourseExports(requestParameters: GetCourseExportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseExportList> {
+        const response = await this.getCourseExportsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * get course list
      */
@@ -355,6 +461,51 @@ export class CourseApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status.  **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Actual SCORM package generation is not yet implemented (TODO) - Export metadata should be persisted to a database table (TODO) - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED 
+     * Create a new SCORM export for a course
+     */
+    async postCourseExportRaw(requestParameters: PostCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseExport>> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling postCourseExport().'
+            );
+        }
+
+        if (requestParameters['postCourseExport'] == null) {
+            throw new runtime.RequiredError(
+                'postCourseExport',
+                'Required parameter "postCourseExport" was null or undefined when calling postCourseExport().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/courses/{courseId}/exports`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostCourseExportToJSON(requestParameters['postCourseExport']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseExportFromJSON(jsonValue));
+    }
+
+    /**
+     * Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status.  **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Actual SCORM package generation is not yet implemented (TODO) - Export metadata should be persisted to a database table (TODO) - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED 
+     * Create a new SCORM export for a course
+     */
+    async postCourseExport(requestParameters: PostCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseExport> {
+        const response = await this.postCourseExportRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Update a course by id
      */

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/PostCourseExport.ts

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

package/src/models/index.ts

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