@easyedu/js-lsm-api 1.40.0 → 1.42.0

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';
@@ -61,6 +62,7 @@ export * from './GetPortalBasicReporting';
 export * from './GetPortalBasicReportingCertificates';
 export * from './GetPortalBasicReportingPortalInfo';
 export * from './GetPortalList';
+export * from './GetPortalLogoUpload';
 export * from './GetPortalStudentReporting';
 export * from './GetPortalStudentReportingCertificates';
 export * from './GetPortalStudentReportingPortalInfo';
@@ -122,6 +124,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';
@@ -179,6 +185,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';
@@ -197,6 +205,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';
@@ -214,3 +223,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);
@@ -79,6 +80,7 @@ __exportStar(require("./GetPortalBasicReporting"), exports);
 __exportStar(require("./GetPortalBasicReportingCertificates"), exports);
 __exportStar(require("./GetPortalBasicReportingPortalInfo"), exports);
 __exportStar(require("./GetPortalList"), exports);
+__exportStar(require("./GetPortalLogoUpload"), exports);
 __exportStar(require("./GetPortalStudentReporting"), exports);
 __exportStar(require("./GetPortalStudentReportingCertificates"), exports);
 __exportStar(require("./GetPortalStudentReportingPortalInfo"), exports);
@@ -140,6 +142,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);
@@ -197,6 +203,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);
@@ -215,6 +223,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);
@@ -232,3 +241,4 @@ __exportStar(require("./ScormSetValueResponse"), exports);
 __exportStar(require("./ShortAnswer"), exports);
 __exportStar(require("./ShortAnswer1"), exports);
 __exportStar(require("./SingleAnswer"), exports);
+__exportStar(require("./SupportTicketUser"), exports);

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/GetPortalLogoUpload.md

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

@@ -4,16 +4,84 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**deletePortalLogo**](PortalApi.md#deleteportallogo) | **DELETE** /portals/{portalId}/branding/logo | Remove the portal logo |
 | [**getPortalById**](PortalApi.md#getportalbyid) | **GET** /portals/{portalId} | Get a portal by id (can use \'current\' to get the current users selected portal) |
 | [**getPortalList**](PortalApi.md#getportallist) | **GET** /portals | Get all portals a user has access to |
 | [**getPortalUsers**](PortalApi.md#getportalusers) | **GET** /portals/{portalId}/users | Get all users for a portal with optional role filtering |
 | [**inviteUserToPortal**](PortalApi.md#inviteusertoportal) | **POST** /portals/{portalId}/invite | Invite a new user to a portal |
 | [**postPortal**](PortalApi.md#postportal) | **POST** /portals | Create a new portal as a child of the current selected portal |
+| [**postPortalLogoUpload**](PortalApi.md#postportallogoupload) | **POST** /portals/{portalId}/branding/logo | Upload a logo image for portal branding |
 | [**putPortalBranding**](PortalApi.md#putportalbranding) | **PUT** /portals/{portalId} | Update portal branding (name, background color, text color) |
 | [**updateSelectedPortal**](PortalApi.md#updateselectedportal) | **PUT** /portals/{portalId}/selected | Update the users current selected portal. Returns new JWT with updated roles. |
 
 
 
+## deletePortalLogo
+
+> deletePortalLogo(portalId)
+
+Remove the portal logo
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { DeletePortalLogoRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+  } satisfies DeletePortalLogoRequest;
+
+  try {
+    const data = await api.deletePortalLogo(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **portalId** | `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** | Logo removed successfully |  -  |
+| **404** | Portal 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)
+
+
 ## getPortalById
 
 > GetPortal getPortalById(portalId)
@@ -353,6 +421,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)
 
 
+## postPortalLogoUpload
+
+> GetPortalLogoUpload postPortalLogoUpload(portalId, file)
+
+Upload a logo image for portal branding
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { PostPortalLogoUploadRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+    // Blob | Logo image file (PNG, JPEG, or SVG). Max 5MB.
+    file: BINARY_DATA_HERE,
+  } satisfies PostPortalLogoUploadRequest;
+
+  try {
+    const data = await api.postPortalLogoUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+| **file** | `Blob` | Logo image file (PNG, JPEG, or SVG). Max 5MB. | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetPortalLogoUpload**](GetPortalLogoUpload.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** | Logo uploaded successfully |  -  |
+| **400** | Invalid file type or file too large |  -  |
+| **404** | Portal 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)
+
+
 ## putPortalBranding
 
 > GetPortal putPortalBranding(portalId, putPortalBranding)

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/PutSupportTicket.md

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