@easyedu/js-lsm-api 1.107.0 → 1.109.0

package/docs/ContentLibraryQuizApi.md

@@ -313,7 +313,7 @@ No authorization required
 
 ## getLibraryQuizList
 
-> GetLibraryQuizList getLibraryQuizList(search, includeArchived, page, pageSize)
+> GetLibraryQuizList getLibraryQuizList(search, includeArchived, tagId, page, pageSize)
 
 List reusable quizzes
 
@@ -335,6 +335,8 @@ async function example() {
     search: search_example,
     // boolean (optional)
     includeArchived: true,
+    // string (optional)
+    tagId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // number (optional)
     page: 56,
     // number (optional)
@@ -360,6 +362,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **search** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **includeArchived** | `boolean` |  | [Optional] [Defaults to `false`] |
+| **tagId** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **page** | `number` |  | [Optional] [Defaults to `1`] |
 | **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
 

package/docs/ContentLibraryTag.md

@@ -0,0 +1,58 @@
+
+# ContentLibraryTag
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`key` | string
+`value` | string
+`archivedAt` | number
+`mergedIntoTagId` | string
+`totalItemCount` | number
+`activeItemCount` | number
+`archivedItemCount` | number
+`resourceCount` | number
+`quizCount` | number
+`createdAt` | number
+`updatedAt` | number
+
+## Example
+
+```typescript
+import type { ContentLibraryTag } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "key": null,
+  "value": null,
+  "archivedAt": null,
+  "mergedIntoTagId": null,
+  "totalItemCount": null,
+  "activeItemCount": null,
+  "archivedItemCount": null,
+  "resourceCount": null,
+  "quizCount": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies ContentLibraryTag
+
+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 ContentLibraryTag
+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/ContentLibraryTagItem.md

@@ -0,0 +1,48 @@
+
+# ContentLibraryTagItem
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`kind` | string
+`name` | string
+`description` | string
+`resourceType` | [ResourceType](ResourceType.md)
+`tags` | [Array<ContentLibraryTag>](ContentLibraryTag.md)
+`updatedAt` | number
+`archivedAt` | number
+
+## Example
+
+```typescript
+import type { ContentLibraryTagItem } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "kind": null,
+  "name": null,
+  "description": null,
+  "resourceType": null,
+  "tags": null,
+  "updatedAt": null,
+  "archivedAt": null,
+} satisfies ContentLibraryTagItem
+
+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 ContentLibraryTagItem
+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/CourseApi.md

@@ -1812,7 +1812,7 @@ No authorization required
 
 Create a new SCORM export for a course
 
-Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status.  **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED 
+Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status.  **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Visible resource placements in the selected sections are exported - Reusable quiz placements are skipped and do not block the export - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED 
 
 ### Example
 

package/docs/CourseCatalogApi.md

@@ -285,7 +285,7 @@ No authorization required
 
 ## getCourseCatalogs
 
-> Array<CourseCatalog> getCourseCatalogs()
+> GetCourseCatalogList getCourseCatalogs(page, pageSize)
 
 List catalogs in the current portal
 
