@easyedu/js-lsm-api 1.77.0 → 1.79.0

package/docs/PortalUserFieldGroup.md

@@ -0,0 +1,44 @@
+
+# PortalUserFieldGroup
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`key` | string
+`label` | string
+`description` | string
+`displayOrder` | number
+`isActive` | boolean
+
+## Example
+
+```typescript
+import type { PortalUserFieldGroup } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "key": null,
+  "label": null,
+  "description": null,
+  "displayOrder": null,
+  "isActive": null,
+} satisfies PortalUserFieldGroup
+
+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 PortalUserFieldGroup
+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/PortalUserFieldMissingRequired.md

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

@@ -0,0 +1,42 @@
+
+# PortalUserFieldOption
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`value` | string
+`label` | string
+`displayOrder` | number
+`isActive` | boolean
+
+## Example
+
+```typescript
+import type { PortalUserFieldOption } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "value": null,
+  "label": null,
+  "displayOrder": null,
+  "isActive": null,
+} satisfies PortalUserFieldOption
+
+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 PortalUserFieldOption
+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/PortalUserFieldValueField.md

@@ -0,0 +1,50 @@
+
+# PortalUserFieldValueField
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`key` | string
+`label` | string
+`description` | string
+`fieldType` | string
+`isRequired` | boolean
+`displayOrder` | number
+`value` | object
+`options` | [Array<PortalUserFieldOption>](PortalUserFieldOption.md)
+
+## Example
+
+```typescript
+import type { PortalUserFieldValueField } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "key": null,
+  "label": null,
+  "description": null,
+  "fieldType": null,
+  "isRequired": null,
+  "displayOrder": null,
+  "value": null,
+  "options": null,
+} satisfies PortalUserFieldValueField
+
+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 PortalUserFieldValueField
+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/PortalUserFieldValueGroup.md

@@ -0,0 +1,42 @@
+
+# PortalUserFieldValueGroup
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`key` | string
+`label` | string
+`displayOrder` | number
+`fields` | [Array<PortalUserFieldValueField>](PortalUserFieldValueField.md)
+
+## Example
+
+```typescript
+import type { PortalUserFieldValueGroup } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "key": null,
+  "label": null,
+  "displayOrder": null,
+  "fields": null,
+} satisfies PortalUserFieldValueGroup
+
+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 PortalUserFieldValueGroup
+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/PortalUserFieldValueInput.md

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

@@ -0,0 +1,55 @@
+
+# PostCourseResume
+
+Launch-ready course resume target for the current learner.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`courseId` | string
+`moduleId` | string
+`contentId` | string
+`contentSessionId` | string
+`launchUrl` | string
+`launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
+`createdAt` | number
+`playerSessionId` | string
+`attemptNumber` | number
+`isCurrent` | boolean
+`selectionReason` | string
+
+## Example
+
+```typescript
+import type { PostCourseResume } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "courseId": null,
+  "moduleId": null,
+  "contentId": null,
+  "contentSessionId": null,
+  "launchUrl": null,
+  "launchMode": null,
+  "createdAt": null,
+  "playerSessionId": null,
+  "attemptNumber": null,
+  "isCurrent": null,
+  "selectionReason": null,
+} satisfies PostCourseResume
+
+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 PostCourseResume
+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/PutPortalUserFieldValues.md

@@ -0,0 +1,34 @@
+
+# PutPortalUserFieldValues
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`values` | [Array<PortalUserFieldValueInput>](PortalUserFieldValueInput.md)
+
+## Example
+
+```typescript
+import type { PutPortalUserFieldValues } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "values": null,
+} satisfies PutPortalUserFieldValues
+
+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 PutPortalUserFieldValues
+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.77.0",
+  "version": "1.79.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/CourseApi.ts

@@ -68,6 +68,11 @@ import {
     PostCourseExportFromJSON,
     PostCourseExportToJSON,
 } from '../models/PostCourseExport';
+import {
+    type PostCourseResume,
+    PostCourseResumeFromJSON,
+    PostCourseResumeToJSON,
+} from '../models/PostCourseResume';
 import {
     type PostDuplicate,
     PostDuplicateFromJSON,
@@ -172,6 +177,10 @@ export interface PostCourseImageUploadRequest {
     file: Blob;
 }
 
+export interface PostCourseResumeRequest {
+    courseId: string;
+}
+
 export interface PutCourseRequest {
     courseId: string;
     putCourse: Omit<PutCourse, 'id'>;
@@ -1088,6 +1097,60 @@ export class CourseApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for postCourseResume without sending the request
+     */
+    async postCourseResumeRequestOpts(requestParameters: PostCourseResumeRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling postCourseResume().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/courses/{courseId}/resume`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Selects the first incomplete published content item in course order, creates or reuses the current live content session, and returns a launch-ready response.
+     * Resume the current learner\'s progress in a course
+     */
+    async postCourseResumeRaw(requestParameters: PostCourseResumeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostCourseResume>> {
+        const requestOptions = await this.postCourseResumeRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PostCourseResumeFromJSON(jsonValue));
+    }
+
+    /**
+     * Selects the first incomplete published content item in course order, creates or reuses the current live content session, and returns a launch-ready response.
+     * Resume the current learner\'s progress in a course
+     */
+    async postCourseResume(requestParameters: PostCourseResumeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostCourseResume | null | undefined > {
+        const response = await this.postCourseResumeRaw(requestParameters, initOverrides);
+        switch (response.raw.status) {
+            case 200:
+                return await response.value();
+            case 204:
+                return null;
+            default:
+                return await response.value();
+        }
+    }
+
     /**
      * Creates request options for putCourse without sending the request
      */