@easyedu/js-lsm-api 1.80.0 → 1.81.0

package/dist/models/RichTextDocument.js

@@ -0,0 +1,70 @@
+"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.RichTextDocumentFormatEnum = void 0;
+exports.instanceOfRichTextDocument = instanceOfRichTextDocument;
+exports.RichTextDocumentFromJSON = RichTextDocumentFromJSON;
+exports.RichTextDocumentFromJSONTyped = RichTextDocumentFromJSONTyped;
+exports.RichTextDocumentToJSON = RichTextDocumentToJSON;
+exports.RichTextDocumentToJSONTyped = RichTextDocumentToJSONTyped;
+const RichTextAsset_1 = require("./RichTextAsset");
+/**
+ * @export
+ */
+exports.RichTextDocumentFormatEnum = {
+    TiptapV2: 'tiptap-v2'
+};
+/**
+ * Check if a given object implements the RichTextDocument interface.
+ */
+function instanceOfRichTextDocument(value) {
+    if (!('format' in value) || value['format'] === undefined)
+        return false;
+    if (!('document' in value) || value['document'] === undefined)
+        return false;
+    if (!('plainText' in value) || value['plainText'] === undefined)
+        return false;
+    if (!('assets' in value) || value['assets'] === undefined)
+        return false;
+    return true;
+}
+function RichTextDocumentFromJSON(json) {
+    return RichTextDocumentFromJSONTyped(json, false);
+}
+function RichTextDocumentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'format': json['format'],
+        'document': json['document'],
+        'plainText': json['plain_text'],
+        'assets': (json['assets'].map(RichTextAsset_1.RichTextAssetFromJSON)),
+    };
+}
+function RichTextDocumentToJSON(json) {
+    return RichTextDocumentToJSONTyped(json, false);
+}
+function RichTextDocumentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'format': value['format'],
+        'document': value['document'],
+        'plain_text': value['plainText'],
+        'assets': (value['assets'].map(RichTextAsset_1.RichTextAssetToJSON)),
+    };
+}

package/dist/models/RichTextInput.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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 RichTextInput
+ */
+export interface RichTextInput {
+    /**
+     * Rich text document format
+     * @type {RichTextInputFormatEnum}
+     * @memberof RichTextInput
+     */
+    format: RichTextInputFormatEnum;
+    /**
+     * TipTap/ProseMirror JSON document
+     * @type {{ [key: string]: any; }}
+     * @memberof RichTextInput
+     */
+    document: {
+        [key: string]: any;
+    };
+}
+/**
+ * @export
+ */
+export declare const RichTextInputFormatEnum: {
+    readonly TiptapV2: "tiptap-v2";
+};
+export type RichTextInputFormatEnum = typeof RichTextInputFormatEnum[keyof typeof RichTextInputFormatEnum];
+/**
+ * Check if a given object implements the RichTextInput interface.
+ */
+export declare function instanceOfRichTextInput(value: object): value is RichTextInput;
+export declare function RichTextInputFromJSON(json: any): RichTextInput;
+export declare function RichTextInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): RichTextInput;
+export declare function RichTextInputToJSON(json: any): RichTextInput;
+export declare function RichTextInputToJSONTyped(value?: RichTextInput | null, ignoreDiscriminator?: boolean): any;

package/dist/models/RichTextInput.js

@@ -0,0 +1,61 @@
+"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.RichTextInputFormatEnum = void 0;
+exports.instanceOfRichTextInput = instanceOfRichTextInput;
+exports.RichTextInputFromJSON = RichTextInputFromJSON;
+exports.RichTextInputFromJSONTyped = RichTextInputFromJSONTyped;
+exports.RichTextInputToJSON = RichTextInputToJSON;
+exports.RichTextInputToJSONTyped = RichTextInputToJSONTyped;
+/**
+ * @export
+ */
+exports.RichTextInputFormatEnum = {
+    TiptapV2: 'tiptap-v2'
+};
+/**
+ * Check if a given object implements the RichTextInput interface.
+ */
+function instanceOfRichTextInput(value) {
+    if (!('format' in value) || value['format'] === undefined)
+        return false;
+    if (!('document' in value) || value['document'] === undefined)
+        return false;
+    return true;
+}
+function RichTextInputFromJSON(json) {
+    return RichTextInputFromJSONTyped(json, false);
+}
+function RichTextInputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'format': json['format'],
+        'document': json['document'],
+    };
+}
+function RichTextInputToJSON(json) {
+    return RichTextInputToJSONTyped(json, false);
+}
+function RichTextInputToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'format': value['format'],
+        'document': value['document'],
+    };
+}

package/dist/models/index.d.ts

@@ -137,6 +137,7 @@ export * from './GetQuizResultsQuestionsInnerStudentAnswer';
 export * from './GetQuizResultsScore';
 export * from './GetQuizResultsTiming';
 export * from './GetQuizStatistics';
+export * from './GetRichTextAssetUpload';
 export * from './GetRole';
 export * from './GetScormApiLogItem';
 export * from './GetScormApiLogs';
@@ -234,6 +235,8 @@ export * from './PostQuizQuestionsQuestionsInner';
 export * from './PostQuizSettings';
 export * from './PostResetPassword';
 export * from './PostRevokeCertificate';
