@easyedu/js-lsm-api 1.77.0 → 1.78.0

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)
@@ -832,7 +974,7 @@ async function example() {
   const body = {
     // string
     portalId: portalId_example,
-    // Blob | Favicon image file (PNG, ICO, or SVG). Max 1MB.
+    // Blob | Avatar image file (PNG, JPEG, or SVG). Max 2MB.
     file: BINARY_DATA_HERE,
   } satisfies PostPortalFaviconUploadRequest;
 
@@ -854,7 +996,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **portalId** | `string` |  | [Defaults to `undefined`] |
-| **file** | `Blob` | Favicon image file (PNG, ICO, or SVG). Max 1MB. | [Defaults to `undefined`] |
+| **file** | `Blob` | Avatar image file (PNG, JPEG, or SVG). Max 2MB. | [Defaults to `undefined`] |
 
 ### Return type
 
@@ -902,7 +1044,7 @@ async function example() {
   const body = {
     // string
     portalId: portalId_example,
-    // Blob | Logo image file (PNG, JPEG, or SVG). Max 5MB.
+    // Blob | Avatar image file (PNG, JPEG, or SVG). Max 2MB.
     file: BINARY_DATA_HERE,
   } satisfies PostPortalLogoUploadRequest;
 
@@ -924,7 +1066,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **portalId** | `string` |  | [Defaults to `undefined`] |
-| **file** | `Blob` | Logo image file (PNG, JPEG, or SVG). Max 5MB. | [Defaults to `undefined`] |
+| **file** | `Blob` | Avatar image file (PNG, JPEG, or SVG). Max 2MB. | [Defaults to `undefined`] |
 
 ### Return type
 
@@ -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/PortalSublicense.md

@@ -12,30 +12,6 @@ Name | Type
 `licenseState` | string
 `activeEnrollmentCount` | number
 
-## Example
-
-```typescript
-import type { PortalSublicense } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "seatLimit": null,
-  "licenseStartAt": null,
-  "licenseEndAt": null,
-  "licenseState": null,
-  "activeEnrollmentCount": null,
-} satisfies PortalSublicense
-
-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 PortalSublicense
-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/PortalUserFieldConfig.md

@@ -0,0 +1,15 @@
+
+# PortalUserFieldConfig
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`groups` | [Array<PortalUserFieldGroup>](PortalUserFieldGroup.md)
+`fields` | [Array<PortalUserFieldDefinition>](PortalUserFieldDefinition.md)
+
+
+[[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,24 @@
+
+# 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)
+
+
+[[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/PortalUserFieldGroup.md

@@ -0,0 +1,19 @@
+
+# PortalUserFieldGroup
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`key` | string
+`label` | string
+`description` | string
+`displayOrder` | number
+`isActive` | boolean
+
+
+[[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,18 @@
+
+# PortalUserFieldMissingRequired
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`key` | string
+`label` | string
+`groupId` | string
+`groupLabel` | string
+
+
+[[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,18 @@
+
+# PortalUserFieldOption
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`value` | string
+`label` | string
+`displayOrder` | number
+`isActive` | boolean
+
+
+[[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,22 @@
+
+# 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)
+
+
+[[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,18 @@
+
+# PortalUserFieldValueGroup
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`key` | string
+`label` | string
+`displayOrder` | number
+`fields` | [Array<PortalUserFieldValueField>](PortalUserFieldValueField.md)
+
+
+[[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,15 @@
+
+# PortalUserFieldValueInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fieldId` | string
+`value` | object
+
+
+[[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/PostCertificate.md

@@ -12,29 +12,6 @@ Name | Type
 `issuedAt` | number
 `note` | string
 
-## Example
-
-```typescript
-import type { PostCertificate } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "userId": null,
-  "expiresAt": null,
-  "issuedAt": null,
-  "note": null,
-} satisfies PostCertificate
-
-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 PostCertificate
-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/PostCertificateConfig.md

@@ -13,31 +13,6 @@ Name | Type
 `minQuizScore` | number
 `quizConfigId` | string
 
-## Example
-
-```typescript
-import type { PostCertificateConfig } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "courseId": null,
-  "enabled": null,
-  "expiryMonths": null,
-  "requireQuizPass": null,
-  "minQuizScore": null,
-  "quizConfigId": null,
-} satisfies PostCertificateConfig
-
-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 PostCertificateConfig
-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/PostContentQuiz.md

@@ -13,31 +13,6 @@ Name | Type
 `order` | number
 `assignment` | [PostContentQuizAssignment](PostContentQuizAssignment.md)
 
-## Example
-
-```typescript
-import type { PostContentQuiz } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "name": null,
-  "description": null,
-  "questionSelection": null,
-  "settings": null,
-  "order": null,
-  "assignment": null,
-} satisfies PostContentQuiz
-
-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 PostContentQuiz
-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/PostContentQuizAssignment.md

@@ -7,34 +7,11 @@ Assignment settings for the quiz
 
 Name | Type
 ------------ | -------------
-`dueDate` | Date
-`availableFrom` | Date
-`availableUntil` | Date
+`dueDate` | string
+`availableFrom` | string
+`availableUntil` | string
 `assignedUsers` | Array<string>
 
-## Example
-
-```typescript
-import type { PostContentQuizAssignment } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "dueDate": null,
-  "availableFrom": null,
-  "availableUntil": null,
-  "assignedUsers": null,
-} satisfies PostContentQuizAssignment
-
-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 PostContentQuizAssignment
-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)