@easyedu/js-lsm-api 1.41.0 → 1.43.0

package/dist/models/SupportTicketUser.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.instanceOfSupportTicketUser = instanceOfSupportTicketUser;
+exports.SupportTicketUserFromJSON = SupportTicketUserFromJSON;
+exports.SupportTicketUserFromJSONTyped = SupportTicketUserFromJSONTyped;
+exports.SupportTicketUserToJSON = SupportTicketUserToJSON;
+exports.SupportTicketUserToJSONTyped = SupportTicketUserToJSONTyped;
+/**
+ * Check if a given object implements the SupportTicketUser interface.
+ */
+function instanceOfSupportTicketUser(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('email' in value) || value['email'] === undefined)
+        return false;
+    if (!('firstName' in value) || value['firstName'] === undefined)
+        return false;
+    if (!('lastName' in value) || value['lastName'] === undefined)
+        return false;
+    return true;
+}
+function SupportTicketUserFromJSON(json) {
+    return SupportTicketUserFromJSONTyped(json, false);
+}
+function SupportTicketUserFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'email': json['email'],
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+    };
+}
+function SupportTicketUserToJSON(json) {
+    return SupportTicketUserToJSONTyped(json, false);
+}
+function SupportTicketUserToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'email': value['email'],
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+    };
+}

package/dist/models/index.d.ts

@@ -1,6 +1,7 @@
 export * from './CriteriaBasedSelection';
 export * from './CriteriaBasedSelectionCriteria';
 export * from './CriteriaBasedSelectionDistribution';
+export * from './DownloadSupportTicketAttachment200Response';
 export * from './Essay';
 export * from './Essay1';
 export * from './FillInBlank';
@@ -38,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';
@@ -123,6 +125,10 @@ export * from './GetScormPackage';
 export * from './GetScormPackagePackageInfo';
 export * from './GetScormSessionData';
 export * from './GetScormSessionDataActivity';
+export * from './GetSupportTicket';
+export * from './GetSupportTicketAttachment';
+export * from './GetSupportTicketComment';
+export * from './GetSupportTicketList';
 export * from './GetUser';
 export * from './GetUserQuizAttempts';
 export * from './GetUserQuizAttemptsAllOfAttempts';
@@ -180,6 +186,8 @@ export * from './PostQuizSettings';
 export * from './PostResetPassword';
 export * from './PostRole';
 export * from './PostSendResetPassword';
+export * from './PostSupportTicket';
+export * from './PostSupportTicketComment';
 export * from './PostVerifyManifest';
 export * from './PostVerifyManifestItemsInner';
 export * from './PostVerifyManifestResourcesInner';
@@ -198,6 +206,7 @@ export * from './PutQuizAnswerGrade';
 export * from './PutQuizSettings';
 export * from './PutRole';
 export * from './PutRolePermissions';
+export * from './PutSupportTicket';
 export * from './PutUser';
 export * from './QuizContent';
 export * from './QuizContentAssignment';
@@ -215,3 +224,4 @@ export * from './ScormSetValueResponse';
 export * from './ShortAnswer';
 export * from './ShortAnswer1';
 export * from './SingleAnswer';
+export * from './SupportTicketUser';

package/dist/models/index.js

@@ -19,6 +19,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./CriteriaBasedSelection"), exports);
 __exportStar(require("./CriteriaBasedSelectionCriteria"), exports);
 __exportStar(require("./CriteriaBasedSelectionDistribution"), exports);
+__exportStar(require("./DownloadSupportTicketAttachment200Response"), exports);
 __exportStar(require("./Essay"), exports);
 __exportStar(require("./Essay1"), exports);
 __exportStar(require("./FillInBlank"), exports);
@@ -56,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);
@@ -141,6 +143,10 @@ __exportStar(require("./GetScormPackage"), exports);
 __exportStar(require("./GetScormPackagePackageInfo"), exports);
 __exportStar(require("./GetScormSessionData"), exports);
 __exportStar(require("./GetScormSessionDataActivity"), exports);
+__exportStar(require("./GetSupportTicket"), exports);
+__exportStar(require("./GetSupportTicketAttachment"), exports);
+__exportStar(require("./GetSupportTicketComment"), exports);
+__exportStar(require("./GetSupportTicketList"), exports);
 __exportStar(require("./GetUser"), exports);
 __exportStar(require("./GetUserQuizAttempts"), exports);
 __exportStar(require("./GetUserQuizAttemptsAllOfAttempts"), exports);
@@ -198,6 +204,8 @@ __exportStar(require("./PostQuizSettings"), exports);
 __exportStar(require("./PostResetPassword"), exports);
 __exportStar(require("./PostRole"), exports);
 __exportStar(require("./PostSendResetPassword"), exports);
