@easyedu/js-lsm-api 1.32.0 → 1.34.0

package/docs/RoleApi.md

@@ -0,0 +1,685 @@
+# RoleApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**assignUserRole**](RoleApi.md#assignuserrole) | **POST** /roles/users/{userId}/portals/{portalId}/roles/{roleId} | Assign a role to a user for a portal |
+| [**createRole**](RoleApi.md#createrole) | **POST** /roles | Create a custom role scoped to the current portal |
+| [**deleteRole**](RoleApi.md#deleterole) | **DELETE** /roles/{roleId} | Deactivate a custom role |
+| [**getPermissions**](RoleApi.md#getpermissions) | **GET** /roles/permissions | List all available permissions in the system |
+| [**getRole**](RoleApi.md#getrole) | **GET** /roles/{roleId} | Get role details with permissions |
+| [**getRoles**](RoleApi.md#getroles) | **GET** /roles | List all roles available to the current portal |
+| [**getUserRoles**](RoleApi.md#getuserroles) | **GET** /roles/users/{userId}/portals/{portalId} | Get all active roles for a user in a portal |
+| [**unassignUserRole**](RoleApi.md#unassignuserrole) | **DELETE** /roles/users/{userId}/portals/{portalId}/roles/{roleId} | Remove a role from a user for a portal |
+| [**updateRole**](RoleApi.md#updaterole) | **PUT** /roles/{roleId} | Update a custom role name and description |
+| [**updateRolePermissions**](RoleApi.md#updaterolepermissions) | **PUT** /roles/{roleId}/permissions | Replace all permissions for a custom role |
+
+
+
+## assignUserRole
+
+> assignUserRole(userId, portalId, roleId)
+
+Assign a role to a user for a portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RoleApi,
+} from '@easyedu/js-lsm-api';
+import type { AssignUserRoleRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new RoleApi();
+
+  const body = {
+    // string
+    userId: userId_example,
+    // string
+    portalId: portalId_example,
+    // string
+    roleId: roleId_example,
+  } satisfies AssignUserRoleRequest;
+
+  try {
+    const data = await api.assignUserRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | `string` |  | [Defaults to `undefined`] |
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+| **roleId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Role assigned |  -  |
+| **404** | User, portal, or role 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)
+
+
+## createRole
+
+> GetRole createRole(postRole)
+
+Create a custom role scoped to the current portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RoleApi,
+} from '@easyedu/js-lsm-api';
+import type { CreateRoleRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new RoleApi();
+
+  const body = {
+    // PostRole
+    postRole: ...,
+  } satisfies CreateRoleRequest;
+
+  try {
+    const data = await api.createRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postRole** | [PostRole](PostRole.md) |  | |
+
+### Return type
+
+[**GetRole**](GetRole.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Role created |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteRole
+
+> deleteRole(roleId)
+
+Deactivate a custom role
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RoleApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteRoleRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new RoleApi();
+
+  const body = {
+    // string
+    roleId: roleId_example,
+  } satisfies DeleteRoleRequest;
+
+  try {
+    const data = await api.deleteRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **roleId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Role deactivated |  -  |
+| **403** | Cannot delete system roles |  -  |
+| **404** | Role 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)
+
+
+## getPermissions
+
+> Array<GetPermission> getPermissions()
+
+List all available permissions in the system
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RoleApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPermissionsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new RoleApi();
+
+  try {
+    const data = await api.getPermissions();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<GetPermission>**](GetPermission.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Permission list |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getRole
+
+> GetRole getRole(roleId)
+
+Get role details with permissions
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RoleApi,
+} from '@easyedu/js-lsm-api';
+import type { GetRoleRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new RoleApi();
+
+  const body = {
+    // string
+    roleId: roleId_example,
+  } satisfies GetRoleRequest;
+
+  try {
+    const data = await api.getRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **roleId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetRole**](GetRole.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Role details |  -  |
+| **404** | Role 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)
+
+
+## getRoles
+
+> Array<GetRole> getRoles()
+
+List all roles available to the current portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RoleApi,
+} from '@easyedu/js-lsm-api';
+import type { GetRolesRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new RoleApi();
+
+  try {
+    const data = await api.getRoles();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<GetRole>**](GetRole.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Role list |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getUserRoles
+
+> Array<GetUserRole> getUserRoles(userId, portalId)
+
+Get all active roles for a user in a portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RoleApi,
+} from '@easyedu/js-lsm-api';
+import type { GetUserRolesRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new RoleApi();
+
+  const body = {
+    // string
+    userId: userId_example,
+    // string
+    portalId: portalId_example,
+  } satisfies GetUserRolesRequest;
+
+  try {
+    const data = await api.getUserRoles(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | `string` |  | [Defaults to `undefined`] |
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<GetUserRole>**](GetUserRole.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | User roles |  -  |
+| **404** | User or 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)
+
+
+## unassignUserRole
+
+> unassignUserRole(userId, portalId, roleId)
+
+Remove a role from a user for a portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RoleApi,
+} from '@easyedu/js-lsm-api';
+import type { UnassignUserRoleRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new RoleApi();
+
+  const body = {
+    // string
+    userId: userId_example,
+    // string
+    portalId: portalId_example,
+    // string
+    roleId: roleId_example,
+  } satisfies UnassignUserRoleRequest;
+
+  try {
+    const data = await api.unassignUserRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | `string` |  | [Defaults to `undefined`] |
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+| **roleId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Role removed |  -  |
+| **404** | User, portal, or role 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)
+
+
+## updateRole
+
+> GetRole updateRole(roleId, putRole)
+
+Update a custom role name and description
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RoleApi,
+} from '@easyedu/js-lsm-api';
+import type { UpdateRoleRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new RoleApi();
+
+  const body = {
+    // string
+    roleId: roleId_example,
+    // PutRole
+    putRole: ...,
+  } satisfies UpdateRoleRequest;
+
+  try {
+    const data = await api.updateRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **roleId** | `string` |  | [Defaults to `undefined`] |
+| **putRole** | [PutRole](PutRole.md) |  | |
+
+### Return type
+
+[**GetRole**](GetRole.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Role updated |  -  |
+| **403** | Cannot modify system roles |  -  |
+| **404** | Role 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)
+
+
+## updateRolePermissions
+
+> updateRolePermissions(roleId, putRolePermissions)
+
+Replace all permissions for a custom role
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RoleApi,
+} from '@easyedu/js-lsm-api';
+import type { UpdateRolePermissionsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new RoleApi();
+
+  const body = {
+    // string
+    roleId: roleId_example,
+    // PutRolePermissions
+    putRolePermissions: ...,
+  } satisfies UpdateRolePermissionsRequest;
+
+  try {
+    const data = await api.updateRolePermissions(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **roleId** | `string` |  | [Defaults to `undefined`] |
+| **putRolePermissions** | [PutRolePermissions](PutRolePermissions.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Permissions updated |  -  |
+| **403** | Cannot modify system role permissions |  -  |
+| **404** | Role 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)
+

package/package.json

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