@easyedu/js-lsm-api 1.42.0 → 1.44.0

package/dist/esm/models/PutCourse.js

@@ -29,7 +29,6 @@ export function PutCourseFromJSONTyped(json, ignoreDiscriminator) {
         'name': json['name'] == null ? undefined : json['name'],
         'description': json['description'] == null ? undefined : json['description'],
         'instructor': json['instructor'] == null ? undefined : json['instructor'],
-        'imageUrl': json['image_url'] == null ? undefined : json['image_url'],
         'published': json['published'] == null ? undefined : json['published'],
     };
 }
@@ -44,7 +43,6 @@ export function PutCourseToJSONTyped(value, ignoreDiscriminator = false) {
         'name': value['name'],
         'description': value['description'],
         'instructor': value['instructor'],
-        'image_url': value['imageUrl'],
         'published': value['published'],
     };
 }

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

@@ -39,6 +39,7 @@ export * from './GetCourseEnrollmentList';
 export * from './GetCourseEnrollmentListItem';
 export * from './GetCourseExport';
 export * from './GetCourseExportList';
+export * from './GetCourseImageUpload';
 export * from './GetCourseList';
 export * from './GetCourseReportingBasic';
 export * from './GetCourseStudentReporting';
@@ -72,6 +73,7 @@ export * from './GetQuestion';
 export * from './GetQuestionAnswerChoicesInner';
 export * from './GetQuestionList';
 export * from './GetQuestionListFilters';
+export * from './GetQuestionQuizzesInner';
 export * from './GetQuiz';
 export * from './GetQuizAttempt';
 export * from './GetQuizAttemptAnalytics';

package/dist/esm/models/index.js

@@ -41,6 +41,7 @@ export * from './GetCourseEnrollmentList';
 export * from './GetCourseEnrollmentListItem';
 export * from './GetCourseExport';
 export * from './GetCourseExportList';
+export * from './GetCourseImageUpload';
 export * from './GetCourseList';
 export * from './GetCourseReportingBasic';
 export * from './GetCourseStudentReporting';
@@ -74,6 +75,7 @@ export * from './GetQuestion';
 export * from './GetQuestionAnswerChoicesInner';
 export * from './GetQuestionList';
 export * from './GetQuestionListFilters';
+export * from './GetQuestionQuizzesInner';
 export * from './GetQuiz';
 export * from './GetQuizAttempt';
 export * from './GetQuizAttemptAnalytics';

package/dist/models/GetCourseImageUpload.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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
+ * @interface GetCourseImageUpload
+ */
+export interface GetCourseImageUpload {
+    /**
+     * Presigned URL for the uploaded course image
+     * @type {string}
+     * @memberof GetCourseImageUpload
+     */
+    imageUrl: string;
+}
+/**
+ * Check if a given object implements the GetCourseImageUpload interface.
+ */
+export declare function instanceOfGetCourseImageUpload(value: object): value is GetCourseImageUpload;
+export declare function GetCourseImageUploadFromJSON(json: any): GetCourseImageUpload;
+export declare function GetCourseImageUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseImageUpload;
+export declare function GetCourseImageUploadToJSON(json: any): GetCourseImageUpload;
+export declare function GetCourseImageUploadToJSONTyped(value?: GetCourseImageUpload | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetCourseImageUpload.js

@@ -0,0 +1,50 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetCourseImageUpload = instanceOfGetCourseImageUpload;
+exports.GetCourseImageUploadFromJSON = GetCourseImageUploadFromJSON;
+exports.GetCourseImageUploadFromJSONTyped = GetCourseImageUploadFromJSONTyped;
+exports.GetCourseImageUploadToJSON = GetCourseImageUploadToJSON;
+exports.GetCourseImageUploadToJSONTyped = GetCourseImageUploadToJSONTyped;
+/**
+ * Check if a given object implements the GetCourseImageUpload interface.
+ */
+function instanceOfGetCourseImageUpload(value) {
+    if (!('imageUrl' in value) || value['imageUrl'] === undefined)
+        return false;
+    return true;
+}
+function GetCourseImageUploadFromJSON(json) {
+    return GetCourseImageUploadFromJSONTyped(json, false);
+}
+function GetCourseImageUploadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'imageUrl': json['image_url'],
+    };
+}
+function GetCourseImageUploadToJSON(json) {
+    return GetCourseImageUploadToJSONTyped(json, false);
+}
+function GetCourseImageUploadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'image_url': value['imageUrl'],
+    };
+}

