@easyedu/js-lsm-api 1.80.0 → 1.82.0

package/docs/RichTextApi.md

@@ -0,0 +1,285 @@
+# RichTextApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getRichTextAsset**](RichTextApi.md#getrichtextasset) | **GET** /rich-text/assets/{assetId} | Redirect to a signed rich text asset URL |
+| [**postRichTextAssetComplete**](RichTextApi.md#postrichtextassetcomplete) | **POST** /rich-text/assets/{assetId}/complete | Complete a pending rich text asset upload |
+| [**postRichTextAssetUpload**](RichTextApi.md#postrichtextassetupload) | **POST** /rich-text/assets/uploads | Create a pending rich text asset upload |
+| [**putRichTextAssetFile**](RichTextApi.md#putrichtextassetfile) | **PUT** /rich-text/assets/{assetId}/file | Upload a pending rich text asset file through the API |
+
+
+
+## getRichTextAsset
+
+> getRichTextAsset(assetId)
+
+Redirect to a signed rich text asset URL
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RichTextApi,
+} from '@easyedu/js-lsm-api';
+import type { GetRichTextAssetRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new RichTextApi();
+
+  const body = {
+    // string
+    assetId: assetId_example,
+  } satisfies GetRichTextAssetRequest;
+
+  try {
+    const data = await api.getRichTextAsset(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **assetId** | `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 |
+|-------------|-------------|------------------|
+| **302** | redirect to signed asset URL |  -  |
+| **404** | rich text asset 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)
+
+
+## postRichTextAssetComplete
+
+> RichTextAsset postRichTextAssetComplete(assetId, postRichTextAssetComplete)
+
+Complete a pending rich text asset upload
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RichTextApi,
+} from '@easyedu/js-lsm-api';
+import type { PostRichTextAssetCompleteRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new RichTextApi();
+
+  const body = {
+    // string
+    assetId: assetId_example,
+    // PostRichTextAssetComplete
+    postRichTextAssetComplete: ...,
+  } satisfies PostRichTextAssetCompleteRequest;
+
+  try {
+    const data = await api.postRichTextAssetComplete(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **assetId** | `string` |  | [Defaults to `undefined`] |
+| **postRichTextAssetComplete** | [PostRichTextAssetComplete](PostRichTextAssetComplete.md) |  | |
+
+### Return type
+
+[**RichTextAsset**](RichTextAsset.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | rich text asset completed |  -  |
+| **404** | rich text asset 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)
+
+
+## postRichTextAssetUpload
+
+> GetRichTextAssetUpload postRichTextAssetUpload(postRichTextAssetUpload)
+
+Create a pending rich text asset upload
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RichTextApi,
+} from '@easyedu/js-lsm-api';
+import type { PostRichTextAssetUploadRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new RichTextApi();
+
+  const body = {
+    // PostRichTextAssetUpload
+    postRichTextAssetUpload: ...,
+  } satisfies PostRichTextAssetUploadRequest;
+
+  try {
+    const data = await api.postRichTextAssetUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postRichTextAssetUpload** | [PostRichTextAssetUpload](PostRichTextAssetUpload.md) |  | |
+
+### Return type
+
+[**GetRichTextAssetUpload**](GetRichTextAssetUpload.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | rich text asset upload created |  -  |
+| **400** | invalid asset upload request |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putRichTextAssetFile
+
+> putRichTextAssetFile(assetId, body)
+
+Upload a pending rich text asset file through the API
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RichTextApi,
+} from '@easyedu/js-lsm-api';
+import type { PutRichTextAssetFileRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new RichTextApi();
+
+  const body = {
+    // string
+    assetId: assetId_example,
+    // Blob
+    body: BINARY_DATA_HERE,
+  } satisfies PutRichTextAssetFileRequest;
+
+  try {
+    const data = await api.putRichTextAssetFile(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **assetId** | `string` |  | [Defaults to `undefined`] |
+| **body** | `Blob` |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `image/png`, `image/jpeg`, `image/webp`, `image/gif`, `application/octet-stream`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | rich text asset file uploaded |  -  |
+| **400** | invalid upload |  -  |
+| **403** | forbidden |  -  |
+| **404** | rich text asset not found |  -  |
+| **413** | file too large |  -  |
+
+[[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/RichTextAsset.md

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

@@ -0,0 +1,40 @@
+
+# RichTextDocument
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`format` | string
+`document` | { [key: string]: any; }
+`plainText` | string
+`assets` | [Array<RichTextAsset>](RichTextAsset.md)
+
+## Example
+
+```typescript
+import type { RichTextDocument } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "format": null,
+  "document": null,
+  "plainText": null,
+  "assets": null,
+} satisfies RichTextDocument
+
+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 RichTextDocument
+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/RichTextInput.md

@@ -0,0 +1,36 @@
+
+# RichTextInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`format` | string
+`document` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { RichTextInput } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "format": null,
+  "document": null,
+} satisfies RichTextInput
+
+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 RichTextInput
+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/package.json

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

package/src/apis/RichTextApi.ts

@@ -0,0 +1,260 @@
+/* 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 * as runtime from '../runtime';
+import {
+    type GetRichTextAssetUpload,
+    GetRichTextAssetUploadFromJSON,
+    GetRichTextAssetUploadToJSON,
+} from '../models/GetRichTextAssetUpload';
+import {
+    type PostRichTextAssetComplete,
+    PostRichTextAssetCompleteFromJSON,
+    PostRichTextAssetCompleteToJSON,
+} from '../models/PostRichTextAssetComplete';
+import {
+    type PostRichTextAssetUpload,
+    PostRichTextAssetUploadFromJSON,
+    PostRichTextAssetUploadToJSON,
+} from '../models/PostRichTextAssetUpload';
+import {
+    type RichTextAsset,
+    RichTextAssetFromJSON,
+    RichTextAssetToJSON,
+} from '../models/RichTextAsset';
+
+export interface GetRichTextAssetRequest {
+    assetId: string;
+}
+
+export interface PostRichTextAssetCompleteRequest {
+    assetId: string;
+    postRichTextAssetComplete: PostRichTextAssetComplete;
+}
+
+export interface PostRichTextAssetUploadRequest {
+    postRichTextAssetUpload: PostRichTextAssetUpload;
+}
+
+export interface PutRichTextAssetFileRequest {
+    assetId: string;
+    body: Blob;
+}
+
+/**
+ * 
+ */
+export class RichTextApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for getRichTextAsset without sending the request
+     */
+    async getRichTextAssetRequestOpts(requestParameters: GetRichTextAssetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['assetId'] == null) {
+            throw new runtime.RequiredError(
+                'assetId',
+                'Required parameter "assetId" was null or undefined when calling getRichTextAsset().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/rich-text/assets/{assetId}`;
+        urlPath = urlPath.replace('{assetId}', encodeURIComponent(String(requestParameters['assetId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Redirect to a signed rich text asset URL
+     */
+    async getRichTextAssetRaw(requestParameters: GetRichTextAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.getRichTextAssetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Redirect to a signed rich text asset URL
+     */
+    async getRichTextAsset(requestParameters: GetRichTextAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getRichTextAssetRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for postRichTextAssetComplete without sending the request
+     */
+    async postRichTextAssetCompleteRequestOpts(requestParameters: PostRichTextAssetCompleteRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['assetId'] == null) {
+            throw new runtime.RequiredError(
+                'assetId',
+                'Required parameter "assetId" was null or undefined when calling postRichTextAssetComplete().'
+            );
+        }
+
+        if (requestParameters['postRichTextAssetComplete'] == null) {
+            throw new runtime.RequiredError(
+                'postRichTextAssetComplete',
+                'Required parameter "postRichTextAssetComplete" was null or undefined when calling postRichTextAssetComplete().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/rich-text/assets/{assetId}/complete`;
+        urlPath = urlPath.replace('{assetId}', encodeURIComponent(String(requestParameters['assetId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostRichTextAssetCompleteToJSON(requestParameters['postRichTextAssetComplete']),
+        };
+    }
+
+    /**
+     * Complete a pending rich text asset upload
+     */
+    async postRichTextAssetCompleteRaw(requestParameters: PostRichTextAssetCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RichTextAsset>> {
+        const requestOptions = await this.postRichTextAssetCompleteRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RichTextAssetFromJSON(jsonValue));
+    }
+
+    /**
+     * Complete a pending rich text asset upload
+     */
+    async postRichTextAssetComplete(requestParameters: PostRichTextAssetCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RichTextAsset> {
+        const response = await this.postRichTextAssetCompleteRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postRichTextAssetUpload without sending the request
+     */
+    async postRichTextAssetUploadRequestOpts(requestParameters: PostRichTextAssetUploadRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['postRichTextAssetUpload'] == null) {
+            throw new runtime.RequiredError(
+                'postRichTextAssetUpload',
+                'Required parameter "postRichTextAssetUpload" was null or undefined when calling postRichTextAssetUpload().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/rich-text/assets/uploads`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostRichTextAssetUploadToJSON(requestParameters['postRichTextAssetUpload']),
+        };
+    }
+
+    /**
+     * Create a pending rich text asset upload
+     */
+    async postRichTextAssetUploadRaw(requestParameters: PostRichTextAssetUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetRichTextAssetUpload>> {
+        const requestOptions = await this.postRichTextAssetUploadRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetRichTextAssetUploadFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a pending rich text asset upload
+     */
+    async postRichTextAssetUpload(requestParameters: PostRichTextAssetUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRichTextAssetUpload> {
+        const response = await this.postRichTextAssetUploadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for putRichTextAssetFile without sending the request
+     */
+    async putRichTextAssetFileRequestOpts(requestParameters: PutRichTextAssetFileRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['assetId'] == null) {
+            throw new runtime.RequiredError(
+                'assetId',
+                'Required parameter "assetId" was null or undefined when calling putRichTextAssetFile().'
+            );
+        }
+
+        if (requestParameters['body'] == null) {
+            throw new runtime.RequiredError(
+                'body',
+                'Required parameter "body" was null or undefined when calling putRichTextAssetFile().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'image/png';
+
+
+        let urlPath = `/rich-text/assets/{assetId}/file`;
+        urlPath = urlPath.replace('{assetId}', encodeURIComponent(String(requestParameters['assetId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters['body'] as any,
+        };
+    }
+
+    /**
+     * Upload a pending rich text asset file through the API
+     */
+    async putRichTextAssetFileRaw(requestParameters: PutRichTextAssetFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.putRichTextAssetFileRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Upload a pending rich text asset file through the API
+     */
+    async putRichTextAssetFile(requestParameters: PutRichTextAssetFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.putRichTextAssetFileRaw(requestParameters, initOverrides);
+    }
+
+}

package/src/apis/index.ts

@@ -15,6 +15,7 @@ export * from './PortalSublicenseApi';
 export * from './QuestionApi';
 export * from './QuizApi';
 export * from './ReportingApi';
+export * from './RichTextApi';
 export * from './RoleApi';
 export * from './SupportTicketApi';
 export * from './SystemApi';