+export * from './PostRichTextAssetComplete';
+export * from './PostRichTextAssetUpload';
 export * from './PostRole';
 export * from './PostSendResetPassword';
 export * from './PostSignupRequest';
@@ -270,6 +273,9 @@ export * from './PutUser';
 export * from './QuizContent';
 export * from './QuizContentAssignment';
 export * from './QuizContentSettings';
+export * from './RichTextAsset';
+export * from './RichTextDocument';
+export * from './RichTextInput';
 export * from './SCORMContent';
 export * from './ScormGetValueResponse';
 export * from './ScormSessionData';

package/dist/models/index.js

@@ -155,6 +155,7 @@ __exportStar(require("./GetQuizResultsQuestionsInnerStudentAnswer"), exports);
 __exportStar(require("./GetQuizResultsScore"), exports);
 __exportStar(require("./GetQuizResultsTiming"), exports);
 __exportStar(require("./GetQuizStatistics"), exports);
+__exportStar(require("./GetRichTextAssetUpload"), exports);
 __exportStar(require("./GetRole"), exports);
 __exportStar(require("./GetScormApiLogItem"), exports);
 __exportStar(require("./GetScormApiLogs"), exports);
@@ -252,6 +253,8 @@ __exportStar(require("./PostQuizQuestionsQuestionsInner"), exports);
 __exportStar(require("./PostQuizSettings"), exports);
 __exportStar(require("./PostResetPassword"), exports);
 __exportStar(require("./PostRevokeCertificate"), exports);
+__exportStar(require("./PostRichTextAssetComplete"), exports);
+__exportStar(require("./PostRichTextAssetUpload"), exports);
 __exportStar(require("./PostRole"), exports);
 __exportStar(require("./PostSendResetPassword"), exports);
 __exportStar(require("./PostSignupRequest"), exports);
@@ -288,6 +291,9 @@ __exportStar(require("./PutUser"), exports);
 __exportStar(require("./QuizContent"), exports);
 __exportStar(require("./QuizContentAssignment"), exports);
 __exportStar(require("./QuizContentSettings"), exports);
+__exportStar(require("./RichTextAsset"), exports);
+__exportStar(require("./RichTextDocument"), exports);
+__exportStar(require("./RichTextInput"), exports);
 __exportStar(require("./SCORMContent"), exports);
 __exportStar(require("./ScormGetValueResponse"), exports);
 __exportStar(require("./ScormSessionData"), exports);

package/docs/GetQuestion.md

@@ -7,11 +7,11 @@
 Name | Type
 ------------ | -------------
 `id` | string
-`questionText` | string
+`questionText` | [RichTextDocument](RichTextDocument.md)
 `questionType` | string
 `answerChoices` | [Array<GetQuestionAnswerChoicesInner>](GetQuestionAnswerChoicesInner.md)
 `correctAnswer` | string
-`explanation` | string
+`explanation` | [RichTextDocument](RichTextDocument.md)
 `topic` | string
 `difficultyLevel` | string
 `tags` | Array<string>

package/docs/GetQuestionAnswerChoicesInner.md

@@ -7,7 +7,7 @@
 Name | Type
 ------------ | -------------
 `id` | string
-`text` | string
+`text` | [RichTextDocument](RichTextDocument.md)
 `isCorrect` | boolean
 
 ## Example

package/docs/GetRichTextAssetUpload.md

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

@@ -6,11 +6,11 @@
 
 Name | Type
 ------------ | -------------
-`questionText` | string
+`questionText` | [RichTextInput](RichTextInput.md)
 `questionType` | string
 `answerChoices` | [Array<PostQuestionAnswerChoicesInner>](PostQuestionAnswerChoicesInner.md)
 `correctAnswer` | string
-`explanation` | string
+`explanation` | [RichTextInput](RichTextInput.md)
 `topic` | string
 `difficultyLevel` | string
 `tags` | Array<string>

package/docs/PostQuestionAnswerChoicesInner.md

@@ -6,7 +6,7 @@
 
 Name | Type
 ------------ | -------------
-`text` | string
+`text` | [RichTextInput](RichTextInput.md)
 `isCorrect` | boolean
 
 ## Example

package/docs/PostRichTextAssetComplete.md

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

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

@@ -6,11 +6,11 @@
 
 Name | Type
 ------------ | -------------
-`questionText` | string
+`questionText` | [RichTextInput](RichTextInput.md)
 `questionType` | string
 `answerChoices` | [Array<PutQuestionAnswerChoicesInner>](PutQuestionAnswerChoicesInner.md)
 `correctAnswer` | string
-`explanation` | string
+`explanation` | [RichTextInput](RichTextInput.md)
 `topic` | string
 `difficultyLevel` | string
 `tags` | Array<string>

package/docs/PutQuestionAnswerChoicesInner.md

@@ -7,7 +7,7 @@
 Name | Type
 ------------ | -------------
 `id` | string
-`text` | string
+`text` | [RichTextInput](RichTextInput.md)
 `isCorrect` | boolean
 
 ## Example

package/docs/RichTextApi.md

@@ -0,0 +1,212 @@
+# 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 |
+
+
+
+## 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)
+

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)
+
+