package/dist/models/GetQuestion.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { GetQuestionAnswerChoicesInner } from './GetQuestionAnswerChoicesInner';
+import type { GetQuestionQuizzesInner } from './GetQuestionQuizzesInner';
 /**
  *
  * @export
@@ -106,6 +107,12 @@ export interface GetQuestion {
      * @memberof GetQuestion
      */
     readonly quizCount?: number;
+    /**
+     * Quizzes that use this question
+     * @type {Array<GetQuestionQuizzesInner>}
+     * @memberof GetQuestion
+     */
+    readonly quizzes?: Array<GetQuestionQuizzesInner>;
 }
 /**
  * @export
@@ -135,4 +142,4 @@ export declare function instanceOfGetQuestion(value: object): value is GetQuesti
 export declare function GetQuestionFromJSON(json: any): GetQuestion;
 export declare function GetQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetQuestion;
 export declare function GetQuestionToJSON(json: any): GetQuestion;
-export declare function GetQuestionToJSONTyped(value?: Omit<GetQuestion, 'id' | 'created_date' | 'updated_date' | 'created_by' | 'quiz_count'> | null, ignoreDiscriminator?: boolean): any;
+export declare function GetQuestionToJSONTyped(value?: Omit<GetQuestion, 'id' | 'created_date' | 'updated_date' | 'created_by' | 'quiz_count' | 'quizzes'> | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetQuestion.js

@@ -20,6 +20,7 @@ exports.GetQuestionFromJSONTyped = GetQuestionFromJSONTyped;
 exports.GetQuestionToJSON = GetQuestionToJSON;
 exports.GetQuestionToJSONTyped = GetQuestionToJSONTyped;
 const GetQuestionAnswerChoicesInner_1 = require("./GetQuestionAnswerChoicesInner");
+const GetQuestionQuizzesInner_1 = require("./GetQuestionQuizzesInner");
 /**
  * @export
  */
@@ -82,6 +83,7 @@ function GetQuestionFromJSONTyped(json, ignoreDiscriminator) {
         'updatedDate': (new Date(json['updated_date'])),
         'createdBy': json['created_by'] == null ? undefined : json['created_by'],
         'quizCount': json['quiz_count'] == null ? undefined : json['quiz_count'],
+        'quizzes': json['quizzes'] == null ? undefined : (json['quizzes'].map(GetQuestionQuizzesInner_1.GetQuestionQuizzesInnerFromJSON)),
     };
 }
 function GetQuestionToJSON(json) {

package/dist/models/GetQuestionQuizzesInner.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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
+ * @interface GetQuestionQuizzesInner
+ */
+export interface GetQuestionQuizzesInner {
+    /**
+     * Quiz external identifier
+     * @type {string}
+     * @memberof GetQuestionQuizzesInner
+     */
+    quizId: string;
+    /**
+     * Quiz name
+     * @type {string}
+     * @memberof GetQuestionQuizzesInner
+     */
+    quizName: string;
+    /**
+     * Module external identifier
+     * @type {string}
+     * @memberof GetQuestionQuizzesInner
+     */
+    moduleId: string;
+    /**
+     * Course external identifier
+     * @type {string}
+     * @memberof GetQuestionQuizzesInner
+     */
+    courseId: string;
+}
+/**
+ * Check if a given object implements the GetQuestionQuizzesInner interface.
+ */
+export declare function instanceOfGetQuestionQuizzesInner(value: object): value is GetQuestionQuizzesInner;
+export declare function GetQuestionQuizzesInnerFromJSON(json: any): GetQuestionQuizzesInner;
+export declare function GetQuestionQuizzesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetQuestionQuizzesInner;
+export declare function GetQuestionQuizzesInnerToJSON(json: any): GetQuestionQuizzesInner;
+export declare function GetQuestionQuizzesInnerToJSONTyped(value?: GetQuestionQuizzesInner | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetQuestionQuizzesInner.js

@@ -0,0 +1,62 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetQuestionQuizzesInner = instanceOfGetQuestionQuizzesInner;
+exports.GetQuestionQuizzesInnerFromJSON = GetQuestionQuizzesInnerFromJSON;
+exports.GetQuestionQuizzesInnerFromJSONTyped = GetQuestionQuizzesInnerFromJSONTyped;
+exports.GetQuestionQuizzesInnerToJSON = GetQuestionQuizzesInnerToJSON;
+exports.GetQuestionQuizzesInnerToJSONTyped = GetQuestionQuizzesInnerToJSONTyped;
+/**
+ * Check if a given object implements the GetQuestionQuizzesInner interface.
+ */
+function instanceOfGetQuestionQuizzesInner(value) {
+    if (!('quizId' in value) || value['quizId'] === undefined)
+        return false;
+    if (!('quizName' in value) || value['quizName'] === undefined)
+        return false;
+    if (!('moduleId' in value) || value['moduleId'] === undefined)
+        return false;
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    return true;
+}
+function GetQuestionQuizzesInnerFromJSON(json) {
+    return GetQuestionQuizzesInnerFromJSONTyped(json, false);
+}
+function GetQuestionQuizzesInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'quizId': json['quiz_id'],
+        'quizName': json['quiz_name'],
+        'moduleId': json['module_id'],
+        'courseId': json['course_id'],
+    };
+}
+function GetQuestionQuizzesInnerToJSON(json) {
+    return GetQuestionQuizzesInnerToJSONTyped(json, false);
+}
+function GetQuestionQuizzesInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'quiz_id': value['quizId'],
+        'quiz_name': value['quizName'],
+        'module_id': value['moduleId'],
+        'course_id': value['courseId'],
+    };
+}