@@ -302,8 +302,15 @@ async function example() {
   console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
   const api = new CourseCatalogApi();
 
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies GetCourseCatalogsRequest;
+
   try {
-    const data = await api.getCourseCatalogs();
+    const data = await api.getCourseCatalogs(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -316,11 +323,15 @@ example().catch(console.error);
 
 ### Parameters
 
-This endpoint does not need any parameter.
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
 
 ### Return type
 
-[**Array<CourseCatalog>**](CourseCatalog.md)
+[**GetCourseCatalogList**](GetCourseCatalogList.md)
 
 ### Authorization
 

package/docs/CourseShareAcceptError.md

@@ -0,0 +1,37 @@
+
+# CourseShareAcceptError
+
+A safe, actionable error returned when a course-share offer cannot be accepted.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { CourseShareAcceptError } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": null,
+  "message": null,
+} satisfies CourseShareAcceptError
+
+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 CourseShareAcceptError
+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/CourseShareApi.md

@@ -87,7 +87,7 @@ No authorization required
 
 ## getCourseSharesOfferedByMe
 
-> Array<CourseShare> getCourseSharesOfferedByMe(state)
+> GetCourseShareList getCourseSharesOfferedByMe(page, pageSize, courseId, state)
 
 List shares the current portal has offered out
 
@@ -105,6 +105,12 @@ async function example() {
   const api = new CourseShareApi();
 
   const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+    // string | Filter by an owned course external ID (optional)
+    courseId: courseId_example,
     // 'offered' | 'accepted_mirror' | 'accepted_clone' | 'declined' | 'revoked' | Filter by share state (case-insensitive) (optional)
     state: state_example,
   } satisfies GetCourseSharesOfferedByMeRequest;
@@ -126,11 +132,14 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+| **courseId** | `string` | Filter by an owned course external ID | [Optional] [Defaults to `undefined`] |
 | **state** | `offered`, `accepted_mirror`, `accepted_clone`, `declined`, `revoked` | Filter by share state (case-insensitive) | [Optional] [Defaults to `undefined`] [Enum: offered, accepted_mirror, accepted_clone, declined, revoked] |
 
 ### Return type
 
-[**Array<CourseShare>**](CourseShare.md)
+[**GetCourseShareList**](GetCourseShareList.md)
 
 ### Authorization
 
@@ -153,11 +162,11 @@ No authorization required
 
 ## getCourseSharesOfferedToMe
 
-> Array<CourseShare> getCourseSharesOfferedToMe(state)
+> GetCourseShareList getCourseSharesOfferedToMe(page, pageSize, state)
 
 List shares offered to the current portal
 
-Returns every `course_share` row where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter. 
+Returns `course_share` rows where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter. 
 
 ### Example
 
@@ -173,6 +182,10 @@ async function example() {
   const api = new CourseShareApi();
 
   const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
     // 'offered' | 'accepted_mirror' | 'accepted_clone' | 'declined' | 'revoked' | Filter by share state (case-insensitive) (optional)
     state: state_example,
   } satisfies GetCourseSharesOfferedToMeRequest;
@@ -194,11 +207,13 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
 | **state** | `offered`, `accepted_mirror`, `accepted_clone`, `declined`, `revoked` | Filter by share state (case-insensitive) | [Optional] [Defaults to `undefined`] [Enum: offered, accepted_mirror, accepted_clone, declined, revoked] |
 
 ### Return type
 
-[**Array<CourseShare>**](CourseShare.md)
+[**GetCourseShareList**](GetCourseShareList.md)
 
 ### Authorization
 
@@ -484,15 +499,19 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: `application/json`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Accepted, course cloned |  -  |
+| **400** | Invalid portal or request |  -  |
 | **403** | Share not addressed to your portal, or mode not allowed |  -  |
 | **404** | Share not found |  -  |
+| **409** | Share or source course is not in a cloneable state |  -  |
+| **503** | Course storage could not be copied |  -  |
+| **500** | Acceptance failed unexpectedly |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -551,15 +570,18 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: `application/json`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Accepted |  -  |
+| **400** | Invalid portal or request |  -  |
 | **403** | Share not addressed to your portal, or mode not allowed |  -  |
 | **404** | Share not found |  -  |
+| **409** | Share is no longer available for mirror acceptance |  -  |
+| **500** | Acceptance failed unexpectedly |  -  |
 
 [[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/GetContentLibraryTagItemList.md

@@ -0,0 +1,42 @@
+
+# GetContentLibraryTagItemList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<ContentLibraryTagItem>](ContentLibraryTagItem.md)
+
+## Example
+
+```typescript
+import type { GetContentLibraryTagItemList } 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 GetContentLibraryTagItemList
+
+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 GetContentLibraryTagItemList
+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/GetContentLibraryTagList.md

@@ -0,0 +1,42 @@
+
+# GetContentLibraryTagList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<ContentLibraryTag>](ContentLibraryTag.md)
+
+## Example
+
+```typescript
+import type { GetContentLibraryTagList } 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 GetContentLibraryTagList
+
+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 GetContentLibraryTagList
+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/GetCourseCatalogList.md

@@ -0,0 +1,42 @@
+
+# GetCourseCatalogList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<CourseCatalog>](CourseCatalog.md)
+
+## Example
+
+```typescript
+import type { GetCourseCatalogList } 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 GetCourseCatalogList
+
+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 GetCourseCatalogList
+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/GetCourseShareList.md

@@ -0,0 +1,42 @@
+
+# GetCourseShareList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<CourseShare>](CourseShare.md)
+
+## Example
+
+```typescript
+import type { GetCourseShareList } 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 GetCourseShareList
+
+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 GetCourseShareList
+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/GetLibraryQuiz.md

@@ -11,6 +11,7 @@ Name | Type
 `name` | string
 `description` | string
 `ownerId` | string
+`tags` | [Array<ContentLibraryTag>](ContentLibraryTag.md)
 `latestPublishedVersion` | [GetLibraryQuizVersion](GetLibraryQuizVersion.md)
 `draftVersion` | [GetLibraryQuizVersion](GetLibraryQuizVersion.md)
 `versions` | [Array<GetLibraryQuizVersion>](GetLibraryQuizVersion.md)
@@ -34,6 +35,7 @@ const example = {
   "name": null,
   "description": null,
   "ownerId": null,
+  "tags": null,
   "latestPublishedVersion": null,
   "draftVersion": null,
   "versions": null,

package/docs/GetQuestion.md

@@ -12,7 +12,6 @@ Name | Type
 `answerChoices` | [Array<GetQuestionAnswerChoicesInner>](GetQuestionAnswerChoicesInner.md)
 `correctAnswer` | string
 `explanation` | [RichTextDocument](RichTextDocument.md)
-`topic` | string
 `difficultyLevel` | string
 `tags` | Array<string>
 `version` | string
@@ -36,7 +35,6 @@ const example = {
   "answerChoices": null,
   "correctAnswer": null,
   "explanation": null,
-  "topic": null,
   "difficultyLevel": null,
   "tags": null,
   "version": null,

package/docs/GetQuestionListFilters.md

@@ -6,7 +6,6 @@
 
 Name | Type
 ------------ | -------------
-`topic` | string
 `questionType` | string
 `difficultyLevel` | string
 `tags` | Array<string>
@@ -21,7 +20,6 @@ import type { GetQuestionListFilters } from '@easyedu/js-lsm-api'
 
 // TODO: Update the object below with actual values
 const example = {
-  "topic": null,
   "questionType": null,
   "difficultyLevel": null,
   "tags": null,

package/docs/GetResource.md

@@ -11,6 +11,7 @@ Name | Type
 `description` | string
 `resourceType` | [ResourceType](ResourceType.md)
 `ownerId` | string
+`tags` | [Array<ContentLibraryTag>](ContentLibraryTag.md)
 `latestPublishedVersion` | [GetContentLibraryVersion](GetContentLibraryVersion.md)
 `draftVersion` | [GetContentLibraryVersion](GetContentLibraryVersion.md)
 `versions` | [Array<GetContentLibraryVersion>](GetContentLibraryVersion.md)
@@ -34,6 +35,7 @@ const example = {
   "description": null,
   "resourceType": null,
   "ownerId": null,
+  "tags": null,
   "latestPublishedVersion": null,
   "draftVersion": null,
   "versions": null,

package/docs/LibraryQuizCriteriaPreviewQuestion.md

@@ -11,7 +11,6 @@ Name | Type
 `questionType` | string
 `versionNumber` | number
 `version` | string
-`topic` | string
 `difficultyLevel` | string
 `tags` | Array<string>
 
@@ -27,7 +26,6 @@ const example = {
   "questionType": null,
   "versionNumber": null,
   "version": null,
-  "topic": null,
   "difficultyLevel": null,
   "tags": null,
 } satisfies LibraryQuizCriteriaPreviewQuestion

package/docs/LibraryQuizCriterion.md

@@ -7,7 +7,6 @@
 Name | Type
 ------------ | -------------
 `id` | string
-`topic` | string
 `difficultyLevel` | string
 `questionType` | string
 `tags` | Array<string>
@@ -23,7 +22,6 @@ import type { LibraryQuizCriterion } from '@easyedu/js-lsm-api'
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
-  "topic": null,
   "difficultyLevel": null,
   "questionType": null,
   "tags": null,

package/docs/PostContentLibraryTag.md

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

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