+__exportStar(require("./PostSupportTicket"), exports);
+__exportStar(require("./PostSupportTicketComment"), exports);
 __exportStar(require("./PostVerifyManifest"), exports);
 __exportStar(require("./PostVerifyManifestItemsInner"), exports);
 __exportStar(require("./PostVerifyManifestResourcesInner"), exports);
@@ -216,6 +224,7 @@ __exportStar(require("./PutQuizAnswerGrade"), exports);
 __exportStar(require("./PutQuizSettings"), exports);
 __exportStar(require("./PutRole"), exports);
 __exportStar(require("./PutRolePermissions"), exports);
+__exportStar(require("./PutSupportTicket"), exports);
 __exportStar(require("./PutUser"), exports);
 __exportStar(require("./QuizContent"), exports);
 __exportStar(require("./QuizContentAssignment"), exports);
@@ -233,3 +242,4 @@ __exportStar(require("./ScormSetValueResponse"), exports);
 __exportStar(require("./ShortAnswer"), exports);
 __exportStar(require("./ShortAnswer1"), exports);
 __exportStar(require("./SingleAnswer"), exports);
+__exportStar(require("./SupportTicketUser"), 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/DownloadSupportTicketAttachment200Response.md

@@ -0,0 +1,34 @@
+
+# DownloadSupportTicketAttachment200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`downloadUrl` | string
+
+## Example
+
+```typescript
+import type { DownloadSupportTicketAttachment200Response } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "downloadUrl": null,
+} satisfies DownloadSupportTicketAttachment200Response
+
+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 DownloadSupportTicketAttachment200Response
+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/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/GetSupportTicket.md

@@ -0,0 +1,60 @@
+
+# GetSupportTicket
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`portalId` | string
+`subject` | string
+`description` | string
+`status` | string
+`priority` | string
+`category` | string
+`reporter` | [SupportTicketUser](SupportTicketUser.md)
+`assignedTo` | [SupportTicketUser](SupportTicketUser.md)
+`commentCount` | number
+`attachments` | [Array<GetSupportTicketAttachment>](GetSupportTicketAttachment.md)
+`createdAt` | number
+`updatedAt` | number
+`closedAt` | number
+
+## Example
+
+```typescript
+import type { GetSupportTicket } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "portalId": null,
+  "subject": null,
+  "description": null,
+  "status": null,
+  "priority": null,
+  "category": null,
+  "reporter": null,
+  "assignedTo": null,
+  "commentCount": null,
+  "attachments": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "closedAt": null,
+} satisfies GetSupportTicket
+
+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 GetSupportTicket
+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/GetSupportTicketAttachment.md

@@ -0,0 +1,44 @@
+
+# GetSupportTicketAttachment
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`fileName` | string
+`fileSize` | number
+`mimeType` | string
+`downloadUrl` | string
+`createdAt` | number
+
+## Example
+
+```typescript
+import type { GetSupportTicketAttachment } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "fileName": null,
+  "fileSize": null,
+  "mimeType": null,
+  "downloadUrl": null,
+  "createdAt": null,
+} satisfies GetSupportTicketAttachment
+
+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 GetSupportTicketAttachment
+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/GetSupportTicketComment.md

@@ -0,0 +1,42 @@
+
+# GetSupportTicketComment
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`user` | [SupportTicketUser](SupportTicketUser.md)
+`content` | string
+`isInternal` | boolean
+`createdAt` | number
+
+## Example
+
+```typescript
+import type { GetSupportTicketComment } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "user": null,
+  "content": null,
+  "isInternal": null,
+  "createdAt": null,
+} satisfies GetSupportTicketComment
+
+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 GetSupportTicketComment
+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/GetSupportTicketList.md

@@ -0,0 +1,42 @@
+
+# GetSupportTicketList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<GetSupportTicket>](GetSupportTicket.md)
+
+## Example
+
+```typescript
+import type { GetSupportTicketList } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "page": null,
+  "pageSize": null,
+  "totalPages": null,
+  "totalItems": null,
+  "items": null,
+} satisfies GetSupportTicketList
+
+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 GetSupportTicketList
+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/PostSupportTicket.md

@@ -0,0 +1,40 @@
+
+# PostSupportTicket
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`subject` | string
+`description` | string
+`priority` | string
+`category` | string
+
+## Example
+
+```typescript
+import type { PostSupportTicket } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "subject": null,
+  "description": null,
+  "priority": null,
+  "category": null,
+} satisfies PostSupportTicket
+
+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 PostSupportTicket
+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/PostSupportTicketComment.md

@@ -0,0 +1,36 @@
+
+# PostSupportTicketComment
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`content` | string
+`isInternal` | boolean
+
+## Example
+
+```typescript
+import type { PostSupportTicketComment } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "content": null,
+  "isInternal": null,
+} satisfies PostSupportTicketComment
+
+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 PostSupportTicketComment
+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