@easyedu/js-lsm-api 1.77.0 → 1.79.0

package/dist/models/PutPortalUserFieldValues.js

@@ -0,0 +1,51 @@
+"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.instanceOfPutPortalUserFieldValues = instanceOfPutPortalUserFieldValues;
+exports.PutPortalUserFieldValuesFromJSON = PutPortalUserFieldValuesFromJSON;
+exports.PutPortalUserFieldValuesFromJSONTyped = PutPortalUserFieldValuesFromJSONTyped;
+exports.PutPortalUserFieldValuesToJSON = PutPortalUserFieldValuesToJSON;
+exports.PutPortalUserFieldValuesToJSONTyped = PutPortalUserFieldValuesToJSONTyped;
+const PortalUserFieldValueInput_1 = require("./PortalUserFieldValueInput");
+/**
+ * Check if a given object implements the PutPortalUserFieldValues interface.
+ */
+function instanceOfPutPortalUserFieldValues(value) {
+    if (!('values' in value) || value['values'] === undefined)
+        return false;
+    return true;
+}
+function PutPortalUserFieldValuesFromJSON(json) {
+    return PutPortalUserFieldValuesFromJSONTyped(json, false);
+}
+function PutPortalUserFieldValuesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'values': (json['values'].map(PortalUserFieldValueInput_1.PortalUserFieldValueInputFromJSON)),
+    };
+}
+function PutPortalUserFieldValuesToJSON(json) {
+    return PutPortalUserFieldValuesToJSONTyped(json, false);
+}
+function PutPortalUserFieldValuesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'values': (value['values'].map(PortalUserFieldValueInput_1.PortalUserFieldValueInputToJSON)),
+    };
+}

package/dist/models/index.d.ts

@@ -84,6 +84,7 @@ export * from './GetPortalStudentReporting';
 export * from './GetPortalStudentReportingCertificates';
 export * from './GetPortalStudentReportingPortalInfo';
 export * from './GetPortalUser';
+export * from './GetPortalUserFieldValues';
 export * from './GetPortalUserList';
 export * from './GetPublicPortalBranding';
 export * from './GetQuestion';
@@ -172,6 +173,14 @@ export * from './MultipleAnswer1';
 export * from './NoAnswer';
 export * from './Paginated';
 export * from './PortalSublicense';
+export * from './PortalUserFieldConfig';
+export * from './PortalUserFieldDefinition';
+export * from './PortalUserFieldGroup';
+export * from './PortalUserFieldMissingRequired';
+export * from './PortalUserFieldOption';
+export * from './PortalUserFieldValueField';
+export * from './PortalUserFieldValueGroup';
+export * from './PortalUserFieldValueInput';
 export * from './PostCertificate';
 export * from './PostCertificateConfig';
 export * from './PostContentQuiz';
@@ -186,6 +195,7 @@ export * from './PostCourse';
 export * from './PostCourseCatalog';
 export * from './PostCourseEnrollment';
 export * from './PostCourseExport';
+export * from './PostCourseResume';
 export * from './PostDuplicate';
 export * from './PostDuplicate1';
 export * from './PostDuplicate2';
@@ -239,6 +249,7 @@ export * from './PutModule';
 export * from './PutModuleReorder';
 export * from './PutPortalBranding';
 export * from './PutPortalSublicense';
+export * from './PutPortalUserFieldValues';
 export * from './PutQuestion';
 export * from './PutQuestionAnswerChoicesInner';
 export * from './PutQuiz';

package/dist/models/index.js

@@ -102,6 +102,7 @@ __exportStar(require("./GetPortalStudentReporting"), exports);
 __exportStar(require("./GetPortalStudentReportingCertificates"), exports);
 __exportStar(require("./GetPortalStudentReportingPortalInfo"), exports);
 __exportStar(require("./GetPortalUser"), exports);
+__exportStar(require("./GetPortalUserFieldValues"), exports);
 __exportStar(require("./GetPortalUserList"), exports);
 __exportStar(require("./GetPublicPortalBranding"), exports);
 __exportStar(require("./GetQuestion"), exports);
@@ -190,6 +191,14 @@ __exportStar(require("./MultipleAnswer1"), exports);
 __exportStar(require("./NoAnswer"), exports);
 __exportStar(require("./Paginated"), exports);
 __exportStar(require("./PortalSublicense"), exports);
+__exportStar(require("./PortalUserFieldConfig"), exports);
+__exportStar(require("./PortalUserFieldDefinition"), exports);
+__exportStar(require("./PortalUserFieldGroup"), exports);
+__exportStar(require("./PortalUserFieldMissingRequired"), exports);
+__exportStar(require("./PortalUserFieldOption"), exports);
+__exportStar(require("./PortalUserFieldValueField"), exports);
+__exportStar(require("./PortalUserFieldValueGroup"), exports);
+__exportStar(require("./PortalUserFieldValueInput"), exports);
 __exportStar(require("./PostCertificate"), exports);
 __exportStar(require("./PostCertificateConfig"), exports);
 __exportStar(require("./PostContentQuiz"), exports);