package/dist/models/PutCourse.d.ts

@@ -39,12 +39,6 @@ export interface PutCourse {
      * @memberof PutCourse
      */
     instructor?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof PutCourse
-     */
-    imageUrl?: string;
     /**
      * Whether the course is published and visible to students
      * @type {boolean}

package/dist/models/PutCourse.js

@@ -36,7 +36,6 @@ function PutCourseFromJSONTyped(json, ignoreDiscriminator) {
         'name': json['name'] == null ? undefined : json['name'],
         'description': json['description'] == null ? undefined : json['description'],
         'instructor': json['instructor'] == null ? undefined : json['instructor'],
-        'imageUrl': json['image_url'] == null ? undefined : json['image_url'],
         'published': json['published'] == null ? undefined : json['published'],
     };
 }
@@ -51,7 +50,6 @@ function PutCourseToJSONTyped(value, ignoreDiscriminator = false) {
         'name': value['name'],
         'description': value['description'],
         'instructor': value['instructor'],
-        'image_url': value['imageUrl'],
         'published': value['published'],
     };
 }

package/dist/models/index.d.ts

@@ -39,6 +39,7 @@ export * from './GetCourseEnrollmentList';
 export * from './GetCourseEnrollmentListItem';
 export * from './GetCourseExport';
 export * from './GetCourseExportList';
+export * from './GetCourseImageUpload';
 export * from './GetCourseList';
 export * from './GetCourseReportingBasic';
 export * from './GetCourseStudentReporting';
@@ -72,6 +73,7 @@ export * from './GetQuestion';
 export * from './GetQuestionAnswerChoicesInner';
 export * from './GetQuestionList';
 export * from './GetQuestionListFilters';
+export * from './GetQuestionQuizzesInner';
 export * from './GetQuiz';
 export * from './GetQuizAttempt';
 export * from './GetQuizAttemptAnalytics';

package/dist/models/index.js

@@ -57,6 +57,7 @@ __exportStar(require("./GetCourseEnrollmentList"), exports);
 __exportStar(require("./GetCourseEnrollmentListItem"), exports);
 __exportStar(require("./GetCourseExport"), exports);
 __exportStar(require("./GetCourseExportList"), exports);
+__exportStar(require("./GetCourseImageUpload"), exports);
 __exportStar(require("./GetCourseList"), exports);
 __exportStar(require("./GetCourseReportingBasic"), exports);
 __exportStar(require("./GetCourseStudentReporting"), exports);
@@ -90,6 +91,7 @@ __exportStar(require("./GetQuestion"), exports);
 __exportStar(require("./GetQuestionAnswerChoicesInner"), exports);
 __exportStar(require("./GetQuestionList"), exports);
 __exportStar(require("./GetQuestionListFilters"), exports);
+__exportStar(require("./GetQuestionQuizzesInner"), exports);
 __exportStar(require("./GetQuiz"), exports);
 __exportStar(require("./GetQuizAttempt"), exports);
 __exportStar(require("./GetQuizAttemptAnalytics"), exports);

package/docs/CourseApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**deleteCourseImage**](CourseApi.md#deletecourseimage) | **DELETE** /courses/{courseId}/image | Remove the course image |
 | [**getCourse**](CourseApi.md#getcourse) | **GET** /courses/{courseId} | get course |
 | [**getCourseEnrollment**](CourseApi.md#getcourseenrollment) | **GET** /courses/{courseId}/enrollments/{enrollmentId} | Get a specific course enrollment |
 | [**getCourseEnrollments**](CourseApi.md#getcourseenrollments) | **GET** /courses/{courseId}/enrollments | Get course enrollments |
@@ -14,11 +15,78 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**postCourse**](CourseApi.md#postcourse) | **POST** /courses | Post a new course |
 | [**postCourseEnrollment**](CourseApi.md#postcourseenrollment) | **POST** /courses/{courseId}/enrollments | Create a new course enrollment |
 | [**postCourseExport**](CourseApi.md#postcourseexport) | **POST** /courses/{courseId}/exports | Create a new SCORM export for a course |
+| [**postCourseImageUpload**](CourseApi.md#postcourseimageupload) | **POST** /courses/{courseId}/image | Upload a course image |
 | [**putCourse**](CourseApi.md#putcourse) | **PUT** /courses/{courseId} | Update a course by id |
 | [**putCourseEnrollment**](CourseApi.md#putcourseenrollment) | **PUT** /courses/{courseId}/enrollments/{enrollmentId} | Update a course enrollment |
 
 
 
+## deleteCourseImage
+
+> deleteCourseImage(courseId)
+
+Remove the course image
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteCourseImageRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+  } satisfies DeleteCourseImageRequest;
+
+  try {
+    const data = await api.deleteCourseImage(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Image removed successfully |  -  |
+| **404** | Course not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getCourse
 
 > GetCourse getCourse(courseId)
@@ -705,6 +773,76 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## postCourseImageUpload
+
+> GetCourseImageUpload postCourseImageUpload(courseId, file)
+
+Upload a course image
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { PostCourseImageUploadRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // Blob | Course image file (PNG, JPEG, or SVG). Max 5MB.
+    file: BINARY_DATA_HERE,
+  } satisfies PostCourseImageUploadRequest;
+
+  try {
+    const data = await api.postCourseImageUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **file** | `Blob` | Course image file (PNG, JPEG, or SVG). Max 5MB. | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetCourseImageUpload**](GetCourseImageUpload.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Image uploaded successfully |  -  |
+| **400** | Invalid file type or file too large |  -  |
+| **404** | Course not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## putCourse
 
 > GetCourse putCourse(courseId, putCourse)

package/docs/GetCourseImageUpload.md

@@ -0,0 +1,34 @@
+
+# GetCourseImageUpload
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`imageUrl` | string
+
+## Example
+
+```typescript
+import type { GetCourseImageUpload } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "imageUrl": null,
+} satisfies GetCourseImageUpload
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetCourseImageUpload
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetQuestion.md

@@ -21,6 +21,7 @@ Name | Type
 `updatedDate` | Date
 `createdBy` | string
 `quizCount` | number
+`quizzes` | [Array<GetQuestionQuizzesInner>](GetQuestionQuizzesInner.md)
 
 ## Example
 
@@ -44,6 +45,7 @@ const example = {
   "updatedDate": null,
   "createdBy": null,
   "quizCount": null,
+  "quizzes": null,
 } satisfies GetQuestion
 
 console.log(example)

package/docs/GetQuestionQuizzesInner.md

@@ -0,0 +1,40 @@
+
+# GetQuestionQuizzesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`quizId` | string
+`quizName` | string
+`moduleId` | string
+`courseId` | string
+
+## Example
+
+```typescript
+import type { GetQuestionQuizzesInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "quizId": null,
+  "quizName": null,
+  "moduleId": null,
+  "courseId": null,
+} satisfies GetQuestionQuizzesInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetQuestionQuizzesInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PutCourse.md

@@ -10,7 +10,6 @@ Name | Type
 `name` | string
 `description` | string
 `instructor` | string
-`imageUrl` | string
 `published` | boolean
 
 ## Example
@@ -24,7 +23,6 @@ const example = {
   "name": null,
   "description": null,
   "instructor": null,
-  "imageUrl": null,
   "published": null,
 } satisfies PutCourse
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.42.0",
+  "version": "1.44.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {