@easyedu/js-lsm-api 1.108.0 → 1.110.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,60 @@
+
+# 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
+`questionCount` | 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,
+  "questionCount": 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/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

@@ -499,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)
 
@@ -566,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/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,9 +12,7 @@ Name | Type
 `answerChoices` | [Array<GetQuestionAnswerChoicesInner>](GetQuestionAnswerChoicesInner.md)
 `correctAnswer` | string
 `explanation` | [RichTextDocument](RichTextDocument.md)
-`topic` | string
-`difficultyLevel` | string
-`tags` | Array<string>
+`tags` | [Array<ContentLibraryTag>](ContentLibraryTag.md)
 `version` | string
 `versionNumber` | number
 `createdDate` | Date
@@ -36,8 +34,6 @@ const example = {
   "answerChoices": null,
   "correctAnswer": null,
   "explanation": null,
-  "topic": null,
-  "difficultyLevel": null,
   "tags": null,
   "version": null,
   "versionNumber": null,

package/docs/GetQuestionListFilters.md

@@ -6,10 +6,8 @@
 
 Name | Type
 ------------ | -------------
-`topic` | string
 `questionType` | string
-`difficultyLevel` | string
-`tags` | Array<string>
+`tagId` | string
 `search` | string
 `createdAfter` | Date
 `createdBefore` | Date
@@ -21,10 +19,8 @@ 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,
+  "tagId": null,
   "search": null,
   "createdAfter": null,
   "createdBefore": 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,8 +11,6 @@ Name | Type
 `questionType` | string
 `versionNumber` | number
 `version` | string
-`topic` | string
-`difficultyLevel` | string
 `tags` | Array<string>
 
 ## Example
@@ -27,8 +25,6 @@ const example = {
   "questionType": null,
   "versionNumber": null,
   "version": null,
-  "topic": null,
-  "difficultyLevel": null,
   "tags": null,
 } satisfies LibraryQuizCriteriaPreviewQuestion
 

package/docs/LibraryQuizCriterion.md

@@ -7,8 +7,6 @@
 Name | Type
 ------------ | -------------
 `id` | string
-`topic` | string
-`difficultyLevel` | string
 `questionType` | string
 `tags` | Array<string>
 `minQuestions` | number
@@ -23,8 +21,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,
   "minQuestions": 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)
+
+

package/docs/PostLibraryQuiz.md

@@ -19,6 +19,7 @@ Name | Type
 `allowReview` | boolean
 `requireAllQuestions` | boolean
 `settings` | { [key: string]: any; }
+`tags` | Set<string>
 
 ## Example
 
@@ -40,6 +41,7 @@ const example = {
   "allowReview": null,
   "requireAllQuestions": null,
   "settings": null,
+  "tags": null,
 } satisfies PostLibraryQuiz
 
 console.log(example)

package/docs/PostQuestion.md

@@ -11,8 +11,6 @@ Name | Type
 `answerChoices` | [Array<PostQuestionAnswerChoicesInner>](PostQuestionAnswerChoicesInner.md)
 `correctAnswer` | string
 `explanation` | [RichTextInput](RichTextInput.md)
-`topic` | string
-`difficultyLevel` | string
 `tags` | Array<string>
 `version` | string
 
@@ -28,8 +26,6 @@ const example = {
   "answerChoices": null,
   "correctAnswer": null,
   "explanation": null,
-  "topic": null,
-  "difficultyLevel": null,
   "tags": null,
   "version": null,
 } satisfies PostQuestion

package/docs/PostResource.md

@@ -11,6 +11,7 @@ Name | Type
 `resourceType` | [ResourceType](ResourceType.md)
 `linkUrl` | string
 `richText` | [RichTextInput](RichTextInput.md)
+`tags` | Set<string>
 
 ## Example
 
@@ -24,6 +25,7 @@ const example = {
   "resourceType": null,
   "linkUrl": null,
   "richText": null,
+  "tags": null,
 } satisfies PostResource
 
 console.log(example)

package/docs/PutContentLibraryTag.md

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

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `name` | string
 `description` | string
+`tags` | Set<string>
 
 ## Example
 
@@ -18,6 +19,7 @@ import type { PutLibraryQuiz } from '@easyedu/js-lsm-api'
 const example = {
   "name": null,
   "description": null,
+  "tags": null,
 } satisfies PutLibraryQuiz
 
 console.log(example)

package/docs/PutQuestion.md

@@ -11,8 +11,6 @@ Name | Type
 `answerChoices` | [Array<PutQuestionAnswerChoicesInner>](PutQuestionAnswerChoicesInner.md)
 `correctAnswer` | string
 `explanation` | [RichTextInput](RichTextInput.md)
-`topic` | string
-`difficultyLevel` | string
 `tags` | Array<string>
 `version` | string
 
@@ -28,8 +26,6 @@ const example = {
   "answerChoices": null,
   "correctAnswer": null,
   "explanation": null,
-  "topic": null,
-  "difficultyLevel": null,
   "tags": null,
   "version": null,
 } satisfies PutQuestion

package/docs/PutResource.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `name` | string
 `description` | string
+`tags` | Set<string>
 
 ## Example
 
@@ -18,6 +19,7 @@ import type { PutResource } from '@easyedu/js-lsm-api'
 const example = {
   "name": null,
   "description": null,
+  "tags": null,
 } satisfies PutResource
 
 console.log(example)

package/docs/QuestionApi.md

@@ -147,7 +147,7 @@ No authorization required
 
 ## getQuestionList
 
-> GetQuestionList getQuestionList(page, pageSize, topic, questionType, difficultyLevel, tags, search)
+> GetQuestionList getQuestionList(page, pageSize, questionType, tagId, search)
 
 Get list of questions with filtering and pagination
 
@@ -169,14 +169,10 @@ async function example() {
     page: 56,
     // number | Number of items per page (optional)
     pageSize: 56,
-    // string | Filter by topic (optional)
-    topic: topic_example,
     // 'single_answer' | 'multiple_answer' | 'fill_in_blank' | Filter by question type (optional)
     questionType: questionType_example,
-    // 'beginner' | 'intermediate' | 'advanced' | Filter by difficulty level (optional)
-    difficultyLevel: difficultyLevel_example,
-    // Array<string> | Filter by tags (optional)
-    tags: ...,
+    // string | Filter by a shared tag (optional)
+    tagId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // string | Search in question text (optional)
     search: search_example,
   } satisfies GetQuestionListRequest;
@@ -200,10 +196,8 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **page** | `number` | Page number | [Optional] [Defaults to `1`] |
 | **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
-| **topic** | `string` | Filter by topic | [Optional] [Defaults to `undefined`] |
 | **questionType** | `single_answer`, `multiple_answer`, `fill_in_blank` | Filter by question type | [Optional] [Defaults to `undefined`] [Enum: single_answer, multiple_answer, fill_in_blank] |
-| **difficultyLevel** | `beginner`, `intermediate`, `advanced` | Filter by difficulty level | [Optional] [Defaults to `undefined`] [Enum: beginner, intermediate, advanced] |
-| **tags** | `Array<string>` | Filter by tags | [Optional] |
+| **tagId** | `string` | Filter by a shared tag | [Optional] [Defaults to `undefined`] |
 | **search** | `string` | Search in question text | [Optional] [Defaults to `undefined`] |
 
 ### Return type

package/package.json

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