@easyedu/js-lsm-api 1.66.0 → 1.67.0

package/docs/PortalApi.md

@@ -7,9 +7,13 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**deletePortalFavicon**](PortalApi.md#deleteportalfavicon) | **DELETE** /portals/{portalId}/branding/favicon | Remove the portal favicon |
 | [**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) |
+| [**getPortalFaviconAsset**](PortalApi.md#getportalfaviconasset) | **GET** /portals/{portalId}/branding/favicon | Stream the configured portal favicon |
 | [**getPortalList**](PortalApi.md#getportallist) | **GET** /portals | Get all portals a user has access to |
+| [**getPortalLogoAsset**](PortalApi.md#getportallogoasset) | **GET** /portals/{portalId}/branding/logo | Stream the configured portal logo |
 | [**getPortalUsers**](PortalApi.md#getportalusers) | **GET** /portals/{portalId}/users | Get all users for a portal with optional role filtering |
 | [**getPublicPortalBranding**](PortalApi.md#getpublicportalbranding) | **GET** /public/portal/branding | Public portal branding resolved from the request host |
+| [**getPublicPortalFaviconAsset**](PortalApi.md#getpublicportalfaviconasset) | **GET** /public/portal/branding/favicon | Public portal favicon resolved from the request host |
+| [**getPublicPortalLogoAsset**](PortalApi.md#getpublicportallogoasset) | **GET** /public/portal/branding/logo | Public portal logo resolved from the request host |
 | [**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 |
 | [**postPortalFaviconUpload**](PortalApi.md#postportalfaviconupload) | **POST** /portals/{portalId}/branding/favicon | Upload a favicon image for portal branding |
@@ -217,6 +221,72 @@ 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)
 
 
+## getPortalFaviconAsset
+
+> Blob getPortalFaviconAsset(portalId)
+
+Stream the configured portal favicon
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPortalFaviconAssetRequest } 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 GetPortalFaviconAssetRequest;
+
+  try {
+    const data = await api.getPortalFaviconAsset(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
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `image/png`, `image/jpeg`, `image/svg+xml`, `image/x-icon`, `application/octet-stream`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Portal favicon image |  -  |
+| **404** | Portal or favicon 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)
+
+
 ## getPortalList
 
 > GetPortalList getPortalList()
@@ -274,6 +344,72 @@ 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)
 
 
+## getPortalLogoAsset
+
+> Blob getPortalLogoAsset(portalId)
+
+Stream the configured portal logo
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPortalLogoAssetRequest } 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 GetPortalLogoAssetRequest;
+
+  try {
+    const data = await api.getPortalLogoAsset(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
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `image/png`, `image/jpeg`, `image/svg+xml`, `application/octet-stream`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Portal logo image |  -  |
+| **404** | Portal or logo 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)
+
+
 ## getPortalUsers
 
 > GetPortalUserList getPortalUsers(portalId, type, roles, search, page, pageSize)
@@ -417,6 +553,128 @@ 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)
 
 
+## getPublicPortalFaviconAsset
+
+> Blob getPublicPortalFaviconAsset()
+
+Public portal favicon resolved from the request host
+
+Resolves the browser Origin/Referer/Host to a portal and streams its configured favicon.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPublicPortalFaviconAssetRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalApi();
+
+  try {
+    const data = await api.getPublicPortalFaviconAsset();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `image/png`, `image/jpeg`, `image/svg+xml`, `image/x-icon`, `application/octet-stream`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Public portal favicon image |  -  |
+| **400** | Invalid portal host |  -  |
+| **404** | Portal host or favicon 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)
+
+
+## getPublicPortalLogoAsset
+
+> Blob getPublicPortalLogoAsset()
+
+Public portal logo resolved from the request host
+
+Resolves the browser Origin/Referer/Host to a portal and streams its configured logo.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPublicPortalLogoAssetRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalApi();
+
+  try {
+    const data = await api.getPublicPortalLogoAsset();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `image/png`, `image/jpeg`, `image/svg+xml`, `application/octet-stream`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Public portal logo image |  -  |
+| **400** | Invalid portal host |  -  |
+| **404** | Portal host or logo 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)
+
+
 ## inviteUserToPortal
 
 > inviteUserToPortal(portalId, postPortalInvite)

package/docs/PostContentSession.md

@@ -10,6 +10,7 @@ Name | Type
 `contentId` | string
 `userId` | string
 `launchUrl` | string
+`launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
 `createdAt` | number
 `playerSessionId` | string
 
@@ -23,6 +24,7 @@ const example = {
   "contentId": null,
   "userId": null,
   "launchUrl": null,
+  "launchMode": null,
   "createdAt": null,
   "playerSessionId": null,
 } satisfies PostContentSession

package/docs/PutContent.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `name` | string
 `published` | boolean
+`launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
 
 ## Example
 
@@ -18,6 +19,7 @@ import type { PutContent } from '@easyedu/js-lsm-api'
 const example = {
   "name": null,
   "published": null,
+  "launchMode": null,
 } satisfies PutContent
 
 console.log(example)

package/docs/SupportTicketApi.md

@@ -86,7 +86,7 @@ No authorization required
 
 ## downloadSupportTicketAttachment
 
-> DownloadSupportTicketAttachment200Response downloadSupportTicketAttachment(ticketId, attachmentId)
+> Blob downloadSupportTicketAttachment(ticketId, attachmentId)
 
 Download a ticket attachment
 
@@ -132,7 +132,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**DownloadSupportTicketAttachment200Response**](DownloadSupportTicketAttachment200Response.md)
+**Blob**
 
 ### Authorization
 
@@ -141,13 +141,13 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: `application/json`
+- **Accept**: `application/octet-stream`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Presigned download URL |  -  |
+| **200** | Attachment file |  -  |
 | **401** | Unauthorized |  -  |
 | **403** | Forbidden |  -  |
 | **404** | Attachment not found |  -  |

package/package.json

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

package/src/apis/ContentApi.ts

@@ -258,6 +258,13 @@ export interface PutContentReorderRequest {
     putContentReorder: PutContentReorder;
 }
 
+export interface PutContentUploadFileRequest {
+    courseId: string;
+    moduleId: string;
+    uploadId: number;
+    body: Blob;
+}
+
 export interface PutContentVersionRequest {
     contentId: string;
     moduleId: string;
@@ -1634,6 +1641,76 @@ export class ContentApi extends runtime.BaseAPI {
         await this.putContentReorderRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for putContentUploadFile without sending the request
+     */
+    async putContentUploadFileRequestOpts(requestParameters: PutContentUploadFileRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling putContentUploadFile().'
+            );
+        }
+
+        if (requestParameters['moduleId'] == null) {
+            throw new runtime.RequiredError(
+                'moduleId',
+                'Required parameter "moduleId" was null or undefined when calling putContentUploadFile().'
+            );
+        }
+
+        if (requestParameters['uploadId'] == null) {
+            throw new runtime.RequiredError(
+                'uploadId',
+                'Required parameter "uploadId" was null or undefined when calling putContentUploadFile().'
+            );
+        }
+
+        if (requestParameters['body'] == null) {
+            throw new runtime.RequiredError(
+                'body',
+                'Required parameter "body" was null or undefined when calling putContentUploadFile().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/octet-stream';
+
+
+        let urlPath = `/courses/{courseId}/modules/{moduleId}/contents/uploads/{uploadId}/file`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
+        urlPath = urlPath.replace('{uploadId}', encodeURIComponent(String(requestParameters['uploadId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters['body'] as any,
+        };
+    }
+
+    /**
+     * Upload content file through the API
+     */
+    async putContentUploadFileRaw(requestParameters: PutContentUploadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.putContentUploadFileRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Upload content file through the API
+     */
+    async putContentUploadFile(requestParameters: PutContentUploadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.putContentUploadFileRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Creates request options for putContentVersion without sending the request
      */

package/src/apis/CourseApi.ts

@@ -102,6 +102,11 @@ export interface DeleteCourseImageRequest {
     courseId: string;
 }
 
+export interface DownloadCourseExportRequest {
+    courseId: string;
+    exportId: string;
+}
+
 export interface GetCourseRequest {
     courseId: string;
 }
@@ -375,6 +380,59 @@ export class CourseApi extends runtime.BaseAPI {
         await this.deleteCourseImageRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for downloadCourseExport without sending the request
+     */
+    async downloadCourseExportRequestOpts(requestParameters: DownloadCourseExportRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling downloadCourseExport().'
+            );
+        }
+
+        if (requestParameters['exportId'] == null) {
+            throw new runtime.RequiredError(
+                'exportId',
+                'Required parameter "exportId" was null or undefined when calling downloadCourseExport().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/courses/{courseId}/exports/{exportId}/download`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{exportId}', encodeURIComponent(String(requestParameters['exportId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Download a completed course export
+     */
+    async downloadCourseExportRaw(requestParameters: DownloadCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
+        const requestOptions = await this.downloadCourseExportRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.BlobApiResponse(response);
+    }
+
+    /**
+     * Download a completed course export
+     */
+    async downloadCourseExport(requestParameters: DownloadCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
+        const response = await this.downloadCourseExportRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getCourse without sending the request
      */