@@ -204,6 +213,7 @@ __exportStar(require("./PostCourse"), exports);
 __exportStar(require("./PostCourseCatalog"), exports);
 __exportStar(require("./PostCourseEnrollment"), exports);
 __exportStar(require("./PostCourseExport"), exports);
+__exportStar(require("./PostCourseResume"), exports);
 __exportStar(require("./PostDuplicate"), exports);
 __exportStar(require("./PostDuplicate1"), exports);
 __exportStar(require("./PostDuplicate2"), exports);
@@ -257,6 +267,7 @@ __exportStar(require("./PutModule"), exports);
 __exportStar(require("./PutModuleReorder"), exports);
 __exportStar(require("./PutPortalBranding"), exports);
 __exportStar(require("./PutPortalSublicense"), exports);
+__exportStar(require("./PutPortalUserFieldValues"), exports);
 __exportStar(require("./PutQuestion"), exports);
 __exportStar(require("./PutQuestionAnswerChoicesInner"), exports);
 __exportStar(require("./PutQuiz"), exports);

package/docs/CourseApi.md

@@ -21,6 +21,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**postCourseEnrollment**](CourseApi.md#postcourseenrollment) | **POST** /courses/{courseId}/enrollments | Create a new course enrollment |
 | [**postCourseExport**](CourseApi.md#postcourseexport) | **POST** /courses/{courseId}/exports | Create a new SCORM export for a course |
 | [**postCourseImageUpload**](CourseApi.md#postcourseimageupload) | **POST** /courses/{courseId}/image | Upload a course image |
+| [**postCourseResume**](CourseApi.md#postcourseresume) | **POST** /courses/{courseId}/resume | Resume the current learner\'s progress in a course |
 | [**putCourse**](CourseApi.md#putcourse) | **PUT** /courses/{courseId} | Update a course by id |
 | [**putCourseEnrollment**](CourseApi.md#putcourseenrollment) | **PUT** /courses/{courseId}/enrollments/{enrollmentId} | Update a course enrollment |
 
@@ -1216,6 +1217,77 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## postCourseResume
+
+> PostCourseResume postCourseResume(courseId)
+
+Resume the current learner\'s progress in a course
+
+Selects the first incomplete published content item in course order, creates or reuses the current live content session, and returns a launch-ready response.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { PostCourseResumeRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+  } satisfies PostCourseResumeRequest;
+
+  try {
+    const data = await api.postCourseResume(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**PostCourseResume**](PostCourseResume.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Launch-ready course resume target |  -  |
+| **204** | No incomplete published content remains in the course |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Course 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)
+
+
 ## putCourse
 
 > GetCourse putCourse(courseId, putCourse)

package/docs/GetPortalUserFieldValues.md

@@ -0,0 +1,40 @@
+
+# GetPortalUserFieldValues
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`complete` | boolean
+`missingRequiredFields` | [Array<PortalUserFieldMissingRequired>](PortalUserFieldMissingRequired.md)
+`groups` | [Array<PortalUserFieldValueGroup>](PortalUserFieldValueGroup.md)
+`ungroupedFields` | [Array<PortalUserFieldValueField>](PortalUserFieldValueField.md)
+
+## Example
+
+```typescript
+import type { GetPortalUserFieldValues } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "complete": null,
+  "missingRequiredFields": null,
+  "groups": null,
+  "ungroupedFields": null,
+} satisfies GetPortalUserFieldValues
+
+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 GetPortalUserFieldValues
+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/PortalApi.md

@@ -10,6 +10,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getPortalFaviconAsset**](PortalApi.md#getportalfaviconasset) | **GET** /portals/{portalId}/branding/favicon | Stream the configured portal favicon |
 | [**getPortalList**](PortalApi.md#getportallist) | **GET** /portals | Get all portals a user has access to |
 | [**getPortalLogoAsset**](PortalApi.md#getportallogoasset) | **GET** /portals/{portalId}/branding/logo | Stream the configured portal logo |
+| [**getPortalUserFieldConfig**](PortalApi.md#getportaluserfieldconfig) | **GET** /portals/{portalId}/user-field-config | Get portal user field configuration |
+| [**getPortalUserFieldValues**](PortalApi.md#getportaluserfieldvalues) | **GET** /portals/{portalId}/users/{userId}/user-field-values | Get a user\'s portal field values and completion status |
 | [**getPortalUsers**](PortalApi.md#getportalusers) | **GET** /portals/{portalId}/users | Get all users for a portal with optional role filtering |
 | [**getPublicPortalBranding**](PortalApi.md#getpublicportalbranding) | **GET** /public/portal/branding | Public portal branding resolved from the request host |
 | [**getPublicPortalFaviconAsset**](PortalApi.md#getpublicportalfaviconasset) | **GET** /public/portal/branding/favicon | Public portal favicon resolved from the request host |
@@ -19,6 +21,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**postPortalFaviconUpload**](PortalApi.md#postportalfaviconupload) | **POST** /portals/{portalId}/branding/favicon | Upload a favicon image for portal branding |
 | [**postPortalLogoUpload**](PortalApi.md#postportallogoupload) | **POST** /portals/{portalId}/branding/logo | Upload a logo image for portal branding |
 | [**putPortalBranding**](PortalApi.md#putportalbranding) | **PUT** /portals/{portalId} | Update portal branding (name, background color, text color) |
+| [**putPortalUserFieldConfig**](PortalApi.md#putportaluserfieldconfig) | **PUT** /portals/{portalId}/user-field-config | Replace portal user field configuration |
+| [**putPortalUserFieldValues**](PortalApi.md#putportaluserfieldvalues) | **PUT** /portals/{portalId}/users/{userId}/user-field-values | Bulk upsert a user\'s portal field values |
 | [**removePortalUser**](PortalApi.md#removeportaluser) | **DELETE** /portals/{portalId}/users/{userId} | Remove a user from a portal |
 | [**updateSelectedPortal**](PortalApi.md#updateselectedportal) | **PUT** /portals/{portalId}/selected | Update the users current selected portal. Returns new JWT with updated roles. |
 
@@ -410,6 +414,144 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getPortalUserFieldConfig
+
+> PortalUserFieldConfig getPortalUserFieldConfig(portalId)
+
+Get portal user field configuration
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPortalUserFieldConfigRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+  } satisfies GetPortalUserFieldConfigRequest;
+
+  try {
+    const data = await api.getPortalUserFieldConfig(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**PortalUserFieldConfig**](PortalUserFieldConfig.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Portal user field configuration |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Portal 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)
+
+
+## getPortalUserFieldValues
+
+> GetPortalUserFieldValues getPortalUserFieldValues(portalId, userId)
+
+Get a user\'s portal field values and completion status
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPortalUserFieldValuesRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+    // string
+    userId: userId_example,
+  } satisfies GetPortalUserFieldValuesRequest;
+
+  try {
+    const data = await api.getPortalUserFieldValues(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+| **userId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetPortalUserFieldValues**](GetPortalUserFieldValues.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Portal user field values |  -  |
+| **400** | Invalid request |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Portal or user 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)
+
+
 ## getPortalUsers
 
 > GetPortalUserList getPortalUsers(portalId, type, roles, search, page, pageSize)
@@ -1020,6 +1162,151 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## putPortalUserFieldConfig
+
+> PortalUserFieldConfig putPortalUserFieldConfig(portalId, portalUserFieldConfig)
+
+Replace portal user field configuration
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { PutPortalUserFieldConfigRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+    // PortalUserFieldConfig
+    portalUserFieldConfig: ...,
+  } satisfies PutPortalUserFieldConfigRequest;
+
+  try {
+    const data = await api.putPortalUserFieldConfig(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+| **portalUserFieldConfig** | [PortalUserFieldConfig](PortalUserFieldConfig.md) |  | |
+
+### Return type
+
+[**PortalUserFieldConfig**](PortalUserFieldConfig.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Portal user field configuration |  -  |
+| **400** | Invalid field configuration |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Portal 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)
+
+
+## putPortalUserFieldValues
+
+> GetPortalUserFieldValues putPortalUserFieldValues(portalId, userId, putPortalUserFieldValues)
+
+Bulk upsert a user\'s portal field values
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { PutPortalUserFieldValuesRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+    // string
+    userId: userId_example,
+    // PutPortalUserFieldValues
+    putPortalUserFieldValues: ...,
+  } satisfies PutPortalUserFieldValuesRequest;
+
+  try {
+    const data = await api.putPortalUserFieldValues(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+| **userId** | `string` |  | [Defaults to `undefined`] |
+| **putPortalUserFieldValues** | [PutPortalUserFieldValues](PutPortalUserFieldValues.md) |  | |
+
+### Return type
+
+[**GetPortalUserFieldValues**](GetPortalUserFieldValues.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Portal user field values |  -  |
+| **400** | Invalid field values |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Portal or user 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)
+
+
 ## removePortalUser
 
 > removePortalUser(portalId, userId)

package/docs/PortalUserFieldConfig.md

@@ -0,0 +1,36 @@
+
+# PortalUserFieldConfig
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`groups` | [Array<PortalUserFieldGroup>](PortalUserFieldGroup.md)
+`fields` | [Array<PortalUserFieldDefinition>](PortalUserFieldDefinition.md)
+
+## Example
+
+```typescript
+import type { PortalUserFieldConfig } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "groups": null,
+  "fields": null,
+} satisfies PortalUserFieldConfig
+
+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 PortalUserFieldConfig
+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/PortalUserFieldDefinition.md

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